class MeasurementType

Supported data types for the Code operator operands.

Use the attributes and methods of this class in conjunction with the result_type method (refer to the data type of the Code operator) to:

specify the data type of the Code operator
test the data type of the input operands

The MeasurementType class is available from the Echoview Python package.

The Echoview Python package also defines TIME_SERIES_TYPES, a collection of MeasurementType attributes that represent time series data types. Use this together with the is_time_series method (for example, MeasurementType.SPEED.is_time_series) to detect and handle time series operands in Code operator scripts.

These time series measurement types correspond to Echoview variable data types such as analysis time series, calibration time series, distance, heading, speed, pitch, roll, transmission time series, and unspecified time series. For COM scripts, these are exposed via the EVariableDataType enum (see the Echoview COM enum values page, entry EVariableDataType).

Attributes

Each attribute is a constant of type int representing a specific acoustic data type or time series data type.

Attribute enum name	Description
SINGLE_BEAM_ANGLE	Angular position variable
SINGLE_BEAM_BOOLEAN	Boolean
SINGLE_BEAM_WIDEBAND_ANGLE	Complex angular position
SINGLE_BEAM_WIDEBAND_POWER	Complex power dB
SINGLE_BEAM_WIDEBAND_SV	Complex Sv
SINGLE_BEAM_WIDEBAND_TS	Complex TS
SINGLE_BEAM_LINEAR	Linear
MULTIBEAM_ANGLE	Multibeam angular position
MULTIBEAM_BOOLEAN	Multibeam boolean
MULTIBEAM_MAGNITUDE	Multibeam magnitude
MULTIBEAM_PHASE	Multibeam phase
MULTIBEAM_SV	Multibeam Sv
MULTIBEAM_TS	Multibeam TS
MULTIBEAM_UNSPECIFIED_DB	Multibeam unspecified dB
SINGLE_BEAM_POWER	Power dB
SINGLE_BEAM_PULSE_COMPRESSED_ANGLE	Pulse compressed complex angular position
SINGLE_BEAM_PULSE_COMPRESSED_POWER	Pulse compressed complex power dB
SINGLE_BEAM_PULSE_COMPRESSED_SV	Pulse compressed complex Sv
SINGLE_BEAM_PULSE_COMPRESSED_TS	Pulse compressed complex TS
SINGLE_BEAM_SV	Sv
SINGLE_BEAM_TS	TS
SINGLE_BEAM_UNSPECIFIED_DB	Unspecified dB
UNDEFINED	Operand unavailable or variable upstream of the operand is unavailable.
Atttibutes of TimeSeriesTypes enum names under the MeasurementType class	Description
ANALYSIS_FEATURE	Virtual analysis time series variable
CALIBRATION_FEATURE	Virtual calibration time series variable
DISTANCE	Distance variable
HEADING	Heading variable
IMPEDANCE_STATISTIC	Virtual transmission time series variable
LENGTH	Length variable
LINE	Line variable.
PITCH	Pitch variable
SPEED	Speed variable
ROLL	Roll variable
UNSPECIFIED_TIME_SERIES	Virtual unspecified time series variable

Properties

is_acoustic	Determines if self (i.e., the MeasurementType object) is an acoustic measurement. Returns a Boolean.
is_time_series	Determines if self is a time series measurement. Returns a Boolean.
is_single_beam	Determines if self is a single beam measurement. Returns a Boolean.
is_multibeam	Determines if self is a multibeam measurement. Returns a Boolean.
is_db	Determines if self is an acoustic measurement in decibels. Returns a Boolean.
is_magnitude	Determines if self is a measurement in the linear domain. Returns a Boolean.
is_wideband_or_pulse_compressed	Determines if self is a wideband or pulse-compressed measurement. Returns a Boolean.

Note: In COM, time series MeasurementTypes correspond to the time series entries of the EVariableDataType enum listed on the Echoview COM enum values page.

class MeasurementType

Attributes

Properties

See also