NIRfsa Namespace

Table of Contents

RfsaSpectrumAcquisition.ReadPowerSpectrumSingle(PrecisionTimeSpan, RfsaSpectrumInfo) Method

  • Updated2025-07-17
  • 1 minute(s) read
RfsaSpectrumAcquisition.ReadPowerSpectrumSingle(PrecisionTimeSpan, RfsaSpectrumInfo) Method

RfsaSpectrumAcquisitionReadPowerSpectrumSingle(PrecisionTimeSpan, RfsaSpectrumInfo) Method

Initiates a spectrum acquisition and returns power spectrum data.

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

Syntax

public float[] ReadPowerSpectrumSingle(
	PrecisionTimeSpan timeout,
	out RfsaSpectrumInfo spectrumInfo
)
Public Function ReadPowerSpectrumSingle ( 
	timeout As PrecisionTimeSpan,
	<OutAttribute> ByRef spectrumInfo As RfsaSpectrumInfo
) As Single()

Parameters

timeout  PrecisionTimeSpan
The time allotted for the method to complete before returning a timeout error. Using MaxValue specifies that the method waits until all data is available.
spectrumInfo  RfsaSpectrumInfo
Additional information about the power spectrum data array, including the frequency, in hertz (Hz), corresponding to the first element in the array; the frequency increment, in Hz, between adjacent array elements; and the number of spectral lines the method returned

Return Value

Single
The power spectrum data.

Exceptions

ExceptionCondition
ObjectDisposedException The ReadPowerSpectrumSingle(PrecisionTimeSpan, RfsaSpectrumInfo) method was accessed after the associated NIRfsa object was disposed.

See Also

Log in to get a better experience