Differences

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

Link to this comparison view

Both sides previous revision Previous revision
save_elevation_graph [2026/01/10 02:39]
admin 		save_elevation_graph [2026/08/17 19:59] (current)
hermann
Line 2: Line 2:
  
 ===== Description ===== ===== Description =====
-This functor saves the elevation patch graph in [[wp>​DOT_(graph_description_language)|Graphviz DOT]] or [[wp>​JSON|JSON]] format.+ 
 +This functor saves the elevation patch graph using the Graphviz DOT or JSON format.
  
 ===== 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  ^ + 
-| Dot Filename ​ | [[Generic Filename Type]] ​ | If provided, represents the filename ​where the elevation ​patch graph representation ​in [[wp>​DOT_(graph_description_language)|Graphviz DOT]] format will be saved. ​ ​| ​null  | +^ Name  ^ Type  ^ Description ​ ^ 
-| Json Filename ​ | [[Generic Filename Type]] ​ | If provided, represents the filename ​where the elevation ​patch graph representation ​in [[wp>JSON|JSON]] ​format will be saved. ​ ​| ​null  |+| 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.  | 
 +| 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.  |
  
 ===== Output ===== ===== Output =====
 +
 None. None.
  
 ===== Group ===== ===== Group =====
 +
 [[Functor List#​Elevation Graph | Elevation Graph]] [[Functor List#​Elevation Graph | Elevation Graph]]
  
 ===== Notes ===== ===== Notes =====
-If the corresponding filename is provided, saves the elevation patch graph in [[wp>​DOT_(graph_description_language)|Graphviz DOT]] or [[wp>​JSON|JSON]] format. 
  
-An error is reported if at least one filename where the elevation patch graph should be saved is not provided.+If the corresponding filename is provided, saves the elevation patch graph using the Graphviz DOT format, the JSON format, or both. 
 + 
 +An error is reported if at least one of "Dot Filename"​ or "Json Filename" ​is not provided.
  
 ===== Internal Name ===== ===== Internal Name =====
-SaveElevationGraph 
  
 +SaveElevationGraph