read_regions_csv

read_regions_csv#

echoregions.read_regions_csv(input_file: Union[str, Path, DataFrame], min_depth: float = 0.0, max_depth: float = 1000.0) Regions2D#

Read a region CSV into a Regions2D object.

Parameters
input_filestr, Path, pd.DataFrame

A valid path to a region CSV or the DataFrame representation of it.

min_depthfloat, default 0

Depth value in meters to set -9999.99 depth edges to.

max_depthfloat, default 1000

Depth value in meters to set 9999.99 depth edges to.

Returns
Regions2D

Object that contains the EVR data and metadata with methods for saving to file.