Skip to content

tinerator.plot

plot_dem

plot_dem(dem_object, hillshade:bool=False, plot_out:str=None)

Plots the DEM corresponding to a tinerator.DEM object.

Arguments

  • dem_object (tinerator.DEM): A DEM object to plot
  • hillshade (bool): use hillshading on plot
  • plot_out (str): filepath to save plot

preview_accumulation

preview_accumulation(dem_object, method:str='D8')

Preview the accumulation matrix on a DEM. Where this is useful is to preview the accumulation level at which you wish to capture a feature.

Arguments

  • dem_object (tinerator.DEM): A DEM class instance
  • method (str): Flow calculation method at_threshold

Returns

The generated accumulation matrix

plot_feature

plot_feature(dem_object)

Displays the feature captured by performing watershed delination

Arguments

  • dem_object (tinerator.DEM): A DEM class instance

plot_boundary

plot_boundary(dem_object)

Plots a tinerator.DEM boundary. Must have been created through the build_refined_triplane or build_uniform_triplane methods.

Arguments

  • dem_object (tinerator.DEM): A DEM instance

preview_boundary

preview_boundary(dem_object, distance:float, rectangular:bool=False, interactive=False)

Preview the mesh boundary nodes that will be generated by edge_length (in DEM.build_uniform_triplane) or max_edge_length (DEM.build_refined_triplane).

Arguments

  • distance (float): Euclidean distance between adjacent boundary nodes
  • rectangular (bool): if True, generates a boundary around the extent of the DEM
  • interactive (bool): if True and function is called within a Jupyter notebook, then function params can be controlled with sliders

plot_faceset

plot_faceset(dem_object, faceset)

Displays a topological preview of how facesets will look after generation.

Arguments

  • dem_object (tinerator.DEM): A DEM class instance
  • faceset (tinerator.Faceset): An initialized Faceset object

plot_triplane

plot_triplane(dem_object)

Plots the triangular surface mesh.

Arguments

  • dem_object (tinerator.DEM): A DEM class instance

plot_full_mesh

plot_full_mesh(dem_object, facesets:list=None)

Plots the triangular surface mesh.

Arguments

  • dem_object (tinerator.DEM): A DEM class instance
  • facesets (list): facesets to render