IviSpecAn Read Y Trace
IviSpecAnBase Capability Group
This VI initiates a signal acquisition based on the present instrument configuration. It then waits for the acquisition to complete, and returns the trace as an array of amplitude values. The amplitude array returns data that represent the amplitude of the signals of the sweep from the start frequency to the stop frequency (in frequency domain, in time domain the amplitude array is ordered from beginning of sweep to end). This VI resets the sweep count.
Notes
(1) If the spectrum analyzer did not complete the acquisition within the time specified in the Maximum Time parameter, this VI returns the Max Time Exceeded (0xBFFA2003) error.
(2) If the data was captured in an uncalibrated spectrum analyzer mode, this VI returns a Measure Uncalibrated (0x3FFA2001) warning.
 |
instrument handle The instrument handle that you obtain from the IviSpecAn Initialize or IviSpecAn Initialize With Options VIs. |
 |
trace name Pass the name of the trace for the desired amplitude array.
This control accepts either a virtual repeated capability name or an instrument-specific trace name. Virtual repeated capability names are aliases for instrument-specific trace strings. The instrument-specific trace strings can differ from one instrument to another. Virtual repeated capability names allow you to use and swap instruments without having to change the trace names in your source code. You specify virtual repeated capability names in MAX. Default Value: "" |
 |
maximum time (ms) Pass the maximum length of time in which to allow the read trace operation to complete. If the operation does not complete within this time interval, the VI returns the IVISPECAN_ERROR_MAX_TIME_EXCEEDED (0xBFFA2003) error code. When this occurs, call IviSpecAn Abort.vi to cancel the read trace operation and return the spectrum analyzer to the Idle state. Units: milliseconds. Defined Values: IVISPECAN_VAL_MAX_TIME_INFINITE (-1) IVISPECAN_VAL_MAX_TIME_IMMEDIATE (0) Default Value: 5000 (ms) Notes(1) The Maximum Time parameter applies only to this VI. It has no effect on other timeout parameters or properties. |
|
array length Pass the number of Amplitude array points requested.
Default Value: None |
 |
error in (no error) The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.
The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed. |
 |
instrument handle out The instrument handle that you obtain from the IviSpecAn Initialize or IviSpecAn Initialize With Options VIs. |
 |
actual points Indicates the number of points the VI places in the Amplitude array. |
 |
amplitude Returns the amplitude waveform that the spectrum analyzer acquires. Units: The units are determined by setting the Amplitude Units parameter of the IviSpecAn Configure Level.vi or by setting IviSpecAn>>Basic Operation>>Amplitude Units property. Notes(1) The IviSpecAn Query Trace Size.vi returns the number of points the spectrum analyzer acquires. Pass a ViReal64 array with at least this many elements. |
 |
error out The error out cluster passes error or warning information out of a VI to be used by other VIs.
The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed. |