Fetches the acquired amplitude trace in the measurement, where the Amplitude array forms the y-axis of the trace. You can use the RFMXPULSE_ATTR_PULSE_ACQUISITION_TRACE_SELECT attribute to select all pulses or the subset of acquired pulses. When you set the RFMXPULSE_ATTR_SEGMENTED_ACQUISITION_ENABLED attribute to False, returns a single element in the Start Indices and Start Time Stamp array.

Syntax

int32 __stdcall RFmxPulse_FetchAcquiredAmplitudeTrace(niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64 *sampleDuration, float32 amplitude[], int32 amplitudeArraySize, int32 *amplitudeActualArraySize, int32 startIndex[], float64 startTimeStamp[], int32 startArraysSize, int32 *startActualArraysSize)

Parameters

NameDirectionTypeDescription
instrumentHandle[in]niRFmxInstrHandle

This parameter specifies the RFmx session refnum. Instrument Handle In is obtained from the RFmxInstr_Initialize function.

selectorString[in]char[]

This parameter specifies a Selector String comprising of the signal name and result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used. The default value is "" (empty string).

Example:

""

"signal::sig1"

"result::r1"

"signal::sig1/result::r1"

timeout[in]float64

This parameter specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete. The default value is 10.

sampleDuration[out]float64 *

This parameter returns the sample duration, in seconds.

amplitude[out]float32[]

This parameter returns the trace of amplitude measured in units specified by RFMXPULSE_ATTR_PULSE_AMPLITUDE_TRACE_UNIT attribute.

amplitudeArraySize[in]int32

Specifies the size of amplitude array. Set the amplitudeArraySize parameter to 0 to get the size of amplitude array in the amplitudeActualArraySize parameter.

amplitudeActualArraySize[out]int32 *

Returns the actual size of the amplitude array, if you pass NULL to amplitude output array parameters, and set the amplitudeArraySize parameter to 0.

startIndex[out]int32[]

This parameter returns the array of sample indices for the start of each segment.

startTimeStamp[out]float64[]

This parameter returns the array of timestamps of each segment start, in seconds.

startArraysSize[in]int32

Specifies the size of start index and start time stamp array. Set the startArraysSize parameter to 0 to get the size of start index and start time stamp arrays in the startActualArraysSize parameter.

startActualArraysSize[out]int32 *

Returns the actual size of the start index and start time stamp array, if you pass NULL to start index and start time stamp output array parameters, and set the startArraysSize parameter to 0.

Returns

Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxPulse_GetError function.

The general meaning of the status code is as follows:

Value

Meaning

0

Success

Positive Values

Warnings

Negative Values

Errors