Differences

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

--- get_elevation_graph_info [2026/01/09 20:16]
admin created
+++ get_elevation_graph_info [2026/08/28 03:20] (current)
hermann Sync from local documentation review
@@ Line 2: / Line 2: @@
 ===== Description =====
-This functor retrieves complete information from the elevation patch graph, including the characteristics of each patch and its relationship with neighboring patches.
+This functor retrieves complete information from an elevation patch graph, including each patch's own properties and its relationship with neighboring patches.
 ===== Inputs =====
 ^ Name  ^ Type  ^ Description  ^
-| Elevation Graph | [[Elevation Graph Type]]  | Elevation patch graph created from neighborhood relationships and their properties.  |
+| Elevation Graph  | [[Elevation Graph Type]]  | Elevation patch graph created from neighborhood relationships and their properties.  |
 ===== Optional Inputs =====
 ^ Name  ^ Type  ^ Description  ^ Default Value  ^
-| Also Retrieve Parent Info  | [[Boolean Type]]  | Flag indicating whether the relationship of neighboring patches of a patch that are higher than it will be returned as the content of the "parentPatches" output port. If false, the returned table will be empty.  | -  |
+| Also Retrieve Parent Info  | [[Boolean Value Type]]  | If true, Parent Patch Info is filled with the relationships of each patch's neighboring patches that are higher than it. If false, that table is left empty.  | No  |
-| Also Retrieve Child Info  | [[Boolean Type]]  | Flag indicating whether the relationship of neighboring patches of a patch that are lower than it will be returned as the content of the "childPatches" output port. If false, the returned table will be empty.  | -  |
+| Also Retrieve Child Info  | [[Boolean Value Type]]  | If true, Child Patch Info is filled with the relationships of each patch's neighboring patches that are lower than it. If false, that table is left empty.  | No  |
+===== Outputs =====
-===== Output =====
 ^ Name  ^ Type  ^ Description  ^
-| Patch Info  | [[Table Type]]  | Table containing the property relationships of each of the elevation patches. The table format is "Patch_Id*:real, Patch_Elevation:real, Patch_Area:real, Patch_Combined_Area:real, Patch_Slope:real, Patch_Y:real, Patch_X:real, Patch_Parents:real, Patch_Children:real".  |
+| Patch Info  | [[Table Type]]  | Table of property relationships for each elevation patch, in the format "Patch_Id*:real, Patch_Elevation:real, Patch_Area:real, Patch_Combined_Area:real, Patch_Slope:real, Patch_Y:real, Patch_X:real, Patch_Parents:real, Patch_Children:real".  |
-| Parent Patch Info  | [[Table Type]]  | Table containing the relationships of neighboring patches of each elevation patch that are higher than it. The table format is "Patch_Id*:real, Parent_Id*:real, Index:real". This table will be empty if "alsoRetrieveParentInfo" is false.  |
+| Parent Patch Info  | [[Table Type]]  | Table of the relationships between each elevation patch and its neighboring patches that are higher than it, in the format "Patch_Id*:real, Parent_Id*:real, Index:real". Empty when Also Retrieve Parent Info is false.  |
-| Child Patch Info  | [[Table Type]]  | Table containing the relationships of neighboring patches of each elevation patch that are lower than it. The table format is "Patch_Id*:real, Child_Id*:real, Index:real". This table will be empty if "alsoRetrieveChildInfo" is false.  |
+| Child Patch Info  | [[Table Type]]  | Table of the relationships between each elevation patch and its neighboring patches that are lower than it, in the format "Patch_Id*:real, Child_Id*:real, Index:real". Empty when Also Retrieve Child Info is false.  |
 ===== Group =====
 [[Functor List#Elevation Graph | Elevation Graph]]
 ===== Notes =====
-Retrieves complete information from the elevation patch graph, including the characteristics of each patch and its relationship with neighboring patches.
+None.
 ===== Internal Name =====
 GetElevationGraphInfo