Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
merge_regional_maps [2011/07/31 18:44] hermann created |
merge_regional_maps [2026/08/28 03:27] (current) hermann Sync from local documentation review |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== Merge Regional Maps ====== | + | ====== Merge Regional Maps ====== |
| ===== Description ===== | ===== Description ===== | ||
| - | This functor merges regional maps in to a single map. | + | Rebuilds a single map by merging together all the regional maps that [[Regional 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 ]] | Name of the regional maps specified in functor “Regional Map”. | | + | | Global Map Name | [[Name Type]] | Name under which the regional maps to merge were registered by [[Regional Map]]. | |
| - | ===== Optinal Inputs ===== | + | ===== Optional Inputs ===== |
| - | ^ Name ^ Type ^ Description ^ Default Value ^ | + | ^ Name ^ Type ^ Description ^ Default Value ^ |
| - | | Region Manager | [[ Region Manager Type|Region Manager ]] | This is internally linked by the “Region Manager” container. | None | | + | | 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 | [[ Map Type|Map ]] | Mosaic map. | | + | | Global Map | [[Map Type]] | Mosaic of the regional maps registered under Global Map Name. | |
| ===== Group ===== | ===== Group ===== | ||
| Line 24: | Line 25: | ||
| [[Functor List#Region | Region]] | [[Functor List#Region | Region]] | ||
| - | ===== Notes ===== | + | ===== Notes ===== |
| - | This functor allows several regional maps to be merged in a single mosaic. | + | This functor raises an error if no [[Regional 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 Map]] registering each region's map inside it. | ||
| + | |||
| + | ===== Internal Name ===== | ||
| MergeRegionalMaps | MergeRegionalMaps | ||