Differences

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

--- get_elevation_graph_common_paths_summaries [2026/08/17 19:58]
hermann created
+++ get_elevation_graph_common_paths_summaries [2026/08/28 03:20] (current)
hermann Sync from local documentation review
@@ Line 3: / Line 3: @@
 ===== Description =====
-This functor retrieves the summaries of the elevation patches common between the paths of pseudo-top pairs to their respective bases.
+This functor retrieves the summaries of the elevation patches common between the paths of pseudo-top pairs and their respective bases.
 ===== Inputs =====
 ^ 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 Top Pairs For Common Paths | [[Base Table Type]]  | Table representing pairs of elevation patch ids for which the nodes common to their respective paths from top to base will be retrieved. If it is a table, it must have the format "Top_Id1*:real, Top_Id2*:real, __unused__" (the value column is ignored). If it is a lookup table, its keys and corresponding values represent the pairs of patch ids. If the id of a patch is not defined in the graph, it will be ignored.  |
+| Pseudo Top Pairs For Common Paths  | [[Base Table Type]]  | Pairs of elevation patch ids for which the nodes common to their respective paths, from top to base, are retrieved. As a table, it must have the format "Top_Id1*:real, Top_Id2*:real, __unused__" (the value column is ignored); as a lookup table, its keys and their associated values represent the pairs of patch ids. A pair naming a patch id not defined in Elevation Graph is ignored.  |
 ===== Optional Inputs =====
-^ Name  ^ Type  ^ Description  ^
+^ Name  ^ Type  ^ Description  ^ Default Value  ^
-| Also Retrieve Lowest Nodes | [[Boolean Value Type]]  | If true, retrieves the id of both the highest and lowest common elevation patch among those that are part of the common paths between the pseudo-tops and the bases. Otherwise, only the id of the highest common elevation patch will be retrieved, and the column corresponding to the lowest elevation patch in the result table will be filled with -9999. The default value is true.  |
+| Also Retrieve Lowest Nodes  | [[Boolean Value Type]]  | If true, retrieves the id of both the highest and the lowest common elevation patch among those in the common paths between the pseudo-tops and their bases. Otherwise, only the highest common elevation patch's id is retrieved, and the output column for the lowest one is filled with -9999.  | Yes  |
-| 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 Top Pairs For Common Paths", if that 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 Top Pairs For Common Paths, 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  |
-| 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  ^
-| Common Path Summaries | [[Table Type]]  | Table containing information about the elevation patches common between the paths of pseudo-top pairs to their respective bases, in the format "Top_Id1*:real, Top_Id2*:real, Highest_Path_Id:real, Lowest_Path_Id:real". If a pair from the "Pseudo Top Pairs For Common Paths" table was ignored, the corresponding entry will not be present. If "Also Retrieve Lowest Nodes" is false, the "Lowest_Path_Id" column will be filled with -9999.  |
+| Common Path Summaries  | [[Table Type]]  | Table of information about the elevation patches common between the paths of each pseudo-top pair and their bases, in the format "Top_Id1*:real, Top_Id2*:real, Highest_Path_Id:real, Lowest_Path_Id:real". A pair ignored from Pseudo Top Pairs For Common Paths has no corresponding entry. If Also Retrieve Lowest Nodes is false, Lowest_Path_Id is filled with -9999.  |
 ===== Group =====
@@ Line 29: / Line 29: @@
 ===== Notes =====
-Retrieves information about the elevation patches common between the paths of pairs of pseudo-tops and their respective bases in the elevation graph, considering either all reachable bases or only the lowest-elevation one for each top, depending on the same base-search criteria used by [[Find Elevation Graph Bases]] and [[Find Elevation Graph Paths]].
+Retrieves information about the elevation patches common between the paths of pairs of pseudo-tops and their respective bases, considering either all reachable bases or only the lowest-elevation one for each top, using the same base-search criteria as Find Elevation Graph Bases and Find Elevation Graph Paths.
 ===== Internal Name =====
 GetElevationGraphCommonPathsSummaries