niFgen Create Waveform (poly) VI

Download PDF

Updated2023-02-21
14 minute(s) read

niFgen Create Waveform (poly) VI

Installed With: NI-FGEN

Takes the data provided and creates an onboard waveform of the same size for use in Arbitrary Waveform or Arbitrary Sequence output mode.

The Waveform Handle returned by the VI can be used later for setting the active waveform, changing the data in the waveform, building sequences of waveforms, or deleting the waveform when it is no longer needed.

Note The signal generator must not be in the Generating state when you call any instance of this polymorphic VI.

Note You must set the Output Mode parameter to Arbitrary Waveform or Arbitrary Sequence using the niFgen Configure Output Mode VI before calling this VI.

niFgen Create Waveform (I16)

Creates an onboard waveform from I16 data for use in Arbitrary Waveform or Arbitrary Sequence output mode. The Waveform Handle returned by the VI can be used later for setting the active waveform, changing the data in the waveform, building sequences of waveforms, or deleting the waveform when it is no longer needed.

This VI can also create an onboard waveform from complex data for use on devices with the OSP Enabled property set to TRUE and the Data Processing Mode property set to Complex. To write complex data, you must interleave the I and Q value pairs.

niFgen Create Waveform (I16)

	Instrument Handle identifies your instrument session. Instrument Handle is obtained from the niFgen Initialize VI, niFgen Initialize With Options VI, or the niFgen Initialize With Channels VI.
	Channel Name specifies the channel that this VI uses.
	Waveform Data Array specifies the array of data you want to use for the new arbitrary waveform. You must normalize the data points in the array to be between -32768 and 32767 inclusive.
	error in describes error conditions that occur before this node runs. This input provides standard error in functionality. Default value: no error
	Instrument Handle Out passes a reference to your instrument session to the next VI.
	Waveform Handle returns a handle that identifies the waveform.
	error out contains error information. This output provides standard error out functionality.

niFgen Create Waveform (WDT)

Creates an onboard waveform from WDT data for use in Arbitrary Waveform or Arbitrary Sequence output mode. The Waveform Handle returned by the VI can be used later for setting the active waveform, changing the data in the waveform, building sequences of waveforms, or deleting the waveform when it is no longer needed.

Note The data must be between -1.0 and +1.0. Use the Gain parameter of the niFgen Configure Arbitrary Waveform VI or the niFgen Configure Arbitrary Sequence VI to generate different voltages.

Note You can set Use Waveform dT for Sample Rate to TRUE to obtain rate information from the waveform, using the inverse of the dT as the rate. If Use Waveform dT for Rate is set to FALSE, the sample rate you set by calling the niFgen Set Sample Rate VI or by setting the Sample Rate property is used as the sample rate. If no sample rate is set, the default sample rate is used.

niFgen Create Waveform (WDT)

	Instrument Handle identifies your instrument session. Instrument Handle is obtained from the niFgen Initialize VI, niFgen Initialize With Options VI, or the niFgen Initialize With Channels VI.
	Channel Name specifies the channel that this VI uses.
	Waveform specifies the data you want to use for the arbitrary waveform.
	Use Waveform dT for Sample Rate specifies whether the sample rate should be set to match the sampling information contained in the Waveform parameter.
	error in describes error conditions that occur before this node runs. This input provides standard error in functionality. Default value: no error
	Instrument Handle Out passes a reference to your instrument session to the next VI.
	Waveform Handle returns a handle that identifies the waveform.
	error out contains error information. This output provides standard error out functionality.

niFgen Create Waveform (DBL)

Creates an onboard waveform from double-precision floating-point data for use in Arbitrary Waveform or Arbitrary Sequence output mode. The waveform handle returned by the VI can be used later for setting the active waveform, changing the data in the waveform, building sequences of waveforms, or deleting the waveform when it is no longer needed.

niFgen Create Waveform (DBL)

	Instrument Handle identifies your instrument session. Instrument Handle is obtained from the niFgen Initialize VI, niFgen Initialize With Options VI, or the niFgen Initialize With Channels VI.
	Channel Name specifies the channel that this VI uses.
	Waveform Data Array specifies the array of data you want to load into the new waveform. You must normalize the data points in the array to be between -1.00 and +1.00.
	error in describes error conditions that occur before this node runs. This input provides standard error in functionality. Default value: no error
	Instrument Handle Out passes a reference to your instrument session to the next VI.
	Waveform Handle returns a handle that identifies the waveform.
	error out contains error information. This output provides standard error out functionality.

niFgen Create Waveform From File (I16)

Takes binary data from a specified file of 16-bit integers and creates an onboard waveform for use in Arbitrary Waveform or Arbitrary Sequence output mode. The Waveform Handle returned by the VI can be used later for setting the active waveform, changing the data in the waveform, building sequences of waveforms, or deleting the waveform when it is no longer needed.

niFgen Create Waveform From File (I16)

Instrument Handle identifies your instrument session.

Instrument Handle is obtained from the niFgen Initialize VI, niFgen Initialize With Options VI, or the niFgen Initialize With Channels VI.

Channel Name specifies the channel that this VI uses.

File Name specifies the full path and name of the file where the waveform data resides.

Byte Order specifies the byte order of the data in the file: Big Endian or Little Endian.

Note Data written by most applications in Windows (including LabWindows/CVI) is in Little Endian format. Data written to a file from LabVIEW is in Big Endian format by default on all platforms. (Big Endian and Little Endian refer to the way data is stored in memory, which can differ on different processors.)

The 16-bit integer, or I16, data (values between -32768 and +32767) is assumed to represent -1 to +1 volts. Use the Gain parameter of the niFgen Configure Arbitrary Waveform VI or niFgen Configure Arbitrary Sequence VI to generate different voltages.

error in describes error conditions that occur before this node runs. This input provides standard error in functionality.

Default value: no error

Instrument Handle Out passes a reference to your instrument session to the next VI.

Waveform Handle returns a handle that identifies the waveform.

error out contains error information. This output provides standard error out functionality.

niFgen Create Waveform From File (HWS)

Takes waveform data from a specified Hierarchical Waveform Storage (HWS) file and creates an onboard waveform for use in Arbitrary Waveform or Arbitrary Sequence output mode. The Waveform Handle returned can be used later for setting the active waveform, changing the data in the waveform, building sequences of waveforms, or deleting the waveform when it is no longer needed.

When the Analog Waveform Editor saves data in an HWS file, it also stores the sample rate, gain, and offset with the data. If the Use Rate from Waveform and Use Gain and Offset from Waveform are set to TRUE, this VI also sets those properties on NI-FGEN.

Note If you choose to have this VI set the gain and offset, you should not use the niFgen Configure Arbitrary Waveform VI or the niFgen Configure Arbitrary Sequence VI, as they also set the gain and offset, thereby overriding the values set by this VI. Instead, use the niFgen Property Node VI to set the Arbitrary Waveform Handle or Arbitrary Sequence Handle properties.

If you set Use Rate from Waveform to TRUE and if Onboard Signal Processing (OSP) is enabled, the rate from the waveform is interpreted as the I/Q rate, and NI-FGEN sets the IQ Rate property for you. In all other cases, it is interpreted as the sample rate, and NI-FGEN sets the sample rate for you.

HWS files may contain 16-bit integer (I16) or double-precision floating-point (DBL) data (depending on how it was saved). This VI automatically adapts to either data type. If the file contains floating-point data, it must be between -1.0 and +1.0. Check the Scale Data to +/- 1V option if writing data from the NI Analog Waveform Editor to ensure your data is between -1.0 and +1.0.

Use the Gain parameter of the niFgen Configure Arbitrary Waveform VI or the niFgen Configure Arbitrary Sequence VI to generate different voltages.

niFgen Create Waveform From File (HWS)

	Instrument Handle identifies your instrument session. Instrument Handle is obtained from the niFgen Initialize VI, niFgen Initialize With Options VI, or the niFgen Initialize With Channels VI.
	Channel Name specifies the channel that this VI uses.
	File Name specifies the full path and name of the file where the waveform data resides.
	Use Gain and Offset from Waveform specifies whether or not NI-FGEN retrieves the gain and offset values from the specified HWS file and applies them to the NI-FGEN driver. Default value: True
	Use Rate from Waveform specifies whether or not NI-FGEN retrieves the sample rate or I/Q rate from the specified HWS file and applies it to the NI-FGEN driver. Default value: True
	error in describes error conditions that occur before this node runs. This input provides standard error in functionality. Default value: no error
	Instrument Handle Out passes a reference to your instrument session to the next VI.
	Waveform Handle returns a handle that identifies the waveform.
	error out contains error information. This output provides standard error out functionality.

niFgen Create Waveform From File (DBL)

Takes waveform data from a specified file of double-precision floating-point data and creates an onboard waveform for use in Arbitrary Waveform or Arbitrary Sequence output mode. The Waveform Handle returned can be used later for setting the active waveform, changing the data in the waveform, building sequences of waveforms, or deleting the waveform when it is no longer needed.

Note The floating-point data must be between -1.0 and +1.0. Use the Gain parameter of the niFgen Configure Arbitrary Waveform VI or the niFgen Configure Arbitrary Sequence VI to generate different voltages.

niFgen Create Waveform From File (DBL)

Instrument Handle identifies your instrument session.

Instrument Handle is obtained from the niFgen Initialize VI, niFgen Initialize With Options VI, or the niFgen Initialize With Channels VI.

Channel Name specifies the channel that this VI uses.

File Name specifies the full path and name of the file where the waveform data resides.

Byte Order specifies the byte order of the data in the file: Big Endian or Little Endian

Note Data written by most applications in Windows (including LabWindows™/CVI™) is in Little Endian format. Data written to a file from LabVIEW is in Big Endian format by default on all platforms. (Big Endian and Little Endian refer to the way data is stored in memory, which can differ on different processors.)

error in describes error conditions that occur before this node runs. This input provides standard error in functionality.

Default value: no error

Instrument Handle Out passes a reference to your instrument session to the next VI.

Waveform Handle returns a handle that identifies the waveform.

error out contains error information. This output provides standard error out functionality.

niFgen Create Waveform (Complex DBL)

Creates an onboard waveform from complex double-precision floating-point data for use in Arbitrary Waveform or Arbitrary Sequence output mode on devices with the OSP Enabled property set to TRUE and the Data Processing Mode property set to Complex. The Waveform Handle returned by the VI can be used later for setting the active waveform, changing the data in the waveform, building sequences of waveforms, or deleting the waveform when it is no longer needed.

niFgen Create Waveform (Complex DBL)

	Instrument Handle identifies your instrument session. Instrument Handle is obtained from the niFgen Initialize VI, niFgen Initialize With Options VI, or the niFgen Initialize With Channels VI.
	Channel Name specifies the channel that this VI uses.
	Waveform Data Array specifies the array of data you want to load into the new waveform. The array must have at least as many elements as the value that you specify in the Waveform Size parameter. You must normalize the data points in the array to be between -1.00 and +1.00.
	error in describes error conditions that occur before this node runs. This input provides standard error in functionality. Default value: no error
	Instrument Handle Out passes a reference to your instrument session to the next VI.
	Waveform Handle returns a handle that identifies the waveform.
	error out contains error information. This output provides standard error out functionality.

niFgen Create Waveform (Complex WDT)

	Instrument Handle identifies your instrument session. Instrument Handle is obtained from the niFgen Initialize VI, niFgen Initialize With Options VI, or the niFgen Initialize With Channels VI.
	Channel Name specifies the channel that this VI uses.
	Waveform specifies the data you want to use for the arbitrary waveform.
	Use Waveform dT for IQ Rate specifies whether the I/Q rate should be set to match the sampling information contained in the Waveform parameter.
	error in describes error conditions that occur before this node runs. This input provides standard error in functionality. Default value: no error
	Instrument Handle Out passes a reference to your instrument session to the next VI.
	Waveform Handle returns a handle that identifies the waveform.
	error out contains error information. This output provides standard error out functionality.

Was this information helpful?

Yes No

NI-FGEN LabVIEW VIs

Filters

Content Type

Programming Language

Table of Contents

niFgen Create Waveform (poly) VI

niFgen Create Waveform (poly) VI

niFgen Create Waveform (I16)

niFgen Create Waveform (WDT)

niFgen Create Waveform (DBL)

niFgen Create Waveform From File (I16)

niFgen Create Waveform From File (HWS)

niFgen Create Waveform From File (DBL)

niFgen Create Waveform (Complex DBL)

niFgen Create Waveform (Complex WDT)

In This Section

Additional Comments

Download PDF