Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | |||
|
save_elevation_graph [2026/08/17 19:59] hermann |
save_elevation_graph [2026/08/28 03:31] (current) hermann Sync from local documentation review |
||
|---|---|---|---|
| Line 3: | Line 3: | ||
| ===== Description ===== | ===== Description ===== | ||
| - | This functor saves the elevation patch graph using the 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 ^ | + | ^ Name ^ Type ^ Description ^ Default Value ^ |
| - | | Dot Filename | [[Generic Filename Type]] | Filename where the representation of the elevation graph in the Graphviz DOT format will be saved, if provided. This can be used for debugging purposes or when transferring the elevation graph to a different software. The default value is 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]] | Filename where the representation of the elevation graph in the JSON format will be saved, if provided. This can be used for debugging purposes or when transferring the elevation graph to a different software. The default value is 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 | |
| - | ===== Output ===== | + | ===== Outputs ===== |
| None. | None. | ||
| Line 22: | Line 22: | ||
| ===== 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 using the Graphviz DOT format, the JSON format, or both. | + | This functor reports an error if neither Dot Filename nor Json Filename is provided. |
| - | + | ||
| - | An error is reported if at least one of "Dot Filename" or "Json Filename" is not provided. | + | |
| ===== Internal Name ===== | ===== Internal Name ===== | ||
| SaveElevationGraph | SaveElevationGraph | ||
| + | |||