Differences

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

Link to this comparison view

Both sides previous revision Previous revision
create_elevation_graph [2026/08/17 19:43]
hermann
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 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]] ​ | Defines spatial connectivity between elevation patches. Elevation patches are represented by their corresponding ids.  | +| Neighborhood Table  | [[Neighborhood Table Type]] ​ | Defines spatial connectivity between elevation patches. Elevation patches are represented by their corresponding ids.  | 
-| Properties | [[Table Type]] ​ | Elevation ​patch properties ​table. The table has the format "​Patch_Id*:​real,​ Patch_Elevation:​real,​ Patch_Area:​real,​ Patch_Slope:​real,​ Patch_Y:​real,​ Patch_X:​real"​. ​The "Patch_Y" ​and "Patch_X" values ​typically ​represent ​the 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]] ​ | Elevation patch graph created from 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 =====
  
-The elevation patch graph is a directed graph whose nodes correspond to the patches defined in the neighborhood table, typically ​constructed ​from a terrain map. The edges between nodes represent the adjacency ​relationships ​and elevation ​differences ​between each patch and its neighbors. The parent nodes of a given node correspond to neighbors with higher elevation, ​while child nodes correspond to neighbors with lower elevation. +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 ​neighborsand its child nodes are its lower-elevation ​neighbors. Neighboring patches must have different elevation values according to Properties, ​or this functor reports ​an error.
- +
-Neighboring patches ​according to the neighborhood relationship ​must have different elevation values according to the table provided in "Properties". Otherwise, an error will be reported.+
  
 ===== Internal Name ===== ===== Internal Name =====
  
 CreateElevationGraph CreateElevationGraph
 +