NIRfsa Namespace

Table of Contents

RfsaIQAcquisition.MemoryOptimizedFetchIQSingleRecordComplexWaveform(Int64, Int64, PrecisionTimeSpan, ComplexWaveform<ComplexDouble>, RfsaWaveformInfo) Method

  • Updated2025-07-17
  • 2 minute(s) read
RfsaIQAcquisition.MemoryOptimizedFetchIQSingleRecordComplexWaveform(Int64, Int64, PrecisionTimeSpan, ComplexWaveform<ComplexDouble>, RfsaWaveformInfo) Method

RfsaIQAcquisitionMemoryOptimizedFetchIQSingleRecordComplexWaveform(Int64, Int64, PrecisionTimeSpan, ComplexWaveformComplexDouble, RfsaWaveformInfo) Method

Fetches I/Q data from a single record in a single acquisition to optimize memory.

Namespace: NationalInstruments.ModularInstruments.NIRfsa
Assembly: NationalInstruments.ModularInstruments.NIRfsa.Fx45 (in NationalInstruments.ModularInstruments.NIRfsa.Fx45.dll) Version: 2025

Syntax

public ComplexWaveform<ComplexDouble> MemoryOptimizedFetchIQSingleRecordComplexWaveform(
	long recordNumber,
	long numberOfSamples,
	PrecisionTimeSpan timeout,
	ref ComplexWaveform<ComplexDouble> waveform,
	out RfsaWaveformInfo waveformInfo
)
Public Function MemoryOptimizedFetchIQSingleRecordComplexWaveform ( 
	recordNumber As Long,
	numberOfSamples As Long,
	timeout As PrecisionTimeSpan,
	ByRef waveform As ComplexWaveform(Of ComplexDouble),
	<OutAttribute> ByRef waveformInfo As RfsaWaveformInfo
) As ComplexWaveform(Of ComplexDouble)

Parameters

recordNumber  Int64
Specifies the record to retrieve. Record numbers are zero-based.
numberOfSamples  Int64
Specifies the number of samples to fetch.
timeout  PrecisionTimeSpan
Specifies the time, in seconds, allotted for the method to complete before returning a timeout error. A value of MaxValue specifies the method waits until all data is available. A value of 0 specifies the method immediately returns available data.
waveform  ComplexWaveformComplexDouble
Contains the ComplexWavefrom object to be populated. New memory won't be allocated if the ComplexWaveform object is not null and its sammpleCount is same as the numberOfSamples.
waveformInfo  RfsaWaveformInfo
Contains the absolute and relative timestamps for the operation, the time interval, and the actual number of samples read.

Return Value

ComplexWaveformComplexDouble
Returns the acquired waveform.

Exceptions

ExceptionCondition
ObjectDisposedException The MemoryOptimizedFetchIQSingleRecordComplexWaveformT(Int64, Int64, PrecisionTimeSpan, ComplexWaveformT) method was accessed after the associated NIRfsa object was disposed.

Remarks

The fetch transfers acquired waveform data from device memory to computer memory. The data was acquired to onboard memory previously by the hardware after the acquisition was initiated. This method is not necessary if you use the ReadIQSingleRecordComplex(PrecisionTimeSpan, RfsaWaveformInfo), or ReadIQSingleRecordComplexWaveform(PrecisionTimeSpan, RfsaWaveformInfo), MemoryOptimizedReadIQSingleRecordComplex(PrecisionTimeSpan, ComplexDouble, RfsaWaveformInfo), or MemoryOptimizedReadIQSingleRecordComplexWaveform(PrecisionTimeSpan, ComplexWaveformComplexDouble, RfsaWaveformInfo) methods, as the fetch is performed as part of these methods.
Memory optimization is not guaranteed.

See Also

Log in to get a better experience