Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
regionalize_categorical_map [2016/05/02 18:21] hermann [Inputs] |
regionalize_categorical_map [2026/08/28 03:31] (current) hermann Sync from local documentation review |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== Regionalize Categorical Map ====== | + | ====== Regionalize Categorical Map ====== |
| ===== Description ===== | ===== Description ===== | ||
| - | This functor splits a categorical map into a series of regional categorical maps. | + | Crops a categorical map down to a single region, returning the piece of the map that falls inside that region's mask. |
| ===== Inputs ===== | ===== Inputs ===== | ||
| ^ Name ^ Type ^ Description ^ | ^ Name ^ Type ^ Description ^ | ||
| - | | Global Map | [[Categorical Map Type]] | A given categorical map. | | + | | Global Map | [[Categorical Map Type]] | The categorical map to crop. | |
| ===== Optional Inputs ===== | ===== Optional Inputs ===== | ||
| ^ Name ^ Type ^ Description ^ Default Value ^ | ^ Name ^ Type ^ Description ^ Default Value ^ | ||
| - | | Region Id | [[Integer Value Type]] | Region identifier.((Since Dinamica EGO 2.0, this input is no longer optional)) | 0 | | + | | Region Id | [[Integer Value Type]] | Identifier of the region to extract. When this functor is placed inside a [[For Each Region]] or [[Region]] container, this port connects to the current region automatically. | Provided automatically | |
| - | | Keep Non Region Cells | [[Boolean Value Type|Boolean Value]] | If true, cells from the regional map located outside the region mask are preserved, including the additional border cells. Otherwise, these cells are filled with null values. | False | | + | | Keep Non Region Cells | [[Boolean Value Type]] | If true, cells located outside the region's mask — including its extra border — are kept in the result. If false, those cells are filled with null values. | No | |
| - | | Region Manager | [[Region Manager Type]] | This is internally linked by the [[Region Manager]] container.((Since Dinamica EGO 2.0, this input is no longer optional)) | None | | + | | Recreate Categories | [[Boolean Value Type]] | If true, the category legend of the cropped region is rebuilt from the values actually present in it. If false, the cropped map keeps the original map's full category legend, whether or not each category is still present in the cropped region. | No | |
| + | | Region Manager | [[Region Manager Type]] | The region manager to read. When this functor is placed inside a [[Region Manager]], [[Region]], or [[For Each Region]] container, this port connects to that container's region manager automatically. | Provided automatically | | ||
| ===== Outputs ===== | ===== Outputs ===== | ||
| ^ Name ^ Type ^ Description ^ | ^ Name ^ Type ^ Description ^ | ||
| - | | Regional Map | [[Categorical Map Type]] | Regional categorical maps. | | + | | Regional Map | [[Categorical Map Type]] | Categorical map cropped to the specified region. This functor preserves the category legend of the input map, subject to Recreate Categories above. | |
| ===== Group ===== | ===== Group ===== | ||
| Line 28: | Line 29: | ||
| ===== Notes ===== | ===== Notes ===== | ||
| - | None. | + | Region Id can be set to a fixed constant instead of being left to auto-bind, but doing so triggers a warning recommending that it be supplied by an enclosing loop's current iteration instead. |
| - | ===== Internal Name ===== | + | ===== Internal Name ===== |
| RegionalizeCategoricalMap | RegionalizeCategoricalMap | ||