class Measurement

Represents a ping. Each item in the window_measurements list (an attribute of the OperandInput class) is an object of the Measurement class.

The Measurement class is available from the Echoview Python package.

Attributes

beam_angle

The beam angle in degrees as an array for multibeam data. The beam_angle is at the center of the beam.

Returns None for single beam data.

beam_width

The beam width in degrees as an array for multibeam data.

Returns None for single beam data.

bearing_angle

See Bearing.

data

The ping sample data.

Single beam data is represented by a 1D NumPy array of 64-bit real or Boolean values.

Multibeam data is represented by a 2D NumPy array of 32-bit real or Boolean values. Axis 0 is the range axis and axis 1 is the beam axis.

data_complex

Ping sample data (for acoustic wideband variables only):

Single beam data is represented by a 1D NumPy array of 64-bit real and imaginary values (i.e., numpy.complex128).

See Wideband support.

datetime

The measurement timestamp represented as a Python datetime.

datetime uses datetime.datetime.utcfromtimestamp

gps_distance

The ping GPS distance in nautical miles. This may or may not be relative to the start of the echogram.

See also vl_distance below.

gps_latitude

The latitude in degrees. See the Navigation section of the Details dialog box.

gps_longitude

The longitude in degrees. See the Navigation section of the Details dialog box.

heading

The heading in degrees. See the Navigation section of the Details dialog box.

index

The ping index or ping number relative to the operand passed to Python for evaluation. Both index and ping number start from zero.

matched_filter

A matched filter is represented by a 1D NumPy array of the real and imaginary components of complex matched filter values (for acoustic wideband variables only).

See Wideband support.

ping_mode

An object of the PingMode class.

speed

The speed. See the Navigation section of the Details dialog box.

start_depth

The start depth for each beam in the ping represented as a real value.

start_range

The start range for each beam in the ping represented as a real value.

stop_depth

The stop depth for each beam in the ping represented as a real value.

stop_range

The stop range for each beam in the ping represented as a real value.

tilt_angle

See Tilt.

type

An object of the MeasurementType class.

vl_distance

The vessel log distance in nautical miles.

See also gps_distance above.

Methods

cal(name)

The Code operator may query a measurement/ping's calibration by using this to return the calibration value for the requested entry by the calibration name, for example cal('PulseDuration').

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 AbsorptionCoeffient: when Francois Garrison values are available, the calculation for the center frequency is evaluated and used.

See also

About the Code operator
Using the Code operator