Differences

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

Link to this comparison view

Next revision
Previous revision
get_elevation_graph_tops_and_bases [2026/01/06 18:57]
admin created
get_elevation_graph_tops_and_bases [2026/08/28 03:20] (current)
hermann Sync from local documentation review
Line 3: Line 3:
 ===== Description ===== ===== Description =====
  
-This functor retrieves the list of patches that correspond to local maxima and minima ​from the elevation patch graph.+This functor retrieves the patches that correspond to local maxima and minima ​of an elevation patch graph.
  
 ===== Inputs ===== ===== Inputs =====
  
 ^ 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 neighborhood relationships and their properties. ​ |
  
 ===== Optional Inputs ===== ===== Optional Inputs =====
Line 14: Line 14:
 None. None.
  
-===== Output ​=====+===== Outputs ​=====
  
 ^ Name  ^ Type  ^ Description ​ ^ ^ Name  ^ Type  ^ Description ​ ^
-| Tops  | [[Table Type]] ​ | List of properties ​of elevation patches corresponding to local maxima. The table has format "id*:​real, ​elevation:​real, ​area:​real, ​slope:​real"​. ​ | +| Tops  | [[Table Type]] ​ | Properties ​of the elevation patches corresponding to local maxima, in the format "Top_Id*:​real, ​Top_Elevation:​real, ​Top_Area:​real, ​Top_Slope:​real,​ Top_Y:real, Top_X:real, Top_Children:​real"​. ​ | 
-| Bases  | [[Table Type]] ​ | List of properties ​of elevation patches corresponding to local minima. The table has format "id*:​real, ​elevation:​real, ​area:​real, ​slope:​real"​. ​ |+| Bases  | [[Table Type]] ​ | Properties ​of the elevation patches corresponding to local minima, in the format "Base_Id*:​real, ​Base_Elevation:​real,​ Base_Area:​real,​ Base_Combined_Area:​real,​ Base_Slope:​real,​ Base_Y:​real, ​Base_X:​real, ​Base_Parents:​real"​. ​ |
  
 ===== Group ===== ===== Group =====
Line 26: Line 26:
 ===== Notes ===== ===== Notes =====
  
-Retrieves the list of patches that correspond to local maxima and minima from the elevation patch graph.+None.
  
 ===== Internal Name ===== ===== Internal Name =====