Differences

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

Link to this comparison view

Next revision 		Previous revision
regionalize_map [2011/07/31 19:50]
hermann created 		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|Map]]  | Any map.  |+| Global Map  | [[Map Type]] ​ | The map to crop.  |
  
 ===== Optional Inputs ===== ===== Optional Inputs =====
  
-^ Name ^ Type ^ Description ^ Default Value ^ +^ Name  ^ Type  ^ Description ​ ^ Default Value  ^ 
-| Region Id  | [[Int Type|Int]]  | Region ​Id.  | 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 ​ | 
-| Region ​Manager ​ | [[Region Manager ​Type|Region Manager ​ ]]  | This is internally linked by the “Region Manager” container. ​ | None  |+| 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|Map]]  | Regional maps.  |+| Regional Map  | [[Map Type]] ​ | Map cropped to the specified region.  |
  
 ===== Group ===== ===== Group =====
Line 27: Line 28:
 ===== Notes ===== ===== Notes =====
  
-===== Internal Name ===== +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 =====
  
 RegionalizeMap RegionalizeMap
 +
 +===== Usage examples =====
 +
 +See practical examples of this functor in [[lesson_14|Lesson 14: Using For Each Category and Region Manager]]