wolfhece.analyze_poly

Module Contents

class wolfhece.analyze_poly.Array_analysis_onepolygon(wa: wolfhece.wolf_array.WolfArray, polygon: wolfhece.PyVertexvectors.vector)

Class for values analysis of an array based on a polygon.

This class select values insides a polygon and plot statistics of the values.

The class is designed to be used with the WolfArray class and the vector class from the PyVertexvectors module.

Plots of the values distribution can be generated using seaborn or plotly.

_wa

_polygon

_selected_cells = None

_values = None

values(which: Literal['Mean', 'Std', 'Median', 'Sum', 'Volume', 'Values']) → pandas.DataFrame | float

Get the values as a pandas DataFrame

Parameters:

which – Mean, Std, Median, Sum, Volume, Values

select_cells(mode: Literal['polygon', 'buffer'] = 'polygon', **kwargs)

Select the cells inside the polygon

_select_cells_polygon(selection_poly: wolfhece.PyVertexvectors.vector)

Select the cells inside the polygon

_select_cells_buffer(buffer_size: float = 0.0)

Select the cells inside the buffer of the polygon

compute_values()

Get the values of the array inside the polygon

plot_values(show: bool = True, bins: int = 100, engine: Literal['seaborn', 'plotly'] = 'seaborn')

Plot a histogram of the values

plot_values_seaborn(bins: int = 100, show: bool = True)

Plot a histogram of the values

plot_values_plotly(bins: int = 100, show: bool = True)

Plot a histogram of the values

class wolfhece.analyze_poly.Array_analysis_polygons(wa: wolfhece.wolf_array.WolfArray, polygons: wolfhece.PyVertexvectors.zone)

Class for values analysis of an array based on a polygon.

This class select values insides a polygon and plot statistics of the values.

The class is designed to be used with the WolfArray class and the vector class from the PyVertexvectors module.

Plots of the values distribution can be generated using seaborn or plotly.

_wa

_polygons

_zone

plot_values(show: bool = True, bins: int = 100, engine: Literal['seaborn', 'plotly'] = 'seaborn')

Plot a histogram of the values

plot_values_seaborn(bins: int = 100, show: bool = True)

Plot a histogram of the values

plot_values_plotly(bins: int = 100, show: bool = True)

Plot a histogram of the values

class wolfhece.analyze_poly.Slope_analysis(wa: wolfhece.wolf_array.WolfArray, trace: wolfhece.PyVertexvectors.vector)

Class for slope analysis of in an array based on a trace vector.

This class allows to select cells inside a polygon or a buffer around a trace vector and compute the slope of the dike. The slope is computed as the difference in elevation between the trace and the cell divided by the distance to the trace.

The slope is computed for each cell inside the polygon or buffer and accessed in a Pandas Dataframe.

Plots of the slope distribution can be generated using seaborn or plotly.

The class is designed to be used with the WolfArray class and the vector class from the PyVertexvectors module.

_wa

_trace

_selection_poly = None

_buffer_size = 0.0

_selected_cells = None

_slopes = None

property slopes: pandas.DataFrame

Get the slopes as a pandas DataFrame

select_cells(mode: Literal['polygon', 'buffer'] = 'polygon', **kwargs)

Select the cells inside the trace

_select_cells_buffer(buffer_size: float = 0.0)

Select the cells inside the buffer of the trace

_select_cells_polygon(selection_poly: wolfhece.PyVertexvectors.vector)

Select the cells inside the polygon

compute_slopes()

Get the slope of the dike

plot_slopes(show: bool = True, bins: int = 100, engine: Literal['seaborn', 'plotly'] = 'seaborn')

Plot a histogram of the slopes

plot_slopes_seaborn(bins: int = 100, show: bool = True)

Plot a histogram of the slopes

plot_slopes_plotly(bins: int = 100, show: bool = True)

Plot a histogram of the slopes