marker
¶
The marker commands module.
These commands are used in the following models: DPO4K, DPO4KB, MDO3, MDO3K, MDO4K, MDO4KB, MDO4KC, MSO4K, MSO4KB
THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED.
Please report an issue if one is found.
Commands and Queries
- MARKER:M<x>:AMPLitude:ABSolute?
- MARKER:M<x>:AMPLitude:DELTa?
- MARKER:M<x>:FREQuency:ABSolute <NR3>
- MARKER:M<x>:FREQuency:ABSolute?
- MARKER:M<x>:FREQuency:DELTa?
- MARKER:M<x>:NOISEDensity?
- MARKER:M<x>:PHASENoise?
- MARKER:MANual {ON|OFF|1|0}
- MARKER:MANual?
- MARKER:PEAK:EXCURsion <NR3>
- MARKER:PEAK:EXCURsion?
- MARKER:PEAK:MAXimum <NR1>
- MARKER:PEAK:MAXimum?
- MARKER:PEAK:STATE {ON|OFF|1|0}
- MARKER:PEAK:STATE?
- MARKER:PEAK:THReshold <NR3>
- MARKER:PEAK:THReshold?
- MARKER:REFERence CENTER
- MARKER:REFERence:AMPlitude?
- MARKER:REFERence:FREQuency?
- MARKER:TYPe {DELTa|ABSolute}
- MARKER:TYPe?
Marker
¶
Bases: SCPICmdRead
The MARKER command tree.
Usage
- Using the
.query()method will send theMARKER?query. - Using the
.verify(value)method will send theMARKER?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.m: TheMARKER:M<x>command tree..manual: TheMARKER:MANualcommand..peak: TheMARKER:PEAKcommand tree..reference: TheMARKER:REFERencecommand..type: TheMARKER:TYPecommand.
m
property
¶
m: dict[int, MarkerMItem]
Return the MARKER:M<x> command tree.
Usage
- Using the
.query()method will send theMARKER:M<x>?query. - Using the
.verify(value)method will send theMARKER:M<x>?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.amplitude: TheMARKER:M<x>:AMPLitudecommand tree..frequency: TheMARKER:M<x>:FREQuencycommand tree..noisedensity: TheMARKER:M<x>:NOISEDensitycommand..phasenoise: TheMARKER:M<x>:PHASENoisecommand.
manual
property
¶
manual: MarkerManual
Return the MARKER:MANual command.
Description
- This command switches on or off the manual markers a and b that are available for
frequency domain traces. Two manual markers are available for measuring non-peak areas
of interest. The absolute measurements are in dBm; the relative measurements (relative
to the Reference Marker) are in dBc (dB relative to the carrier). When the manual
markers are turned off, and the peak markers are turned on, the Reference Marker is
placed on the highest amplitude peak. With manual markers on, the Reference Marker is
placed at the a manual marker. The manual markers use the units specified with the
command
RF:UNITS.
Usage
- Using the
.query()method will send theMARKER:MANual?query. - Using the
.verify(value)method will send theMARKER:MANual?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMARKER:MANual valuecommand.
SCPI Syntax
- MARKER:MANual {ON|OFF|1|0}
- MARKER:MANual?
Info
OFFor 0 turns the manual markers off.ONor 1 turns the manual markers on.
peak
property
¶
peak: MarkerPeak
Return the MARKER:PEAK command tree.
Usage
- Using the
.query()method will send theMARKER:PEAK?query. - Using the
.verify(value)method will send theMARKER:PEAK?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.excursion: TheMARKER:PEAK:EXCURsioncommand..maximum: TheMARKER:PEAK:MAXimumcommand..state: TheMARKER:PEAK:STATEcommand..threshold: TheMARKER:PEAK:THResholdcommand.
reference
property
¶
reference: MarkerReference
Return the MARKER:REFERence command.
Description
- This command changes the Center Frequency to the frequency indicated by the Reference
Marker, in effect moving the Reference Marker to the center of the screen. This
applies when markers are turned on (using the command
MARKER:PEAK:STATEorMARKER:MANUAL). This is equivalent to the ‘R’ to Center side menu button in the front panel Markers menu.
Usage
- Using the
.write(value)method will send theMARKER:REFERence valuecommand.
SCPI Syntax
- MARKER:REFERence CENTER
Sub-properties
.amplitude: TheMARKER:REFERence:AMPlitudecommand..frequency: TheMARKER:REFERence:FREQuencycommand.
type
property
¶
type: MarkerType
Return the MARKER:TYPe command.
Description
- This command specifies the marker type (either DELTa or ABSolute). An absolute marker shows the frequency and amplitude at the location of the marker. A delta marker shows the frequency and amplitude of the marker relative to the Reference Marker. The Reference Marker shows the absolute frequency and amplitude, regardless of this command. The marker amplitude measurements are in dBm for absolute, or in dBc (dB below carrier amplitude) for delta.
Usage
- Using the
.query()method will send theMARKER:TYPe?query. - Using the
.verify(value)method will send theMARKER:TYPe?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMARKER:TYPe valuecommand.
SCPI Syntax
- MARKER:TYPe {DELTa|ABSolute}
- MARKER:TYPe?
Info
DELTaspecifies to display the frequency and amplitude of the markers relative to the Reference Marker. The relative amplitude is in dBc (dB below carrier amplitude); the relative frequency is in Hz.ABSolutespecifies to display the actual frequency and amplitude of each marker. The absolute amplitude is in user-set units; the absolute frequency is in Hz.
MarkerMItem
¶
Bases: ValidatedDynamicNumberCmd, SCPICmdRead
The MARKER:M<x> command tree.
Usage
- Using the
.query()method will send theMARKER:M<x>?query. - Using the
.verify(value)method will send theMARKER:M<x>?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.amplitude: TheMARKER:M<x>:AMPLitudecommand tree..frequency: TheMARKER:M<x>:FREQuencycommand tree..noisedensity: TheMARKER:M<x>:NOISEDensitycommand..phasenoise: TheMARKER:M<x>:PHASENoisecommand.
amplitude
property
¶
amplitude: MarkerMItemAmplitude
Return the MARKER:M<x>:AMPLitude command tree.
Usage
- Using the
.query()method will send theMARKER:M<x>:AMPLitude?query. - Using the
.verify(value)method will send theMARKER:M<x>:AMPLitude?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.absolute: TheMARKER:M<x>:AMPLitude:ABSolutecommand..delta: TheMARKER:M<x>:AMPLitude:DELTacommand.
frequency
property
¶
frequency: MarkerMItemFrequency
Return the MARKER:M<x>:FREQuency command tree.
Usage
- Using the
.query()method will send theMARKER:M<x>:FREQuency?query. - Using the
.verify(value)method will send theMARKER:M<x>:FREQuency?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.absolute: TheMARKER:M<x>:FREQuency:ABSolutecommand..delta: TheMARKER:M<x>:FREQuency:DELTacommand.
noisedensity
property
¶
noisedensity: MarkerMItemNoisedensity
Return the MARKER:M<x>:NOISEDensity command.
Description
- This command returns the noise density of the
RF_NORMaltrace at the specified marker position in/Hz units, where are the units specified by the command RF:UNITS.
Usage
- Using the
.query()method will send theMARKER:M<x>:NOISEDensity?query. - Using the
.verify(value)method will send theMARKER:M<x>:NOISEDensity?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MARKER:M<x>:NOISEDensity?
phasenoise
property
¶
phasenoise: MarkerMItemPhasenoise
Return the MARKER:M<x>:PHASENoise command.
Description
- This command returns the phase noise of the
RF_NORMaltrace at the specified marker position in dBc/Hz units.
Usage
- Using the
.query()method will send theMARKER:M<x>:PHASENoise?query. - Using the
.verify(value)method will send theMARKER:M<x>:PHASENoise?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MARKER:M<x>:PHASENoise?
MarkerMItemAmplitude
¶
Bases: SCPICmdRead
The MARKER:M<x>:AMPLitude command tree.
Usage
- Using the
.query()method will send theMARKER:M<x>:AMPLitude?query. - Using the
.verify(value)method will send theMARKER:M<x>:AMPLitude?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.absolute: TheMARKER:M<x>:AMPLitude:ABSolutecommand..delta: TheMARKER:M<x>:AMPLitude:DELTacommand.
absolute
property
¶
absolute: MarkerMItemAmplitudeAbsolute
Return the MARKER:M<x>:AMPLitude:ABSolute command.
Description
- This query returns the actual amplitude (vertical) value of either of the two manual
markers that are available for frequency domain traces, in user-set units. M
can be either M1, which specifies manual marker a, or M2, which specifies manual marker b. (Use RF:UNITSto specify the units.)
Usage
- Using the
.query()method will send theMARKER:M<x>:AMPLitude:ABSolute?query. - Using the
.verify(value)method will send theMARKER:M<x>:AMPLitude:ABSolute?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MARKER:M<x>:AMPLitude:ABSolute?
delta
property
¶
delta: MarkerMItemAmplitudeDelta
Return the MARKER:M<x>:AMPLitude:DELTa command.
Description
- This query returns the delta amplitude (vertical) value of either of the two manual
markers that are available for frequency domain traces, in relation to the Reference
Marker. M
can be either M1, which specifies manual marker a, or M2, which specifies manual marker b.
Usage
- Using the
.query()method will send theMARKER:M<x>:AMPLitude:DELTa?query. - Using the
.verify(value)method will send theMARKER:M<x>:AMPLitude:DELTa?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MARKER:M<x>:AMPLitude:DELTa?
MarkerMItemAmplitudeAbsolute
¶
Bases: SCPICmdRead
The MARKER:M<x>:AMPLitude:ABSolute command.
Description
- This query returns the actual amplitude (vertical) value of either of the two manual
markers that are available for frequency domain traces, in user-set units. M
can be either M1, which specifies manual marker a, or M2, which specifies manual marker b. (Use RF:UNITSto specify the units.)
Usage
- Using the
.query()method will send theMARKER:M<x>:AMPLitude:ABSolute?query. - Using the
.verify(value)method will send theMARKER:M<x>:AMPLitude:ABSolute?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MARKER:M<x>:AMPLitude:ABSolute?
MarkerMItemAmplitudeDelta
¶
Bases: SCPICmdRead
The MARKER:M<x>:AMPLitude:DELTa command.
Description
- This query returns the delta amplitude (vertical) value of either of the two manual
markers that are available for frequency domain traces, in relation to the Reference
Marker. M
can be either M1, which specifies manual marker a, or M2, which specifies manual marker b.
Usage
- Using the
.query()method will send theMARKER:M<x>:AMPLitude:DELTa?query. - Using the
.verify(value)method will send theMARKER:M<x>:AMPLitude:DELTa?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MARKER:M<x>:AMPLitude:DELTa?
MarkerMItemFrequency
¶
Bases: SCPICmdRead
The MARKER:M<x>:FREQuency command tree.
Usage
- Using the
.query()method will send theMARKER:M<x>:FREQuency?query. - Using the
.verify(value)method will send theMARKER:M<x>:FREQuency?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.absolute: TheMARKER:M<x>:FREQuency:ABSolutecommand..delta: TheMARKER:M<x>:FREQuency:DELTacommand.
absolute
property
¶
absolute: MarkerMItemFrequencyAbsolute
Return the MARKER:M<x>:FREQuency:ABSolute command.
Description
- This command specifies the actual frequency (horizontal) value of either of the two
manual markers that are available for frequency domain traces. M
can be either M1, which specifies manual marker a, or M2, which specifies manual marker b.
Usage
- Using the
.query()method will send theMARKER:M<x>:FREQuency:ABSolute?query. - Using the
.verify(value)method will send theMARKER:M<x>:FREQuency:ABSolute?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMARKER:M<x>:FREQuency:ABSolute valuecommand.
SCPI Syntax
- MARKER:M<x>:FREQuency:ABSolute <NR3>
- MARKER:M<x>:FREQuency:ABSolute?
Info
<NR3>is a floating point value that indicates the actual frequency of either of the two manual markers.
delta
property
¶
delta: MarkerMItemFrequencyDelta
Return the MARKER:M<x>:FREQuency:DELTa command.
Description
- This query returns the delta frequency (horizontal) value of either of the two manual
markers that are available for frequency domain traces, in relation to the Reference
Marker. M
can be either M1, which specifies manual marker a, or M2, which specifies manual marker b. The manual marker readouts use the units specified with the command RF:UNITS.
Usage
- Using the
.query()method will send theMARKER:M<x>:FREQuency:DELTa?query. - Using the
.verify(value)method will send theMARKER:M<x>:FREQuency:DELTa?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MARKER:M<x>:FREQuency:DELTa?
MarkerMItemFrequencyAbsolute
¶
Bases: SCPICmdWrite, SCPICmdRead
The MARKER:M<x>:FREQuency:ABSolute command.
Description
- This command specifies the actual frequency (horizontal) value of either of the two manual
markers that are available for frequency domain traces. M
can be either M1, which specifies manual marker a, or M2, which specifies manual marker b.
Usage
- Using the
.query()method will send theMARKER:M<x>:FREQuency:ABSolute?query. - Using the
.verify(value)method will send theMARKER:M<x>:FREQuency:ABSolute?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMARKER:M<x>:FREQuency:ABSolute valuecommand.
SCPI Syntax
- MARKER:M<x>:FREQuency:ABSolute <NR3>
- MARKER:M<x>:FREQuency:ABSolute?
Info
<NR3>is a floating point value that indicates the actual frequency of either of the two manual markers.
MarkerMItemFrequencyDelta
¶
Bases: SCPICmdRead
The MARKER:M<x>:FREQuency:DELTa command.
Description
- This query returns the delta frequency (horizontal) value of either of the two manual
markers that are available for frequency domain traces, in relation to the Reference
Marker. M
can be either M1, which specifies manual marker a, or M2, which specifies manual marker b. The manual marker readouts use the units specified with the command RF:UNITS.
Usage
- Using the
.query()method will send theMARKER:M<x>:FREQuency:DELTa?query. - Using the
.verify(value)method will send theMARKER:M<x>:FREQuency:DELTa?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MARKER:M<x>:FREQuency:DELTa?
MarkerMItemNoisedensity
¶
Bases: SCPICmdRead
The MARKER:M<x>:NOISEDensity command.
Description
- This command returns the noise density of the
RF_NORMaltrace at the specified marker position in/Hz units, where are the units specified by the command RF:UNITS.
Usage
- Using the
.query()method will send theMARKER:M<x>:NOISEDensity?query. - Using the
.verify(value)method will send theMARKER:M<x>:NOISEDensity?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MARKER:M<x>:NOISEDensity?
MarkerMItemPhasenoise
¶
Bases: SCPICmdRead
The MARKER:M<x>:PHASENoise command.
Description
- This command returns the phase noise of the
RF_NORMaltrace at the specified marker position in dBc/Hz units.
Usage
- Using the
.query()method will send theMARKER:M<x>:PHASENoise?query. - Using the
.verify(value)method will send theMARKER:M<x>:PHASENoise?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MARKER:M<x>:PHASENoise?
MarkerManual
¶
Bases: SCPICmdWrite, SCPICmdRead
The MARKER:MANual command.
Description
- This command switches on or off the manual markers a and b that are available for
frequency domain traces. Two manual markers are available for measuring non-peak areas of
interest. The absolute measurements are in dBm; the relative measurements (relative to the
Reference Marker) are in dBc (dB relative to the carrier). When the manual markers are
turned off, and the peak markers are turned on, the Reference Marker is placed on the
highest amplitude peak. With manual markers on, the Reference Marker is placed at the a
manual marker. The manual markers use the units specified with the command
RF:UNITS.
Usage
- Using the
.query()method will send theMARKER:MANual?query. - Using the
.verify(value)method will send theMARKER:MANual?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMARKER:MANual valuecommand.
SCPI Syntax
- MARKER:MANual {ON|OFF|1|0}
- MARKER:MANual?
Info
OFFor 0 turns the manual markers off.ONor 1 turns the manual markers on.
MarkerPeak
¶
Bases: SCPICmdRead
The MARKER:PEAK command tree.
Usage
- Using the
.query()method will send theMARKER:PEAK?query. - Using the
.verify(value)method will send theMARKER:PEAK?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.excursion: TheMARKER:PEAK:EXCURsioncommand..maximum: TheMARKER:PEAK:MAXimumcommand..state: TheMARKER:PEAK:STATEcommand..threshold: TheMARKER:PEAK:THResholdcommand.
excursion
property
¶
excursion: MarkerPeakExcursion
Return the MARKER:PEAK:EXCURsion command.
Description
- This command specifies the peak excursion value, in dB, for the frequency domain trace automatic peak markers. Peak excursion refers to how far an RF signal needs to fall in amplitude between marked peaks, in order to be considered another valid peak. If the peak excursion value is low, more peaks will tend to qualify as valid peaks and have associated markers. If the peak excursion value is high, fewer peaks will tend to qualify as valid peaks and have associated markers.
Usage
- Using the
.query()method will send theMARKER:PEAK:EXCURsion?query. - Using the
.verify(value)method will send theMARKER:PEAK:EXCURsion?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMARKER:PEAK:EXCURsion valuecommand.
SCPI Syntax
- MARKER:PEAK:EXCURsion <NR3>
- MARKER:PEAK:EXCURsion?
Info
<NR3>is a floating point number that specifies the automatic marker excursion value.
maximum
property
¶
maximum: MarkerPeakMaximum
Return the MARKER:PEAK:MAXimum command.
Description
- This command specifies the maximum number of frequency domain trace peaks that could
have automatic markers placed on them. This can be a number between 1 and 11. The
default is 5. To turn on the automatic peak markers, use the command
MARKER:PEAK:STATE. To list all of the peak markers, use the commandSEARCH:SPECTRAL:LIST Theactual number of automatic markers may be less than the maximum, depending on the threshold and excursion values and the spectral content of the RF signal. If more peaks than the maximum are detected that meet the threshold and excursion criteria, only the highest amplitude peaks will have automatic markers placed on them.
Usage
- Using the
.query()method will send theMARKER:PEAK:MAXimum?query. - Using the
.verify(value)method will send theMARKER:PEAK:MAXimum?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMARKER:PEAK:MAXimum valuecommand.
SCPI Syntax
- MARKER:PEAK:MAXimum <NR1>
- MARKER:PEAK:MAXimum?
Info
<NR1>is an integer that represents the maximum number of peaks that could have automatic markers.
state
property
¶
state: MarkerPeakState
Return the MARKER:PEAK:STATE command.
Description
- This command switches on or off the automatic peak markers that are available for
frequency domain traces. There are up to 11 automatic markers. The maximum number of
markers can be set using the command
MARKER:PEAK:MAXIMUM. The automatic peak markers find amplitude peaks based upon user threshold and excursion settings (set with theMARKER:PEAK:EXCURSIONandMARKER:PEAK:THRESHOLDcommands.) Each automatic marker has a readout associated with it. These can be absolute or delta readouts (set with theMARKER:TYPEcommand.) To list all of the peak markers, use the commandSEARCH:SPECTRAL:LIST
Usage
- Using the
.query()method will send theMARKER:PEAK:STATE?query. - Using the
.verify(value)method will send theMARKER:PEAK:STATE?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMARKER:PEAK:STATE valuecommand.
SCPI Syntax
- MARKER:PEAK:STATE {ON|OFF|1|0}
- MARKER:PEAK:STATE?
Info
OFFor 0 turns the automatic peak markers off.ONor 1 turns the automatic peak markers on.
threshold
property
¶
threshold: MarkerPeakThreshold
Return the MARKER:PEAK:THReshold command.
Description
- This command specifies the threshold value of the automatic peak markers available for
frequency domain traces. (Use the
RF:UNITScommand to specify the units.) Only peaks with an amplitude greater than the threshold value will qualify for automatic peak marker placement. To set the excursion value for the automatic markers, use the commandMARKER:PEAK:EXCURSION. To switch the automatic marker readout between absolute and delta, use the commandMARKER:TYPE. To turn on and set the number of automatic markers, use the commandsMARKER:PEAK:STATEandMARKER:PEAK:MAXIMUM. To list all of the peak markers, use the commandSEARCH:SPECTRAL:LIST
Usage
- Using the
.query()method will send theMARKER:PEAK:THReshold?query. - Using the
.verify(value)method will send theMARKER:PEAK:THReshold?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMARKER:PEAK:THReshold valuecommand.
SCPI Syntax
- MARKER:PEAK:THReshold <NR3>
- MARKER:PEAK:THReshold?
Info
<NR3>is a floating point number that indicates the automatic marker threshold value.
MarkerPeakExcursion
¶
Bases: SCPICmdWrite, SCPICmdRead
The MARKER:PEAK:EXCURsion command.
Description
- This command specifies the peak excursion value, in dB, for the frequency domain trace automatic peak markers. Peak excursion refers to how far an RF signal needs to fall in amplitude between marked peaks, in order to be considered another valid peak. If the peak excursion value is low, more peaks will tend to qualify as valid peaks and have associated markers. If the peak excursion value is high, fewer peaks will tend to qualify as valid peaks and have associated markers.
Usage
- Using the
.query()method will send theMARKER:PEAK:EXCURsion?query. - Using the
.verify(value)method will send theMARKER:PEAK:EXCURsion?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMARKER:PEAK:EXCURsion valuecommand.
SCPI Syntax
- MARKER:PEAK:EXCURsion <NR3>
- MARKER:PEAK:EXCURsion?
Info
<NR3>is a floating point number that specifies the automatic marker excursion value.
MarkerPeakMaximum
¶
Bases: SCPICmdWrite, SCPICmdRead
The MARKER:PEAK:MAXimum command.
Description
- This command specifies the maximum number of frequency domain trace peaks that could have
automatic markers placed on them. This can be a number between 1 and 11. The default is 5.
To turn on the automatic peak markers, use the command
MARKER:PEAK:STATE. To list all of the peak markers, use the commandSEARCH:SPECTRAL:LIST Theactual number of automatic markers may be less than the maximum, depending on the threshold and excursion values and the spectral content of the RF signal. If more peaks than the maximum are detected that meet the threshold and excursion criteria, only the highest amplitude peaks will have automatic markers placed on them.
Usage
- Using the
.query()method will send theMARKER:PEAK:MAXimum?query. - Using the
.verify(value)method will send theMARKER:PEAK:MAXimum?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMARKER:PEAK:MAXimum valuecommand.
SCPI Syntax
- MARKER:PEAK:MAXimum <NR1>
- MARKER:PEAK:MAXimum?
Info
<NR1>is an integer that represents the maximum number of peaks that could have automatic markers.
MarkerPeakState
¶
Bases: SCPICmdWrite, SCPICmdRead
The MARKER:PEAK:STATE command.
Description
- This command switches on or off the automatic peak markers that are available for
frequency domain traces. There are up to 11 automatic markers. The maximum number of
markers can be set using the command
MARKER:PEAK:MAXIMUM. The automatic peak markers find amplitude peaks based upon user threshold and excursion settings (set with theMARKER:PEAK:EXCURSIONandMARKER:PEAK:THRESHOLDcommands.) Each automatic marker has a readout associated with it. These can be absolute or delta readouts (set with theMARKER:TYPEcommand.) To list all of the peak markers, use the commandSEARCH:SPECTRAL:LIST
Usage
- Using the
.query()method will send theMARKER:PEAK:STATE?query. - Using the
.verify(value)method will send theMARKER:PEAK:STATE?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMARKER:PEAK:STATE valuecommand.
SCPI Syntax
- MARKER:PEAK:STATE {ON|OFF|1|0}
- MARKER:PEAK:STATE?
Info
OFFor 0 turns the automatic peak markers off.ONor 1 turns the automatic peak markers on.
MarkerPeakThreshold
¶
Bases: SCPICmdWrite, SCPICmdRead
The MARKER:PEAK:THReshold command.
Description
- This command specifies the threshold value of the automatic peak markers available for
frequency domain traces. (Use the
RF:UNITScommand to specify the units.) Only peaks with an amplitude greater than the threshold value will qualify for automatic peak marker placement. To set the excursion value for the automatic markers, use the commandMARKER:PEAK:EXCURSION. To switch the automatic marker readout between absolute and delta, use the commandMARKER:TYPE. To turn on and set the number of automatic markers, use the commandsMARKER:PEAK:STATEandMARKER:PEAK:MAXIMUM. To list all of the peak markers, use the commandSEARCH:SPECTRAL:LIST
Usage
- Using the
.query()method will send theMARKER:PEAK:THReshold?query. - Using the
.verify(value)method will send theMARKER:PEAK:THReshold?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMARKER:PEAK:THReshold valuecommand.
SCPI Syntax
- MARKER:PEAK:THReshold <NR3>
- MARKER:PEAK:THReshold?
Info
<NR3>is a floating point number that indicates the automatic marker threshold value.
MarkerReference
¶
Bases: SCPICmdWrite, SCPICmdRead
The MARKER:REFERence command.
Description
- This command changes the Center Frequency to the frequency indicated by the Reference
Marker, in effect moving the Reference Marker to the center of the screen. This applies
when markers are turned on (using the command
MARKER:PEAK:STATEorMARKER:MANUAL). This is equivalent to the ‘R’ to Center side menu button in the front panel Markers menu.
Usage
- Using the
.write(value)method will send theMARKER:REFERence valuecommand.
SCPI Syntax
- MARKER:REFERence CENTER
Properties
.amplitude: TheMARKER:REFERence:AMPlitudecommand..frequency: TheMARKER:REFERence:FREQuencycommand.
amplitude
property
¶
amplitude: MarkerReferenceAmplitude
Return the MARKER:REFERence:AMPlitude command.
Description
- This query returns the actual amplitude (vertical) value of the Reference Marker in user-set units. This value indicates the absolute amplitude of the Reference Marker, regardless of whether the other markers are manual or automatic. This data is equivalent to the number that appears on the display next to the red R inside a triangle when markers are turned on. If all markers are turned off, the value returned will be the last value displayed.
Usage
- Using the
.query()method will send theMARKER:REFERence:AMPlitude?query. - Using the
.verify(value)method will send theMARKER:REFERence:AMPlitude?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MARKER:REFERence:AMPlitude?
frequency
property
¶
frequency: MarkerReferenceFrequency
Return the MARKER:REFERence:FREQuency command.
Description
- This query returns the frequency of the Reference Marker, in Hz, when the frequency
domain trace markers are on (using either the command
MARKER:PEAK:STATEorMARKER:MANUAL). This data is equivalent to the number that appears on the display next to the red R inside a triangle when markers areon. If all markers are off, the value returned will be the last value displayed.
Usage
- Using the
.query()method will send theMARKER:REFERence:FREQuency?query. - Using the
.verify(value)method will send theMARKER:REFERence:FREQuency?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MARKER:REFERence:FREQuency?
MarkerReferenceAmplitude
¶
Bases: SCPICmdRead
The MARKER:REFERence:AMPlitude command.
Description
- This query returns the actual amplitude (vertical) value of the Reference Marker in user-set units. This value indicates the absolute amplitude of the Reference Marker, regardless of whether the other markers are manual or automatic. This data is equivalent to the number that appears on the display next to the red R inside a triangle when markers are turned on. If all markers are turned off, the value returned will be the last value displayed.
Usage
- Using the
.query()method will send theMARKER:REFERence:AMPlitude?query. - Using the
.verify(value)method will send theMARKER:REFERence:AMPlitude?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MARKER:REFERence:AMPlitude?
MarkerReferenceFrequency
¶
Bases: SCPICmdRead
The MARKER:REFERence:FREQuency command.
Description
- This query returns the frequency of the Reference Marker, in Hz, when the frequency domain
trace markers are on (using either the command
MARKER:PEAK:STATEorMARKER:MANUAL). This data is equivalent to the number that appears on the display next to the red R inside a triangle when markers areon. If all markers are off, the value returned will be the last value displayed.
Usage
- Using the
.query()method will send theMARKER:REFERence:FREQuency?query. - Using the
.verify(value)method will send theMARKER:REFERence:FREQuency?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MARKER:REFERence:FREQuency?
MarkerType
¶
Bases: SCPICmdWrite, SCPICmdRead
The MARKER:TYPe command.
Description
- This command specifies the marker type (either DELTa or ABSolute). An absolute marker shows the frequency and amplitude at the location of the marker. A delta marker shows the frequency and amplitude of the marker relative to the Reference Marker. The Reference Marker shows the absolute frequency and amplitude, regardless of this command. The marker amplitude measurements are in dBm for absolute, or in dBc (dB below carrier amplitude) for delta.
Usage
- Using the
.query()method will send theMARKER:TYPe?query. - Using the
.verify(value)method will send theMARKER:TYPe?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMARKER:TYPe valuecommand.
SCPI Syntax
- MARKER:TYPe {DELTa|ABSolute}
- MARKER:TYPe?
Info
DELTaspecifies to display the frequency and amplitude of the markers relative to the Reference Marker. The relative amplitude is in dBc (dB below carrier amplitude); the relative frequency is in Hz.ABSolutespecifies to display the actual frequency and amplitude of each marker. The absolute amplitude is in user-set units; the absolute frequency is in Hz.