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.

To use er.read_region_csv, the input dataframe/CSV must contain (at minimum) columns region_id, depth, and time where each depth entry is a 1-D float array and each time entry is a 1-D datetime64[ns] array. Please see the ‘Saving to “.csv” and Reading From “.csv”’ section in https://echoregions.readthedocs.io/en/latest/Regions2D_functionality.html for an example of this formatting.

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.