✎ get_elevation_graph_bases_from_pseudo_tops [Dinamica EGO]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Get Elevation Graph Bases From Pseudo Tops ======

===== Description =====

This functor retrieves the elevation patches that are bases corresponding to the specified patches from the elevation graphs.

===== Inputs =====

^ Name  ^ Type  ^ Description  ^
| Elevation Graph | [[Elevation Graph Type]]  | Graph of elevation patches created from the 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 ids of the top elevation patches. The values associated with each key are ignored.  |

===== Optional Inputs =====

^ Name  ^ Type  ^ Description  ^ Default Value  ^
| Use Branch Bases  | bool  | If true, the base node of the elevation patch will be selected in the graph at points where the path branches, instead of retrieving only the lowest node. Otherwise, only the lowest node will be considered as the base.  | false  |
| Also Retrieve Paths  | bool  | If true, the list of elevation patches along the entire path between each top and the corresponding base found will be returned as content of the "pathsRelation" table. Otherwise this table will be left empty.  | true  |
| Maximum Nodes  | int  | Maximum number of nodes that can be handled between the top elevation patch and the corresponding base. If this quantity is exceeded, that top will be ignored. If set to 0, the maximum number of nodes will be unlimited.  | 0  |

===== Output =====

^ Name  ^ Type  ^ Description  ^
| Base Relations  | [[Table Type]]  | Table containing the list of elevation patches representing the base corresponding to the specified top. The table has format "top_id*:real, base_id:real, height_difference:real".  |
| Path Relations  | [[Table Type]]  | Table containing the list of elevation patches representing the path between each top and corresponding base. The table has format "top_id*:real, path_id*:real, path_index:real". This table will be empty if the "alsoRetrivePaths" parameter is false.  |
| All Path Nodes  | [[Table Type]]  | Table containing the list of elevation patches representing those that are part of the path between each top and base. The table has format "row_index*:real, top_id*:real, path_id*:real, path_index:real". This table will be empty if the "alsoRetrivePaths" parameter is false.  |

===== Group =====

[[Functor List#Elevation Graph | Elevation Graph]]

===== Notes =====

Retrieves the elevation patches that are bases corresponding to the specified patches from the elevation graphs and, optionally, retrieves the complete path between each top and its corresponding base.

===== Internal Name =====

GetElevationGraphBasesFromPseudoTops