PeakSearch
SCPI Command:
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: OFF | ON Configures marker 0 OFF Search from PeakRangeFrom0 to PeakRangeTo0 ON Search the full frequency span
Peak_Range_From_0: float: Start of peak search range for FullSpanEnable0 = OFF Range: - span / 2 to span / 2, Unit: Hz
Peak_Range_To_0: float: End of peak search range for FullSpanEnable0 = OFF Range: - span / 2 to span / 2, Unit: Hz
Full_Span_Enable_1: bool: Configures marker 1
Peak_Range_From_1: float: No parameter help available
Peak_Range_To_1: float: No parameter help available
Full_Span_Enable_2: bool: Configures marker 2
Peak_Range_From_2: float: No parameter help available
Peak_Range_To_2: float: No parameter help available
Full_Span_Enable_3: bool: Configures marker 3
Peak_Range_From_3: float: No parameter help available
Peak_Range_To_3: float: No parameter help available
Full_Span_Enable_4: bool: Configures marker 4
Peak_Range_From_4: float: No parameter help available
Peak_Range_To_4: float: No parameter help available
- get_noa_markers() int [source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:FFTSanalyzer:PSEarch:NOAMarkers value: int = driver.configure.gprfMeasurement.fftSpecAn.peakSearch.get_noa_markers()
Specifies the number of active peak search markers.
- return:
no_active_markers: Range: 0 to 5
- get_value() ValueStruct [source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:FFTSanalyzer:PSEarch value: ValueStruct = driver.configure.gprfMeasurement.fftSpecAn.peakSearch.get_value()
Defines the peak search ranges for the five markers. In this command, the markers are labeled 0 to 4. At the graphical user interface, they are labeled 1 to 5. The allowed ranges, reset values and default units are identical for all markers. The ranges depend on the configured span, see method RsCma.Configure.GprfMeasurement.FftSpecAn.fspan.
- 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.gprfMeasurement.fftSpecAn.peakSearch.set_noa_markers(no_active_markers = 1)
Specifies the number of active peak search markers.
- param no_active_markers:
Range: 0 to 5
- set_value(value: ValueStruct) None [source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:FFTSanalyzer:PSEarch structure = driver.configure.gprfMeasurement.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.gprfMeasurement.fftSpecAn.peakSearch.set_value(value = structure)
Defines the peak search ranges for the five markers. In this command, the markers are labeled 0 to 4. At the graphical user interface, they are labeled 1 to 5. The allowed ranges, reset values and default units are identical for all markers. The ranges depend on the configured span, see method RsCma.Configure.GprfMeasurement.FftSpecAn.fspan.
- param value:
see the help for ValueStruct structure arguments.