Differences

This shows you the differences between two versions of the page.

--- for_each_region [2026/08/27 03:46]
hermann
+++ for_each_region [2026/08/28 03:20] (current)
hermann Sync from local documentation review
@@ Line 1: / Line 1: @@
 ====== For Each Region ======
-=== Description ===
+===== Description =====
 This container creates and manages the regions identified by a categorical map, and executes the functors it contains once for each region. Each execution is called a step. While a step runs, the container makes the region manager available to its contents through the internal output port Region Manager, and the identifier of the region currently being processed through the internal output port Step.
-=== Inputs ===
+===== Inputs =====
-^ Name ^ Type ^ Description ^
+^ Name  ^ Type  ^ Description  ^
-| Regions | [[categorical_map_type|Categorical Map Type]] | Map of subregions, such as countries, states, or counties. The cells that make up a region do not need to be contiguous. |
+| Regions  | [[Categorical Map Type]]  | Map of subregions, such as countries, states, or counties. The cells that make up a region do not need to be contiguous.  |
-=== Optional Inputs ===
+===== Optional Inputs =====
-^ Name ^ Type ^ Default ^ Description ^
+^ Name  ^ Type  ^ Description  ^ Default Value  ^
-| Border Cells | [[non_negative_integer_value_type|Non Negative Integer Value Type]] | 0 | Number of lines and columns added as an extra border around each region in its regional maps. |
+| Border Cells  | [[Non Negative Integer Value Type]]  | Number of lines and columns added as an extra border around each region in its regional maps.  | 0  |
-| Sequence Input | [[none_type|None Type]] | None | Ensures that the functor connected to this port finishes executing before this container starts. |
+| Sequence Input  | [[None Type]]  | Ensures that the functor connected to this port finishes executing before this container starts.  | None  |
-=== Outputs ===
+===== Outputs =====
-^ Name ^ Type ^ Description ^
+^ Name  ^ Type  ^ Description  ^
-| Sequence Output | [[none_type|None Type]] | Connect this port to another container's Sequence Input to make this container finish executing before that other container starts. |
+| Sequence Output  | [[None Type]]  | Connect this port to another container's Sequence Input to make this container finish executing before that other container starts.  |
-=== Internal Outputs ===
+===== Internal Outputs =====
-^ Name ^ Type ^ Description ^
+^ Name  ^ Type  ^ Description  ^
-| Region Manager | [[region_manager_type|Region Manager Type]] | The region manager holding the regions being iterated. |
+| Region Manager  | [[Region Manager Type]]  | The region manager holding the regions being iterated.  |
-| Step | [[integer_value_type|Integer Value Type]] | Identifier of the region currently being processed. |
+| Step  | [[Integer Value Type]]  | Identifier of the region currently being processed.  |
-=== Group ===
+===== Group =====
-[[functor_list#control|Control]]
+[[Functor List#Control | Control]]
-=== Notes ===
+===== Notes =====
-  * When there is no dependency between regions, this container may process several of them at the same time instead of one after another.
+When there is no dependency between regions, this container may process several of them at the same time instead of one after another.
-  * [[Get Region Info]], [[Regionalize Map]], [[Regionalize Categorical Map]], and [[Region]] placed directly inside this container read the current region automatically through their own inputs, with no need to connect Region Manager or Step explicitly.
-  * The region manager this container exposes only supports splitting a map into its regions — it cannot be used to merge regional maps back together. Placing [[Merge Regional Maps]] or [[Merge Regional Categorical Maps]] inside this container, reading from its region manager, causes the model to report an error. Placing [[Regional Map]] or [[Regional Categorical Map]] here has no effect, since there is nothing for them to register a map against.
-  * When a result produced by the contained functors is used outside the container, connect a matching junction (such as [[Map Junction]] or [[Value Junction]]) after the container, so a value still reaches the rest of the model if there are no regions to process.
-=== Internal Name ===
+[[Get Region Info]], [[Regionalize Map]], [[Regionalize Categorical Map]], and [[Region]] placed directly inside this container read the current region automatically through their own inputs, with no need to connect Region Manager or Step explicitly.
+The region manager this container exposes only supports splitting a map into its regions — it cannot be used to merge regional maps back together. Placing [[Merge Regional Maps]] or [[Merge Regional Categorical Maps]] inside this container, reading from its region manager, causes the model to report an error. Placing [[Regional Map]] or [[Regional Categorical Map]] here has no effect, since there is nothing for them to register a map against.
+When a result produced by the contained functors is used outside the container, connect a matching junction (such as [[Map Junction]] or [[Value Junction]]) after the container, so a value still reaches the rest of the model if there are no regions to process.
+===== Internal Name =====
 ForEachRegion