read_lines_csv

Contents

read_lines_csv#

echoregions.read_lines_csv(input_file: Union[str, Path, DataFrame], nan_depth_value: float = None) Lines#

Read a lines CSV into a Lines object.

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

Parameters
input_filestr, Path, pd.DataFrame

A valid path to an lines CSV or the DataFrame representation of it.

nan_depth_valuefloat, default None

Depth in meters to replace -10000.990000 ranges with.

Returns
Lines

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