[python source code]

enums

Enumerators used to enforce typing.

BaseTypes

Bases: Enum

flowchart LR tm_data_types.helpers.enums.BaseTypes[BaseTypes] click tm_data_types.helpers.enums.BaseTypes href "" "tm_data_types.helpers.enums.BaseTypes"

What kind of base is used for acquisition.

ByteOrderFormat

Bases: Enum

flowchart LR tm_data_types.helpers.enums.ByteOrderFormat[ByteOrderFormat] click tm_data_types.helpers.enums.ByteOrderFormat href "" "tm_data_types.helpers.enums.ByteOrderFormat"

The endianness of the .wfm file.

ChecksumType

Bases: Enum

flowchart LR tm_data_types.helpers.enums.ChecksumType[ChecksumType] click tm_data_types.helpers.enums.ChecksumType href "" "tm_data_types.helpers.enums.ChecksumType"

How each fast frame is checksum.

Currently not used.

CurveFormats

Bases: Enum

flowchart LR tm_data_types.helpers.enums.CurveFormats[CurveFormats] click tm_data_types.helpers.enums.CurveFormats href "" "tm_data_types.helpers.enums.CurveFormats"

What data type each value is in the curve.

CurveFormatsVer3

Bases: Enum

flowchart LR tm_data_types.helpers.enums.CurveFormatsVer3[CurveFormatsVer3] click tm_data_types.helpers.enums.CurveFormatsVer3 href "" "tm_data_types.helpers.enums.CurveFormatsVer3"

What data type each value is in the curve for Version 3 files.

CustomStrEnum

Bases: Enum

flowchart LR tm_data_types.helpers.enums.CustomStrEnum[CustomStrEnum] click tm_data_types.helpers.enums.CustomStrEnum href "" "tm_data_types.helpers.enums.CustomStrEnum"

A custom base class for string Enums.

This class provides better type hinting for the value property.

name property 

name: str

Return the name of the Enum member.

value property 

value: str

Return the value of the Enum member.

list_values classmethod 

list_values() -> List[str]

Return a list of all the values of the enum.

DSYFormat

Bases: Enum

flowchart LR tm_data_types.helpers.enums.DSYFormat[DSYFormat] click tm_data_types.helpers.enums.DSYFormat href "" "tm_data_types.helpers.enums.DSYFormat"

Pixel map display format.

DataTypes

Bases: Enum

flowchart LR tm_data_types.helpers.enums.DataTypes[DataTypes] click tm_data_types.helpers.enums.DataTypes href "" "tm_data_types.helpers.enums.DataTypes"

What data type is being written to the scope.

IQWindowTypes

Bases: CustomStrEnum

flowchart LR tm_data_types.helpers.enums.IQWindowTypes[IQWindowTypes] tm_data_types.helpers.enums.CustomStrEnum[CustomStrEnum] tm_data_types.helpers.enums.CustomStrEnum --> tm_data_types.helpers.enums.IQWindowTypes click tm_data_types.helpers.enums.IQWindowTypes href "" "tm_data_types.helpers.enums.IQWindowTypes" click tm_data_types.helpers.enums.CustomStrEnum href "" "tm_data_types.helpers.enums.CustomStrEnum"

The window type used when determining the sample rate of the IQ waveform.

name property 

name: str

Return the name of the Enum member.

value property 

value: str

Return the value of the Enum member.

list_values classmethod 

list_values() -> List[str]

Return a list of all the values of the enum.

SIBaseUnit

Bases: Enum

flowchart LR tm_data_types.helpers.enums.SIBaseUnit[SIBaseUnit] click tm_data_types.helpers.enums.SIBaseUnit href "" "tm_data_types.helpers.enums.SIBaseUnit"

Different SI units that can be used in a waveform.

StorageTypes

Bases: Enum

flowchart LR tm_data_types.helpers.enums.StorageTypes[StorageTypes] click tm_data_types.helpers.enums.StorageTypes href "" "tm_data_types.helpers.enums.StorageTypes"

How the curve data is formatted.

SummaryFrameType

Bases: Enum

flowchart LR tm_data_types.helpers.enums.SummaryFrameType[SummaryFrameType] click tm_data_types.helpers.enums.SummaryFrameType href "" "tm_data_types.helpers.enums.SummaryFrameType"

Available in version 3 .wfm files.

SweepTypes

Bases: Enum

flowchart LR tm_data_types.helpers.enums.SweepTypes[SweepTypes] click tm_data_types.helpers.enums.SweepTypes href "" "tm_data_types.helpers.enums.SweepTypes"

Type of acquisition.

VersionNumber

Bases: Enum

flowchart LR tm_data_types.helpers.enums.VersionNumber[VersionNumber] click tm_data_types.helpers.enums.VersionNumber href "" "tm_data_types.helpers.enums.VersionNumber"

The version of the .wfm file.

WaveformDimension

Bases: CustomStrEnum

flowchart LR tm_data_types.helpers.enums.WaveformDimension[WaveformDimension] tm_data_types.helpers.enums.CustomStrEnum[CustomStrEnum] tm_data_types.helpers.enums.CustomStrEnum --> tm_data_types.helpers.enums.WaveformDimension click tm_data_types.helpers.enums.WaveformDimension href "" "tm_data_types.helpers.enums.WaveformDimension" click tm_data_types.helpers.enums.CustomStrEnum href "" "tm_data_types.helpers.enums.CustomStrEnum"

The names of the two dimensions in the dimensions class.

name property 

name: str

Return the name of the Enum member.

value property 

value: str

Return the value of the Enum member.

list_values classmethod 

list_values() -> List[str]

Return a list of all the values of the enum.

WaveformTypes

Bases: Enum

flowchart LR tm_data_types.helpers.enums.WaveformTypes[WaveformTypes] click tm_data_types.helpers.enums.WaveformTypes href "" "tm_data_types.helpers.enums.WaveformTypes"

What the waveform file format consists of.