Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
save_elevation_graph [2026/01/10 02:36] admin created |
save_elevation_graph [2026/08/28 03:31] (current) hermann Sync from local documentation review |
||
|---|---|---|---|
| Line 2: | Line 2: | ||
| ===== Description ===== | ===== Description ===== | ||
| - | This functor saves the elevation patch graph in Graphviz DOT or JSON format. | + | |
| + | This functor saves an elevation patch graph using the Graphviz DOT format, the JSON format, or both. | ||
| ===== Inputs ===== | ===== Inputs ===== | ||
| + | |||
| ^ 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 neighborhood relationships and their properties. | |
| ===== Optional Inputs ===== | ===== Optional Inputs ===== | ||
| + | |||
| ^ Name ^ Type ^ Description ^ Default Value ^ | ^ Name ^ Type ^ Description ^ Default Value ^ | ||
| - | | Dot Filename | [[Generic Filename Type]] | If provided, represents the filename where the elevation patch graph representation in Graphviz DOT format will be saved. | null | | + | | Dot Filename | [[Generic Filename Type]] | Filename where Elevation Graph is saved in the Graphviz DOT format, if provided. Useful for debugging, or for transferring the elevation graph to other software. This is an advanced port. | .none | |
| - | | Json Filename | [[Generic Filename Type]] | If provided, represents the filename where the elevation patch graph representation in JSON format will be saved. | null | | + | | Json Filename | [[Generic Filename Type]] | Filename where Elevation Graph is saved in the JSON format, if provided. Useful for debugging, or for transferring the elevation graph to other software. This is an advanced port. | .none | |
| + | |||
| + | ===== Outputs ===== | ||
| - | ===== Output ===== | ||
| None. | None. | ||
| ===== Group ===== | ===== Group ===== | ||
| - | [[Functor List#Elevation Graph | Elevation Graph]] | + | |
| + | [[Functor List#Elevation Graph: Debug | Elevation Graph: Debug]] | ||
| ===== Notes ===== | ===== Notes ===== | ||
| - | If the corresponding filename is provided, saves the elevation patch graph in Graphviz DOT or JSON format. | ||
| - | An error is reported if at least one filename where the elevation patch graph should be saved is not provided. | + | This functor reports an error if neither Dot Filename nor Json Filename is provided. |
| ===== Internal Name ===== | ===== Internal Name ===== | ||
| + | |||
| SaveElevationGraph | SaveElevationGraph | ||