Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | |||
|
get_region_info [2026/08/27 03:49] hermann |
get_region_info [2026/08/28 03:22] (current) hermann Sync from local documentation review |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== Get Region Info ====== | ====== Get Region Info ====== | ||
| - | === Description === | + | ===== Description ===== |
| Returns the mask, dimensions, projection, and boundary coordinates of a single region held by a region manager. | Returns the mask, dimensions, projection, and boundary coordinates of a single region held by a region manager. | ||
| - | === Inputs === | + | ===== Inputs ===== |
| None. | None. | ||
| - | === Optional Inputs === | + | ===== Optional Inputs ===== |
| - | ^ Name ^ Type ^ Default ^ Description ^ | + | ^ Name ^ Type ^ Description ^ Default Value ^ |
| - | | Region Id | [[integer_value_type|Integer Value Type]] | Provided automatically | Identifier of the region to describe. When this functor is placed inside a [[For Each Region]] or [[Region]] container, this port connects to the current region automatically. | | + | | Region Id | [[Integer Value Type]] | Identifier of the region to describe. 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 Type]] | Provided automatically | 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. | | + | | 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 ^ |
| - | | Region Mask | [[categorical_map_type|Categorical Map Type]] | Map representing the region's mask and geographic extent. | | + | | Region Mask | [[Categorical Map Type]] | Map representing the region's mask and geographic extent. | |
| - | | Region Lines | [[positive_integer_value_type|Positive Integer Value Type]] | Total number of lines of the region's map. | | + | | Region Lines | [[Positive Integer Value Type]] | Total number of lines of the region's map. | |
| - | | Region Columns | [[positive_integer_value_type|Positive Integer Value Type]] | Total number of columns of the region's map. | | + | | Region Columns | [[Positive Integer Value Type]] | Total number of columns of the region's map. | |
| - | | Region Projection | [[projection_type|Projection Type]] | Coordinate reference system of the original map the region was extracted from. | | + | | Region Projection | [[Projection Type]] | Coordinate reference system of the original map the region was extracted from. | |
| - | | Region Top Y Coordinate | [[real_value_type|Real Value Type]] | Y coordinate of the region's top boundary. | | + | | Region Top Y Coordinate | [[Real Value Type]] | Y coordinate of the region's top boundary. | |
| - | | Region Left X Coordinate | [[real_value_type|Real Value Type]] | X coordinate of the region's left boundary. | | + | | Region Left X Coordinate | [[Real Value Type]] | X coordinate of the region's left boundary. | |
| - | | Region Bottom Y Coordinate | [[real_value_type|Real Value Type]] | Y coordinate of the region's bottom boundary. | | + | | Region Bottom Y Coordinate | [[Real Value Type]] | Y coordinate of the region's bottom boundary. | |
| - | | Region Right X Coordinate | [[real_value_type|Real Value Type]] | X coordinate of the region's right boundary. | | + | | Region Right X Coordinate | [[Real Value Type]] | X coordinate of the region's right boundary. | |
| - | === Group === | + | ===== Group ===== |
| - | [[functor_list#region|Region]] | + | [[Functor List#Region | Region]] |
| - | === Notes === | + | ===== Notes ===== |
| - | * 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. | + | 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 ===== |
| GetRegionInfo | GetRegionInfo | ||