Differences

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

Link to this comparison view

Next revision
Previous revision
create_elevation_graph [2026/01/06 19:31]
admin created
create_elevation_graph [2026/08/28 03:14] (current)
hermann Sync from local documentation review
Line 3: Line 3:
 ===== Description ===== ===== Description =====
  
-This functor creates the elevation patch graph from the neighborhood information and their properties.+This functor creates the elevation patch graph from neighborhood information and patch properties.
  
 ===== Inputs ===== ===== Inputs =====
  
 ^ Name  ^ Type  ^ Description ​ ^ ^ Name  ^ Type  ^ Description ​ ^
-| Neighborhood Table | [[Neighborhood Table Type]] ​ | Relationship of neighborhoods ​between ​the patches. ​ | +| Neighborhood Table  | [[Neighborhood Table Type]] ​ | Defines spatial connectivity ​between ​elevation patches. Elevation ​patches ​are represented by their corresponding ids.  | 
-| Properties | [[Table Type]] ​ | Table of elevation patch properties. The table has format "id*:​real, ​elevation:​real, ​area:​real, ​slope:​real, ​y:​real, ​x:​real"​. ​The y and x values ​typically ​represent ​coordinates of the patch centroids.  |+| Properties ​ | [[Table Type]] ​ | Table of elevation patch properties, in the format "Patch_Id*:​real, ​Patch_Elevation:​real, ​Patch_Area:​real, ​Patch_Slope:​real, ​Patch_Y:​real, ​Patch_X:​real"​. ​Patch_Y ​and Patch_X ​typically ​hold the coordinates of each patch's centroid. Neighboring patches, per Neighborhood Table, must have different elevation values in Properties, or this functor reports an error.  |
  
 ===== Optional Inputs ===== ===== Optional Inputs =====
Line 15: Line 15:
 None. None.
  
-===== Output ​=====+===== Outputs ​=====
  
 ^ Name  ^ Type  ^ Description ​ ^ ^ Name  ^ Type  ^ Description ​ ^
-| Elevation Graph  | [[Elevation Graph Type]] ​ | Graph of elevation patches ​created from the neighborhood relationships and their properties. ​ |+| Elevation Graph  | [[Elevation Graph Type]] ​ | Elevation patch graph created from the neighborhood relationships and their properties. ​ |
  
 ===== Group ===== ===== Group =====
Line 26: Line 26:
 ===== Notes ===== ===== Notes =====
  
-Creates the elevation patch graph from the neighborhood information ​and their properties.+The elevation patch graph is a directed graph whose nodes correspond to the patches defined in Neighborhood Table, typically built from a terrain map. Its edges represent ​the adjacency ​and elevation-difference relationships between each patch and its neighbors: a node's parent nodes are its higher-elevation neighbors, and its child nodes are its lower-elevation neighbors. Neighboring patches must have different elevation values according to Properties, or this functor reports an error.
  
 ===== Internal Name ===== ===== Internal Name =====