TDRSource class

Base definition of the TDR input data

class tdrsource.TDRSource(tdr_file, depth_name='depth', has_speed=False, **kwargs)[source]

Define TDR data source

Use xarray.Dataset to ensure pseudo-standard metadata

tdr_file

String indicating the file where the data comes from.

Type

str

tdr

Dataset with input data.

Type

xarray.Dataset

depth_name

Name of data variable with depth measurements.

Type

str

has_speed

Whether input data include speed measurements.

Type

bool

speed_name

Name of data variable with the speed measurements.

Type

str

Examples

>>> from skdiveMove.tests import diveMove2skd
>>> tdrX = diveMove2skd(True)
>>> print(tdrX)
get_depth()[source]

Return depth array

Returns

Return type

xarray.DataArray

get_speed()[source]

Return speed array

Returns

Return type

xarray.DataArray

get_tdr()[source]

Return TDR Dataset

Returns

Return type

xarray.Dataset