Skip to content

NI FGEN Arbitrary Waveform Attributes

Jump to bottom
Palash Khare edited this page Jun 3, 2021 · 1 revision

Arbitrary Waveform Attributes

NIFGEN_ATTRIBUTE_ARB_GAIN

IviFgenArbWfm Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1250202 ViReal64 R/W Channel None niFgen_ConfigureArbWaveform

Description

Specifies the factor by which the signal generator scales the arbitrary waveform data. When you create arbitrary waveforms, you must first normalize the data points to the range –1.0 to +1.0. Use this channel–based attribute to scale the arbitrary waveform to other ranges. For example, when you set this attribute to 2.0, the output signal ranges from –2.0 V to +2.0 V.

Use this attribute when the NIFGEN_ATTRIBUTE_OUTPUT_MODE attribute is set to NIFGEN_VAL_OUTPUT_ARB, NIFGEN_VAL_OUTPUT_SCRIPT or NIFGEN_VAL_OUTPUT_SEQ.

NIFGEN_ATTRIBUTE_ARB_OFFSET

IviFgenArbWfm Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1250203 ViReal64 R/W Channel None niFgen_ConfigureArbWaveform

Description

Specifies the value that the signal generator adds to the arbitrary waveform data. When you create arbitrary waveforms, you must first normalize the data points to the range –1.0 to +1.0. Use this channel–based attribute to shift the arbitrary waveform range. For example, when you set this attribute to 1.0, the output signal ranges from 2.0 V to 0.0 V.

Use this attribute when the NIFGEN_ATTRIBUTE_OUTPUT_MODE attribute is set to NIFGEN_VAL_OUTPUT_ARB, NIFGEN_VAL_OUTPUT_SCRIPT, or NIFGEN_VAL_OUTPUT_SEQ.

Units: volts

NIFGEN_ATTRIBUTE_ARB_WAVEFORM_HANDLE

IviFgenArbWfm Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1250201 ViInt32 R/W Channel None niFgen_ConfigureArbWaveform

Description

Selects which arbitrary waveform the signal generator produces. You can create multiple arbitrary waveforms using one of the following niFgen Create Waveform functions:

  • niFgen_CreateWaveformF64
  • niFgen_CreateWaveformI16
  • niFgen_CreateWaveformFromFileI16
  • niFgen_CreateWaveformFromFileF64
  • niFgen_CreateWaveformFromFileHWS

These functions return a handle that you can use to identify the particular waveform. To configure the signal generator to produce a particular waveform, set this channel–based attribute to the waveform handle.

Use this attribute only when the NIFGEN_ATTRIBUTE_OUTPUT_MODE attribute is set to NIFGEN_VAL_OUTPUT_ARB.

Note:  You cannot change this attribute while the device is generating a waveform. If you want to change the device configuration, call the niFgen_AbortGeneration function or wait for the generation to complete.

NIFGEN_ATTRIBUTE_ARB_MARKER_POSITION

Specific Attribute

Numeric Value Data
type		 Access Applies to Coercion High Level Functions
1150327 ViInt32 R/W N/A None None

Description

Specifies the position for a marker to be asserted in the arbitrary waveform. Use this attribute when the NIFGEN_ATTRIBUTE_OUTPUT_MODE attribute is set to NIFGEN_VAL_OUTPUT_ARB. Use the niFgen_ExportSignal function to export the marker signal.

Default Value: -1

NIFGEN_ATTRIBUTE_ARB_REPEAT_COUNT

Specific Attribute

Numeric Value Data
type		 Access Applies to Coercion High Level Functions
1150328 ViInt32 R/W N/A None None

Description

Specifies number of times to repeat the arbitrary waveform when the triggerMode parameter of the niFgen_ConfigureTriggerMode function is set to NIFGEN_VAL_SINGLE or NIFGEN_VAL_STEPPED. This attribute is ignored if the triggerMode parameter is set to NIFGEN_VAL_CONTINUOUS or NIFGEN_VAL_BURST. Use this attribute when the NIFGEN_ATTRIBUTE_OUTPUT_MODE attribute is set to NIFGEN_VAL_OUTPUT_ARB.

When used during streaming operations, this attribute specifies the number of times to repeat the streaming waveform (the onboard memory allocated for streaming).

Default Value: 1

NIFGEN_ATTRIBUTE_ARB_SEQUENCE_HANDLE

IviFgenArbSeq Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1250211 ViInt32 R/W Channel None niFgen_ConfigureArbSequence

Description

Selects which sequence the signal generator produces. You can create multiple sequences using the niFgen_CreateArbSequence function. The niFgen_CreateArbSequence function returns a handle that you can use to identify the particular sequence. To configure the signal generator to produce a particular sequence, set this channel–based attribute to the sequence handle value.

Use this attribute only when the NIFGEN_ATTRIBUTE_OUTPUT_MODE attribute is set to NIFGEN_VAL_OUTPUT_SEQ.

Note:  You cannot change this attribute while the device is generating a waveform. If you want to change the device configuration, call the niFgen_Abort_Generation function or wait for the generation to complete.

NIFGEN_ATTRIBUTE_MAX_NUM_SEQUENCES

IviFgenArbSeq Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1250212 ViInt32 RO N/A None niFgen_QueryArbSeqCapabilities

Description

Returns the maximum number of arbitrary sequences that the signal generator allows. Typically, this value is constant for the signal generator.

NIFGEN_ATTRIBUTE_MAX_SEQUENCE_LENGTH

IviFgenArbSeq Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1250214 ViInt32 RO N/A None niFgen_QueryArbSeqCapabilities

Description

Returns the maximum number of arbitrary waveforms that the signal generator allows in a sequence. Typically, this value is constant for the signal generator.

NIFGEN_ATTRIBUTE_MIN_SEQUENCE_LENGTH

IviFgenArbSeq Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1250213 ViInt32 RO N/A None niFgen_QueryArbSeqCapabilities

Description

Returns the minimum number of arbitrary waveforms that the signal generator allows in a sequence. Typically, this value is constant for the signal generator.

NIFGEN_ATTRIBUTE_MAX_LOOP_COUNT

IviFgenArbSeq Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1250215 ViInt32 RO N/A None niFgen_QueryArbSeqCapabilities

Description

Returns the maximum number of times that the signal generator can repeat a waveform in a sequence. Typically, this value is constant for the signal generator.

NIFGEN_ATTRIBUTE_SCRIPT_TO_GENERATE

Specific Attribute

Numeric Value Data
type		 Access Applies to Coercion High Level Functions
1150270 ViString R/W Yes None None

Description

Specifies which script the generator produces. To configure the generator to run a particular script, set this attribute to the name of the script.

Use the niFgen_WriteScript function to create multiple scripts. Use this property only when the NIFGEN_ATTRIBUTE_OUTPUT_MODE attribute is set to NIFGEN_VAL_OUTPUT_SCRIPT.

Note:  You cannot change this attribute while the device is generating a waveform. If you want to change the device configuration, call the niFgen_AbortGeneration function or wait for the generation to complete.

NIFGEN_ATTRIBUTE_WAVEFORM_QUANTUM

IviFgenArbWfm Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1250206 ViInt32 RO N/A None niFgen_QueryArbWfmCapabilities

Description

Returns the quantum value that the signal generator allows. The size of each arbitrary waveform must be a multiple of a quantum value.

For example, when this attribute returns a value of 4, all waveform sizes must be a multiple of 4. Typically, this value is constant for the signal generator.

NIFGEN_ATTRIBUTE_MAX_NUM_WAVEFORMS

IviFgenArbWfm Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1250205 ViInt32 RO N/A None niFgen_QueryArbWfmCapabilities

Description

Returns the maximum number of arbitrary waveforms that the signal generator allows. On some signal generators, this value may vary with remaining onboard memory.

NIFGEN_ATTRIBUTE_MIN_WAVEFORM_SIZE

IviFgenArbWfm Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1250207 ViInt32 RO N/A None niFgen_QueryArbWfmCapabilities

Description

Returns the minimum number of points that the signal generator allows in an arbitrary waveform. Typically, this value is constant for the signal generator.

Note:  In some cases you may need to supply a larger waveform than the value specified by this property. Refer to the NI Signal Generators Help for a table of minimum waveform sizes.

NIFGEN_ATTRIBUTE_MAX_WAVEFORM_SIZE

IviFgenArbWfm Attribute

Numeric Value Data Type Access Applies to Coercion High-Level Functions
1250208 ViInt32 RO N/A None niFgen_QueryArbWfmCapabilities

Description

Returns the size, in samples, of the largest waveform that can be created. This attribute reflects the space currently available, taking into account previously allocated waveforms and instructions. On some signal generators, this value may vary with remaining onboard memory.

Table of Contents

Home

Internal Development

Creating and Setting Up a gRPC Server

Server Security Support

Creating a gRPC Client

gRPC Client Examples

Session Utilities API Reference

Driver Documentation

gRPC API Differences From C API

Sharing Driver Sessions Between Clients

C API Docs
NI-DAQmx
NI-DCPOWER
NI-DIGITAL PATTERN DRIVER
NI-DMM
NI-FGEN
NI-FPGA
NI-RFmx Bluetooth
NI-RFmx NR
NI-RFmx WCDMA
NI-RFmx GSM
NI-RFmx CDMA2k
NI-RFmx Instr
NI-RFmx LTE
NI-RFmx SpecAn
NI-RFmx TD-SCDMA
NI-RFmx WLAN
NI-RFSA
NI-RFSG
NI-SCOPE
NI-SWITCH
NI-TCLK
NI-XNET
Clone this wiki locally