read_evr

echoregions.read_evr(filepath, convert_time=False, convert_range_edges=True, offset=0, min_depth=None, max_depth=None, raw_range=None) → echoregions.formats.regions2d.Regions2D

Read an EVR file into a Regions2D object.

Parameters

filepathstr, Path object

A valid path to an EVR file

convert_timebool, default False

Convert time from EV format to numpy datetime64. Converting the time will cause the data to no longer be JSON serializable.

convert_range_edgesbool, default True

Convert -9999.99 and -9999.99 depth edges to real values. Set the values by assigning range values to min_depth and max_depth or by passing a file into set_range_edge_from_raw, or by setting raw_range to a range vector.

offsetfloat, default 0

Depth offset in meters

min_depthfloat, default None

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

max_depthfloat, default None

Depth value in meters to set 9999.99 depth edges to.

raw_rangearray, default None

Array of range values assumed to be monotonically increasing

Returns

Regions2D

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