API reference

This page provides an auto-generated summary of echoregions’ API.

echoregions Package

Functions

from_JSON(j)	Opens a JSON file
merge(objects[, reindex_ids])	Merge echoregion objects.
parse_filetime(fname)	Convert Simrad-style datetime to a numpy datetime64 object
parse_time(ev_time[, datetime_format, unix])	Convert EV datetime to a numpy datetime64 object
read_evl(filepath[, convert_time, …])	Read an EVL file into a Lines object.
read_evr(filepath[, convert_time, …])	Read an EVR file into a Regions2D object.

Classes

CalibrationParser([input_file])	Class for parsing EV calibration (ECS) files
Lines([input_file, parse, convert_time, …])	Attributes
MultiRegions2D(objects)	Container for many Regions2D objects
Regions2D([input_file, parse, convert_time, …])	Attributes

echoregions.formats Package

Classes

Lines([input_file, parse, convert_time, …])	Attributes
MultiRegions2D(objects)	Container for many Regions2D objects
Regions2D([input_file, parse, convert_time, …])	Attributes

echoregions.convert Package

Functions

from_JSON(j)	Opens a JSON file
parse_filetime(fname)	Convert Simrad-style datetime to a numpy datetime64 object
parse_time(ev_time[, datetime_format, unix])	Convert EV datetime to a numpy datetime64 object

Classes

CalibrationParser([input_file])

Class for parsing EV calibration (ECS) files