Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
regionalize_map [2016/05/02 18:34] hermann |
regionalize_map [2026/08/28 03:31] (current) hermann Sync from local documentation review |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== Regionalize Map ====== | + | ====== Regionalize Map ====== |
| ===== Description ===== | ===== Description ===== | ||
| - | This functor splits a map into a series of regional maps. | + | Crops a 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 | [[Map Type]] | Any map. | | + | | Global Map | [[Map Type]] | The map to crop. | |
| - | | Region Id | [[Integer Value Type]] | Region identifier.((Since Dinamica EGO 2.0, this input is no longer optional)) | | + | |
| - | | Keep Non Region Cells | [[Boolean Value Type]] | 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. | | + | ===== Optional Inputs ===== |
| - | | 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)) | | + | |
| + | ^ Name ^ Type ^ Description ^ Default Value ^ | ||
| + | | 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]] | 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]] | 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 | [[Map Type]] | Regional maps. | | + | | Regional Map | [[Map Type]] | Map cropped to the specified region. | |
| ===== Group ===== | ===== Group ===== | ||
| - | [[Functor List#Region|Region]] | + | [[Functor List#Region | Region]] |
| ===== 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 ===== |
| RegionalizeMap | RegionalizeMap | ||
| + | |||
| + | ===== Usage examples ===== | ||
| + | |||
| + | See practical examples of this functor in [[lesson_14|Lesson 14: Using For Each Category and Region Manager]] | ||