Differences

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

--- get_region_info [2026/01/29 20:28]
admin created
+++ get_region_info [2026/08/28 03:22] (current)
hermann Sync from local documentation review
@@ Line 2: / Line 2: @@
 ===== Description =====
-This functor retrieves information regarding a region.
+Returns the mask, dimensions, projection, and boundary coordinates of a single region held by a region manager.
 ===== Inputs =====
 None.
 ===== Optional Inputs =====
 ^ Name  ^ Type  ^ Description  ^ Default Value  ^
-| Region Id  | [[Integer Value Type]]  | Identifier of the region for which information will be obtained. This port automatically associates with the innermost compatible container.  | -  |
+| 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]]  | Manager where the coverage maps of each region are maintained. This port automatically associates with the innermost compatible container. This port is advanced.  | -  |
+| 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 =====
-===== Output =====
 ^ Name  ^ Type  ^ Description  ^
-| Regional Mask  | [[Categorical Map Type]]  | Map corresponding to the mask and geographic area of the specified region.  |
+| Region Mask  | [[Categorical Map Type]]  | Map representing the region's mask and geographic extent.  |
-| Region Lines  | [[Positive Integer Value Type]]  | Total number of lines in the map of the specified region.  |
+| Region Lines  | [[Positive Integer Value Type]]  | Total number of lines of the region's map.  |
-| Region Columns  | [[Positive Integer Value Type]]  | Total number of columns in the map of the specified region.  |
+| Region Columns  | [[Positive Integer Value Type]]  | Total number of columns of the region's map.  |
-| Region Projection  | [[Projection Type]]  | Cartographic projection system used in the original map from which the region was extracted.  |
+| Region Projection  | [[Projection Type]]  | Coordinate reference system of the original map the region was extracted from.  |
-| Region Top Y Coordinate  | [[Real Value Type]]  | Y coordinate value of the upper boundary of the region.  |
+| Region Top Y Coordinate  | [[Real Value Type]]  | Y coordinate of the region's top boundary.  |
-| Region Left X Coordinate  | [[Real Value Type]]  | X coordinate value of the left boundary of the region.  |
+| Region Left X Coordinate  | [[Real Value Type]]  | X coordinate of the region's left boundary.  |
-| Region Bottom Y Coordinate  | [[Real Value Type]]  | Y coordinate value of the lower boundary of the region.  |
+| Region Bottom Y Coordinate  | [[Real Value Type]]  | Y coordinate of the region's bottom boundary.  |
-| Region Right X Coordinate  | [[Real Value Type]]  | X coordinate value of the right boundary of the region.  |
+| Region Right X Coordinate  | [[Real Value Type]]  | X coordinate of the region's right boundary.  |
 ===== Group =====
 [[Functor List#Region | Region]]
 ===== Notes =====
-Retrieves the information of a region.
+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 =====
 GetRegionInfo