Get Elevation Graph Info

Description

This functor retrieves complete information from the elevation patch graph, including the characteristics of each patch 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.

Optional Inputs

Name	Type	Description	Default Value
Also Retrieve Parent Info	Boolean Value 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 Child Info	Boolean Value 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.	-

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”.
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.
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.

Group

Elevation Graph

Notes

Retrieves complete information from the elevation patch graph, including the characteristics of each patch and its relationship with neighboring patches.

Internal Name

GetElevationGraphInfo