Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
merge_regional_categorical_maps [2016/05/02 18:43] hermann |
merge_regional_categorical_maps [2026/08/28 03:27] (current) hermann Sync from local documentation review |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== Merge Regional Categorical Maps ====== | + | ====== Merge Regional Categorical Maps ====== |
| ===== Description ===== | ===== Description ===== | ||
| - | This functor merges regional categorical maps in to a single map. | + | Rebuilds a single categorical map by merging together all the regional categorical maps that [[Regional Categorical Map]] registered under a given name in the same region manager. |
| ===== Inputs ===== | ===== Inputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ | + | ^ Name ^ Type ^ Description ^ |
| - | | Global Map Name | [[Name Type]] | Name of the regional categorical maps specified in functor “Regional Map”. | | + | | Global Map Name | [[Name Type]] | Name under which the regional categorical maps to merge were registered by [[Regional Categorical Map]]. | |
| - | | 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)) | | + | |
| ===== Optional Inputs ===== | ===== Optional Inputs ===== | ||
| ^ Name ^ Type ^ Description ^ Default Value ^ | ^ Name ^ Type ^ Description ^ Default Value ^ | ||
| - | | Merge Non Region Cells | [[Boolean Value Type]] | If true, cells from the regional map located outside the region mask are combined, including the additional border cells. Otherwise, these cells are ignored. The combination of two cells are possible only if they have the same value or one of them is a null value, otherwise an error is reported. | False | | + | | Merge Non Region Cells | [[Boolean Value Type]] | If true, cells located outside a region's mask — including its extra border — are merged in as well. If false, those cells are ignored. Merging two cells only works when they carry the same value, or when one of them is null. | No | |
| + | | Region Manager | [[Region Manager Type]] | The region manager to read. When this functor is placed inside a [[Region Manager]] or [[Region]] container, this port connects to that container's region manager automatically. | Provided automatically | | ||
| ===== Outputs ===== | ===== Outputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ | + | ^ Name ^ Type ^ Description ^ |
| - | | Global Map | [[Categorical Map Type]] | Mosaic categorical map. | | + | | Global Map | [[Categorical Map Type]] | Mosaic of the regional categorical maps registered under Global Map Name. | |
| ===== Group ===== | ===== Group ===== | ||
| - | [[Functor List#Region|Region]] | + | [[Functor List#Region | Region]] |
| - | ===== Notes ===== | + | ===== Notes ===== |
| - | This functor allows several regional categorical maps to be merged in a single mosaic. | + | This functor raises an error if no [[Regional Categorical Map]] registered a map under Global Map Name in the same region manager. |
| - | ===== Internal Name ===== | + | Merging cells outside the region masks raises an error if two different regional maps disagree on the value of the same cell — that is, both give it a non-null value, and the values differ. |
| + | |||
| + | Placing this functor inside a [[For Each Region]] container raises an error, since the region manager that container exposes does not store regional maps — it only splits a map into regions, it does not collect them back together. Use a [[Region Manager]] (or [[Region]]) instead, with [[Regional Categorical Map]] registering each region's map inside it. | ||
| + | |||
| + | ===== Internal Name ===== | ||
| MergeRegionalCategoricalMaps | MergeRegionalCategoricalMaps | ||