PeakSearch

SCPI Commands :

CONFigure:GPRF:MEASurement<Instance>:FFTSanalyzer:PSEarch:NOAMarkers
CONFigure:GPRF:MEASurement<Instance>:FFTSanalyzer:PSEarch
class PeakSearchCls[source]

PeakSearch commands group definition. 2 total commands, 0 Subgroups, 2 group commands

class ValueStruct[source]

Structure for setting input parameters. Fields:

  • Full_Span_Enable_0: bool: Enable full-span search for marker 0. OFF: Search the configured range. ON: Search the full span and ignore the configured range.

  • Peak_Range_From_0: float: Lower end of the search range for marker 0.

  • Peak_Range_To_0: float: Upper end of the search range for marker 0.

  • Full_Span_Enable_1: bool: Enable full-span search for marker 1.

  • Peak_Range_From_1: float: Lower end of the search range for marker 1.

  • Peak_Range_To_1: float: Upper end of the search range for marker 1.

  • Full_Span_Enable_2: bool: Enable full-span search for marker 2.

  • Peak_Range_From_2: float: Lower end of the search range for marker 2.

  • Peak_Range_To_2: float: Upper end of the search range for marker 2.

  • Full_Span_Enable_3: bool: Enable full-span search for marker 3.

  • Peak_Range_From_3: float: Lower end of the search range for marker 3.

  • Peak_Range_To_3: float: Upper end of the search range for marker 3.

  • Full_Span_Enable_4: bool: Enable full-span search for marker 4.

  • Peak_Range_From_4: float: Lower end of the search range for marker 4.

  • Peak_Range_To_4: float: Upper end of the search range for marker 4.

get_noa_markers() → int[source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:FFTSanalyzer:PSEarch:NOAMarkers
value: int = driver.configure.gprf.measurement.fftSpecAn.peakSearch.get_noa_markers()

Defines the number of active markers for the peak search.

return:

no_active_markers: No help available

get_value() → ValueStruct[source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:FFTSanalyzer:PSEarch
value: ValueStruct = driver.configure.gprf.measurement.fftSpecAn.peakSearch.get_value()

Defines the peak search ranges. The maximum allowed search ranges depend on the frequency span: –span/2 to span/2.

return:

structure: for return value, see the help for ValueStruct structure arguments.

set_noa_markers(no_active_markers: int) → None[source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:FFTSanalyzer:PSEarch:NOAMarkers
driver.configure.gprf.measurement.fftSpecAn.peakSearch.set_noa_markers(no_active_markers = 1)

Defines the number of active markers for the peak search.

param no_active_markers:

No help available

set_value(value: ValueStruct) → None[source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:FFTSanalyzer:PSEarch
structure = driver.configure.gprf.measurement.fftSpecAn.peakSearch.ValueStruct()
structure.Full_Span_Enable_0: bool = False
structure.Peak_Range_From_0: float = 1.0
structure.Peak_Range_To_0: float = 1.0
structure.Full_Span_Enable_1: bool = False
structure.Peak_Range_From_1: float = 1.0
structure.Peak_Range_To_1: float = 1.0
structure.Full_Span_Enable_2: bool = False
structure.Peak_Range_From_2: float = 1.0
structure.Peak_Range_To_2: float = 1.0
structure.Full_Span_Enable_3: bool = False
structure.Peak_Range_From_3: float = 1.0
structure.Peak_Range_To_3: float = 1.0
structure.Full_Span_Enable_4: bool = False
structure.Peak_Range_From_4: float = 1.0
structure.Peak_Range_To_4: float = 1.0
driver.configure.gprf.measurement.fftSpecAn.peakSearch.set_value(value = structure)

Defines the peak search ranges. The maximum allowed search ranges depend on the frequency span: –span/2 to span/2.

param value:

see the help for ValueStruct structure arguments.