nitypes 1.1.0.dev2

Data types for NI Python APIs

Info	Data types for NI Python APIs
Author	National Instruments

Table of Contents

• Table of Contents
• About
  • Documentation
  • Operating System Support
  • Python Version Support
• Installation
• Waveforms
  • Analog Waveforms
  • Complex Waveforms
  • Digital Waveforms
  • Frequency Spectrums
• Complex Numbers
  • Complex Integers
  • Complex Number Conversion
• Time
  • Time Conversion
  • Binary Time
• Scalar Values
  • Scalar
  • Vector
  • XYData

About

The nitypes Python package defines data types for NI Python APIs:

• Analog, complex, and digital waveforms
• Frequency spectrums
• Complex integers
• Time conversion

NI created and supports this package.

Documentation

See the API Reference.

Operating System Support

nitypes supports Windows and Linux operating systems.

Python Version Support

nitypes supports CPython 3.9+ and PyPy3.

Installation

Installing NI driver Python APIs that support waveforms will automatically install nitypes.

You can also directly install the nitypes package using pip or by listing it as a dependency in your project's pyproject.toml file.

Waveforms

Analog Waveforms

The nitypes.waveform.AnalogWaveform class represents a single analog signal with timing information and extended properties (such as channel name and units). Multi-channel analog data is represented using a collection of waveforms, such as list[nitypes.waveform.AnalogWaveform]. For more details, see Analog Waveforms in the API Reference.

Complex Waveforms

The nitypes.waveform.ComplexWaveform class represents a complex-number signal, such as I/Q data, with timing information and extended properties (such as channel name and units). For more details, see Complex Waveforms in the API Reference.

Digital Waveforms

The nitypes.waveform.DigitalWaveform class represents one or more digital signals with timing information and extended properties (such as channel name and signal names). For more details, see Digital Waveforms in the API Reference.

Frequency Spectrums

The nitypes.waveform.Spectrum class represents a frequency spectrum with frequency range information and extended properties (such as channel name and units). For more details, see Frequency Spectrums in the API Reference.

Complex Numbers

Complex Integers

nitypes.complex.ComplexInt32DType is a NumPy structured data type object representing a complex integer with 16-bit real and imag fields. This structured data type has the same memory layout as the NIComplexI16 C struct used by NI driver APIs. For more details, see Complex Integers in the API Reference.

Complex Number Conversion

You can use the nitypes.complex.convert_complex() function to convert complex-number NumPy arrays between nitypes.complex.ComplexInt32DType and the standard np.complex64 and np.complex128 data types. For more details, see Complex >> Conversion in the API Reference.

Time

Time Conversion

You can use the nitypes.time.convert_datetime() and nitypes.time.convert_timedelta() functions to convert time values between the standard datetime library, the high-precision hightime library, and bintime. For more details, see Time >> Conversion in the API Reference.

Binary Time

The nitypes.bintime module implements the NI Binary Time Format (NI-BTF), a high-resolution time format used by NI software. An NI-BTF time value is a 128-bit fixed point number consisting of a 64-bit whole seconds part and a 64-bit fractional seconds part. For more details, see NI Binary Time Format in the API Reference.

Scalar Values

Scalar

nitypes.scalar.Scalar is a data type that represents a single scalar value with units information and extended properties. Valid types for the scalar value are bool, int, float, and str. For more details, see Scalar in the API Reference.

Vector

nitypes.vector.Vector is a data type that represents an array of scalar values with units information and extended properties. Valid types for the scalar values are bool, int, float, and str. For more details, see Scalar in the API Reference.

XYData

nitypes.xy_data.XYData is a data type that represents a two axes (sequences) of numeric values with units information. Valid types for the numeric values are int and float. For more details, see XYData in the API Reference.