marker¶
List of supported commands:
-
class
nardascripting.base.scpi.marker.
ScpiMarker
(com: nardascripting.base.comm.CommBase)¶ SignalShark MARKer SCPI subsystem class.
-
get_fxd_frequency
()¶ Queries the frequency of fixed marker
- Returns
Marker frequency in Hz
- Return type
float
-
get_fxd_time
()¶ Queries the time postion of fixed marker
- Returns
Time position of fixed Marker in seconds
- Return type
float
-
get_fxd_value
()¶ Queries the value of fixed marker
- Returns
Fixed marker value in actual unit
- Return type
float
-
get_spectrum_data_frequency
(index: int)¶ Queries the marker or deltamarker frequency data
- Parameters
index (int) – Marker Index (1…8)
- Returns
Marker frequency in Hz
- Return type
float
-
get_spectrum_data_level
(index: int)¶ Queries marker or deltamarker level data
- Parameters
index (int) – Marker Index (1…8)
- Returns
Marker power level in actual unit
- Return type
float
-
get_spectrum_data_peak_state
(index: int)¶ Queries the marker peak state. PEAK:STATe only works in HOLD or STOP mode or with track peak enabled (PEAK:TRACk ON.)
- Parameters
index (int) – Marker Index (1…8)
- Returns
1 = peak was found, 0 = no peak was found
- Return type
bool
-
get_spectrum_data_time
(index: int)¶ Queries the marker or deltamarker time data
- Parameters
index (int) – Marker Index (1…8)
- Returns
Marker time in seconds
- Return type
float
-
get_spectrum_enable
(index: int)¶ Queries the current state of a marker
- Parameters
index (int) – Marker Index (1…8)
- Returns
Enable state
- Return type
bool
-
get_spectrum_frequency
(index: int)¶ Queries the current frequency for a marker
- Parameters
index (int) – Marker Index (1…8)
- Returns
Marker frequency in Hz
- Return type
float
-
get_spectrum_frequency_link
(index: int)¶ Queries the marker frequency link to another marker
- Parameters
index (int) – Marker Index (1…8)
- Returns
Frequency link Marker Index (1…8)
- Return type
int
-
get_spectrum_frequency_link_offset
(index: int)¶ Queries the frequency link offset
- Parameters
index (int) – Marker Index (2…8)
- Returns
Marker frequency in Hz
- Return type
float
-
get_spectrum_function
(index: int)¶ Queries the channel power function
- Parameters
index (int) – Marker Index (1…8)
- Returns
Function name
- Return type
-
get_spectrum_function_cpower_cbw
()¶ Queries the CBW
- Returns
CBW frequency in Hz
- Return type
float
-
get_spectrum_function_cpower_data
(index: int)¶ Queries data for marker function: Channel Power
- Parameters
index (int) – Marker Index (1…8)
- Returns
Marker function data in actual unit
- Return type
float
-
get_spectrum_function_noise_data
(index: int)¶ Queries data for marker or deltamarker function: Noise
- Parameters
index (int) – Marker Index (1…8)
- Returns
Marker function data in actual unit
- Return type
float
-
get_spectrum_function_noise_nbw
()¶ Queries the NBW
- Returns
NBW frequency in Hz
- Return type
float
-
get_spectrum_function_noise_nbw_auto
()¶ Queries the NBW auto coupling state
- Returns
Coupling state
- Return type
bool
-
get_spectrum_function_ocbw_data
(index: int)¶ Queries data for marker function: OCCUPIED_BANDWIDTH
- Parameters
index (int) – Marker Index (1…8)
- Returns
Occupied Bandwidth value; Middle Frequency; Channel Power
- Return type
float, float, float
-
get_spectrum_function_ocbw_mode
()¶ Mode for marker function: OCCUPIED_BANDWIDTH
- Returns
Occupied bandwith mode
- Return type
-
get_spectrum_function_ocbw_ntrials
()¶ NTrials (number of trials) for marker function: OCCUPIED_BANDWIDTH
- Returns
Occupied bandwith NTrials parameter
- Return type
int
-
get_spectrum_function_ocbw_percent
()¶ Queries the % for marker function: OCCUPIED_BANDWIDTH
- Returns
Occupied bandwith % parameter
- Return type
float
-
get_spectrum_function_ocbw_threshold
()¶ Queries the threshold for marker function: OCCUPIED_BANDWIDTH
- Returns
Threshold level in actual unit
- Return type
float
-
get_spectrum_function_ocbw_xdb
()¶ XdB for marker function: OCCUPIED_BANDWIDTH
- Returns
Occupied bandwith XdB parameter
- Return type
float
-
get_spectrum_function_transmitter_data
(index: int)¶ Queries the data for Marker function: TRANSMITTER
- Parameters
index (int) – Marker Index (1…8)
- Returns
Transmitter name; Transmitter type; Transmitter comment
- Return type
str, str, str
-
get_spectrum_list
()¶ Queries a list of enabled spectrum markers as string
- Returns
List of enabled spectrum markers as string (M1,D2,…)
- Return type
str
-
get_spectrum_marker_list
() → List[Tuple[str, int]]¶ Queries a list of enabled spectrum markers
- Returns
List of enabled spectrum markers (name, index])
-
get_spectrum_reference
(index: int)¶ Queries the corresponding reference marker
- Parameters
index (int) – Marker Index (2…8)
- Returns
ref_index: Reference Marker Index (0 == disabled, 1…8 == marker index, 9 == FXD marker).
- Return type
int
-
get_spectrum_search_auto_peak_enable
()¶ Queries the searchlimit enable state
- Returns
‘Auto Peak Search for M1’
- Return type
bool
-
get_spectrum_search_frequency_lower
()¶ Queries the lower frequency searchlimit
- Returns
Frequency searchlimit in Hz
- Return type
float
-
get_spectrum_search_frequency_upper
()¶ Queries the upper frequency searchlimit
- Returns
Frequency searchlimit in Hz
- Return type
float
-
get_spectrum_search_limits_enable
()¶ Queries the searchlimit enable state
- Returns
‘Use Search Limits’
- Return type
bool
-
get_spectrum_search_loexclude_enable
()¶ Queries the searchlimit enable state
- Returns
‘Exclude LO’
- Return type
bool
-
get_spectrum_search_peak_excursion
()¶ Queries the peak excursion
- Returns
Peak Excursion in dB
- Return type
float
-
get_spectrum_search_peak_excursion_enable
()¶ Queries the peak excursion enable state
- Returns
‘Peak Excursion’
- Return type
bool
-
get_spectrum_search_sgram_range
()¶ Queries the spectrogram searchrange
- Returns
Spectrogram searchrange (All, Visible)
- Return type
-
get_spectrum_search_threshold
()¶ Queries the threshold searchlimit
- Returns
Threshold level in actual unit
- Return type
float
-
get_spectrum_search_track_peaks_enable
()¶ Queries the searchlimit enable state
- Returns
‘Track Peaks’
- Return type
bool
-
get_spectrum_time
(index: int)¶ Queries marker time position
- Parameters
index (int) – Marker Index (1…8)
- Returns
Time position of the Marker in seconds
- Return type
float
-
get_spectrum_time_link
(index: int)¶ Queries the time link marker
- Parameters
index (int) – Marker Index (1…8)
- Returns
Time link Marker Index (1…8)
- Return type
int
-
get_spectrum_time_link_offset
(index: int)¶ Queries the time link offset
- Parameters
index (int) – Marker Index (2…8)
- Returns
Offset time in seconds
- Return type
float
-
get_spectrum_trace
(index: int)¶ Queries the active trace of a marker
- Parameters
index (int) – Marker Index (1…8)
- Returns
RMS, PPk, MPk, Avg, Smp, MnR, AvR, MxR, MxP, MnP, MxA, MxS
- Return type
-
get_spectrum_type
(index: int)¶ Queries the configuration of a marker, normal or delta
- Parameters
index (int) – Marker Index (2…8)
- Returns
Type (NORMAL,DELTA)
- Return type
-
set_fxd_frequency
(value: float)¶ Sets the frequency of fixed marker
- Parameters
value (float) – Fixed Marker frequency (Hz)
-
set_fxd_time
(value: float)¶ Sets the time postion of fixed marker
- Parameters
value (float) – Fixed Marker time (s)
-
set_fxd_value
(value: float)¶ Sets the value of fixed marker
- Parameters
value (float) – Fixed marker value in actual unit (dBm,…)
-
set_spectrum_enable
(index: int, value: bool)¶ Marker enable or disable
- Parameters
index (int) – Marker Index (1…8)
value (bool) – Enable state
-
set_spectrum_frequency
(index: int, value: float)¶ Marker frequency (see also MARKer<Index>:SPECtrum:DATA:FREQuency?)
- Parameters
index (int) – Marker Index (1…8)
value (float) – Marker frequency (Hz)
-
set_spectrum_frequency_link
(index: int, link_index: int)¶ Marker frequency link
- Parameters
index (int) – Marker Index (1…8)
link_index (int) – Frequency link Marker Index (1…8). If Marker Index equals Link Index, Frequency link is disabled.
-
set_spectrum_frequency_link_offset
(index: int, value: float)¶ Marker frequency link offset
- Parameters
index (int) – Marker Index (2…8)
value (float) – Marker frequency (Hz)
-
set_spectrum_function
(index: int, sfunction: nardascripting.base.scpi.enums.SpecMarkerFunctions)¶ Sets the marker function
- Parameters
index (int) – Marker Index (1…8)
sfunction (SpecMarkerFunctions) – Function name e.g. ‘CHANNEL_POWER’, ‘NOISE’, ‘OCCUPIED_BANDWIDTH’ or Off to disable function
-
set_spectrum_function_cpower_cbw
(value: float)¶ CBW for marker function: Channel Power
- Parameters
value (float) – CBW frequency (Hz)
-
set_spectrum_function_noise_nbw
(value: float)¶ NBW for marker function: Noise
- Parameters
value (float) – NBW frequency (Hz)
-
set_spectrum_function_noise_nbw_auto
(value: bool)¶ NBW auto coupling for marker function: Noise
- Parameters
value (bool) – Coupling state
-
set_spectrum_function_ocbw_mode
(value: nardascripting.base.scpi.enums.OcbwModes)¶ Mode for marker function: OCCUPIED_BANDWIDTH
- Parameters
value (OcbwModes) – Occupied bandwith mode (%, dB)
-
set_spectrum_function_ocbw_ntrials
(value: int)¶ Sets the NTrials (number of trials) for marker function: OCCUPIED_BANDWIDTH
- Parameters
value (int) – Occupied bandwith NTrials parameter (1…1000)
-
set_spectrum_function_ocbw_percent
(value: float)¶ Sets the % for marker function: OCCUPIED_BANDWIDTH
- Parameters
value (float) – Occupied bandwith % parameter (50 … 99.99)
-
set_spectrum_function_ocbw_threshold
(value: float)¶ Sets the threshold for marker function: OCCUPIED_BANDWIDTH
- Parameters
value (float) – Threshold level in acutal unit
-
set_spectrum_function_ocbw_xdb
(value: float)¶ XdB for marker function: OCCUPIED_BANDWIDTH
- Parameters
value (float) – Occupied bandwith XdB parameter (-60…1)
-
set_spectrum_reference
(index: int, ref_index: int)¶ Reference marker for a delta marker
- Parameters
index (int) – Marker Index (2…8)
ref_index (ULongEnum) – Reference Marker Index (0 == disabled, 1…8 == marker index, 9 == FXD marker).
-
set_spectrum_search_auto_peak_enable
(value: bool)¶ ‘Auto Peak Search for M1’ for marker
- Parameters
value (bool) – ‘Auto Peak Search for M1’
-
set_spectrum_search_frequency_lower
(value: float)¶ Lower frequency searchlimit for marker and peaktable
- Parameters
value (float) – Frequency searchlimit (Hz)
-
set_spectrum_search_frequency_upper
(value: float)¶ Upper frequency searchlimit for marker and peaktable
- Parameters
value (float) – Frequency searchlimit (Hz)
-
set_spectrum_search_limits_enable
(value: bool)¶ Sets the ‘Use Search Limits’ enable state for marker and peaktable
- Parameters
value (bool) – ‘Use Search Limits’
-
set_spectrum_search_loexclude_enable
(value: bool)¶ ‘Exclude LO’ searchlimit for marker and peaktable
- Parameters
value (bool) – ‘Exclude LO’
-
set_spectrum_search_peak_excursion
(value: float)¶ Sets the peak excursion for marker and peaktable
- Parameters
value (float) – Peak Excursion (dB)
-
set_spectrum_search_peak_excursion_enable
(value: bool)¶ ‘Peak Excursion’ searchlimit for marker and peaktable
- Parameters
value (bool) – ‘Peak Excursion’
-
set_spectrum_search_sgram_range
(value: nardascripting.base.scpi.enums.SpectrogramSRanges)¶ Sets the spectrogram searchrange
- Parameters
value (SpectrogramSRanges) – Spectrogram searchrange (All, Visible)
-
set_spectrum_search_threshold
(value: float)¶ Threshold searchlimit for marker and peaktable
- Parameters
value (float) – Threshold level in actual unit
-
set_spectrum_search_track_peaks_enable
(value: bool)¶ ‘Track Peaks’ for marker
- Parameters
value (bool) – ‘Track Peaks’
-
set_spectrum_time
(index: int, value: float)¶ Time position of a marker (see also MARKer<Index>:SPECtrum:DATA:TIME?)
- Parameters
index (int) – Marker Index (1…8)
value (float) – Marker time (s)
-
set_spectrum_time_link
(index: int, link_index: int)¶ Marker time link
- Parameters
index (int) – Marker Index (1…8)
link_index (int) – Time link Marker Index (1…8). If Marker Index equals Link Index, Time link is disabled.
-
set_spectrum_time_link_offset
(index: int, value: float)¶ Marker time link offset. A time offset can only be set if the selected task is an RT Spectrum task.
- Parameters
index (int) – Marker Index (2…8)
value (float) – Offset time (s)
-
set_spectrum_trace
(index: int, name: nardascripting.base.scpi.enums.SpecTraceTypes)¶ Selects the active trace for a marker. Only traces enabled by SPECtrum:TRACe:ENABle are available.
- Parameters
index (int) – Marker Index (1…8)
name (SpecTraceTypes) – RMS, PPk, MPk, Avg, Smp, MnR, AvR, MxR, MxP, MnP, MxA, MxS
-
set_spectrum_type
(index: int, stype: nardascripting.base.scpi.enums.SpecMarkerTypes)¶ Sets the Marker type
- Parameters
index (int) – Marker Index (2…8)
stype (SpecMarkerTypes) – Type (NORMAL,DELTA)
-
spectrum_peak
(index: int)¶ Marker peak search (time or frequency domain)
- Parameters
index (int) – Marker Index (1…8)
-
spectrum_peak_left
(index: int)¶ Marker left peak search (frequency domain)
- Parameters
index (int) – Marker Index (1…8)
-
spectrum_peak_lower
(index: int)¶ Marker lower peak search (time domain)
- Parameters
index (int) – Marker Index (1…8)
-
spectrum_peak_next
(index: int)¶ Marker next peak search (time or frequency domain)
- Parameters
index (int) – Marker Index (1…8)
-
spectrum_peak_right
(index: int)¶ Marker right peak search (frequency domain)
- Parameters
index (int) – Marker Index (1…8)
-
spectrum_peak_upper
(index: int)¶ Marker upper peak search (time domain)
- Parameters
index (int) – Marker Index (1…8)
-