API reference#

API components that most users will interact with.

Content

EchoRegions Core Functions#

These core functions are what users will call on at the beginning of their programming and will produce objects that contain the majority of the functionality within echoregions.

Functions#

read_evl(filepath[, nan_depth_value])

Read an EVL file into a Lines object.

read_evr(filepath[, min_depth, max_depth])

Read an EVR file into a Regions2D object.

convert_mask_2d_to_3d(mask_2d_da)

Convert 2D multi-labeled mask data into its 3D one-hot encoded form.

convert_mask_3d_to_2d(mask_3d_ds)

Convert 3D one-hot encoded mask data into its 2D multi-labeled form.

EchoRegions Lines#

Class that contains and performs operations with Depth/Lines data from Echoview EVL files.

Classes#

Lines(input_file[, nan_depth_value])

Class that contains and performs operations with Depth/Lines data from Echoview EVL files.

EchoRegions Regions2D#

Class that contains and performs operations with 2D Regions data from Echoview EVR files.

Classes#

Regions2D(input_file[, min_depth, max_depth])

Class that contains and performs operations with Regions2D data from Echoview EVR files.