FftSpecAn

SCPI Command:

CONFigure:GPRF:MEASurement<Instance>:FFTSanalyzer:TOUT
CONFigure:GPRF:MEASurement<Instance>:FFTSanalyzer:AMODe
CONFigure:GPRF:MEASurement<Instance>:FFTSanalyzer:DETector
CONFigure:GPRF:MEASurement<Instance>:FFTSanalyzer:FFTLength
CONFigure:GPRF:MEASurement<Instance>:FFTSanalyzer:FSPan
CONFigure:GPRF:MEASurement<Instance>:FFTSanalyzer:MOEXception
CONFigure:GPRF:MEASurement<Instance>:FFTSanalyzer:REPetition
CONFigure:GPRF:MEASurement<Instance>:FFTSanalyzer:RCOupling
CONFigure:GPRF:MEASurement<Instance>:FFTSanalyzer:SCOunt

class FftSpecAnCls

FftSpecAn commands group definition. 13 total commands, 2 Subgroups, 9 group commands

get_amode() → AveragingMode

# SCPI: CONFigure:GPRF:MEASurement<Instance>:FFTSanalyzer:AMODe
value: enums.AveragingMode = driver.configure.gprfMeasurement.fftSpecAn.get_amode()

Defines how the average FFT trace is derived from the current trace.

return:

averaging_mode: LINear | LOGarithmic LINear Averaging of the linear powers LOGarithmic Averaging of the dBm values

get_detector() → DetectorSimple

# SCPI: CONFigure:GPRF:MEASurement<Instance>:FFTSanalyzer:DETector
value: enums.DetectorSimple = driver.configure.gprfMeasurement.fftSpecAn.get_detector()

Defines how a spectrum diagram point is calculated from adjacent frequency domain samples.

return:

detector: PEAK | RMS PEAK The sample with the largest power is displayed. RMS The RMS value of the samples is displayed.

get_fft_length() → int

# SCPI: CONFigure:GPRF:MEASurement<Instance>:FFTSanalyzer:FFTLength
value: int = driver.configure.gprfMeasurement.fftSpecAn.get_fft_length()

Specifies the number of samples used for the FFT analysis.

return:

length: You can enter values between 1024 and 16384. The setting is rounded to the closest integer power of two.

get_fspan() → float

# SCPI: CONFigure:GPRF:MEASurement<Instance>:FFTSanalyzer:FSPan
value: float = driver.configure.gprfMeasurement.fftSpecAn.get_fspan()

Defines the frequency range to be measured and thus the x-axis of the spectrum result diagram.

return:

frequency_span: You can enter values between 10 kHz and 20 MHz. The setting is rounded to the closest of the following values: 10 / 20 / 40 / 80 / 160 / 320 / 640 kHz 1.25 / 2.5 / 5 / 10 / 20 MHz Unit: Hz

get_mo_exception() → bool

# SCPI: CONFigure:GPRF:MEASurement<Instance>:FFTSanalyzer:MOEXception
value: bool = driver.configure.gprfMeasurement.fftSpecAn.get_mo_exception()

Specifies whether measurement results that the CMA identifies as faulty or inaccurate are rejected.

return:

meas_on_exception: OFF | ON OFF Faulty results are rejected ON Results are never rejected

get_rcoupling() → bool

# SCPI: CONFigure:GPRF:MEASurement<Instance>:FFTSanalyzer:RCOupling
value: bool = driver.configure.gprfMeasurement.fftSpecAn.get_rcoupling()

Couples the repetition mode (single shot or continuous) of all measurements.

return:

repetition_coupl: OFF | ON

get_repetition() → Repeat

# SCPI: CONFigure:GPRF:MEASurement<Instance>:FFTSanalyzer:REPetition
value: enums.Repeat = driver.configure.gprfMeasurement.fftSpecAn.get_repetition()

Selects whether the measurement is repeated continuously or not.

return:

repetition: SINGleshot | CONTinuous SINGleshot Single-shot measurement, stopped after one measurement cycle CONTinuous Continuous measurement, running until explicitly terminated

get_scount() → int

# SCPI: CONFigure:GPRF:MEASurement<Instance>:FFTSanalyzer:SCOunt
value: int = driver.configure.gprfMeasurement.fftSpecAn.get_scount()

Specifies the number of measurement intervals per measurement cycle. One measurement interval comprises the number of samples defined by the ‘FFT Length’.

return:

statistic_count: Range: 1 to 1000

get_timeout() → float

# SCPI: CONFigure:GPRF:MEASurement<Instance>:FFTSanalyzer:TOUT
value: float = driver.configure.gprfMeasurement.fftSpecAn.get_timeout()

Defines a timeout for the measurement. The timer is started when the measurement is initiated via a READ or INIT command. It is not started if the measurement is initiated via the graphical user interface. The timer is reset after the first measurement cycle. If the first measurement cycle has not been completed when the timer expires, the measurement is stopped and the reliability indicator is set to 1. Still running READ, FETCh or CALCulate commands are completed, returning the available results. At least for some results, there are no values at all or the statistical depth has not been reached. A timeout of 0 s corresponds to an infinite measurement timeout.

return:

tcd_timeout: Unit: s

set_amode(averaging_mode: AveragingMode) → None

# SCPI: CONFigure:GPRF:MEASurement<Instance>:FFTSanalyzer:AMODe
driver.configure.gprfMeasurement.fftSpecAn.set_amode(averaging_mode = enums.AveragingMode.LINear)

Defines how the average FFT trace is derived from the current trace.

param averaging_mode:

LINear | LOGarithmic LINear Averaging of the linear powers LOGarithmic Averaging of the dBm values

set_detector(detector: DetectorSimple) → None

# SCPI: CONFigure:GPRF:MEASurement<Instance>:FFTSanalyzer:DETector
driver.configure.gprfMeasurement.fftSpecAn.set_detector(detector = enums.DetectorSimple.PEAK)

Defines how a spectrum diagram point is calculated from adjacent frequency domain samples.

param detector:

PEAK | RMS PEAK The sample with the largest power is displayed. RMS The RMS value of the samples is displayed.

set_fft_length(length: int) → None

# SCPI: CONFigure:GPRF:MEASurement<Instance>:FFTSanalyzer:FFTLength
driver.configure.gprfMeasurement.fftSpecAn.set_fft_length(length = 1)

Specifies the number of samples used for the FFT analysis.

param length:

You can enter values between 1024 and 16384. The setting is rounded to the closest integer power of two.

set_fspan(frequency_span: float) → None

# SCPI: CONFigure:GPRF:MEASurement<Instance>:FFTSanalyzer:FSPan
driver.configure.gprfMeasurement.fftSpecAn.set_fspan(frequency_span = 1.0)

Defines the frequency range to be measured and thus the x-axis of the spectrum result diagram.

param frequency_span:

You can enter values between 10 kHz and 20 MHz. The setting is rounded to the closest of the following values: 10 / 20 / 40 / 80 / 160 / 320 / 640 kHz 1.25 / 2.5 / 5 / 10 / 20 MHz Unit: Hz

set_mo_exception(meas_on_exception: bool) → None

# SCPI: CONFigure:GPRF:MEASurement<Instance>:FFTSanalyzer:MOEXception
driver.configure.gprfMeasurement.fftSpecAn.set_mo_exception(meas_on_exception = False)

Specifies whether measurement results that the CMA identifies as faulty or inaccurate are rejected.

param meas_on_exception:

OFF | ON OFF Faulty results are rejected ON Results are never rejected

set_rcoupling(repetition_coupl: bool) → None

# SCPI: CONFigure:GPRF:MEASurement<Instance>:FFTSanalyzer:RCOupling
driver.configure.gprfMeasurement.fftSpecAn.set_rcoupling(repetition_coupl = False)

Couples the repetition mode (single shot or continuous) of all measurements.

param repetition_coupl:

OFF | ON

set_repetition(repetition: Repeat) → None

# SCPI: CONFigure:GPRF:MEASurement<Instance>:FFTSanalyzer:REPetition
driver.configure.gprfMeasurement.fftSpecAn.set_repetition(repetition = enums.Repeat.CONTinuous)

Selects whether the measurement is repeated continuously or not.

param repetition:

SINGleshot | CONTinuous SINGleshot Single-shot measurement, stopped after one measurement cycle CONTinuous Continuous measurement, running until explicitly terminated

set_scount(statistic_count: int) → None

# SCPI: CONFigure:GPRF:MEASurement<Instance>:FFTSanalyzer:SCOunt
driver.configure.gprfMeasurement.fftSpecAn.set_scount(statistic_count = 1)

Specifies the number of measurement intervals per measurement cycle. One measurement interval comprises the number of samples defined by the ‘FFT Length’.

param statistic_count:

Range: 1 to 1000

set_timeout(tcd_timeout: float) → None

# SCPI: CONFigure:GPRF:MEASurement<Instance>:FFTSanalyzer:TOUT
driver.configure.gprfMeasurement.fftSpecAn.set_timeout(tcd_timeout = 1.0)

Defines a timeout for the measurement. The timer is started when the measurement is initiated via a READ or INIT command. It is not started if the measurement is initiated via the graphical user interface. The timer is reset after the first measurement cycle. If the first measurement cycle has not been completed when the timer expires, the measurement is stopped and the reliability indicator is set to 1. Still running READ, FETCh or CALCulate commands are completed, returning the available results. At least for some results, there are no values at all or the statistical depth has not been reached. A timeout of 0 s corresponds to an infinite measurement timeout.

param tcd_timeout:

Unit: s

Cloning the Group

# Create a clone of the original group, that exists independently
group2 = driver.configure.gprfMeasurement.fftSpecAn.clone()

Subgroups

• Marker<MarkerOther>
  • Enable
  • Placement
• PeakSearch