Differences

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

--- find_elevation_graph_bases [2026/08/17 19:54]
hermann created
+++ find_elevation_graph_bases [2026/08/28 03:19] (current)
hermann Sync from local documentation review
@@ Line 8: / Line 8: @@
 ^ 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.  |
-| Pseudo Tops | [[Base Table Type]]  | Table or lookup table listing the top elevation patches for which the base patches will be retrieved. These can be any patches in the elevation patch tree, not necessarily top-level top patches. The table keys represent the elevation patch ids of the tops. The values associated with each key are ignored.  |
+| Pseudo Tops  | [[Base Table Type]]  | Table or lookup table listing the top elevation patches for which the base patches are retrieved. These can be any patches in the elevation patch tree, not necessarily top-level patches. The table's keys are the ids of the top patches; the values associated with each key are ignored.  |
 ===== Optional Inputs =====
-^ Name  ^ Type  ^ Description  ^
+^ Name  ^ Type  ^ Description  ^ Default Value  ^
-| Search For All Bases | [[Boolean Value Type]]  | If true, the elevation patches of all reachable bases from each specified top will be retrieved. Otherwise, only the elevation patches of the lowest-elevation base will be retrieved. The default value is false.  |
+| Search For All Bases  | [[Boolean Value Type]]  | If true, the elevation patches of every reachable base from each specified top are retrieved. Otherwise, only the elevation patch of the lowest-elevation base is retrieved.  | No  |
-| Pseudo Bases | [[Base Table Type]]  | Table whose keys correspond to the ids of elevation patches that can be treated as bases of the graph. For each top specified in "Pseudo Tops", if the table is not provided or the respective id is not present in it, the search uses the regular criterion to determine if a node is a base. If the id is present, it is accepted as a base if reached during the search for the corresponding top, and none of that node's child nodes will be analyzed. The default value is null.  |
+| Pseudo Bases  | [[Base Table Type]]  | Table whose keys are the ids of elevation patches that can be treated as bases of the graph. For each top in Pseudo Tops, if this table is not provided or the top's id is not present in it, the search uses the regular criterion to decide whether a node is a base; if the id is present, that patch is accepted as a base once reached, and none of its child nodes are analyzed further.  | .none  |
-| Minimum Elevations | [[Lookup Table Type]]  | Lookup table listing elevation patches and the respective minimum elevations of those that can be retrieved as part of the paths between that patch and its respective bases. For each patch specified in "Pseudo Tops", if the table is not provided or the respective id is not present in it, the search assumes that any elevation is valid when searching for the base. If the id is present, the value associated with it will be used as the minimum elevation and patches with values lower than that will be ignored. Patches are also considered bases of the elevation graph if all their children are ignored. The default value is null.  |
+| Minimum Elevations  | [[Lookup Table Type]]  | Lookup table of elevation patches and the minimum elevation of patches that can be retrieved along the paths between that patch and its bases. For each top in Pseudo Tops, if this table is not provided or the top's id is not present in it, the search treats any elevation as valid; if the id is present, patches with a lower elevation than the associated value are ignored, and a patch is also treated as a base of the graph if all its children are ignored this way.  | .none  |
-| Maximum Nodes | [[Non Negative Integer Value Type]]  | Maximum number of nodes that can be visited between the top elevation patch and the corresponding base. If this quantity is exceeded, the top will be ignored. If 0, the maximum number of visited nodes is unlimited. The default value is 0.  |
+| Maximum Nodes  | [[Non Negative Integer Value Type]]  | Maximum number of nodes that can be visited between a top elevation patch and its corresponding base. A top exceeding this quantity is ignored. 0 means the number of visited nodes is unlimited. This is an advanced port.  | 0  |
-===== Output =====
+===== Outputs =====
 ^ Name  ^ Type  ^ Description  ^
-| Base Relations | [[Table Type]]  | Table containing the elevation patches representing the base corresponding to each top. The table has the format "Top_Id*:real, Base_Id*:real, Index:real".  |
+| Base Relations  | [[Table Type]]  | Table of the elevation patches representing the base corresponding to each top, in the format "Top_Id*:real, Base_Id*:real, Index:real".  |
-| All Base Patches | [[Table Type]]  | Table containing the list of elevation patches representing the bases corresponding to each top, without any specific structure. The table has the format "Row_Index*:real, Top_Id:real, Base_Id:real, Base_Index:real".  |
+| All Base Patches  | [[Table Type]]  | Table of the elevation patches representing the bases corresponding to each top, without any specific structure, in the format "Row_Index*:real, Top_Id:real, Base_Id:real, Base_Index:real".  |
 ===== Group =====
@@ Line 31: / Line 31: @@
 ===== Notes =====
-Retrieves the ids of the elevation patches corresponding to the bases of the paths from the specified pseudo-tops, considering either all reachable bases or only the lowest-elevation one, depending on "Search For All Bases".
+Retrieves the ids of the elevation patches corresponding to the bases of the paths from the specified pseudo-tops, considering either all reachable bases or only the lowest-elevation one, depending on Search For All Bases.
 ===== Internal Name =====
 FindElevationGraphBases