class TimeSeriesMeasurement

Represents a single estimated (interpolated or extrapolated) measurement from a time series operand passed to the Code or Code - Time series operator.

When an operand is a time series variable, each item in the window_measurements list (i.e., an attribute of the OperandInput class) is a TimeSeriesMeasurement object. The measurement attribute of OperandInput also returns a TimeSeriesMeasurement object.

The TimeSeriesMeasurement class is available from the Echoview Python package.

Attributes

Attribute	Description
type	An object of the MeasurementType class.
index	The index of the measurement in the `window_measurements` list (not an index into the original time series variable).
datetime	The timestamp of the estimated measurement as a Python `datetime` object (aligned to the ping time from Operand 1).
gps_distance	Distance along the survey track at the specified time, based on GPS data (nautical miles).
gps_latitude	Latitude at the specified time (decimal degrees).
gps_longitude	Longitude at the specified time (decimal degrees).
vl_distance	Distance along the survey track at the specified time, based on vessel logs (nautical miles).
speed	Vessel speed at the specified time, in knots.
heading	Vessel heading at the specified time, in degrees.
status	The status of the time series measurement, represented by a TimeSeriesStatus enum.
value	The interpolated or extrapolated value of the time series variable at the specified time.

Notes:

Values in a TimeSeriesMeasurement are estimated using the time series operand’s selected or inherent interpolation mode—linear, circular, stepped, or dB. Measurements are aligned to the ping times of Operand 1 and may not coincide with stored measurements in the source time series.
When the Code - Time series operator outputs an UNSPECIFIED_TIME_SERIES, the result_type() method must return a tuple containing that MeasurementType and a TimeSeriesInterpolationMode. See Understanding the default Echoview Python source file: Code - Time series.

Methods

cal(name)

Use cal(name) to return a time series calibration value for the requested calibration name, for example cal('PulseDuration'). The method is available to both the Code and Code - Time series operators. Currently, sounder detected lines may have calibration values.

Note:

If no calibration value exists with the specified calibration name, Echoview generally uses a default value. In addition, where there is:

no TransducerGain: Echoview returns TransducerGain if it is set.
no TRFactor: the KaijoTrFactor is used if it is set otherwise TRFactor is determined using the Simrad EK60 power to Sv and TS equation.
no AbsorptionCoefficient: when Francois & Garrison (1982) values are available, the calculation for the center frequency is evaluated and used.

class TimeSeriesMeasurement

Attributes

Methods

See also