Table Of Contents

IviSpecAn Read Y Trace (G Dataflow)

Version:
    Last Modified: October 24, 2017

    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 node resets the sweep count.

    spd-note-note
    Note  

    If the spectrum analyzer did not complete the acquisition within the time specified in the Maximum Time parameter, this node returns the Max Time Exceeded (0xBFFA2003) error.

    spd-note-note
    Note  

    If the data was captured in an uncalibrated spectrum analyzer mode, this node returns a Measure Uncalibrated (0x3FFA2001) warning.

    connector_pane_image
    datatype_icon

    array length (2048)

    Pass the number of Amplitude array points requested. Default Value: None

    datatype_icon

    instrument handle

    The instrument handle that you obtain from the IviSpecAn Initialize Node or IviSpecAn Initialize With Options Node. The handle identifies a particular instrument session.

    Default: None

    datatype_icon

    error in

    Error conditions that occur before this node runs.

    The node responds to this input according to standard error behavior.

    Standard Error Behavior

    Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

    error in does not contain an error error in contains an error
    If no error occurred before the node runs, the node begins execution normally.

    If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

    If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

    Default: No error

    datatype_icon

    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. Users who want to achieve interchangeability should use a virtual repeated capability name. The virtual repeated capability name should be sufficiently specific to the test system such that it is unlikely to conflict with a physical repeated capability 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: ""

    datatype_icon

    maximum time (5000 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.

    datatype_icon

    instrument handle out

    The instrument handle that you obtain from the IviSpecAn Initialize Node or IviSpecAn Initialize With Options Node. The handle identifies a particular instrument session.

    Default: None

    datatype_icon

    error out

    Error information.

    The node produces this output according to standard error behavior.

    Standard Error Behavior

    Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

    error in does not contain an error error in contains an error
    If no error occurred before the node runs, the node begins execution normally.

    If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

    If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.
    datatype_icon

    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.

    datatype_icon

    actual points

    Indicates the number of points the VI places in the Amplitude array.

    Where This Node Can Run:

    Desktop OS: Windows

    FPGA: Not supported

    Web Server: Not supported in VIs that run in a web application


    Recently Viewed Topics