mask
¶
The mask commands module.
These commands are used in the following models: DPO5K, DPO5KB, DPO70KC, DPO70KD, DPO70KDX, DPO70KSX, DPO7K, DPO7KC, DSA70KC, DSA70KD, MSO5K, MSO5KB, MSO70KC, MSO70KDX
THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED.
Please report an issue if one is found.
Commands and Queries
- MASK:AUTOAdjust {ON|OFF|<NR1>}
- MASK:AUTOAdjust:HDELTA {<NR3>}
- MASK:AUTOAdjust:HDELTA?
- MASK:AUTOAdjust:VDELTA {<NR3>}
- MASK:AUTOAdjust:VDELTA?
- MASK:AUTOAdjust?
- MASK:AUTOSet:AUTOAdjust {ON|OFF|<NR1>}
- MASK:AUTOSet:AUTOAdjust?
- MASK:AUTOSet:HPOS {ON|OFF|<NR1>}
- MASK:AUTOSet:HPOS?
- MASK:AUTOSet:HSCAle {ON|OFF|<NR1>}
- MASK:AUTOSet:HSCAle?
- MASK:AUTOSet:MODe {MANual|AUTO}
- MASK:AUTOSet:MODe?
- MASK:AUTOSet:OFFSETAdj {ON|OFF|<NR1>}
- MASK:AUTOSet:OFFSETAdj?
- MASK:AUTOSet:STANdard {ATATXG<x>|ATARXG<x>|CLOCKCoax|CLOCKSymmetrical|D<x>|DS0Contra|DS0Double|DS0Single|DS0Timing|DS1|DS1A|DS1C|DS2RATESymmetrical|DS2RATECoax|DS2|DS3|DS4NA|DS4NA_Max|E1Symmetrical|E1Coax|E2|E3|E4_0|E4_1|ENET100FX|ENET100STP|ENET100UTP|ENET1250|ENET1000BCX_NTP2|ENET1000BCX_ATP2|ENET1000BCX_ATP3|ENETXAUI_Near|ENETXAUI_Far|FC133|FC266|FC531|FC1063|FC1063Draft|FC2125|FC133E|FC266E|FC531E|FC1063E|FC1063E_NBT|FC1063E_NDT|FC1063E_NGT|FC1063E_ABT|FC1063E_ADT|FC1063E_AGT|FC1063E_ABR|FC1063E_ADR|FC1063E_AGR|FC2125E_NBT|FC2125E_NDT|FC2125E_NGT|FC2125E_ABT|FC2125E_ADT|FC2125E_AGT|FC2125E_ABR|FC2125E_ADR|FC2125E_AGR|FC4250E_ABR|FC4250E_ABT|FC4250E_ADR|FC4250E_ADT|FC4250E_AGR|FC4250E_AGT|FC4250E_NBT|FC4250E_NDT|FC4250E_NGT|FST1|FST2|FST3|FST4|FST5|FST6|FW1394BS400BT1|FW1394BS400BT2|FW1394BS800BT1|FW1394BS800BT2|FW1394BS1600BT1|FW1394BS1600BT2|FW1394BS400B|FW1394BS800B|FW1394BS1600B|G703DS1|G703DS3|HST<x>|INF2_5G|INF2_5GE|NONe|OC1|OC3|OC12|OC48|OC48_FEC|RATE32Mbit|RATE97Mbit|RIO_DRV500M|RIO_DRV750M|RIO_DRV1G|RIO_DRV1_5G|RIO_DRV2G|RIO_EDRV500M|RIO_EDRV750M|RIO_EDRV1G|RIO_EDRV1_5G|RIO_EDRV2G|RIO_RCV500M|RIO_RCV750M|RIO_RCV1G|RIO_RCV1_5G|RIO_RCV2G|RIO_SERIAL_1G|RIO_SERIAL_2G|RIO_SERIAL_3G|SFI5_XMITADATA2|SFI5_XMITCDATA2|SFI5_XMITACLK2|SFI5_XMITCCLK2|SFI5_RCVBDATA2|SFI5_RCVDDATA2|SFI5_RCVBCLK2|SFI5_RCVDCLK2|SFI5_XMITADATA3|SFI5_XMITCDATA3|SFI5_XMITACLK3|SFI5_XMITCCLK3|SFI5_RCVBDATA3|SFI5_RCVDDATA3|SFI5_RCVBCLK3|SFI5_RCVDCLK3|PCIEXPRESS_Xmit|PCIEXPRESS_Rcv|SAS1_5_IR|SAS1_5_CR|SAS1_5_XR|SAS1_5_IR_AASJ|SAS1_5_CR_AASJ|SAS1_5_XR_AASJ|SAS1_5_SATA|SAS3_0_IR|SAS3_0_CR|SAS3_0_XR|SAS3_0_IR_AASJ|SAS3_0_CR_AASJ|SAS3_0_XR_AASJ|SAS3_0_SATA|STM0_1|STM0_0|STM0_HDBX|STM1E_0|STM1E_1|STS1Pulse|STS1Eye|STS3|STS3_Max|TFI5_2|TFI5_3|USERMask|VIDEO270|VIDEO292M|VIDEO360|VSROC192}
- MASK:AUTOSet:STANdard?
- MASK:AUTOSet:TRIGger {ON|OFF|<NR1>}
- MASK:AUTOSet:TRIGger?
- MASK:AUTOSet:USER:ONE <NR3>
- MASK:AUTOSet:USER:ONE?
- MASK:AUTOSet:USER:TYPe {ABSolute|NORMALIZed}
- MASK:AUTOSet:USER:TYPe?
- MASK:AUTOSet:USER:ZERo <NR3>
- MASK:AUTOSet:USER:ZERo?
- MASK:AUTOSet:VPOS {ON|OFF|<NR1>}
- MASK:AUTOSet:VPOS?
- MASK:AUTOSet:VSCAle {ON|OFF|<NR1>}
- MASK:AUTOSet:VSCAle?
- MASK:COPy:USER
- MASK:COUNt RESET
- MASK:COUNt:FAILURES?
- MASK:COUNt:HITS?
- MASK:COUNt:SEG<m>:HITS?
- MASK:COUNt:STATE {ON|OFF|<NR1>}
- MASK:COUNt:STATE?
- MASK:COUNt:TESTS?
- MASK:COUNt:TOTal?
- MASK:COUNt:VIOLATIONS?
- MASK:COUNt:WAVEFORMS?
- MASK:DISplay {ON|OFF|<NR1>}
- MASK:DISplay?
- MASK:FILTer {ON|OFF|<NR1>}
- MASK:FILTer:ORR:VERT_INDEX? CH<x>
- MASK:FILTer?
- MASK:HIGHLIGHTHits {ON|OFF|<NR1>}
- MASK:HIGHLIGHTHits?
- MASK:INVert {ON|OFF|<NR1>}
- MASK:LOCk {ON|OFF|<NR1>}
- MASK:LOCk?
- MASK:MARgin:PERCent <NR3>
- MASK:MARgin:PERCent?
- MASK:MARgin:STATE {ON|OFF|<NR1>}
- MASK:MARgin:STATE?
- MASK:MASKPRE:AMPlitude <NR3>
- MASK:MASKPRE:AMPlitude?
- MASK:MASKPRE:HSCAle <NR3>
- MASK:MASKPRE:HSCAle?
- MASK:MASKPRE:HTRIGPOS <NR3>
- MASK:MASKPRE:HTRIGPOS?
- MASK:MASKPRE:PATTERNBITS <NR1>
- MASK:MASKPRE:PATTERNBITS?
- MASK:MASKPRE:PRESAMPBITS <NR1>
- MASK:MASKPRE:PRESAMPBITS?
- MASK:MASKPRE:RECOrdlength <NR1>
- MASK:MASKPRE:RECOrdlength?
- MASK:MASKPRE:SERIALTRIG {AMI|HDB3|B3ZS|B6ZS|B8ZS|CMI|NRZ|MLT3|EDGE}
- MASK:MASKPRE:SERIALTRIG?
- MASK:MASKPRE:TRIGTOSAMP <NR3>
- MASK:MASKPRE:TRIGTOSAMP?
- MASK:MASKPRE:VOFFSet <NR3>
- MASK:MASKPRE:VOFFSet?
- MASK:MASKPRE:VPOS <NR3>
- MASK:MASKPRE:VPOS?
- MASK:MASKPRE:VSCAle <NR3>
- MASK:MASKPRE:VSCAle?
- MASK:MASKPRE:WIDth <NR3>
- MASK:MASKPRE:WIDth?
- MASK:POLarity {BOTh|NEGAtive|POSITIVe}
- MASK:POLarity?
- MASK:SEG<m> DELEte
- MASK:SEG<m>:NR_Pt?
- MASK:SEG<m>:POINTS <NR3>,<NR3>[,<NR3>,<NR3>]
- MASK:SEG<m>:POINTS?
- MASK:SOUrce {CH<x>|MATH<x>|REF<x>}
- MASK:SOUrce?
- MASK:STANdard {ATARXG<x>|ATATXG1|ATATXG2|ATATXG3|CLOCKCoax|CLOCKSymmetrical|D<x>|DS0Contra|DS0Double|DS0Single|DS0Timing|DS1|DS1A|DS1C|DS2|DS2RATECoax|DS2RATESymmetrical|DS3|DS4NA|DS4NA_Max|E1Coax|E1Symmetrical|E2|E3|E4_1|E4_0|ENET1000BCX_ATP2|ENET1000BCX_ATP3|ENET1000BCX_NTP2|ENET100FX|ENET100STP|ENET100UTP|ENET1250|ENETXAUI_Far|ENETXAUI_Near|FC1063|FC1063Draft|FC1063E|FC1063E_ABR|FC1063E_ABT|FC1063E_ADR|FC1063E_ADT|FC1063E_AGR|FC1063E_AGT|FC1063E_NBT|FC1063E_NDT|FC1063E_NGT|FC133|FC133E|FC2125|FC2125E_ABR|FC2125E_ABT|FC2125E_ADR|FC2125E_ADT|FC2125E_AGR|FC2125E_AGT|FC2125E_NBT|FC2125E_NDT|FC2125E_NGT|FC266|FC266E|FC4250E_ABR|FC4250E_ABT|FC4250E_ADR|FC4250E_ADT|FC4250E_AGR|FC4250E_AGT|FC4250E_NBT|FC4250E_NDT|FC4250E_NGT|FC531|FC531E|FST1|FST2|FST3|FST4|FST5|FST6|FW1394BS1600B|FW1394BS1600BT1|FW1394BS1600BT2|FW1394BS400B|FW1394BS400BT1|FW1394BS400BT2|FW1394BS800B|FW1394BS800BT1|FW1394BS800BT2|G703DS1|G703DS3|HST<x>|INF2_5G|INF2_5GE|NONe|OC1|OC12|OC3|OC48|OC48_FEC|PCIEXPRESS_Rcv|PCIEXPRESS_Xmit|RATE32Mbit|RATE97Mbit|RIO_DRV1G|RIO_DRV1_5G|RIO_DRV2G|RIO_DRV500M|RIO_DRV500M|RIO_DRV750M|RIO_EDRV1G|RIO_EDRV1_5G|RIO_EDRV2G|RIO_EDRV500M|RIO_EDRV500M|RIO_EDRV750M|RIO_RCV1G|RIO_RCV1_5G|RIO_RCV2G|RIO_RCV500M|RIO_RCV500M|RIO_RCV750M|RIO_SERIAL_1G|RIO_SERIAL_2G|RIO_SERIAL_3G|SFI5_RCVBCLK2|SFI5_RCVBCLK3|SFI5_RCVBDATA2|SFI5_RCVBDATA3|SFI5_RCVDCLK2|SFI5_RCVDCLK3|SFI5_RCVDDATA2|SFI5_RCVDDATA3|SFI5_XMITACLK2|SFI5_XMITACLK3|SFI5_XMITADATA2|SFI5_XMITADATA3|SFI5_XMITCCLK2|SFI5_XMITCCLK3|SFI5_XMITCDATA2|SFI5_XMITCDATA3|STM0_0|STM0_1|STM0_HDBX|STM1E_1|STM1E_0|STS1Eye|STS1Pulse|STS3|STS3_Max|TFI5_2|TFI5_3|USERMask|VIDEO270|VIDEO292M|VIDEO360|VSROC192|SAS1_5_IR|SAS1_5_CR|SAS1_5_XR|SAS1_5_IR_AASJ|SAS1_5_CR_AASJ|SAS1_5_XR_AASJ|SAS1_5_SATA|SAS3_0_IR|SAS3_0_CR|SAS3_0_XR|SAS3_0_IR_AASJ|SAS3_0_CR_AASJ|SAS3_0_XR_AASJ|SAS3_0_SATA}
- MASK:STANdard?
- MASK:STOPOnviolation {ON|OFF|<NR1>}
- MASK:STOPOnviolation?
- MASK:TESt:AUX:COMPLetion {ON|OFF|<NR1>}
- MASK:TESt:AUX:COMPLetion?
- MASK:TESt:AUX:FAILure {ON|OFF|<NR1>}
- MASK:TESt:AUX:FAILure?
- MASK:TESt:BEEP:COMPLetion {ON|OFF|<NR1>}
- MASK:TESt:BEEP:COMPLetion?
- MASK:TESt:BEEP:FAILure {ON|OFF|<NR1>}
- MASK:TESt:BEEP:FAILure?
- MASK:TESt:DELay <NR3>
- MASK:TESt:DELay?
- MASK:TESt:HARDCopy {ON|OFF|<NR1>}
- MASK:TESt:HARDCopy?
- MASK:TESt:LOG:FAILure {ON|OFF|<NR1>}
- MASK:TESt:LOG:FAILure?
- MASK:TESt:REPeat {ON|OFF|<NR1>}
- MASK:TESt:REPeat?
- MASK:TESt:SAMple {<NR1>}
- MASK:TESt:SAMple:THReshold {<NR1>}
- MASK:TESt:SAMple:THReshold?
- MASK:TESt:SAMple?
- MASK:TESt:SAVEWFM {ON|OFF|<NR1>}
- MASK:TESt:SAVEWFM:FILEName <QString>
- MASK:TESt:SAVEWFM:FILEName?
- MASK:TESt:SAVEWFM?
- MASK:TESt:SRQ:COMPLetion {ON|OFF|<NR1>}
- MASK:TESt:SRQ:COMPLetion?
- MASK:TESt:SRQ:FAILure {ON|OFF|<NR1>}
- MASK:TESt:SRQ:FAILure?
- MASK:TESt:STATE {ON|OFF|<NR1>}
- MASK:TESt:STATE?
- MASK:TESt:STATUS?
- MASK:TESt:STOP:FAILure {ON|OFF|<NR1>}
- MASK:TESt:STOP:FAILure?
- MASK:TESt:THReshold <NR1>
- MASK:TESt:THReshold?
- MASK:TESt:WAVEform <NR1>
- MASK:TESt:WAVEform?
- MASK:USER:AMPlitude <NR3>
- MASK:USER:AMPlitude?
- MASK:USER:BITRate <NR1>
- MASK:USER:BITRate?
- MASK:USER:HSCAle <NR3>
- MASK:USER:HSCAle?
- MASK:USER:HTRIGPOS <NR3>
- MASK:USER:HTRIGPOS?
- MASK:USER:LABel <QString>
- MASK:USER:LABel?
- MASK:USER:PATTERNBITS <NR1>
- MASK:USER:PATTERNBITS?
- MASK:USER:PRESAMPBITS <NR1>
- MASK:USER:PRESAMPBITS?
- MASK:USER:RECOrdlength <NR1>
- MASK:USER:RECOrdlength?
- MASK:USER:SEG<m> DELEte
- MASK:USER:SEG<m>:NR_Pt?
- MASK:USER:SEG<m>:POINTS <NR3>, <NR3> [, <NR3>, <NR3>]
- MASK:USER:SEG<m>:POINTS?
- MASK:USER:TRIGTOSAMP <NR3>
- MASK:USER:TRIGTOSAMP?
- MASK:USER:VOFFSet <NR3>
- MASK:USER:VOFFSet?
- MASK:USER:VPOS <NR3>
- MASK:USER:VPOS?
- MASK:USER:VSCAle <NR3>
- MASK:USER:VSCAle?
- MASK:USER:WIDth <NR3>
- MASK:USER:WIDth?
- MASK?
Mask
¶
Bases: SCPICmdRead
The MASK command.
Description
- This query-only command returns the states of all settable mask parameters.
Usage
- Using the
.query()method will send theMASK?query. - Using the
.verify(value)method will send theMASK?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MASK?
Properties
.autoadjust: TheMASK:AUTOAdjustcommand..autoset: TheMASK:AUTOSetcommand tree..copy: TheMASK:COPycommand tree..count: TheMASK:COUNtcommand..display: TheMASK:DISplaycommand..filter: TheMASK:FILTercommand..highlighthits: TheMASK:HIGHLIGHTHitscommand..invert: TheMASK:INVertcommand..lock: TheMASK:LOCkcommand..margin: TheMASK:MARgincommand tree..maskpre: TheMASK:MASKPREcommand tree..polarity: TheMASK:POLaritycommand..seg: TheMASK:SEG<m>command..source: TheMASK:SOUrcecommand..standard: TheMASK:STANdardcommand..stoponviolation: TheMASK:STOPOnviolationcommand..test: TheMASK:TEStcommand tree..user: TheMASK:USERcommand tree.
autoadjust
property
¶
autoadjust: MaskAutoadjust
Return the MASK:AUTOAdjust command.
Description
- This command optimizes or queries the signal position within the mask to minimize
hits. It sets a mode so that the
MASK:SOURCEwaveform is compared against the mask and is shifted up, down, left, or right to minimize the hits.
Usage
- Using the
.query()method will send theMASK:AUTOAdjust?query. - Using the
.verify(value)method will send theMASK:AUTOAdjust?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:AUTOAdjust valuecommand.
SCPI Syntax
- MASK:AUTOAdjust {ON|OFF|<NR1>}
- MASK:AUTOAdjust?
Info
<NR1>= 0 disables the autoadjust function; any other value enables it.ONenables the autoadjust function.OFFdisables the autoadjust function.
Sub-properties
.hdelta: TheMASK:AUTOAdjust:HDELTAcommand..vdelta: TheMASK:AUTOAdjust:VDELTAcommand.
autoset
property
¶
autoset: MaskAutoset
Return the MASK:AUTOSet command tree.
Usage
- Using the
.query()method will send theMASK:AUTOSet?query. - Using the
.verify(value)method will send theMASK:AUTOSet?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.autoadjust: TheMASK:AUTOSet:AUTOAdjustcommand..hpos: TheMASK:AUTOSet:HPOScommand..hscale: TheMASK:AUTOSet:HSCAlecommand..mode: TheMASK:AUTOSet:MODecommand..offsetadj: TheMASK:AUTOSet:OFFSETAdjcommand..standard: TheMASK:AUTOSet:STANdardcommand..trigger: TheMASK:AUTOSet:TRIGgercommand..user: TheMASK:AUTOSet:USERcommand tree..vpos: TheMASK:AUTOSet:VPOScommand..vscale: TheMASK:AUTOSet:VSCAlecommand.
copy
property
¶
copy: MaskCopy
Return the MASK:COPy command tree.
Usage
- Using the
.query()method will send theMASK:COPy?query. - Using the
.verify(value)method will send theMASK:COPy?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.user: TheMASK:COPy:USERcommand.
count
property
¶
count: MaskCount
Return the MASK:COUNt command.
Description
- This command resets to zero the number of hits and failures for all mask segments. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.write(value)method will send theMASK:COUNt valuecommand.
SCPI Syntax
- MASK:COUNt RESET
Sub-properties
.failures: TheMASK:COUNt:FAILUREScommand..hits: TheMASK:COUNt:HITScommand..seg: TheMASK:COUNt:SEG<m>command tree..state: TheMASK:COUNt:STATEcommand..tests: TheMASK:COUNt:TESTScommand..total: TheMASK:COUNt:TOTalcommand..violations: TheMASK:COUNt:VIOLATIONScommand..waveforms: TheMASK:COUNt:WAVEFORMScommand.
display
property
¶
display: MaskDisplay
Return the MASK:DISplay command.
Description
- This command sets or queries whether defined masks are displayed on the screen. This is useful for temporarily turning off user-defined masks without deleting them. It is also useful for removing a standard mask from the screen, but leaving it as the selected standard. Mask counting, mask testing, and mask autoset are unavailable if the mask display is Off. The default is On.
Usage
- Using the
.query()method will send theMASK:DISplay?query. - Using the
.verify(value)method will send theMASK:DISplay?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:DISplay valuecommand.
SCPI Syntax
- MASK:DISplay {ON|OFF|<NR1>}
- MASK:DISplay?
Info
<NR1>= 0 removes the masks from the display; any other value shows the masks on the display.ONshows the masks on the display. This is the default value.OFFremoves the masks from the display.
filter
property
¶
filter: MaskFilter
Return the MASK:FILTer command.
Description
- This command sets or returns whether the selected digital filter will be run on the waveform data. The filter simulates optical hardware. That is, it simulates different hardware for each of several different optical standards. The digital filter runs on OC1, OC3, OC12, OC48, FC133, FC266, FC531, FC1063, FC2125Draft, Gigabit Ethernet, Infiniband 2.5 Gb, 1394 b, 393 Mb, 786.43 Mb, 1.572 Gb
Usage
- Using the
.query()method will send theMASK:FILTer?query. - Using the
.verify(value)method will send theMASK:FILTer?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:FILTer valuecommand.
SCPI Syntax
- MASK:FILTer {ON|OFF|<NR1>}
- MASK:FILTer?
Info
<NR1>= 0 disables the digital filter; any other value enables it.OFFdisables the digital filter.ONenables the digital filter.
Sub-properties
.orr: TheMASK:FILTer:ORRcommand tree.
highlighthits
property
¶
highlighthits: MaskHighlighthits
Return the MASK:HIGHLIGHTHits command.
Description
- This command sets or returns whether hits in a mask are highlighted in different colors than other waveform data. The default is On.
Usage
- Using the
.query()method will send theMASK:HIGHLIGHTHits?query. - Using the
.verify(value)method will send theMASK:HIGHLIGHTHits?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:HIGHLIGHTHits valuecommand.
SCPI Syntax
- MASK:HIGHLIGHTHits {ON|OFF|<NR1>}
- MASK:HIGHLIGHTHits?
Info
<NR1>= 0 disables themask:highlighthitsfunction; any other value enables it.OFFdisables themask:highlighthitsfunction.ONenables themask:highlighthitsfunction.
invert
property
¶
invert: MaskInvert
Return the MASK:INVert command.
Description
- This command controls whether the mask is drawn inverted. It has no effect if this mask cannot be inverted. The default is Off (Positive).
Usage
- Using the
.write(value)method will send theMASK:INVert valuecommand.
SCPI Syntax
- MASK:INVert {ON|OFF|<NR1>}
Info
<NR1>= 0 disables themask:invertfunction; any other value enables it.OFFPositive.ONNegative.
lock
property
¶
lock: MaskLock
Return the MASK:LOCk command.
Description
- This command locks the mask to the source waveform so that any changes made to the horizontal and/or vertical scale settings of the waveform will redraw the mask segments in proportion. This feature is useful for expanding the horizontal and/or vertical settings in order to zoom in on waveforms and masks, and visually examine violation areas in more detail. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:LOCk?query. - Using the
.verify(value)method will send theMASK:LOCk?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:LOCk valuecommand.
SCPI Syntax
- MASK:LOCk {ON|OFF|<NR1>}
- MASK:LOCk?
Info
ONturns on this feature, so that the mask is locked to the waveform.OFFturns off this feature.<NR1> = 0turns off this feature. Any other value turns it on.
margin
property
¶
margin: MaskMargin
Return the MASK:MARgin command tree.
Usage
- Using the
.query()method will send theMASK:MARgin?query. - Using the
.verify(value)method will send theMASK:MARgin?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.percent: TheMASK:MARgin:PERCentcommand..state: TheMASK:MARgin:STATEcommand.
maskpre
property
¶
maskpre: MaskMaskpre
Return the MASK:MASKPRE command tree.
Usage
- Using the
.query()method will send theMASK:MASKPRE?query. - Using the
.verify(value)method will send theMASK:MASKPRE?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.amplitude: TheMASK:MASKPRE:AMPlitudecommand..hscale: TheMASK:MASKPRE:HSCAlecommand..htrigpos: TheMASK:MASKPRE:HTRIGPOScommand..patternbits: TheMASK:MASKPRE:PATTERNBITScommand..presampbits: TheMASK:MASKPRE:PRESAMPBITScommand..recordlength: TheMASK:MASKPRE:RECOrdlengthcommand..serialtrig: TheMASK:MASKPRE:SERIALTRIGcommand..trigtosamp: TheMASK:MASKPRE:TRIGTOSAMPcommand..voffset: TheMASK:MASKPRE:VOFFSetcommand..vpos: TheMASK:MASKPRE:VPOScommand..vscale: TheMASK:MASKPRE:VSCAlecommand..width: TheMASK:MASKPRE:WIDthcommand.
polarity
property
¶
polarity: MaskPolarity
Return the MASK:POLarity command.
Description
- This command sets or returns the input waveform polarity for the pass/fail test. It
controls whether to test positive pulse, negative pulse, or both during pass/fail
testing. This command only applies when
MASK:TEST:STATEis on.
Usage
- Using the
.query()method will send theMASK:POLarity?query. - Using the
.verify(value)method will send theMASK:POLarity?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:POLarity valuecommand.
SCPI Syntax
- MASK:POLarity {BOTh|NEGAtive|POSITIVe}
- MASK:POLarity?
Info
BOThenables testing for both positive and negative pulses. The instrument tests positive pulses on themask:sourcewaveform until ½ of the waveform is tested. Then the instrument inverts the mask and performs the remaining tests.NEGAtiveenables testing on negative pulses.POSITIVeenables testing on positive pulses. This is the default.
seg
property
¶
seg: dict[int, MaskSegItem]
Return the MASK:SEG<m> command.
Description
- This command deletes the specified mask segment from the current mask. m is an integer that specifies the mask segment number to delete from the current mask.
Usage
- Using the
.write(value)method will send theMASK:SEG<m> valuecommand.
SCPI Syntax
- MASK:SEG<m> DELEte
Info
DELETEremoves the specified mask segment from the mask.
Sub-properties
.nr_pt: TheMASK:SEG<m>:NR_Ptcommand..points: TheMASK:SEG<m>:POINTScommand.
source
property
¶
source: MaskSource
Return the MASK:SOUrce command.
Description
- This command sets or reports which source will be compared against the mask(s) when counting is turned on; it controls which trace to use in mask counting. It also affects mask autoset and how triggering is set up when you select the mask.
Usage
- Using the
.query()method will send theMASK:SOUrce?query. - Using the
.verify(value)method will send theMASK:SOUrce?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:SOUrce valuecommand.
SCPI Syntax
- MASK:SOUrce {CH<x>|MATH<x>|REF<x>}
- MASK:SOUrce?
Info
CH<1-4>selects a channel waveform to be compared against the specified mask. The range for is 1 through 4.MATH<1-4>selects a math waveform to be compared against the specified mask. The range for is 1 through 4.REF<1-4>selects a reference waveform to be compared against the specified mask. The range is 1 through 4.
standard
property
¶
standard: MaskStandard
Return the MASK:STANdard command.
Description
- This command deletes the existing mask (if any) and sets the selected standard mask.
If
MASK:COUNT:STATEis ON, mask counting starts immediately. The query form of this command returns the current mask standard. The following warning event is posted if the mask exceeds the instrument bandwidth: 2318,’Consider system bandwidth when testing at this bit rate.’
Usage
- Using the
.query()method will send theMASK:STANdard?query. - Using the
.verify(value)method will send theMASK:STANdard?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:STANdard valuecommand.
SCPI Syntax
- MASK:STANdard {ATARXG<x>|ATATXG1|ATATXG2|ATATXG3|CLOCKCoax|CLOCKSymmetrical|D<x>|DS0Contra|DS0Double|DS0Single|DS0Timing|DS1|DS1A|DS1C|DS2|DS2RATECoax|DS2RATESymmetrical|DS3|DS4NA|DS4NA_Max|E1Coax|E1Symmetrical|E2|E3|E4_1|E4_0|ENET1000BCX_ATP2|ENET1000BCX_ATP3|ENET1000BCX_NTP2|ENET100FX|ENET100STP|ENET100UTP|ENET1250|ENETXAUI_Far|ENETXAUI_Near|FC1063|FC1063Draft|FC1063E|FC1063E_ABR|FC1063E_ABT|FC1063E_ADR|FC1063E_ADT|FC1063E_AGR|FC1063E_AGT|FC1063E_NBT|FC1063E_NDT|FC1063E_NGT|FC133|FC133E|FC2125|FC2125E_ABR|FC2125E_ABT|FC2125E_ADR|FC2125E_ADT|FC2125E_AGR|FC2125E_AGT|FC2125E_NBT|FC2125E_NDT|FC2125E_NGT|FC266|FC266E|FC4250E_ABR|FC4250E_ABT|FC4250E_ADR|FC4250E_ADT|FC4250E_AGR|FC4250E_AGT|FC4250E_NBT|FC4250E_NDT|FC4250E_NGT|FC531|FC531E|FST1|FST2|FST3|FST4|FST5|FST6|FW1394BS1600B|FW1394BS1600BT1|FW1394BS1600BT2|FW1394BS400B|FW1394BS400BT1|FW1394BS400BT2|FW1394BS800B|FW1394BS800BT1|FW1394BS800BT2|G703DS1|G703DS3|HST<x>|INF2_5G|INF2_5GE|NONe|OC1|OC12|OC3|OC48|OC48_FEC|PCIEXPRESS_Rcv|PCIEXPRESS_Xmit|RATE32Mbit|RATE97Mbit|RIO_DRV1G|RIO_DRV1_5G|RIO_DRV2G|RIO_DRV500M|RIO_DRV500M|RIO_DRV750M|RIO_EDRV1G|RIO_EDRV1_5G|RIO_EDRV2G|RIO_EDRV500M|RIO_EDRV500M|RIO_EDRV750M|RIO_RCV1G|RIO_RCV1_5G|RIO_RCV2G|RIO_RCV500M|RIO_RCV500M|RIO_RCV750M|RIO_SERIAL_1G|RIO_SERIAL_2G|RIO_SERIAL_3G|SFI5_RCVBCLK2|SFI5_RCVBCLK3|SFI5_RCVBDATA2|SFI5_RCVBDATA3|SFI5_RCVDCLK2|SFI5_RCVDCLK3|SFI5_RCVDDATA2|SFI5_RCVDDATA3|SFI5_XMITACLK2|SFI5_XMITACLK3|SFI5_XMITADATA2|SFI5_XMITADATA3|SFI5_XMITCCLK2|SFI5_XMITCCLK3|SFI5_XMITCDATA2|SFI5_XMITCDATA3|STM0_0|STM0_1|STM0_HDBX|STM1E_1|STM1E_0|STS1Eye|STS1Pulse|STS3|STS3_Max|TFI5_2|TFI5_3|USERMask|VIDEO270|VIDEO292M|VIDEO360|VSROC192|SAS1_5_IR|SAS1_5_CR|SAS1_5_XR|SAS1_5_IR_AASJ|SAS1_5_CR_AASJ|SAS1_5_XR_AASJ|SAS1_5_SATA|SAS3_0_IR|SAS3_0_CR|SAS3_0_XR|SAS3_0_IR_AASJ|SAS3_0_CR_AASJ|SAS3_0_XR_AASJ|SAS3_0_SATA}
- MASK:STANdard?
Info
ATARXG1(Serial ATA, G1 Rx 1.5 Gb/s).ATARXG2(Serial ATA, G2, Rx, 3.0 Gb/s).ATARXG3(Serial ATA, G3, Rx).ATATXG1(Serial ATA, G1 Tx, 1.5 Gb/s).ATATXG2(Serial ATA, G2 Tx, 3.0 Gb/s).H ATATXG3(Serial ATA, G3 Tx).CLOCKCoaxCLOCKSymmetricalD1D2DS0Contra(ITU-T, G703 (10/98), 64 kb/s).DS0Double(ITU-T, G703 (10/98), 64 kb/s).DS0Single(ITU-T, G703 (10/98), 64 kb/s).DS0Timing(ITU-T, G703 (10/98), 64 kb/s).DS1(ANSI T1.102-1993 (R1999), DS1, 1.544 Mb/s).DS1A(ANSI T1.102-1993 (R1999), DS1A, 2.048 Mb/s).DS1C(ANSI T1.102-1993 (R1999), DS1C, 3.152 Mb/s).DS2(ANSI T1.102-1993 (R1999), DS2, 6.312 Mb/s).DS2RATECoax(ITU-T, G703 (10/98), D2 Rate Coax, 6.312 Mb/s).DS2RATESymmetrical(ITU-T, G703 (10/98), D2 Rate Sym, 6.312 Mb/s).DS3(ANSI T1.102-1993 (R1999), DS3, 44.736 Mb/s).DS4NA(ANSI T1.102-1993 (R1999), DS4NA, 139.26 Mb/s).DS4NA_Max(ANSI T1.102-1993 (R1999), DSNA Max Output, 139.26 Mb.E1Coax(ITU-T, G703 (10/98), E1 Coax Pair, 2.048 Mb/s).E1Symmetrical(ITU-T, G703 (10/98), E1 Sym Pair, 2.048 Mb/s).E2(ITU-T, G703 (10/98), E2, 8.448 Mb/s).E3(ITU-T, G703 (10/98), E3, 34.368 Mb/s).E4_0(ITU-T, G703 (10/98), E4 Binary 0).E4_1(ITU-T, G703 (10/98), E4 Binary 1).ENET100FXENET100STP(IEEE Std 802.3 and ANSI X3.263-1995, 100 Base-Tx, STP, 125 Mb/s ).ENET100UTP(IEEE Std 802.3 and ANSI X3.263-1995, 100 Base-Tx, UTP, 125 Mb/s).ENET1000BCX_ATP2(1000B-CX Abs, TP2, 1.25 Gb/s).ENET1000BCX_ATP3(1000B-CX Abs, TP3, 1.25 Gb/s).ENET1000BCX_NTP2(1000B-CX Norm, TP2, 1.25 Gb/s).ENET1250(IEEE Std 802.3 and ANSI X3.263-1995, GB Ethernet, 1.25 Gb/s).ENETXAUI_FAR(10 Gigabit Attachment Unit Interface (XAUI), Far, 3.125 Gb/s).ENETXAUI_Near(10 Gigabit Attachment Unit Interface (XAUI), Near, 3,125 Gb/s).FC133(ANSI X3.230-1999 NCITS 1235D/Rev 11, Optical, 132.8 Mb/s).FC133E(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Electrical 132.8 Mb/s).FC266(ANSI X3.230-1999 NCITS 1235D/Rev 11, Optical, 265.6 Mb/s).FC266E(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Electrical, 132.8 Mb/s).FC531(ANSI X3.230-1999 NCITS 1235D/Rev 11, Optical, 531.2 Mb/s).FC531E(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Electrical, 531.2 Mb/s).FC1063(ANSI X3.230-1999 NCITS 1235D/Rev 11, Optical, 1.065 Gb/s).FC1063E(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Electrical, 1.0625 Gb/s).FC1063E_ABT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Beta, Transm).FC1063E_ADT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Beta, Transm).FC1063E_AGT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Gamma, Transm).FC1063E_NBT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Norm, Beta, Transm).FC1063E_NDT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Norm, Delta, Transm).FC1063E_NGT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Norm, Gamma, Transm).FC1063E_ABR(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Beta, Recv).FC1063E_ADR(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Delta, Recv).FC1063E_AGR(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Gamma, Recv).FC1063Draft(ANSI X3.230-1999 NCITS 1235D/Rev 11, Optical, Draft Rev 11).FC2125(ANSI X3.230-1999 NCITS 1235D/Rev 11, Optical, 2.125).FC2125E_ABT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Beta, Transm).FC2125E_ADT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Delta, Transm).FC2125E_AGT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Gamma, Transm).FC2125E_NBT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Norm, Beta, Transm).FC2125E_NDT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Norm, Delta, Transm).FC2125E_NGT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Norm, Gamma, Transm).FC2125E_ABR(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Beta, Recv).FC2125E_ADR(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Delta, Recv).FC2125E_AGR(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Gamma, Recv).FC4250E_ABT(ANS1 X3.230-1999 NCITS 1235D/Rev 4.0, Abs, Beta, Transm).FC4250E_ADT(ANS1 X3.230-1999 NCITS 1235D/Rev 4.0, Abs, Delta, Transm).FC4250E_AGT(ANS1 X3.230-1999 NCITS 1235D/Rev 4.0, Abs, Gamma, Transm).FC4250E_NBT(ANS1 X3.230-1999 NCITS 1235D/Rev 4.0, Norm, Beta, Transm).FC4250E_NDT(ANS1 X3.230-1999 NCITS 1235D/Rev 4.0, Norm, Delta, Transm).FC4250E_NGT(ANS1 X3.230-1999 NCITS 1235D/Rev 4.0, Norm, Gamma, Transm).FC4250E_ABR(ANS1 X3.230-1999 NCITS 1235D/Rev 4.0, Abs, Beta, Recv).FC4250E_ADR(ANS1 X3.230-1999 NCITS 1235D/Rev 4.0, Abs, Delta, Recv).FC4250E_AGR(ANS1 X3.230-1999 NCITS 1235D/Rev 4.0, Abs, Gamma, Recv).FST1(USB,FS:T1, 12 Mb/s).FST2(USB,FS:T2, 12 Mb/s).FST3(USB,FS:T3, 12 Mb/s).FST4(USB,FS:T4: 12 Mb/s).FST5(USB,FS:T5, 12 Mb/s).FST6(USB,FS:T6, 12 Mb/s).FW1394BS400B(IEEE 1394b, S400 Optical, 491.5 Mb/s).FW1394BS400BT1(IEEE 1394b, S400b T1, 491.5 Mb/s).FW1394BS400BT2(IEEE 1394b, S400b T2, 491.5 Mb/s).FW1394BS800B(IEEE 1394b, S800 Optical, 988.0 Mb/s).FW1394BS800BT1(IEEE 1394b, S800b T1, 983.0 Mb/s).FW1394BS800BT2(IEEE 1394b, S800b T2, 983.0 Mb/s).FW1394BS1600B(IEEE 1394b, S1600 Optical, 1.966 Gb/s).FW1394BS1600BT1(IEEE 1394b, S1600b T1, 1.966 Gb/s).FW1394BS1600BT2(IEEE 1394b, S1600b T2, 1.966 Gb/s).G703D1(ITU-T, G703 (10/98), DS1 Rate, 1.544 Mb/s).G703DS3(ITU-T, G703 (10/98).HST1(USB,HS:T1, 480 Mb/s) G703DS3 (ITU-T, G703 (10/98).HST2(USB,HS:T2, 480 Mb/s) G703DS3 (ITU-T, G703 (10/98).HST3(USB,HS:T3, 480 Mb/s).HST4(USB,HS:T4, 480 Mb/s).HST5(USB,HS:T5, 480 Mb/s).HST6(USB,HS:T6, 480 Mb/s).INF2_5G(InfiniBand, IBTA Spec 1.0a, 2.5 Optical, 2.5 Gb/s).INF2_5GE(InfiniBand, IBTA Spec 1.0a, 2.5 Electrical, 2.5 Gb/s).NONeOC1(GR 253-CORE Issue 3 9/21/2000 OC1/STM0, 51.84 Mb/s).OC3(GR 253-CORE Issue 3 9/21/2000 OC1/STM1, 155.52, Mb/s).OC12(GR 253-CORE Issue 3 9/21/2000 OC1/STM4, 622.08 Mb/s).OC48(GR 253-CORE Issue 3 9/21/2000 OC1/STM16, 2.4883 Gb/s.OC48_FEC(Forward Error Correction - CSA8000 mask, 2.666 Gb/s).PCIEXPRESS_Xmit(PCI Express Transmitter, 2.5 Gb/s).PCIEXPRESS_Rcv(PCI Express Receiver, 2.5 Gb/s).RATE32Mbit(ITU-T, G703 (10/98), 32.064 Mb/s).RATE97Mbit(ITU-T, G703 (10/98), 97 Mbit, 97.728 Mb/s).RIO_DRV1G(Rapid IO Driver, 1 Gb/s).RIO_DRV1_5G(Rapid IO Driver, 5 Gb/s).RIO_DRV2G(Rapid IO Driver, 2 Gb/s).RIO_DRV500M(Rapid IO Driver, 500 Mb/s).RIO_DRV750M(Rapid IO Driver, 750 Mb/s).RIO_EDRV1G(Rapid IO Extended Driver, 1 Gb/s).RIO_EDRV1_5G(Rapid IO Extended Driver, 1.5 Gb/s).RIO_EDRV2G(Rapid IO Extended Driver, 2 Gb/s).RIO_EDRV500M(Rapid IO Extended Driver, 500 Mb/s).RIO_EDRV750M(Rapid IO Extended Driver, 750 Mb/s).RIO_RCV500M(Rapid IO Receiver, 500 Mb/s).RIO_RCV750M(Rapid IO Receiver, 750 Mb/s).RIO_RCV1G(Rapid IO Receiver, 1 Gb/s).RIO_RCV1_5G(Rapid IO Receiver, 1.5 Gb/s).RIO_RCV2G(Rapid IO Receiver, 2 Gb/s).RIO_SERIAL_1G(Rapid IO Serial, 1.25 Gb/s).RIO_SERIAL_2G(Rapid IO Serial, 2.5 Gb/s).RIO_SERIAL_3G(Rapid IO Serial, 3.25 Gb/s).SFI5_XMITADATA2(SFI15 Transmit: Test Point A Data Signal 2, 2.488 Gb/s).SFI5_XMITCDATA2(SFI15 Transmit: Test Point C Data Signal 2, 2.488 Gb/s).SFI5_XMITACLK2(SFI15 Transmit: Test Point A Clock Signal 2, 2.488 Gb/s).SFI5_XMITCCLK2(SFI15 Transmit: Test Point C Clock Signal 2, 2.488 Gb/s).SFI5_RCVBDATA2(SFI15 Receive: Test Point B Data Signal 2, 2.488 Gb/s).SFI5_RCVDDATA2(SFI15 Receive: Test Point D Data Signal 2, 2.488 Gb/s).SFI5_RCVBCLK2(SFI15 Receive: Test Point B Clock Signal 2, 2.488 Gb/s).SFI5_RCVDCLK2(SFI15 Receive: Test Point D Clock Signal 2, 2.488 Gb/s).SFI5_XMITADATA3(SFI15 Transmit: Test Point A Data Signal 3, 3.125 Gb/s).SFI5_XMITCDATA3(SFI15 Transmit: Test Point C Data Signal 3, 3.125 Gb/s).SFI5_XMITACLK3(SFI15 Transmit: Test Point A Clock Signal 3, 3.125 Gb/s).SFI5_XMITCCLK3(SFI15 Transmit: Test Point C Clock Signal 3, 3.125 Gb/s).SFI5_RCVBDATA3(SFI15 Receive: Test Point B Data Signal 3, 3.125 Gb/s).SFI5_RCVDDATA3(SFI15 Receive: Test Point D Data Signal 3, 3.125 Gb/s).SFI5_RCVBCLK3(SFI15 Receive: Test Point B Clock Signal 3, 3.125 Gb/s).SFI5_RCVDCLK3(SFI15 Receive: Test Point D Clock Signal 3, 3.125 Gb/s.STM0_0(ITU-T, G703 (10/98), STM1E Binary 0).STM0_1(ITU-T, G703 (10/98), STM1E Binary 1).STM0_HDBXSTS1Eye(ANSI T1.102-1993 (R1999), STS-1 Eye, 51.84 Mb/s).STS1Pulse(ANSI T1.102-1993 (R1999), STS-1 Pulse, 51.84 Mb/s).STS3(ANSI T1.102-1993 (R1999), STS-3, 155.52 Mb/s).STS3_Max(ANSI T1.102-1993 (R1999), STS-3 Max Output, 155.52 Mb/s).TFI15_2(TFI-5, 2.488 Gb/s).TFI5_3(TFI-5, 3.1104 Gb/s).USERMaskVIDEO270VIDEO292MVIDEO360VSROC192(VSR OC192/STM64, 1.24416 Gb/s).
stoponviolation
property
¶
stoponviolation: MaskStoponviolation
Return the MASK:STOPOnviolation command.
Description
- This command stops the waveform acquisitions upon the first occurrence of a waveform
violation. The
MASK:ACTONEVENT:ENABLEcommand should be set to ON for this event to happen. After the event occursMASK:ACTONEVENT:ENABLEcommand will be set to OFF automatically. You can also specify an action to be performed when acquisitions are stopped by using the commands such asMASK:TEST:SAVEWFM,MASK:TEST:SAVEIMAGE,MASK:TEST:AUXOUT:FAILURE,MASK:TEST:HARDCOPY, orMASK:TEST:SRQ:FAILURE. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:STOPOnviolation?query. - Using the
.verify(value)method will send theMASK:STOPOnviolation?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:STOPOnviolation valuecommand.
SCPI Syntax
- MASK:STOPOnviolation {ON|OFF|<NR1>}
- MASK:STOPOnviolation?
Info
ONstops waveform acquisition on the first occurrence of a mask violation.OFFturns this feature off.<NR1>=0turns this feature off ; any other value turns it on.
test
property
¶
test: MaskTest
Return the MASK:TESt command tree.
Usage
- Using the
.query()method will send theMASK:TESt?query. - Using the
.verify(value)method will send theMASK:TESt?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.aux: TheMASK:TESt:AUXcommand tree..beep: TheMASK:TESt:BEEPcommand tree..delay: TheMASK:TESt:DELaycommand..hardcopy: TheMASK:TESt:HARDCopycommand..log: TheMASK:TESt:LOGcommand tree..repeat: TheMASK:TESt:REPeatcommand..sample: TheMASK:TESt:SAMplecommand..savewfm: TheMASK:TESt:SAVEWFMcommand..srq: TheMASK:TESt:SRQcommand tree..state: TheMASK:TESt:STATEcommand..status: TheMASK:TESt:STATUScommand..stop: TheMASK:TESt:STOPcommand tree..threshold: TheMASK:TESt:THResholdcommand..waveform: TheMASK:TESt:WAVEformcommand.
user
property
¶
user: MaskUser
Return the MASK:USER command tree.
Usage
- Using the
.query()method will send theMASK:USER?query. - Using the
.verify(value)method will send theMASK:USER?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.amplitude: TheMASK:USER:AMPlitudecommand..bitrate: TheMASK:USER:BITRatecommand..hscale: TheMASK:USER:HSCAlecommand..htrigpos: TheMASK:USER:HTRIGPOScommand..label: TheMASK:USER:LABelcommand..patternbits: TheMASK:USER:PATTERNBITScommand..presampbits: TheMASK:USER:PRESAMPBITScommand..recordlength: TheMASK:USER:RECOrdlengthcommand..seg: TheMASK:USER:SEG<m>command..trigtosamp: TheMASK:USER:TRIGTOSAMPcommand..voffset: TheMASK:USER:VOFFSetcommand..vpos: TheMASK:USER:VPOScommand..vscale: TheMASK:USER:VSCAlecommand..width: TheMASK:USER:WIDthcommand.
MaskAutoadjust
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:AUTOAdjust command.
Description
- This command optimizes or queries the signal position within the mask to minimize hits. It
sets a mode so that the
MASK:SOURCEwaveform is compared against the mask and is shifted up, down, left, or right to minimize the hits.
Usage
- Using the
.query()method will send theMASK:AUTOAdjust?query. - Using the
.verify(value)method will send theMASK:AUTOAdjust?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:AUTOAdjust valuecommand.
SCPI Syntax
- MASK:AUTOAdjust {ON|OFF|<NR1>}
- MASK:AUTOAdjust?
Info
<NR1>= 0 disables the autoadjust function; any other value enables it.ONenables the autoadjust function.OFFdisables the autoadjust function.
Properties
.hdelta: TheMASK:AUTOAdjust:HDELTAcommand..vdelta: TheMASK:AUTOAdjust:VDELTAcommand.
hdelta
property
¶
hdelta: MaskAutoadjustHdelta
Return the MASK:AUTOAdjust:HDELTA command.
Description
- This command sets or returns how far autofit searches horizontally. Autofit moves the waveform vertically and/or horizontally to reduce the number of hits within a given mask. If infinite or variable persistence is enabled, these movements will clear any persistent data. If Autofit makes frequent adjustments, there might be very little or even no persistent data displayed.
Usage
- Using the
.query()method will send theMASK:AUTOAdjust:HDELTA?query. - Using the
.verify(value)method will send theMASK:AUTOAdjust:HDELTA?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:AUTOAdjust:HDELTA valuecommand.
SCPI Syntax
- MASK:AUTOAdjust:HDELTA {<NR3>}
- MASK:AUTOAdjust:HDELTA?
Info
<NR3>is a floating point number that represents a percent of a division.
vdelta
property
¶
vdelta: MaskAutoadjustVdelta
Return the MASK:AUTOAdjust:VDELTA command.
Description
- This command sets or returns how far autofit searches vertically. Autofit moves the waveform vertically and/or horizontally to reduce the number of hits within a given mask. If infinite or variable persistence is enabled, these movements will clear any persistent data. If Autofit makes frequent adjustments, there might be very little or even no persistent data displayed.
Usage
- Using the
.query()method will send theMASK:AUTOAdjust:VDELTA?query. - Using the
.verify(value)method will send theMASK:AUTOAdjust:VDELTA?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:AUTOAdjust:VDELTA valuecommand.
SCPI Syntax
- MASK:AUTOAdjust:VDELTA {<NR3>}
- MASK:AUTOAdjust:VDELTA?
Info
<NR3>is a floating point number that represents a percent of a division.
MaskAutoadjustHdelta
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:AUTOAdjust:HDELTA command.
Description
- This command sets or returns how far autofit searches horizontally. Autofit moves the waveform vertically and/or horizontally to reduce the number of hits within a given mask. If infinite or variable persistence is enabled, these movements will clear any persistent data. If Autofit makes frequent adjustments, there might be very little or even no persistent data displayed.
Usage
- Using the
.query()method will send theMASK:AUTOAdjust:HDELTA?query. - Using the
.verify(value)method will send theMASK:AUTOAdjust:HDELTA?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:AUTOAdjust:HDELTA valuecommand.
SCPI Syntax
- MASK:AUTOAdjust:HDELTA {<NR3>}
- MASK:AUTOAdjust:HDELTA?
Info
<NR3>is a floating point number that represents a percent of a division.
MaskAutoadjustVdelta
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:AUTOAdjust:VDELTA command.
Description
- This command sets or returns how far autofit searches vertically. Autofit moves the waveform vertically and/or horizontally to reduce the number of hits within a given mask. If infinite or variable persistence is enabled, these movements will clear any persistent data. If Autofit makes frequent adjustments, there might be very little or even no persistent data displayed.
Usage
- Using the
.query()method will send theMASK:AUTOAdjust:VDELTA?query. - Using the
.verify(value)method will send theMASK:AUTOAdjust:VDELTA?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:AUTOAdjust:VDELTA valuecommand.
SCPI Syntax
- MASK:AUTOAdjust:VDELTA {<NR3>}
- MASK:AUTOAdjust:VDELTA?
Info
<NR3>is a floating point number that represents a percent of a division.
MaskAutoset
¶
Bases: SCPICmdRead
The MASK:AUTOSet command tree.
Usage
- Using the
.query()method will send theMASK:AUTOSet?query. - Using the
.verify(value)method will send theMASK:AUTOSet?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.autoadjust: TheMASK:AUTOSet:AUTOAdjustcommand..hpos: TheMASK:AUTOSet:HPOScommand..hscale: TheMASK:AUTOSet:HSCAlecommand..mode: TheMASK:AUTOSet:MODecommand..offsetadj: TheMASK:AUTOSet:OFFSETAdjcommand..standard: TheMASK:AUTOSet:STANdardcommand..trigger: TheMASK:AUTOSet:TRIGgercommand..user: TheMASK:AUTOSet:USERcommand tree..vpos: TheMASK:AUTOSet:VPOScommand..vscale: TheMASK:AUTOSet:VSCAlecommand.
autoadjust
property
¶
autoadjust: MaskAutosetAutoadjust
Return the MASK:AUTOSet:AUTOAdjust command.
Description
- This command sets or returns whether the instrument settings are automatically matched
to signal characteristics and specific mask requirements. It controls what happens at
the end of a mask autoset. If ON, the horz/vert auto adjustment is run ONCE to
potentially improve the result of mask autoset. This command, like all the
MASK:AUTOSETcommands, affects only an autoset on a standard mask, not the general instrument autoset function.
Usage
- Using the
.query()method will send theMASK:AUTOSet:AUTOAdjust?query. - Using the
.verify(value)method will send theMASK:AUTOSet:AUTOAdjust?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:AUTOSet:AUTOAdjust valuecommand.
SCPI Syntax
- MASK:AUTOSet:AUTOAdjust {ON|OFF|<NR1>}
- MASK:AUTOSet:AUTOAdjust?
Info
<NR1>= 0 disables theautoset:autoadjustfunction; any other value enables it.ONenables theautoset:autoadjustfunction.OFFdisables theautoset:autoadjustfunction.
hpos
property
¶
hpos: MaskAutosetHpos
Return the MASK:AUTOSet:HPOS command.
Description
- This command controls whether the autoset algorithm will attempt to change the
horizontal position of the signal while attempting to do a mask autoset. The default
is ON. This command, like all the
MASK:AUTOSETcommands, affects only an autoset on a standard mask, not the general instrument autoset function.
Usage
- Using the
.query()method will send theMASK:AUTOSet:HPOS?query. - Using the
.verify(value)method will send theMASK:AUTOSet:HPOS?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:AUTOSet:HPOS valuecommand.
SCPI Syntax
- MASK:AUTOSet:HPOS {ON|OFF|<NR1>}
- MASK:AUTOSet:HPOS?
Info
<NR1>= 0 disables theautoset:hposfunction; any other value disables enables it.ONenables theautoset:hposfunction.OFFdisables theautoset:hposfunction.
hscale
property
¶
hscale: MaskAutosetHscale
Return the MASK:AUTOSet:HSCAle command.
Description
- This command controls whether the autoset algorithm will attempt to change the
horizontal scale while attempting a mask autoset. This command, like all the
MASK:AUTOSETcommands, affects only an autoset on a standard mask, not the general instrument autoset function.
Usage
- Using the
.query()method will send theMASK:AUTOSet:HSCAle?query. - Using the
.verify(value)method will send theMASK:AUTOSet:HSCAle?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:AUTOSet:HSCAle valuecommand.
SCPI Syntax
- MASK:AUTOSet:HSCAle {ON|OFF|<NR1>}
- MASK:AUTOSet:HSCAle?
Info
<NR1>= 0 disables theautoset:hscalefunction; any other value enables it.ONenables theautoset:hscalefunction.OFFdisables theautoset:hscalefunction.
mode
property
¶
mode: MaskAutosetMode
Return the MASK:AUTOSet:MODe command.
Description
- This command controls whether a mask autoset will be automatically done after a
standard mask is selected. The autoset will never happen if the standard mask is
selected from GPIB, since a ‘SET?’ sent back to the oscilloscope should not perform a
mask autoset. The default value is: manual. This command, like all the
MASK:AUTOSETcommands, affects only an autoset on a standard mask, not the general instrument autoset function.
Usage
- Using the
.query()method will send theMASK:AUTOSet:MODe?query. - Using the
.verify(value)method will send theMASK:AUTOSet:MODe?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:AUTOSet:MODe valuecommand.
SCPI Syntax
- MASK:AUTOSet:MODe {MANual|AUTO}
- MASK:AUTOSet:MODe?
Info
MANualmask autoset is set manually.AUTOmask autoset is set automatically.
offsetadj
property
¶
offsetadj: MaskAutosetOffsetadj
Return the MASK:AUTOSet:OFFSETAdj command.
Description
- This command sets mask autoset not to enforce the rule that, for pulse standards,
require 0 V to be in a certain place in the mask. Instead, mask autoset will attempt
to measure the DC offse t in the signal and use oscilloscope offset or position
controls to compensate for the DC offset in the signal. This command, like all the
MASK:AUTOSETcommands, affects only an autoset on a standard mask, not the general instrument autoset function.
Usage
- Using the
.query()method will send theMASK:AUTOSet:OFFSETAdj?query. - Using the
.verify(value)method will send theMASK:AUTOSet:OFFSETAdj?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:AUTOSet:OFFSETAdj valuecommand.
SCPI Syntax
- MASK:AUTOSet:OFFSETAdj {ON|OFF|<NR1>}
- MASK:AUTOSet:OFFSETAdj?
Info
<NR1>= 0 disables theautoset:offsetadjfunction; any other value enables it.ONenables theautoset:offsetadjfunction.OFFdisables theautoset:offsetadjfunction.
standard
property
¶
standard: MaskAutosetStandard
Return the MASK:AUTOSet:STANdard command.
Description
- This command selects the standard mask in a mask autoset. This command, like all the
MASK:AUTOSETcommands, affects only an autoset on a standard mask, not the general instrument autoset function.
Usage
- Using the
.query()method will send theMASK:AUTOSet:STANdard?query. - Using the
.verify(value)method will send theMASK:AUTOSet:STANdard?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:AUTOSet:STANdard valuecommand.
SCPI Syntax
- MASK:AUTOSet:STANdard {ATATXG<x>|ATARXG<x>|CLOCKCoax|CLOCKSymmetrical|D<x>|DS0Contra|DS0Double|DS0Single|DS0Timing|DS1|DS1A|DS1C|DS2RATESymmetrical|DS2RATECoax|DS2|DS3|DS4NA|DS4NA_Max|E1Symmetrical|E1Coax|E2|E3|E4_0|E4_1|ENET100FX|ENET100STP|ENET100UTP|ENET1250|ENET1000BCX_NTP2|ENET1000BCX_ATP2|ENET1000BCX_ATP3|ENETXAUI_Near|ENETXAUI_Far|FC133|FC266|FC531|FC1063|FC1063Draft|FC2125|FC133E|FC266E|FC531E|FC1063E|FC1063E_NBT|FC1063E_NDT|FC1063E_NGT|FC1063E_ABT|FC1063E_ADT|FC1063E_AGT|FC1063E_ABR|FC1063E_ADR|FC1063E_AGR|FC2125E_NBT|FC2125E_NDT|FC2125E_NGT|FC2125E_ABT|FC2125E_ADT|FC2125E_AGT|FC2125E_ABR|FC2125E_ADR|FC2125E_AGR|FC4250E_ABR|FC4250E_ABT|FC4250E_ADR|FC4250E_ADT|FC4250E_AGR|FC4250E_AGT|FC4250E_NBT|FC4250E_NDT|FC4250E_NGT|FST1|FST2|FST3|FST4|FST5|FST6|FW1394BS400BT1|FW1394BS400BT2|FW1394BS800BT1|FW1394BS800BT2|FW1394BS1600BT1|FW1394BS1600BT2|FW1394BS400B|FW1394BS800B|FW1394BS1600B|G703DS1|G703DS3|HST<x>|INF2_5G|INF2_5GE|NONe|OC1|OC3|OC12|OC48|OC48_FEC|RATE32Mbit|RATE97Mbit|RIO_DRV500M|RIO_DRV750M|RIO_DRV1G|RIO_DRV1_5G|RIO_DRV2G|RIO_EDRV500M|RIO_EDRV750M|RIO_EDRV1G|RIO_EDRV1_5G|RIO_EDRV2G|RIO_RCV500M|RIO_RCV750M|RIO_RCV1G|RIO_RCV1_5G|RIO_RCV2G|RIO_SERIAL_1G|RIO_SERIAL_2G|RIO_SERIAL_3G|SFI5_XMITADATA2|SFI5_XMITCDATA2|SFI5_XMITACLK2|SFI5_XMITCCLK2|SFI5_RCVBDATA2|SFI5_RCVDDATA2|SFI5_RCVBCLK2|SFI5_RCVDCLK2|SFI5_XMITADATA3|SFI5_XMITCDATA3|SFI5_XMITACLK3|SFI5_XMITCCLK3|SFI5_RCVBDATA3|SFI5_RCVDDATA3|SFI5_RCVBCLK3|SFI5_RCVDCLK3|PCIEXPRESS_Xmit|PCIEXPRESS_Rcv|SAS1_5_IR|SAS1_5_CR|SAS1_5_XR|SAS1_5_IR_AASJ|SAS1_5_CR_AASJ|SAS1_5_XR_AASJ|SAS1_5_SATA|SAS3_0_IR|SAS3_0_CR|SAS3_0_XR|SAS3_0_IR_AASJ|SAS3_0_CR_AASJ|SAS3_0_XR_AASJ|SAS3_0_SATA|STM0_1|STM0_0|STM0_HDBX|STM1E_0|STM1E_1|STS1Pulse|STS1Eye|STS3|STS3_Max|TFI5_2|TFI5_3|USERMask|VIDEO270|VIDEO292M|VIDEO360|VSROC192}
- MASK:AUTOSet:STANdard?
Info
ATATXG1(Serial ATA, G1 Tx, 1.5 Gb/s).ATATXG2(Serial ATA, G2 Tx, 3.0 Gb/s).ATATXG3(Serial ATA, G3 Tx).ATARXG1(Serial ATA, G1 Rx 1.5 Gb/s).ATARXG2(Serial ATA, G2, Rx, 3.0 Gb/s).ATARXG3(Serial ATA, G3, Rx).G703D1(ITU-T, G703 (10/98), DS1 Rate, 1.544 Mb/s).DS1(ANSI T1.102-1993 (R1999), DS1, 1.544 Mb/s).DS1A(ANSI T1.102-1993 (R1999), DS1A, 2.048 Mb/s).DS1C(ANSI T1.102-1993 (R1999), DS1C, 3.152 Mb/s).DS2(ANSI T1.102-1993 (R1999), DS2, 6.312 Mb/s).DS3(ANSI T1.102-1993 (R1999), DS3, 44.736 Mb/s).DS4NA(ANSI T1.102-1993 (R1999), DS4NA, 139.26 Mb/s).DS4NA_Max(ANSI T1.102-1993 (R1999), DSNA Max Output, 139.26 Mb/s).DS2RATECoax(ITU-T, G703 (10/98), D2 Rate Coax, 6.312 Mb/s).DS2RATESymmetrical(ITU-T, G703 (10/98), D2 Rate Sym, 6.312 Mb/s).E1Coax(ITU-T, G703 (10/98), E1 Coax Pair, 2.048 Mb/s).E1Symmetrical(ITU-T, G703 (10/98), E1 Sym Pair, 2.048 Mb/s).E2(ITU-T, G703 (10/98), 8.448 Mb/s).RATE32Mbit(ITU-T, G703 (10/98), 32.064 Mb/s).E3(ITU-T, G703 (10/98), E3, 34.368 Mb/s).E4_0(ITU-T, G703 (10/98), E4 Binary 0).E4_1(ITU-T, G703 (10/98), E4 Binary 1).ENET100STP(IEEE Std 802.3 and ANSI X3.263-1995, 100 Base-Tx, STP, 125 Mb/s ).ENET100UTP(IEEE Std 802.3 and ANSI X3.263-1995, 100 Base-Tx, UTP, 125 Mb/s).ENET1250(IEEE Std 802.3 and ANSI X3.263-1995, GB Ethernet, 1.25 Gb/s).FC133(ANSI X3.230-1999 NCITS 1235D/Rev 11, Optical, 132.8 Mb/s).FC266(ANSI X3.230-1999 NCITS 1235D/Rev 11, Optical, 265.6 Mb/s).FC531(ANSI X3.230-1999 NCITS 1235D/Rev 11, Optical, 531.2 Mb/s).FC1063(ANSI X3.230-1999 NCITS 1235D/Rev 11, Optical, 1.065 Gb/s).FC1063Draft(ANSI X3.230-1999 NCITS 1235D/Rev 11, Optical, Draft Rev 11).FC2125(ANSI X3.230-1999 NCITS 1235D/Rev 11, Optical, 2.125).FC133E(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Electrical 132.8 Mb/s).FC266E(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Electrical, 132.8 Mb/s).FC531E(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Electrical, 531.2 Mb/s).FC1063E(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Electrical, 1.0625 Gb/s).FC1063E_NBT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Norm, Beta, Transm).FC1063E_NDT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Norm, Delta, Transm).FC1063E_NGT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Norm, Gamma, Transm).FC1063E_ABT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Beta, Transm).FC1063E_ADT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Beta, Transm).FC1063E_AGT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Gamma, Transm).FC1063E_ABR(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Beta, Recv).FC1063E_ADR(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Delta, Recv).FC1063E_AGR(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Gamma, Recv).FC2125E_NBT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Norm, Beta, Transm).FC2125E_NDT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Norm, Delta, Transm).FC2125E_NGT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Norm, Gamma, Transm).FC2125E_ABT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Beta, Transm).FC2125E_ADT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Delta, Transm).FC2125E_AGT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Gamma, Transm).FC2125E_ABR(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Beta, Recv).FC2125E_ADR(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Delta, Recv).FC2125E_AGR(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Gamma, Recv).ENET1000BCX_NTP2(1000B-CX Norm, TP2, 1.25 Gb/s).ENET1000BCX_ATP2(1000B-CX Abs, TP2, 1.25 Gb/s).ENET1000BCX_ATP3(1000B-CX Abs, TP3, 1.25 Gb/s).ENETXAUI_Near(10 Gigabit Attachment Unit Interface (XAUI), Near, 3,125 Gb/s).ENETXAUI_Far(10 Gigabit Attachment Unit Interface (XAUI), Far, 3.125 Gb/s).FST1(USB,FS:T1, 12 Mb/s).FST2(USB,FS:T2, 12 Mb/s).FST3(USB,FS:T3, 12 Mb/s).FST4(USB,FS:T4: 12 Mb/s).FST5(USB,FS:T5, 12 Mb/s).FST6(USB,FS:T6, 12 Mb/s).FW1394BS400BT1(IEEE 1394b, S400b T1, 491.5 Mb/s).FW1394BS400BT2(IEEE 1394b, S400b T2, 491.5 Mb/s).FW1394BS800BT1(IEEE 1394b, S800b T1, 983.0 Mb/s).FW1394BS800BT2(IEEE 1394b, S800b T2, 983.0 Mb/s).FW1394BS1600BT1(IEEE 1394b, S1600b T1, 1.966 Gb/s).FW1394BS1600BT2(IEEE 1394b, S1600b T2, 1.966 Gb/s).FW1394BS400B(IEEE 1394b, S400 Optical, 491.5 Mb/s).FW1394BS800B(IEEE 1394b, S800 Optical, 988.0 Mb/s).FW1394BS1600B(IEEE 1394b, S1600 Optical, 1.966 Gb/s).G703DS3(ITU-T, G703 (10/98)).HST1(USB,HS:T1, 480 Mb/s).HST2(USB,HS:T2, 480 Mb/s).HST3(USB,HS:T3, 480 Mb/s).HST4(USB,HS:T4, 480 Mb/s).HST5(USB,HS:T5, 480 Mb/s).HST6(USB,HS:T6, 480 Mb/s).INF2_5G(InfiniBand, IBTA Spec 1.0a, 2.5 Optical, 2.5 Gb/s).INF2_5GE(InfiniBand, IBTA Spec 1.0a, 2.5 Electrical, 2.5 Gb/s).OC1(GR 253-CORE Issue 3 9/21/2000 OC1/STM0, 51.84 Mb/s).OC3(GR 253-CORE Issue 3 9/21/2000 OC1/STM1, 155.52, Mb/s).OC12(GR 253-CORE Issue 3 9/21/2000 OC1/STM4, 622.08 Mb/s).OC48(GR 253-CORE Issue 3 9/21/2000 OC1/STM16, 2.4883 Gb/s.OC48_FEC(Forward Error Correction - CSA8000 mask, 2.666 Gb/s).PCIEXPRESS_Xmit(PCI Express Transmitter, 2.5 Gb/s).PCIEXPRESS_Rcv(PCI Express Receiver, 2.5 Gb/s).RATE97Mbit(ITU-T, G703 (10/98), 97 Mbit, 97.728 Mb/s).RIO_DRV500M(Rapid IO Driver, 500 Mb/s).RIO_DRV750M(Rapid IO Driver, 750 Mb/s).RIO_DRV1G(Rapid IO Driver, 1 Gb/s).RIO_DRV1_5G(Rapid IO Driver, 5 Gb/s).RIO_DRV2G(Rapid IO Driver, 2 Gb/s).RIO_EDRV500M(Rapid IO Extended Driver, 500 Mb/s).RIO_EDRV750M(Rapid IO Extended Driver, 750 Mb/s).RIO_EDRV1G(Rapid IO Extended Driver, 1 Gb/s).RIO_EDRV1_5G(Rapid IO Extended Driver, 1.5 Gb/s).RIO_EDRV2G(Rapid IO Extended Driver, 2 Gb/s).RIO_RCV500M(Rapid IO Receiver, 500 Mb/s).RIO_RCV750M(Rapid IO Receiver, 750 Mb/s).RIO_RCV1G(Rapid IO Receiver, 1 Gb/s).RIO_RCV1_5G(Rapid IO Receiver, 1.5 Gb/s).RIO_RCV2G(Rapid IO Receiver, 2 Gb/s).RIO_SERIAL_1G(Rapid IO Serial, 1.25 Gb/s).RIO_SERIAL_2G(Rapid IO Serial, 2.5 Gb/s).RIO_SERIAL_3G(Rapid IO Serial, 3.25 Gb/s).SFI5_XMITADATA2(SFI15 Transmit: Test Point A Data Signal 2, 2.488 Gb/s).SFI5_XMITCDATA2(SFI15 Transmit: Test Point C Data Signal 2, 2.488 Gb/s).SFI5_XMITACLK2(SFI15 Transmit: Test Point A Clock Signal 2, 2.488 Gb/s).SFI5_XMITCCLK2(SFI15 Transmit: Test Point C Clock Signal 2, 2.488 Gb/s).SFI5_RCVBDATA2(SFI15 Receive: Test Point B Data Signal 2, 2.488 Gb/s).SFI5_RCVDDATA2(SFI15 Receive: Test Point D Data Signal 2, 2.488 Gb/s).SFI5_RCVBCLK2(SFI15 Receive: Test Point B Clock Signal 2, 2.488 Gb/s).SFI5_RCVDCLK2(SFI15 Receive: Test Point D Clock Signal 2, 2.488 Gb/s).SFI5_XMITADATA3(SFI15 Transmit: Test Point A Data Signal 3, 3.125 Gb/s).SFI5_XMITCDATA3(SFI15 Transmit: Test Point C Data Signal 3, 3.125 Gb/s).SFI5_XMITACLK3(SFI15 Transmit: Test Point A Clock Signal 3, 3.125 Gb/s).SFI5_XMITCCLK3(SFI15 Transmit: Test Point C Clock Signal 3, 3.125 Gb/s).SFI5_RCVBDATA3(SFI15 Receive: Test Point B Data Signal 3, 3.125 Gb/s).SFI5_RCVDDATA3(SFI15 Receive: Test Point D Data Signal 3, 3.125 Gb/s).SFI5_RCVBCLK3(SFI15 Receive: Test Point B Clock Signal 3, 3.125 Gb/s).SFI5_RCVDCLK3(SFI15 Receive: Test Point D Clock Signal 3, 3.125 Gb/s.STM1E_0(ITU-T, G703 (10/98), STM1E Binary 0).STM1E_1(ITU-T, G703 (10/98), STM1E Binary 1).STS1Pulse(ANSI T1.102-1993 (R1999), STS-1 Pulse, 51.84 Mb/s).STS1Eye(ANSI T1.102-1993 (R1999), STS-1 Eye, 51.84 Mb/s).STS3(ANSI T1.102-1993 (R1999), STS-3, 155.52 Mb/s).STS3_Max(ANSI T1.102-1993 (R1999), STS-3 Max Output, 155.52 Mb/s).TFI15_2(TFI-5, 2.488 Gb/s).TFI5_3(TFI-5, 3.1104 Gb/s).USERMaskVIDEO292M(SMPTE, 1.485 Gb/s).VSROC192(VSR OC192/STM64, 1.24416 Gb/s).
trigger
property
¶
trigger: MaskAutosetTrigger
Return the MASK:AUTOSet:TRIGger command.
Description
- This command specifies whether a mask AUTOSET affects the trigger level. Other trigger settings such as type of trigger are not changed by autoset. The default is ON. This command, like all the mask autoset commands, affects only an autoset on a standard mask, not the general instrument autoset function.
Usage
- Using the
.query()method will send theMASK:AUTOSet:TRIGger?query. - Using the
.verify(value)method will send theMASK:AUTOSet:TRIGger?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:AUTOSet:TRIGger valuecommand.
SCPI Syntax
- MASK:AUTOSet:TRIGger {ON|OFF|<NR1>}
- MASK:AUTOSet:TRIGger?
Info
<NR1>= 0 disables theautoset:triggerfunction; any other value enables it.ONenables theautoset:triggerfunction.OFFdisables theautoset:triggerfunction.
user
property
¶
user: MaskAutosetUser
Return the MASK:AUTOSet:USER command tree.
Usage
- Using the
.query()method will send theMASK:AUTOSet:USER?query. - Using the
.verify(value)method will send theMASK:AUTOSet:USER?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.one: TheMASK:AUTOSet:USER:ONEcommand..type: TheMASK:AUTOSet:USER:TYPecommand..zero: TheMASK:AUTOSet:USER:ZERocommand.
vpos
property
¶
vpos: MaskAutosetVpos
Return the MASK:AUTOSet:VPOS command.
Description
- This command controls whether the mask autoset algorithm will affect the vertical position (or offset) of the signal while attempting to autoset. The default is ON. This command, like all the mask autoset commands, affects only an autoset on a standard mask, not the general instrument autoset function.
Usage
- Using the
.query()method will send theMASK:AUTOSet:VPOS?query. - Using the
.verify(value)method will send theMASK:AUTOSet:VPOS?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:AUTOSet:VPOS valuecommand.
SCPI Syntax
- MASK:AUTOSet:VPOS {ON|OFF|<NR1>}
- MASK:AUTOSet:VPOS?
Info
<NR1>= 0 disables theautoset:vposfunction; any other value enables it.ONenables theautoset:vposfunction.OFFdisables theautoset:vposfunction.
vscale
property
¶
vscale: MaskAutosetVscale
Return the MASK:AUTOSet:VSCAle command.
Description
- This command controls whether the mask autoset algorithm will affect the vertical scale while attempting to autoset. This command, like all the mask autoset commands, affects only an autoset on a standard mask, not the general instrument autoset function.
Usage
- Using the
.query()method will send theMASK:AUTOSet:VSCAle?query. - Using the
.verify(value)method will send theMASK:AUTOSet:VSCAle?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:AUTOSet:VSCAle valuecommand.
SCPI Syntax
- MASK:AUTOSet:VSCAle {ON|OFF|<NR1>}
- MASK:AUTOSet:VSCAle?
Info
<NR1>= 0 disables theautoset:vscalefunction; any other value enables it.ONenables theautoset:vscalefunction.OFFdisables theautoset:vscalefunction.
MaskAutosetAutoadjust
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:AUTOSet:AUTOAdjust command.
Description
- This command sets or returns whether the instrument settings are automatically matched to
signal characteristics and specific mask requirements. It controls what happens at the end
of a mask autoset. If ON, the horz/vert auto adjustment is run ONCE to potentially improve
the result of mask autoset. This command, like all the
MASK:AUTOSETcommands, affects only an autoset on a standard mask, not the general instrument autoset function.
Usage
- Using the
.query()method will send theMASK:AUTOSet:AUTOAdjust?query. - Using the
.verify(value)method will send theMASK:AUTOSet:AUTOAdjust?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:AUTOSet:AUTOAdjust valuecommand.
SCPI Syntax
- MASK:AUTOSet:AUTOAdjust {ON|OFF|<NR1>}
- MASK:AUTOSet:AUTOAdjust?
Info
<NR1>= 0 disables theautoset:autoadjustfunction; any other value enables it.ONenables theautoset:autoadjustfunction.OFFdisables theautoset:autoadjustfunction.
MaskAutosetHpos
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:AUTOSet:HPOS command.
Description
- This command controls whether the autoset algorithm will attempt to change the horizontal
position of the signal while attempting to do a mask autoset. The default is ON. This
command, like all the
MASK:AUTOSETcommands, affects only an autoset on a standard mask, not the general instrument autoset function.
Usage
- Using the
.query()method will send theMASK:AUTOSet:HPOS?query. - Using the
.verify(value)method will send theMASK:AUTOSet:HPOS?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:AUTOSet:HPOS valuecommand.
SCPI Syntax
- MASK:AUTOSet:HPOS {ON|OFF|<NR1>}
- MASK:AUTOSet:HPOS?
Info
<NR1>= 0 disables theautoset:hposfunction; any other value disables enables it.ONenables theautoset:hposfunction.OFFdisables theautoset:hposfunction.
MaskAutosetHscale
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:AUTOSet:HSCAle command.
Description
- This command controls whether the autoset algorithm will attempt to change the horizontal
scale while attempting a mask autoset. This command, like all the
MASK:AUTOSETcommands, affects only an autoset on a standard mask, not the general instrument autoset function.
Usage
- Using the
.query()method will send theMASK:AUTOSet:HSCAle?query. - Using the
.verify(value)method will send theMASK:AUTOSet:HSCAle?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:AUTOSet:HSCAle valuecommand.
SCPI Syntax
- MASK:AUTOSet:HSCAle {ON|OFF|<NR1>}
- MASK:AUTOSet:HSCAle?
Info
<NR1>= 0 disables theautoset:hscalefunction; any other value enables it.ONenables theautoset:hscalefunction.OFFdisables theautoset:hscalefunction.
MaskAutosetMode
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:AUTOSet:MODe command.
Description
- This command controls whether a mask autoset will be automatically done after a standard
mask is selected. The autoset will never happen if the standard mask is selected from
GPIB, since a ‘SET?’ sent back to the oscilloscope should not perform a mask autoset. The
default value is: manual. This command, like all the
MASK:AUTOSETcommands, affects only an autoset on a standard mask, not the general instrument autoset function.
Usage
- Using the
.query()method will send theMASK:AUTOSet:MODe?query. - Using the
.verify(value)method will send theMASK:AUTOSet:MODe?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:AUTOSet:MODe valuecommand.
SCPI Syntax
- MASK:AUTOSet:MODe {MANual|AUTO}
- MASK:AUTOSet:MODe?
Info
MANualmask autoset is set manually.AUTOmask autoset is set automatically.
MaskAutosetOffsetadj
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:AUTOSet:OFFSETAdj command.
Description
- This command sets mask autoset not to enforce the rule that, for pulse standards, require
0 V to be in a certain place in the mask. Instead, mask autoset will attempt to measure
the DC offse t in the signal and use oscilloscope offset or position controls to
compensate for the DC offset in the signal. This command, like all the
MASK:AUTOSETcommands, affects only an autoset on a standard mask, not the general instrument autoset function.
Usage
- Using the
.query()method will send theMASK:AUTOSet:OFFSETAdj?query. - Using the
.verify(value)method will send theMASK:AUTOSet:OFFSETAdj?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:AUTOSet:OFFSETAdj valuecommand.
SCPI Syntax
- MASK:AUTOSet:OFFSETAdj {ON|OFF|<NR1>}
- MASK:AUTOSet:OFFSETAdj?
Info
<NR1>= 0 disables theautoset:offsetadjfunction; any other value enables it.ONenables theautoset:offsetadjfunction.OFFdisables theautoset:offsetadjfunction.
MaskAutosetStandard
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:AUTOSet:STANdard command.
Description
- This command selects the standard mask in a mask autoset. This command, like all the
MASK:AUTOSETcommands, affects only an autoset on a standard mask, not the general instrument autoset function.
Usage
- Using the
.query()method will send theMASK:AUTOSet:STANdard?query. - Using the
.verify(value)method will send theMASK:AUTOSet:STANdard?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:AUTOSet:STANdard valuecommand.
SCPI Syntax
- MASK:AUTOSet:STANdard {ATATXG<x>|ATARXG<x>|CLOCKCoax|CLOCKSymmetrical|D<x>|DS0Contra|DS0Double|DS0Single|DS0Timing|DS1|DS1A|DS1C|DS2RATESymmetrical|DS2RATECoax|DS2|DS3|DS4NA|DS4NA_Max|E1Symmetrical|E1Coax|E2|E3|E4_0|E4_1|ENET100FX|ENET100STP|ENET100UTP|ENET1250|ENET1000BCX_NTP2|ENET1000BCX_ATP2|ENET1000BCX_ATP3|ENETXAUI_Near|ENETXAUI_Far|FC133|FC266|FC531|FC1063|FC1063Draft|FC2125|FC133E|FC266E|FC531E|FC1063E|FC1063E_NBT|FC1063E_NDT|FC1063E_NGT|FC1063E_ABT|FC1063E_ADT|FC1063E_AGT|FC1063E_ABR|FC1063E_ADR|FC1063E_AGR|FC2125E_NBT|FC2125E_NDT|FC2125E_NGT|FC2125E_ABT|FC2125E_ADT|FC2125E_AGT|FC2125E_ABR|FC2125E_ADR|FC2125E_AGR|FC4250E_ABR|FC4250E_ABT|FC4250E_ADR|FC4250E_ADT|FC4250E_AGR|FC4250E_AGT|FC4250E_NBT|FC4250E_NDT|FC4250E_NGT|FST1|FST2|FST3|FST4|FST5|FST6|FW1394BS400BT1|FW1394BS400BT2|FW1394BS800BT1|FW1394BS800BT2|FW1394BS1600BT1|FW1394BS1600BT2|FW1394BS400B|FW1394BS800B|FW1394BS1600B|G703DS1|G703DS3|HST<x>|INF2_5G|INF2_5GE|NONe|OC1|OC3|OC12|OC48|OC48_FEC|RATE32Mbit|RATE97Mbit|RIO_DRV500M|RIO_DRV750M|RIO_DRV1G|RIO_DRV1_5G|RIO_DRV2G|RIO_EDRV500M|RIO_EDRV750M|RIO_EDRV1G|RIO_EDRV1_5G|RIO_EDRV2G|RIO_RCV500M|RIO_RCV750M|RIO_RCV1G|RIO_RCV1_5G|RIO_RCV2G|RIO_SERIAL_1G|RIO_SERIAL_2G|RIO_SERIAL_3G|SFI5_XMITADATA2|SFI5_XMITCDATA2|SFI5_XMITACLK2|SFI5_XMITCCLK2|SFI5_RCVBDATA2|SFI5_RCVDDATA2|SFI5_RCVBCLK2|SFI5_RCVDCLK2|SFI5_XMITADATA3|SFI5_XMITCDATA3|SFI5_XMITACLK3|SFI5_XMITCCLK3|SFI5_RCVBDATA3|SFI5_RCVDDATA3|SFI5_RCVBCLK3|SFI5_RCVDCLK3|PCIEXPRESS_Xmit|PCIEXPRESS_Rcv|SAS1_5_IR|SAS1_5_CR|SAS1_5_XR|SAS1_5_IR_AASJ|SAS1_5_CR_AASJ|SAS1_5_XR_AASJ|SAS1_5_SATA|SAS3_0_IR|SAS3_0_CR|SAS3_0_XR|SAS3_0_IR_AASJ|SAS3_0_CR_AASJ|SAS3_0_XR_AASJ|SAS3_0_SATA|STM0_1|STM0_0|STM0_HDBX|STM1E_0|STM1E_1|STS1Pulse|STS1Eye|STS3|STS3_Max|TFI5_2|TFI5_3|USERMask|VIDEO270|VIDEO292M|VIDEO360|VSROC192}
- MASK:AUTOSet:STANdard?
Info
ATATXG1(Serial ATA, G1 Tx, 1.5 Gb/s).ATATXG2(Serial ATA, G2 Tx, 3.0 Gb/s).ATATXG3(Serial ATA, G3 Tx).ATARXG1(Serial ATA, G1 Rx 1.5 Gb/s).ATARXG2(Serial ATA, G2, Rx, 3.0 Gb/s).ATARXG3(Serial ATA, G3, Rx).G703D1(ITU-T, G703 (10/98), DS1 Rate, 1.544 Mb/s).DS1(ANSI T1.102-1993 (R1999), DS1, 1.544 Mb/s).DS1A(ANSI T1.102-1993 (R1999), DS1A, 2.048 Mb/s).DS1C(ANSI T1.102-1993 (R1999), DS1C, 3.152 Mb/s).DS2(ANSI T1.102-1993 (R1999), DS2, 6.312 Mb/s).DS3(ANSI T1.102-1993 (R1999), DS3, 44.736 Mb/s).DS4NA(ANSI T1.102-1993 (R1999), DS4NA, 139.26 Mb/s).DS4NA_Max(ANSI T1.102-1993 (R1999), DSNA Max Output, 139.26 Mb/s).DS2RATECoax(ITU-T, G703 (10/98), D2 Rate Coax, 6.312 Mb/s).DS2RATESymmetrical(ITU-T, G703 (10/98), D2 Rate Sym, 6.312 Mb/s).E1Coax(ITU-T, G703 (10/98), E1 Coax Pair, 2.048 Mb/s).E1Symmetrical(ITU-T, G703 (10/98), E1 Sym Pair, 2.048 Mb/s).E2(ITU-T, G703 (10/98), 8.448 Mb/s).RATE32Mbit(ITU-T, G703 (10/98), 32.064 Mb/s).E3(ITU-T, G703 (10/98), E3, 34.368 Mb/s).E4_0(ITU-T, G703 (10/98), E4 Binary 0).E4_1(ITU-T, G703 (10/98), E4 Binary 1).ENET100STP(IEEE Std 802.3 and ANSI X3.263-1995, 100 Base-Tx, STP, 125 Mb/s ).ENET100UTP(IEEE Std 802.3 and ANSI X3.263-1995, 100 Base-Tx, UTP, 125 Mb/s).ENET1250(IEEE Std 802.3 and ANSI X3.263-1995, GB Ethernet, 1.25 Gb/s).FC133(ANSI X3.230-1999 NCITS 1235D/Rev 11, Optical, 132.8 Mb/s).FC266(ANSI X3.230-1999 NCITS 1235D/Rev 11, Optical, 265.6 Mb/s).FC531(ANSI X3.230-1999 NCITS 1235D/Rev 11, Optical, 531.2 Mb/s).FC1063(ANSI X3.230-1999 NCITS 1235D/Rev 11, Optical, 1.065 Gb/s).FC1063Draft(ANSI X3.230-1999 NCITS 1235D/Rev 11, Optical, Draft Rev 11).FC2125(ANSI X3.230-1999 NCITS 1235D/Rev 11, Optical, 2.125).FC133E(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Electrical 132.8 Mb/s).FC266E(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Electrical, 132.8 Mb/s).FC531E(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Electrical, 531.2 Mb/s).FC1063E(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Electrical, 1.0625 Gb/s).FC1063E_NBT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Norm, Beta, Transm).FC1063E_NDT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Norm, Delta, Transm).FC1063E_NGT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Norm, Gamma, Transm).FC1063E_ABT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Beta, Transm).FC1063E_ADT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Beta, Transm).FC1063E_AGT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Gamma, Transm).FC1063E_ABR(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Beta, Recv).FC1063E_ADR(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Delta, Recv).FC1063E_AGR(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Gamma, Recv).FC2125E_NBT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Norm, Beta, Transm).FC2125E_NDT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Norm, Delta, Transm).FC2125E_NGT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Norm, Gamma, Transm).FC2125E_ABT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Beta, Transm).FC2125E_ADT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Delta, Transm).FC2125E_AGT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Gamma, Transm).FC2125E_ABR(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Beta, Recv).FC2125E_ADR(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Delta, Recv).FC2125E_AGR(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Gamma, Recv).ENET1000BCX_NTP2(1000B-CX Norm, TP2, 1.25 Gb/s).ENET1000BCX_ATP2(1000B-CX Abs, TP2, 1.25 Gb/s).ENET1000BCX_ATP3(1000B-CX Abs, TP3, 1.25 Gb/s).ENETXAUI_Near(10 Gigabit Attachment Unit Interface (XAUI), Near, 3,125 Gb/s).ENETXAUI_Far(10 Gigabit Attachment Unit Interface (XAUI), Far, 3.125 Gb/s).FST1(USB,FS:T1, 12 Mb/s).FST2(USB,FS:T2, 12 Mb/s).FST3(USB,FS:T3, 12 Mb/s).FST4(USB,FS:T4: 12 Mb/s).FST5(USB,FS:T5, 12 Mb/s).FST6(USB,FS:T6, 12 Mb/s).FW1394BS400BT1(IEEE 1394b, S400b T1, 491.5 Mb/s).FW1394BS400BT2(IEEE 1394b, S400b T2, 491.5 Mb/s).FW1394BS800BT1(IEEE 1394b, S800b T1, 983.0 Mb/s).FW1394BS800BT2(IEEE 1394b, S800b T2, 983.0 Mb/s).FW1394BS1600BT1(IEEE 1394b, S1600b T1, 1.966 Gb/s).FW1394BS1600BT2(IEEE 1394b, S1600b T2, 1.966 Gb/s).FW1394BS400B(IEEE 1394b, S400 Optical, 491.5 Mb/s).FW1394BS800B(IEEE 1394b, S800 Optical, 988.0 Mb/s).FW1394BS1600B(IEEE 1394b, S1600 Optical, 1.966 Gb/s).G703DS3(ITU-T, G703 (10/98)).HST1(USB,HS:T1, 480 Mb/s).HST2(USB,HS:T2, 480 Mb/s).HST3(USB,HS:T3, 480 Mb/s).HST4(USB,HS:T4, 480 Mb/s).HST5(USB,HS:T5, 480 Mb/s).HST6(USB,HS:T6, 480 Mb/s).INF2_5G(InfiniBand, IBTA Spec 1.0a, 2.5 Optical, 2.5 Gb/s).INF2_5GE(InfiniBand, IBTA Spec 1.0a, 2.5 Electrical, 2.5 Gb/s).OC1(GR 253-CORE Issue 3 9/21/2000 OC1/STM0, 51.84 Mb/s).OC3(GR 253-CORE Issue 3 9/21/2000 OC1/STM1, 155.52, Mb/s).OC12(GR 253-CORE Issue 3 9/21/2000 OC1/STM4, 622.08 Mb/s).OC48(GR 253-CORE Issue 3 9/21/2000 OC1/STM16, 2.4883 Gb/s.OC48_FEC(Forward Error Correction - CSA8000 mask, 2.666 Gb/s).PCIEXPRESS_Xmit(PCI Express Transmitter, 2.5 Gb/s).PCIEXPRESS_Rcv(PCI Express Receiver, 2.5 Gb/s).RATE97Mbit(ITU-T, G703 (10/98), 97 Mbit, 97.728 Mb/s).RIO_DRV500M(Rapid IO Driver, 500 Mb/s).RIO_DRV750M(Rapid IO Driver, 750 Mb/s).RIO_DRV1G(Rapid IO Driver, 1 Gb/s).RIO_DRV1_5G(Rapid IO Driver, 5 Gb/s).RIO_DRV2G(Rapid IO Driver, 2 Gb/s).RIO_EDRV500M(Rapid IO Extended Driver, 500 Mb/s).RIO_EDRV750M(Rapid IO Extended Driver, 750 Mb/s).RIO_EDRV1G(Rapid IO Extended Driver, 1 Gb/s).RIO_EDRV1_5G(Rapid IO Extended Driver, 1.5 Gb/s).RIO_EDRV2G(Rapid IO Extended Driver, 2 Gb/s).RIO_RCV500M(Rapid IO Receiver, 500 Mb/s).RIO_RCV750M(Rapid IO Receiver, 750 Mb/s).RIO_RCV1G(Rapid IO Receiver, 1 Gb/s).RIO_RCV1_5G(Rapid IO Receiver, 1.5 Gb/s).RIO_RCV2G(Rapid IO Receiver, 2 Gb/s).RIO_SERIAL_1G(Rapid IO Serial, 1.25 Gb/s).RIO_SERIAL_2G(Rapid IO Serial, 2.5 Gb/s).RIO_SERIAL_3G(Rapid IO Serial, 3.25 Gb/s).SFI5_XMITADATA2(SFI15 Transmit: Test Point A Data Signal 2, 2.488 Gb/s).SFI5_XMITCDATA2(SFI15 Transmit: Test Point C Data Signal 2, 2.488 Gb/s).SFI5_XMITACLK2(SFI15 Transmit: Test Point A Clock Signal 2, 2.488 Gb/s).SFI5_XMITCCLK2(SFI15 Transmit: Test Point C Clock Signal 2, 2.488 Gb/s).SFI5_RCVBDATA2(SFI15 Receive: Test Point B Data Signal 2, 2.488 Gb/s).SFI5_RCVDDATA2(SFI15 Receive: Test Point D Data Signal 2, 2.488 Gb/s).SFI5_RCVBCLK2(SFI15 Receive: Test Point B Clock Signal 2, 2.488 Gb/s).SFI5_RCVDCLK2(SFI15 Receive: Test Point D Clock Signal 2, 2.488 Gb/s).SFI5_XMITADATA3(SFI15 Transmit: Test Point A Data Signal 3, 3.125 Gb/s).SFI5_XMITCDATA3(SFI15 Transmit: Test Point C Data Signal 3, 3.125 Gb/s).SFI5_XMITACLK3(SFI15 Transmit: Test Point A Clock Signal 3, 3.125 Gb/s).SFI5_XMITCCLK3(SFI15 Transmit: Test Point C Clock Signal 3, 3.125 Gb/s).SFI5_RCVBDATA3(SFI15 Receive: Test Point B Data Signal 3, 3.125 Gb/s).SFI5_RCVDDATA3(SFI15 Receive: Test Point D Data Signal 3, 3.125 Gb/s).SFI5_RCVBCLK3(SFI15 Receive: Test Point B Clock Signal 3, 3.125 Gb/s).SFI5_RCVDCLK3(SFI15 Receive: Test Point D Clock Signal 3, 3.125 Gb/s.STM1E_0(ITU-T, G703 (10/98), STM1E Binary 0).STM1E_1(ITU-T, G703 (10/98), STM1E Binary 1).STS1Pulse(ANSI T1.102-1993 (R1999), STS-1 Pulse, 51.84 Mb/s).STS1Eye(ANSI T1.102-1993 (R1999), STS-1 Eye, 51.84 Mb/s).STS3(ANSI T1.102-1993 (R1999), STS-3, 155.52 Mb/s).STS3_Max(ANSI T1.102-1993 (R1999), STS-3 Max Output, 155.52 Mb/s).TFI15_2(TFI-5, 2.488 Gb/s).TFI5_3(TFI-5, 3.1104 Gb/s).USERMaskVIDEO292M(SMPTE, 1.485 Gb/s).VSROC192(VSR OC192/STM64, 1.24416 Gb/s).
MaskAutosetTrigger
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:AUTOSet:TRIGger command.
Description
- This command specifies whether a mask AUTOSET affects the trigger level. Other trigger settings such as type of trigger are not changed by autoset. The default is ON. This command, like all the mask autoset commands, affects only an autoset on a standard mask, not the general instrument autoset function.
Usage
- Using the
.query()method will send theMASK:AUTOSet:TRIGger?query. - Using the
.verify(value)method will send theMASK:AUTOSet:TRIGger?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:AUTOSet:TRIGger valuecommand.
SCPI Syntax
- MASK:AUTOSet:TRIGger {ON|OFF|<NR1>}
- MASK:AUTOSet:TRIGger?
Info
<NR1>= 0 disables theautoset:triggerfunction; any other value enables it.ONenables theautoset:triggerfunction.OFFdisables theautoset:triggerfunction.
MaskAutosetUser
¶
Bases: SCPICmdRead
The MASK:AUTOSet:USER command tree.
Usage
- Using the
.query()method will send theMASK:AUTOSet:USER?query. - Using the
.verify(value)method will send theMASK:AUTOSet:USER?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.one: TheMASK:AUTOSet:USER:ONEcommand..type: TheMASK:AUTOSet:USER:TYPecommand..zero: TheMASK:AUTOSet:USER:ZERocommand.
one
property
¶
one: MaskAutosetUserOne
Return the MASK:AUTOSet:USER:ONE command.
Description
- This command sets or queries the level 1 value used by autoset for user masks.
Usage
- Using the
.query()method will send theMASK:AUTOSet:USER:ONE?query. - Using the
.verify(value)method will send theMASK:AUTOSet:USER:ONE?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:AUTOSet:USER:ONE valuecommand.
SCPI Syntax
- MASK:AUTOSet:USER:ONE <NR3>
- MASK:AUTOSet:USER:ONE?
Info
<NR3>sets the level 1 value used by autoset for user masks.
type
property
¶
type: MaskAutosetUserType
Return the MASK:AUTOSet:USER:TYPe command.
Description
- This command sets or queries how autoset scales a mask.
Usage
- Using the
.query()method will send theMASK:AUTOSet:USER:TYPe?query. - Using the
.verify(value)method will send theMASK:AUTOSet:USER:TYPe?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:AUTOSet:USER:TYPe valuecommand.
SCPI Syntax
- MASK:AUTOSet:USER:TYPe {ABSolute|NORMALIZed}
- MASK:AUTOSet:USER:TYPe?
Info
ABSOLUTEtells autoset to use the values supplied byMASK:AUTOSET:USER:ONEandMASK:AUTOSET:USER:ZEROfor the one and zero of the mask.NORMALIZEDtells autoset to determine the mask one and zero by looking at the mask.
zero
property
¶
zero: MaskAutosetUserZero
Return the MASK:AUTOSet:USER:ZERo command.
Description
- This command sets or queries the level 0 used by autoset for user masks.
Usage
- Using the
.query()method will send theMASK:AUTOSet:USER:ZERo?query. - Using the
.verify(value)method will send theMASK:AUTOSet:USER:ZERo?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:AUTOSet:USER:ZERo valuecommand.
SCPI Syntax
- MASK:AUTOSet:USER:ZERo <NR3>
- MASK:AUTOSet:USER:ZERo?
Info
<NR3>sets the zero level that autoset uses for user masks.
MaskAutosetUserOne
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:AUTOSet:USER:ONE command.
Description
- This command sets or queries the level 1 value used by autoset for user masks.
Usage
- Using the
.query()method will send theMASK:AUTOSet:USER:ONE?query. - Using the
.verify(value)method will send theMASK:AUTOSet:USER:ONE?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:AUTOSet:USER:ONE valuecommand.
SCPI Syntax
- MASK:AUTOSet:USER:ONE <NR3>
- MASK:AUTOSet:USER:ONE?
Info
<NR3>sets the level 1 value used by autoset for user masks.
MaskAutosetUserType
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:AUTOSet:USER:TYPe command.
Description
- This command sets or queries how autoset scales a mask.
Usage
- Using the
.query()method will send theMASK:AUTOSet:USER:TYPe?query. - Using the
.verify(value)method will send theMASK:AUTOSet:USER:TYPe?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:AUTOSet:USER:TYPe valuecommand.
SCPI Syntax
- MASK:AUTOSet:USER:TYPe {ABSolute|NORMALIZed}
- MASK:AUTOSet:USER:TYPe?
Info
ABSOLUTEtells autoset to use the values supplied byMASK:AUTOSET:USER:ONEandMASK:AUTOSET:USER:ZEROfor the one and zero of the mask.NORMALIZEDtells autoset to determine the mask one and zero by looking at the mask.
MaskAutosetUserZero
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:AUTOSet:USER:ZERo command.
Description
- This command sets or queries the level 0 used by autoset for user masks.
Usage
- Using the
.query()method will send theMASK:AUTOSet:USER:ZERo?query. - Using the
.verify(value)method will send theMASK:AUTOSet:USER:ZERo?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:AUTOSet:USER:ZERo valuecommand.
SCPI Syntax
- MASK:AUTOSet:USER:ZERo <NR3>
- MASK:AUTOSet:USER:ZERo?
Info
<NR3>sets the zero level that autoset uses for user masks.
MaskAutosetVpos
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:AUTOSet:VPOS command.
Description
- This command controls whether the mask autoset algorithm will affect the vertical position (or offset) of the signal while attempting to autoset. The default is ON. This command, like all the mask autoset commands, affects only an autoset on a standard mask, not the general instrument autoset function.
Usage
- Using the
.query()method will send theMASK:AUTOSet:VPOS?query. - Using the
.verify(value)method will send theMASK:AUTOSet:VPOS?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:AUTOSet:VPOS valuecommand.
SCPI Syntax
- MASK:AUTOSet:VPOS {ON|OFF|<NR1>}
- MASK:AUTOSet:VPOS?
Info
<NR1>= 0 disables theautoset:vposfunction; any other value enables it.ONenables theautoset:vposfunction.OFFdisables theautoset:vposfunction.
MaskAutosetVscale
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:AUTOSet:VSCAle command.
Description
- This command controls whether the mask autoset algorithm will affect the vertical scale while attempting to autoset. This command, like all the mask autoset commands, affects only an autoset on a standard mask, not the general instrument autoset function.
Usage
- Using the
.query()method will send theMASK:AUTOSet:VSCAle?query. - Using the
.verify(value)method will send theMASK:AUTOSet:VSCAle?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:AUTOSet:VSCAle valuecommand.
SCPI Syntax
- MASK:AUTOSet:VSCAle {ON|OFF|<NR1>}
- MASK:AUTOSet:VSCAle?
Info
<NR1>= 0 disables theautoset:vscalefunction; any other value enables it.ONenables theautoset:vscalefunction.OFFdisables theautoset:vscalefunction.
MaskCopy
¶
Bases: SCPICmdRead
The MASK:COPy command tree.
Usage
- Using the
.query()method will send theMASK:COPy?query. - Using the
.verify(value)method will send theMASK:COPy?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.user: TheMASK:COPy:USERcommand.
user
property
¶
user: MaskCopyUser
Return the MASK:COPy:USER command.
Description
- This creates a user-defined custom mask by making a copy of the source mask that was specified prior with the command . The source mask could be a standard, limit or another custom mask. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.write()method will send theMASK:COPy:USERcommand.
SCPI Syntax
- MASK:COPy:USER
MaskCopyUser
¶
Bases: SCPICmdWriteNoArguments
The MASK:COPy:USER command.
Description
- This creates a user-defined custom mask by making a copy of the source mask that was specified prior with the command . The source mask could be a standard, limit or another custom mask. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.write()method will send theMASK:COPy:USERcommand.
SCPI Syntax
- MASK:COPy:USER
MaskCount
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:COUNt command.
Description
- This command resets to zero the number of hits and failures for all mask segments. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.write(value)method will send theMASK:COUNt valuecommand.
SCPI Syntax
- MASK:COUNt RESET
Properties
.failures: TheMASK:COUNt:FAILUREScommand..hits: TheMASK:COUNt:HITScommand..seg: TheMASK:COUNt:SEG<m>command tree..state: TheMASK:COUNt:STATEcommand..tests: TheMASK:COUNt:TESTScommand..total: TheMASK:COUNt:TOTalcommand..violations: TheMASK:COUNt:VIOLATIONScommand..waveforms: TheMASK:COUNt:WAVEFORMScommand.
failures
property
¶
failures: MaskCountFailures
Return the MASK:COUNt:FAILURES command.
Description
- This query returns the number of pass/fail mask tests that have failed. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:COUNt:FAILURES?query. - Using the
.verify(value)method will send theMASK:COUNt:FAILURES?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MASK:COUNt:FAILURES?
hits
property
¶
hits: MaskCountHits
Return the MASK:COUNt:HITS command.
Description
- This query returns the sum of all hits in all mask segments. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:COUNt:HITS?query. - Using the
.verify(value)method will send theMASK:COUNt:HITS?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MASK:COUNt:HITS?
seg
property
¶
seg: dict[int, MaskCountSegItem]
Return the MASK:COUNt:SEG<m> command tree.
Usage
- Using the
.query()method will send theMASK:COUNt:SEG<m>?query. - Using the
.verify(value)method will send theMASK:COUNt:SEG<m>?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.hits: TheMASK:COUNt:SEG<m>:HITScommand.
state
property
¶
state: MaskCountState
Return the MASK:COUNt:STATE command.
Description
- This command sets or queries the mask hits count state; it controls whether mask
counting is being done.
MASK:DISPLAYmust be ON to enableMASK:COUNt:STATEto count mask violations.
Usage
- Using the
.query()method will send theMASK:COUNt:STATE?query. - Using the
.verify(value)method will send theMASK:COUNt:STATE?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:COUNt:STATE valuecommand.
SCPI Syntax
- MASK:COUNt:STATE {ON|OFF|<NR1>}
- MASK:COUNt:STATE?
Info
<NR1>= 0 turns off mask hit counting, and other values turn on mask hit counting.ONturns on mask counting.OFFturns off mask counting. This is the default state.
tests
property
¶
tests: MaskCountTests
Return the MASK:COUNt:TESTS command.
Description
- This query returns the number of pass/fail mask tests that have occurred. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:COUNt:TESTS?query. - Using the
.verify(value)method will send theMASK:COUNt:TESTS?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MASK:COUNt:TESTS?
total
property
¶
total: MaskCountTotal
Return the MASK:COUNt:TOTal command.
Description
- This query-only command returns the sum of all hits in all mask segments. This command
is the same as
MASK:COUNT:HITS?and is kept for compatibility with other Tektronix instruments.
Usage
- Using the
.query()method will send theMASK:COUNt:TOTal?query. - Using the
.verify(value)method will send theMASK:COUNt:TOTal?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MASK:COUNt:TOTal?
violations
property
¶
violations: MaskCountViolations
Return the MASK:COUNt:VIOLATIONS command.
Description
- This query returns the number of test violations that have occurred in the current mask pass/fail test. A test violation occurs when any part of a waveform falls within any mask segment. The default is 0. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:COUNt:VIOLATIONS?query. - Using the
.verify(value)method will send theMASK:COUNt:VIOLATIONS?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MASK:COUNt:VIOLATIONS?
waveforms
property
¶
waveforms: MaskCountWaveforms
Return the MASK:COUNt:WAVEFORMS command.
Description
- This query returns the number of waveforms that have been acquired and processed during pass/fail mask testing. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:COUNt:WAVEFORMS?query. - Using the
.verify(value)method will send theMASK:COUNt:WAVEFORMS?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MASK:COUNt:WAVEFORMS?
MaskCountFailures
¶
Bases: SCPICmdRead
The MASK:COUNt:FAILURES command.
Description
- This query returns the number of pass/fail mask tests that have failed. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:COUNt:FAILURES?query. - Using the
.verify(value)method will send theMASK:COUNt:FAILURES?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MASK:COUNt:FAILURES?
MaskCountHits
¶
Bases: SCPICmdRead
The MASK:COUNt:HITS command.
Description
- This query returns the sum of all hits in all mask segments. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:COUNt:HITS?query. - Using the
.verify(value)method will send theMASK:COUNt:HITS?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MASK:COUNt:HITS?
MaskCountSegItem
¶
Bases: ValidatedDynamicNumberCmd, SCPICmdRead
The MASK:COUNt:SEG<m> command tree.
Usage
- Using the
.query()method will send theMASK:COUNt:SEG<m>?query. - Using the
.verify(value)method will send theMASK:COUNt:SEG<m>?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.hits: TheMASK:COUNt:SEG<m>:HITScommand.
hits
property
¶
hits: MaskCountSegItemHits
Return the MASK:COUNt:SEG<m>:HITS command.
Description
- This query-only command returns the number of hits in mask segment
. Hit counting must be turned on. m is the mask segment number.
Usage
- Using the
.query()method will send theMASK:COUNt:SEG<m>:HITS?query. - Using the
.verify(value)method will send theMASK:COUNt:SEG<m>:HITS?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MASK:COUNt:SEG<m>:HITS?
MaskCountSegItemHits
¶
Bases: SCPICmdRead
The MASK:COUNt:SEG<m>:HITS command.
Description
- This query-only command returns the number of hits in mask segment
. Hit counting must be turned on. m is the mask segment number.
Usage
- Using the
.query()method will send theMASK:COUNt:SEG<m>:HITS?query. - Using the
.verify(value)method will send theMASK:COUNt:SEG<m>:HITS?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MASK:COUNt:SEG<m>:HITS?
MaskCountState
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:COUNt:STATE command.
Description
- This command sets or queries the mask hits count state; it controls whether mask counting
is being done.
MASK:DISPLAYmust be ON to enableMASK:COUNt:STATEto count mask violations.
Usage
- Using the
.query()method will send theMASK:COUNt:STATE?query. - Using the
.verify(value)method will send theMASK:COUNt:STATE?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:COUNt:STATE valuecommand.
SCPI Syntax
- MASK:COUNt:STATE {ON|OFF|<NR1>}
- MASK:COUNt:STATE?
Info
<NR1>= 0 turns off mask hit counting, and other values turn on mask hit counting.ONturns on mask counting.OFFturns off mask counting. This is the default state.
MaskCountTests
¶
Bases: SCPICmdRead
The MASK:COUNt:TESTS command.
Description
- This query returns the number of pass/fail mask tests that have occurred. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:COUNt:TESTS?query. - Using the
.verify(value)method will send theMASK:COUNt:TESTS?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MASK:COUNt:TESTS?
MaskCountTotal
¶
Bases: SCPICmdRead
The MASK:COUNt:TOTal command.
Description
- This query-only command returns the sum of all hits in all mask segments. This command is
the same as
MASK:COUNT:HITS?and is kept for compatibility with other Tektronix instruments.
Usage
- Using the
.query()method will send theMASK:COUNt:TOTal?query. - Using the
.verify(value)method will send theMASK:COUNt:TOTal?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MASK:COUNt:TOTal?
MaskCountViolations
¶
Bases: SCPICmdRead
The MASK:COUNt:VIOLATIONS command.
Description
- This query returns the number of test violations that have occurred in the current mask pass/fail test. A test violation occurs when any part of a waveform falls within any mask segment. The default is 0. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:COUNt:VIOLATIONS?query. - Using the
.verify(value)method will send theMASK:COUNt:VIOLATIONS?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MASK:COUNt:VIOLATIONS?
MaskCountWaveforms
¶
Bases: SCPICmdRead
The MASK:COUNt:WAVEFORMS command.
Description
- This query returns the number of waveforms that have been acquired and processed during pass/fail mask testing. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:COUNt:WAVEFORMS?query. - Using the
.verify(value)method will send theMASK:COUNt:WAVEFORMS?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MASK:COUNt:WAVEFORMS?
MaskDisplay
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:DISplay command.
Description
- This command sets or queries whether defined masks are displayed on the screen. This is useful for temporarily turning off user-defined masks without deleting them. It is also useful for removing a standard mask from the screen, but leaving it as the selected standard. Mask counting, mask testing, and mask autoset are unavailable if the mask display is Off. The default is On.
Usage
- Using the
.query()method will send theMASK:DISplay?query. - Using the
.verify(value)method will send theMASK:DISplay?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:DISplay valuecommand.
SCPI Syntax
- MASK:DISplay {ON|OFF|<NR1>}
- MASK:DISplay?
Info
<NR1>= 0 removes the masks from the display; any other value shows the masks on the display.ONshows the masks on the display. This is the default value.OFFremoves the masks from the display.
MaskFilter
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:FILTer command.
Description
- This command sets or returns whether the selected digital filter will be run on the waveform data. The filter simulates optical hardware. That is, it simulates different hardware for each of several different optical standards. The digital filter runs on OC1, OC3, OC12, OC48, FC133, FC266, FC531, FC1063, FC2125Draft, Gigabit Ethernet, Infiniband 2.5 Gb, 1394 b, 393 Mb, 786.43 Mb, 1.572 Gb
Usage
- Using the
.query()method will send theMASK:FILTer?query. - Using the
.verify(value)method will send theMASK:FILTer?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:FILTer valuecommand.
SCPI Syntax
- MASK:FILTer {ON|OFF|<NR1>}
- MASK:FILTer?
Info
<NR1>= 0 disables the digital filter; any other value enables it.OFFdisables the digital filter.ONenables the digital filter.
Properties
.orr: TheMASK:FILTer:ORRcommand tree.
orr
property
¶
orr: MaskFilterOrr
Return the MASK:FILTer:ORR command tree.
Usage
- Using the
.query()method will send theMASK:FILTer:ORR?query. - Using the
.verify(value)method will send theMASK:FILTer:ORR?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.vert_index: TheMASK:FILTer:ORR:VERT_INDEXcommand.
MaskFilterOrr
¶
Bases: SCPICmdRead
The MASK:FILTer:ORR command tree.
Usage
- Using the
.query()method will send theMASK:FILTer:ORR?query. - Using the
.verify(value)method will send theMASK:FILTer:ORR?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.vert_index: TheMASK:FILTer:ORR:VERT_INDEXcommand.
vert_index
property
¶
vert_index: MaskFilterOrrVertIndex
Return the MASK:FILTer:ORR:VERT_INDEX command.
Description
- This query-only command returns the optional channel specified vertical index used in the calibration filter. If no argument is supplied, CH1 vertical index is returned.
Usage
- Using the
.query(argument)method will send theMASK:FILTer:ORR:VERT_INDEX? argumentquery. - Using the
.verify(argument, value)method will send theMASK:FILTer:ORR:VERT_INDEX? argumentquery and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MASK:FILTer:ORR:VERT_INDEX? CH<x>
MaskFilterOrrVertIndex
¶
Bases: SCPICmdReadWithArguments
The MASK:FILTer:ORR:VERT_INDEX command.
Description
- This query-only command returns the optional channel specified vertical index used in the calibration filter. If no argument is supplied, CH1 vertical index is returned.
Usage
- Using the
.query(argument)method will send theMASK:FILTer:ORR:VERT_INDEX? argumentquery. - Using the
.verify(argument, value)method will send theMASK:FILTer:ORR:VERT_INDEX? argumentquery and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MASK:FILTer:ORR:VERT_INDEX? CH<x>
MaskHighlighthits
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:HIGHLIGHTHits command.
Description
- This command sets or returns whether hits in a mask are highlighted in different colors than other waveform data. The default is On.
Usage
- Using the
.query()method will send theMASK:HIGHLIGHTHits?query. - Using the
.verify(value)method will send theMASK:HIGHLIGHTHits?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:HIGHLIGHTHits valuecommand.
SCPI Syntax
- MASK:HIGHLIGHTHits {ON|OFF|<NR1>}
- MASK:HIGHLIGHTHits?
Info
<NR1>= 0 disables themask:highlighthitsfunction; any other value enables it.OFFdisables themask:highlighthitsfunction.ONenables themask:highlighthitsfunction.
MaskInvert
¶
Bases: SCPICmdWrite
The MASK:INVert command.
Description
- This command controls whether the mask is drawn inverted. It has no effect if this mask cannot be inverted. The default is Off (Positive).
Usage
- Using the
.write(value)method will send theMASK:INVert valuecommand.
SCPI Syntax
- MASK:INVert {ON|OFF|<NR1>}
Info
<NR1>= 0 disables themask:invertfunction; any other value enables it.OFFPositive.ONNegative.
MaskLock
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:LOCk command.
Description
- This command locks the mask to the source waveform so that any changes made to the horizontal and/or vertical scale settings of the waveform will redraw the mask segments in proportion. This feature is useful for expanding the horizontal and/or vertical settings in order to zoom in on waveforms and masks, and visually examine violation areas in more detail. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:LOCk?query. - Using the
.verify(value)method will send theMASK:LOCk?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:LOCk valuecommand.
SCPI Syntax
- MASK:LOCk {ON|OFF|<NR1>}
- MASK:LOCk?
Info
ONturns on this feature, so that the mask is locked to the waveform.OFFturns off this feature.<NR1> = 0turns off this feature. Any other value turns it on.
MaskMargin
¶
Bases: SCPICmdRead
The MASK:MARgin command tree.
Usage
- Using the
.query()method will send theMASK:MARgin?query. - Using the
.verify(value)method will send theMASK:MARgin?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.percent: TheMASK:MARgin:PERCentcommand..state: TheMASK:MARgin:STATEcommand.
percent
property
¶
percent: MaskMarginPercent
Return the MASK:MARgin:PERCent command.
Description
- Sets or returns the tolerance for the mask test. A positive value expands the mask and a negative margin shrinks the mask by the specified percentage. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:MARgin:PERCent?query. - Using the
.verify(value)method will send theMASK:MARgin:PERCent?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:MARgin:PERCent valuecommand.
SCPI Syntax
- MASK:MARgin:PERCent <NR3>
- MASK:MARgin:PERCent?
Info
<NR3>is a floating point value that ranges from -50.0 to +50.0. The default is 5.
state
property
¶
state: MaskMarginState
Return the MASK:MARgin:STATE command.
Description
- This command sets or returns the state of the mask margins.
Usage
- Using the
.query()method will send theMASK:MARgin:STATE?query. - Using the
.verify(value)method will send theMASK:MARgin:STATE?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:MARgin:STATE valuecommand.
SCPI Syntax
- MASK:MARgin:STATE {ON|OFF|<NR1>}
- MASK:MARgin:STATE?
Info
<NR1>= 0 turns off mask margins; any other integer turns on the selected mask margins.OFFturns off mask margins. The currently displayed margined mask is erased and the original mask is displayed.ONturns on mask margins.
MaskMarginPercent
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:MARgin:PERCent command.
Description
- Sets or returns the tolerance for the mask test. A positive value expands the mask and a negative margin shrinks the mask by the specified percentage. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:MARgin:PERCent?query. - Using the
.verify(value)method will send theMASK:MARgin:PERCent?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:MARgin:PERCent valuecommand.
SCPI Syntax
- MASK:MARgin:PERCent <NR3>
- MASK:MARgin:PERCent?
Info
<NR3>is a floating point value that ranges from -50.0 to +50.0. The default is 5.
MaskMarginState
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:MARgin:STATE command.
Description
- This command sets or returns the state of the mask margins.
Usage
- Using the
.query()method will send theMASK:MARgin:STATE?query. - Using the
.verify(value)method will send theMASK:MARgin:STATE?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:MARgin:STATE valuecommand.
SCPI Syntax
- MASK:MARgin:STATE {ON|OFF|<NR1>}
- MASK:MARgin:STATE?
Info
<NR1>= 0 turns off mask margins; any other integer turns on the selected mask margins.OFFturns off mask margins. The currently displayed margined mask is erased and the original mask is displayed.ONturns on mask margins.
MaskMaskpre
¶
Bases: SCPICmdRead
The MASK:MASKPRE command tree.
Usage
- Using the
.query()method will send theMASK:MASKPRE?query. - Using the
.verify(value)method will send theMASK:MASKPRE?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.amplitude: TheMASK:MASKPRE:AMPlitudecommand..hscale: TheMASK:MASKPRE:HSCAlecommand..htrigpos: TheMASK:MASKPRE:HTRIGPOScommand..patternbits: TheMASK:MASKPRE:PATTERNBITScommand..presampbits: TheMASK:MASKPRE:PRESAMPBITScommand..recordlength: TheMASK:MASKPRE:RECOrdlengthcommand..serialtrig: TheMASK:MASKPRE:SERIALTRIGcommand..trigtosamp: TheMASK:MASKPRE:TRIGTOSAMPcommand..voffset: TheMASK:MASKPRE:VOFFSetcommand..vpos: TheMASK:MASKPRE:VPOScommand..vscale: TheMASK:MASKPRE:VSCAlecommand..width: TheMASK:MASKPRE:WIDthcommand.
amplitude
property
¶
amplitude: MaskMaskpreAmplitude
Return the MASK:MASKPRE:AMPlitude command.
Description
- This command sets or returns the current mask’s nominal pulse amplitude in volts. The query form of this command returns the nominal pulse amplitude of the displayed mask. The set form of this command affects only the current (displayed) mask.
Usage
- Using the
.query()method will send theMASK:MASKPRE:AMPlitude?query. - Using the
.verify(value)method will send theMASK:MASKPRE:AMPlitude?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:MASKPRE:AMPlitude valuecommand.
SCPI Syntax
- MASK:MASKPRE:AMPlitude <NR3>
- MASK:MASKPRE:AMPlitude?
Info
<NR3>is a floating number that sets the nominal pulse amplitude in volts.
hscale
property
¶
hscale: MaskMaskpreHscale
Return the MASK:MASKPRE:HSCAle command.
Description
- This command sets or returns the nominal timing resolution used to draw the mask in time/division. The query form of this command returns the nominal timing resolution of the displayed mask. The set form of this command affects only the current (displayed) mask.
Usage
- Using the
.query()method will send theMASK:MASKPRE:HSCAle?query. - Using the
.verify(value)method will send theMASK:MASKPRE:HSCAle?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:MASKPRE:HSCAle valuecommand.
SCPI Syntax
- MASK:MASKPRE:HSCAle <NR3>
- MASK:MASKPRE:HSCAle?
Info
<NR3>is a floating point number that sets the mask drawing timing resolution.
htrigpos
property
¶
htrigpos: MaskMaskpreHtrigpos
Return the MASK:MASKPRE:HTRIGPOS command.
Description
- This command sets or returns the nominal trigger position (pulse leading edge) used to draw the mask as a fraction of the display width. The query form of this command returns the nominal trigger position of the displayed mask. The set form of this command affects only the current (displayed) mask.
Usage
- Using the
.query()method will send theMASK:MASKPRE:HTRIGPOS?query. - Using the
.verify(value)method will send theMASK:MASKPRE:HTRIGPOS?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:MASKPRE:HTRIGPOS valuecommand.
SCPI Syntax
- MASK:MASKPRE:HTRIGPOS <NR3>
- MASK:MASKPRE:HTRIGPOS?
Info
<NR3>is a floating point number in the range of 0.0 to 1.0 that sets the trigger points as a fraction of the display width, referenced from the left edge of the graticule. The number 0.0 represents the left edge.
patternbits
property
¶
patternbits: MaskMaskprePatternbits
Return the MASK:MASKPRE:PATTERNBITS command.
Description
- This command sets or returns the number of bits used for serial trigger for the User mask standard. For example, DS1 requires six bits: four leading zeros, a one, and a trailing zero. The query form of this command returns the serial bit value of the displayed mask. The set form of this command affects only the current (displayed) mask.
Usage
- Using the
.query()method will send theMASK:MASKPRE:PATTERNBITS?query. - Using the
.verify(value)method will send theMASK:MASKPRE:PATTERNBITS?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:MASKPRE:PATTERNBITS valuecommand.
SCPI Syntax
- MASK:MASKPRE:PATTERNBITS <NR1>
- MASK:MASKPRE:PATTERNBITS?
Info
<NR1>is an integer that sets the number of bits.
presampbits
property
¶
presampbits: MaskMaskprePresampbits
Return the MASK:MASKPRE:PRESAMPBITS command.
Description
- This command sets or returns the number of bits before the (isolated one) pulse leading edge in the serial trigger pass/fail testing. For example, DS1 has four leading zeros. The query form of this command returns the presample bit value of the displayed mask. The set form of this command only affects the current (displayed) mask.
Usage
- Using the
.query()method will send theMASK:MASKPRE:PRESAMPBITS?query. - Using the
.verify(value)method will send theMASK:MASKPRE:PRESAMPBITS?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:MASKPRE:PRESAMPBITS valuecommand.
SCPI Syntax
- MASK:MASKPRE:PRESAMPBITS <NR1>
- MASK:MASKPRE:PRESAMPBITS?
Info
<NR1>is an integer that sets the number of bits before the trigger pulse.
recordlength
property
¶
recordlength: MaskMaskpreRecordlength
Return the MASK:MASKPRE:RECOrdlength command.
Description
- This command sets or returns the nominal record length for pulse mask testing. The query form of this command returns the record length value of the displayed mask. The set form of this command affects only the current (displayed) mask.
Usage
- Using the
.query()method will send theMASK:MASKPRE:RECOrdlength?query. - Using the
.verify(value)method will send theMASK:MASKPRE:RECOrdlength?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:MASKPRE:RECOrdlength valuecommand.
SCPI Syntax
- MASK:MASKPRE:RECOrdlength <NR1>
- MASK:MASKPRE:RECOrdlength?
Info
<NR1>is an integer number that sets the record length.
serialtrig
property
¶
serialtrig: MaskMaskpreSerialtrig
Return the MASK:MASKPRE:SERIALTRIG command.
Description
- This command sets or returns the type of triggering used in pass/fail testing of the current mask.
Usage
- Using the
.query()method will send theMASK:MASKPRE:SERIALTRIG?query. - Using the
.verify(value)method will send theMASK:MASKPRE:SERIALTRIG?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:MASKPRE:SERIALTRIG valuecommand.
SCPI Syntax
- MASK:MASKPRE:SERIALTRIG {AMI|HDB3|B3ZS|B6ZS|B8ZS|CMI|NRZ|MLT3|EDGE}
- MASK:MASKPRE:SERIALTRIG?
Info
AMIis Alternate Mark Inversion.HDB3is High-Density Bipolar Three-Bit substitution.B3ZSis Bipolar 3 Zero Substitution.B6ZSis Bipolar 6 Zero Substitution.B8ZSis Bipolar 8 Zero Substitution.CMIis Coded Mark Inversion.NRZis Non-Return to Zero.MLT3is Multi-Level Transition.
trigtosamp
property
¶
trigtosamp: MaskMaskpreTrigtosamp
Return the MASK:MASKPRE:TRIGTOSAMP command.
Description
- This command sets or returns the time in seconds, from the (leading edge) trigger position to the pulse bit sampling position. The query form of this command returns the time value of the displayed mask. The set form of this command only affects the current (displayed) mask.
Usage
- Using the
.query()method will send theMASK:MASKPRE:TRIGTOSAMP?query. - Using the
.verify(value)method will send theMASK:MASKPRE:TRIGTOSAMP?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:MASKPRE:TRIGTOSAMP valuecommand.
SCPI Syntax
- MASK:MASKPRE:TRIGTOSAMP <NR3>
- MASK:MASKPRE:TRIGTOSAMP?
Info
<NR3>is the floating point number that sets the time to the pulse bit sampling position.
voffset
property
¶
voffset: MaskMaskpreVoffset
Return the MASK:MASKPRE:VOFFSet command.
Description
- This command sets or returns the nominal vertical offset in volts, used to vertically offset the input channels. The query form of this command returns the offset value of the displayed mask. The set form of this command affects only the current (displayed) mask.
Usage
- Using the
.query()method will send theMASK:MASKPRE:VOFFSet?query. - Using the
.verify(value)method will send theMASK:MASKPRE:VOFFSet?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:MASKPRE:VOFFSet valuecommand.
SCPI Syntax
- MASK:MASKPRE:VOFFSet <NR3>
- MASK:MASKPRE:VOFFSet?
Info
<NR3>is a floating point number that sets the nominal vertical offset in volts.
vpos
property
¶
vpos: MaskMaskpreVpos
Return the MASK:MASKPRE:VPOS command.
Description
- This command sets or returns the nominal vertical position, control in divisions, used to vertically position the input channels. The query form of this command returns the vertical position value of the displayed mask. The set form of this command affects only the current (displayed) mask.
Usage
- Using the
.query()method will send theMASK:MASKPRE:VPOS?query. - Using the
.verify(value)method will send theMASK:MASKPRE:VPOS?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:MASKPRE:VPOS valuecommand.
SCPI Syntax
- MASK:MASKPRE:VPOS <NR3>
- MASK:MASKPRE:VPOS?
Info
<NR3>is a floating point number that sets the nominal vertical position control in divisions.
vscale
property
¶
vscale: MaskMaskpreVscale
Return the MASK:MASKPRE:VSCAle command.
Description
- This command sets or returns the nominal vertical scale in volts per division, used to vertically scale the input channels. The query form of this command returns the vertical scale value of the displayed mask. The set form of this command affects only the current (displayed) mask.
Usage
- Using the
.query()method will send theMASK:MASKPRE:VSCAle?query. - Using the
.verify(value)method will send theMASK:MASKPRE:VSCAle?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:MASKPRE:VSCAle valuecommand.
SCPI Syntax
- MASK:MASKPRE:VSCAle <NR3>
- MASK:MASKPRE:VSCAle?
Info
<NR3>is a floating point number that sets the nominal bit width in seconds.
width
property
¶
width: MaskMaskpreWidth
Return the MASK:MASKPRE:WIDth command.
Description
- This command sets or returns the nominal bit width in seconds. The query form of this command returns the bit width value of the displayed mask. The set form of this command affects only the current (displayed) mask.
Usage
- Using the
.query()method will send theMASK:MASKPRE:WIDth?query. - Using the
.verify(value)method will send theMASK:MASKPRE:WIDth?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:MASKPRE:WIDth valuecommand.
SCPI Syntax
- MASK:MASKPRE:WIDth <NR3>
- MASK:MASKPRE:WIDth?
Info
<NR3>is a floating point number that sets the nominal bit width in seconds. This number is the time of one bit of data where bit width = 1 / ( data rate of the signal ).
MaskMaskpreAmplitude
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:MASKPRE:AMPlitude command.
Description
- This command sets or returns the current mask’s nominal pulse amplitude in volts. The query form of this command returns the nominal pulse amplitude of the displayed mask. The set form of this command affects only the current (displayed) mask.
Usage
- Using the
.query()method will send theMASK:MASKPRE:AMPlitude?query. - Using the
.verify(value)method will send theMASK:MASKPRE:AMPlitude?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:MASKPRE:AMPlitude valuecommand.
SCPI Syntax
- MASK:MASKPRE:AMPlitude <NR3>
- MASK:MASKPRE:AMPlitude?
Info
<NR3>is a floating number that sets the nominal pulse amplitude in volts.
MaskMaskpreHscale
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:MASKPRE:HSCAle command.
Description
- This command sets or returns the nominal timing resolution used to draw the mask in time/division. The query form of this command returns the nominal timing resolution of the displayed mask. The set form of this command affects only the current (displayed) mask.
Usage
- Using the
.query()method will send theMASK:MASKPRE:HSCAle?query. - Using the
.verify(value)method will send theMASK:MASKPRE:HSCAle?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:MASKPRE:HSCAle valuecommand.
SCPI Syntax
- MASK:MASKPRE:HSCAle <NR3>
- MASK:MASKPRE:HSCAle?
Info
<NR3>is a floating point number that sets the mask drawing timing resolution.
MaskMaskpreHtrigpos
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:MASKPRE:HTRIGPOS command.
Description
- This command sets or returns the nominal trigger position (pulse leading edge) used to draw the mask as a fraction of the display width. The query form of this command returns the nominal trigger position of the displayed mask. The set form of this command affects only the current (displayed) mask.
Usage
- Using the
.query()method will send theMASK:MASKPRE:HTRIGPOS?query. - Using the
.verify(value)method will send theMASK:MASKPRE:HTRIGPOS?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:MASKPRE:HTRIGPOS valuecommand.
SCPI Syntax
- MASK:MASKPRE:HTRIGPOS <NR3>
- MASK:MASKPRE:HTRIGPOS?
Info
<NR3>is a floating point number in the range of 0.0 to 1.0 that sets the trigger points as a fraction of the display width, referenced from the left edge of the graticule. The number 0.0 represents the left edge.
MaskMaskprePatternbits
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:MASKPRE:PATTERNBITS command.
Description
- This command sets or returns the number of bits used for serial trigger for the User mask standard. For example, DS1 requires six bits: four leading zeros, a one, and a trailing zero. The query form of this command returns the serial bit value of the displayed mask. The set form of this command affects only the current (displayed) mask.
Usage
- Using the
.query()method will send theMASK:MASKPRE:PATTERNBITS?query. - Using the
.verify(value)method will send theMASK:MASKPRE:PATTERNBITS?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:MASKPRE:PATTERNBITS valuecommand.
SCPI Syntax
- MASK:MASKPRE:PATTERNBITS <NR1>
- MASK:MASKPRE:PATTERNBITS?
Info
<NR1>is an integer that sets the number of bits.
MaskMaskprePresampbits
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:MASKPRE:PRESAMPBITS command.
Description
- This command sets or returns the number of bits before the (isolated one) pulse leading edge in the serial trigger pass/fail testing. For example, DS1 has four leading zeros. The query form of this command returns the presample bit value of the displayed mask. The set form of this command only affects the current (displayed) mask.
Usage
- Using the
.query()method will send theMASK:MASKPRE:PRESAMPBITS?query. - Using the
.verify(value)method will send theMASK:MASKPRE:PRESAMPBITS?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:MASKPRE:PRESAMPBITS valuecommand.
SCPI Syntax
- MASK:MASKPRE:PRESAMPBITS <NR1>
- MASK:MASKPRE:PRESAMPBITS?
Info
<NR1>is an integer that sets the number of bits before the trigger pulse.
MaskMaskpreRecordlength
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:MASKPRE:RECOrdlength command.
Description
- This command sets or returns the nominal record length for pulse mask testing. The query form of this command returns the record length value of the displayed mask. The set form of this command affects only the current (displayed) mask.
Usage
- Using the
.query()method will send theMASK:MASKPRE:RECOrdlength?query. - Using the
.verify(value)method will send theMASK:MASKPRE:RECOrdlength?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:MASKPRE:RECOrdlength valuecommand.
SCPI Syntax
- MASK:MASKPRE:RECOrdlength <NR1>
- MASK:MASKPRE:RECOrdlength?
Info
<NR1>is an integer number that sets the record length.
MaskMaskpreSerialtrig
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:MASKPRE:SERIALTRIG command.
Description
- This command sets or returns the type of triggering used in pass/fail testing of the current mask.
Usage
- Using the
.query()method will send theMASK:MASKPRE:SERIALTRIG?query. - Using the
.verify(value)method will send theMASK:MASKPRE:SERIALTRIG?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:MASKPRE:SERIALTRIG valuecommand.
SCPI Syntax
- MASK:MASKPRE:SERIALTRIG {AMI|HDB3|B3ZS|B6ZS|B8ZS|CMI|NRZ|MLT3|EDGE}
- MASK:MASKPRE:SERIALTRIG?
Info
AMIis Alternate Mark Inversion.HDB3is High-Density Bipolar Three-Bit substitution.B3ZSis Bipolar 3 Zero Substitution.B6ZSis Bipolar 6 Zero Substitution.B8ZSis Bipolar 8 Zero Substitution.CMIis Coded Mark Inversion.NRZis Non-Return to Zero.MLT3is Multi-Level Transition.
MaskMaskpreTrigtosamp
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:MASKPRE:TRIGTOSAMP command.
Description
- This command sets or returns the time in seconds, from the (leading edge) trigger position to the pulse bit sampling position. The query form of this command returns the time value of the displayed mask. The set form of this command only affects the current (displayed) mask.
Usage
- Using the
.query()method will send theMASK:MASKPRE:TRIGTOSAMP?query. - Using the
.verify(value)method will send theMASK:MASKPRE:TRIGTOSAMP?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:MASKPRE:TRIGTOSAMP valuecommand.
SCPI Syntax
- MASK:MASKPRE:TRIGTOSAMP <NR3>
- MASK:MASKPRE:TRIGTOSAMP?
Info
<NR3>is the floating point number that sets the time to the pulse bit sampling position.
MaskMaskpreVoffset
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:MASKPRE:VOFFSet command.
Description
- This command sets or returns the nominal vertical offset in volts, used to vertically offset the input channels. The query form of this command returns the offset value of the displayed mask. The set form of this command affects only the current (displayed) mask.
Usage
- Using the
.query()method will send theMASK:MASKPRE:VOFFSet?query. - Using the
.verify(value)method will send theMASK:MASKPRE:VOFFSet?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:MASKPRE:VOFFSet valuecommand.
SCPI Syntax
- MASK:MASKPRE:VOFFSet <NR3>
- MASK:MASKPRE:VOFFSet?
Info
<NR3>is a floating point number that sets the nominal vertical offset in volts.
MaskMaskpreVpos
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:MASKPRE:VPOS command.
Description
- This command sets or returns the nominal vertical position, control in divisions, used to vertically position the input channels. The query form of this command returns the vertical position value of the displayed mask. The set form of this command affects only the current (displayed) mask.
Usage
- Using the
.query()method will send theMASK:MASKPRE:VPOS?query. - Using the
.verify(value)method will send theMASK:MASKPRE:VPOS?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:MASKPRE:VPOS valuecommand.
SCPI Syntax
- MASK:MASKPRE:VPOS <NR3>
- MASK:MASKPRE:VPOS?
Info
<NR3>is a floating point number that sets the nominal vertical position control in divisions.
MaskMaskpreVscale
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:MASKPRE:VSCAle command.
Description
- This command sets or returns the nominal vertical scale in volts per division, used to vertically scale the input channels. The query form of this command returns the vertical scale value of the displayed mask. The set form of this command affects only the current (displayed) mask.
Usage
- Using the
.query()method will send theMASK:MASKPRE:VSCAle?query. - Using the
.verify(value)method will send theMASK:MASKPRE:VSCAle?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:MASKPRE:VSCAle valuecommand.
SCPI Syntax
- MASK:MASKPRE:VSCAle <NR3>
- MASK:MASKPRE:VSCAle?
Info
<NR3>is a floating point number that sets the nominal bit width in seconds.
MaskMaskpreWidth
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:MASKPRE:WIDth command.
Description
- This command sets or returns the nominal bit width in seconds. The query form of this command returns the bit width value of the displayed mask. The set form of this command affects only the current (displayed) mask.
Usage
- Using the
.query()method will send theMASK:MASKPRE:WIDth?query. - Using the
.verify(value)method will send theMASK:MASKPRE:WIDth?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:MASKPRE:WIDth valuecommand.
SCPI Syntax
- MASK:MASKPRE:WIDth <NR3>
- MASK:MASKPRE:WIDth?
Info
<NR3>is a floating point number that sets the nominal bit width in seconds. This number is the time of one bit of data where bit width = 1 / ( data rate of the signal ).
MaskPolarity
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:POLarity command.
Description
- This command sets or returns the input waveform polarity for the pass/fail test. It
controls whether to test positive pulse, negative pulse, or both during pass/fail testing.
This command only applies when
MASK:TEST:STATEis on.
Usage
- Using the
.query()method will send theMASK:POLarity?query. - Using the
.verify(value)method will send theMASK:POLarity?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:POLarity valuecommand.
SCPI Syntax
- MASK:POLarity {BOTh|NEGAtive|POSITIVe}
- MASK:POLarity?
Info
BOThenables testing for both positive and negative pulses. The instrument tests positive pulses on themask:sourcewaveform until ½ of the waveform is tested. Then the instrument inverts the mask and performs the remaining tests.NEGAtiveenables testing on negative pulses.POSITIVeenables testing on positive pulses. This is the default.
MaskSegItem
¶
Bases: ValidatedDynamicNumberCmd, SCPICmdWrite, SCPICmdRead
The MASK:SEG<m> command.
Description
- This command deletes the specified mask segment from the current mask. m is an integer that specifies the mask segment number to delete from the current mask.
Usage
- Using the
.write(value)method will send theMASK:SEG<m> valuecommand.
SCPI Syntax
- MASK:SEG<m> DELEte
Info
DELETEremoves the specified mask segment from the mask.
Properties
.nr_pt: TheMASK:SEG<m>:NR_Ptcommand..points: TheMASK:SEG<m>:POINTScommand.
nr_pt
property
¶
nr_pt: MaskSegItemNrPt
Return the MASK:SEG<m>:NR_Pt command.
Description
- This query-only command returns the number of points that make up the specified mask segment of the current mask. Each mask point consists of an X-Y pair of coordinates. m is an integer number that specifies a mask segment number of the current mask.
Usage
- Using the
.query()method will send theMASK:SEG<m>:NR_Pt?query. - Using the
.verify(value)method will send theMASK:SEG<m>:NR_Pt?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MASK:SEG<m>:NR_Pt?
points
property
¶
points: MaskSegItemPoints
Return the MASK:SEG<m>:POINTS command.
Description
- This command sets or returns the X-Y user coordinates of all points in the current mask segment. The set form defines new points in the current mask, replacing any existing points in the current mask segment; it sets or returns the vertices for a particular segment in the current mask. m is an integer that specifies the current mask segment number.
Usage
- Using the
.query()method will send theMASK:SEG<m>:POINTS?query. - Using the
.verify(value)method will send theMASK:SEG<m>:POINTS?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:SEG<m>:POINTS valuecommand.
SCPI Syntax
- MASK:SEG<m>:POINTS <NR3>,<NR3>[,<NR3>,<NR3>]
- MASK:SEG<m>:POINTS?
Info
<NR3>refers to the coordinates of one of the vertices in the Current mask. Each pair of numbers represents the horizontal and vertical coordinates of a mask segment vertex. The pairs must be listed in a counterclockwise order. If the vertical or horizontal scale or position is changed after this command and then the query form of this command is issued, the value returned from the instrument will not be the same. If just one pair is input, it is ignored and the current mask segment is marked as undefined. The default is no points in the current mask segment.
MaskSegItemNrPt
¶
Bases: SCPICmdRead
The MASK:SEG<m>:NR_Pt command.
Description
- This query-only command returns the number of points that make up the specified mask segment of the current mask. Each mask point consists of an X-Y pair of coordinates. m is an integer number that specifies a mask segment number of the current mask.
Usage
- Using the
.query()method will send theMASK:SEG<m>:NR_Pt?query. - Using the
.verify(value)method will send theMASK:SEG<m>:NR_Pt?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MASK:SEG<m>:NR_Pt?
MaskSegItemPoints
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:SEG<m>:POINTS command.
Description
- This command sets or returns the X-Y user coordinates of all points in the current mask segment. The set form defines new points in the current mask, replacing any existing points in the current mask segment; it sets or returns the vertices for a particular segment in the current mask. m is an integer that specifies the current mask segment number.
Usage
- Using the
.query()method will send theMASK:SEG<m>:POINTS?query. - Using the
.verify(value)method will send theMASK:SEG<m>:POINTS?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:SEG<m>:POINTS valuecommand.
SCPI Syntax
- MASK:SEG<m>:POINTS <NR3>,<NR3>[,<NR3>,<NR3>]
- MASK:SEG<m>:POINTS?
Info
<NR3>refers to the coordinates of one of the vertices in the Current mask. Each pair of numbers represents the horizontal and vertical coordinates of a mask segment vertex. The pairs must be listed in a counterclockwise order. If the vertical or horizontal scale or position is changed after this command and then the query form of this command is issued, the value returned from the instrument will not be the same. If just one pair is input, it is ignored and the current mask segment is marked as undefined. The default is no points in the current mask segment.
MaskSource
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:SOUrce command.
Description
- This command sets or reports which source will be compared against the mask(s) when counting is turned on; it controls which trace to use in mask counting. It also affects mask autoset and how triggering is set up when you select the mask.
Usage
- Using the
.query()method will send theMASK:SOUrce?query. - Using the
.verify(value)method will send theMASK:SOUrce?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:SOUrce valuecommand.
SCPI Syntax
- MASK:SOUrce {CH<x>|MATH<x>|REF<x>}
- MASK:SOUrce?
Info
CH<1-4>selects a channel waveform to be compared against the specified mask. The range for is 1 through 4.MATH<1-4>selects a math waveform to be compared against the specified mask. The range for is 1 through 4.REF<1-4>selects a reference waveform to be compared against the specified mask. The range is 1 through 4.
MaskStandard
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:STANdard command.
Description
- This command deletes the existing mask (if any) and sets the selected standard mask. If
MASK:COUNT:STATEis ON, mask counting starts immediately. The query form of this command returns the current mask standard. The following warning event is posted if the mask exceeds the instrument bandwidth: 2318,’Consider system bandwidth when testing at this bit rate.’
Usage
- Using the
.query()method will send theMASK:STANdard?query. - Using the
.verify(value)method will send theMASK:STANdard?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:STANdard valuecommand.
SCPI Syntax
- MASK:STANdard {ATARXG<x>|ATATXG1|ATATXG2|ATATXG3|CLOCKCoax|CLOCKSymmetrical|D<x>|DS0Contra|DS0Double|DS0Single|DS0Timing|DS1|DS1A|DS1C|DS2|DS2RATECoax|DS2RATESymmetrical|DS3|DS4NA|DS4NA_Max|E1Coax|E1Symmetrical|E2|E3|E4_1|E4_0|ENET1000BCX_ATP2|ENET1000BCX_ATP3|ENET1000BCX_NTP2|ENET100FX|ENET100STP|ENET100UTP|ENET1250|ENETXAUI_Far|ENETXAUI_Near|FC1063|FC1063Draft|FC1063E|FC1063E_ABR|FC1063E_ABT|FC1063E_ADR|FC1063E_ADT|FC1063E_AGR|FC1063E_AGT|FC1063E_NBT|FC1063E_NDT|FC1063E_NGT|FC133|FC133E|FC2125|FC2125E_ABR|FC2125E_ABT|FC2125E_ADR|FC2125E_ADT|FC2125E_AGR|FC2125E_AGT|FC2125E_NBT|FC2125E_NDT|FC2125E_NGT|FC266|FC266E|FC4250E_ABR|FC4250E_ABT|FC4250E_ADR|FC4250E_ADT|FC4250E_AGR|FC4250E_AGT|FC4250E_NBT|FC4250E_NDT|FC4250E_NGT|FC531|FC531E|FST1|FST2|FST3|FST4|FST5|FST6|FW1394BS1600B|FW1394BS1600BT1|FW1394BS1600BT2|FW1394BS400B|FW1394BS400BT1|FW1394BS400BT2|FW1394BS800B|FW1394BS800BT1|FW1394BS800BT2|G703DS1|G703DS3|HST<x>|INF2_5G|INF2_5GE|NONe|OC1|OC12|OC3|OC48|OC48_FEC|PCIEXPRESS_Rcv|PCIEXPRESS_Xmit|RATE32Mbit|RATE97Mbit|RIO_DRV1G|RIO_DRV1_5G|RIO_DRV2G|RIO_DRV500M|RIO_DRV500M|RIO_DRV750M|RIO_EDRV1G|RIO_EDRV1_5G|RIO_EDRV2G|RIO_EDRV500M|RIO_EDRV500M|RIO_EDRV750M|RIO_RCV1G|RIO_RCV1_5G|RIO_RCV2G|RIO_RCV500M|RIO_RCV500M|RIO_RCV750M|RIO_SERIAL_1G|RIO_SERIAL_2G|RIO_SERIAL_3G|SFI5_RCVBCLK2|SFI5_RCVBCLK3|SFI5_RCVBDATA2|SFI5_RCVBDATA3|SFI5_RCVDCLK2|SFI5_RCVDCLK3|SFI5_RCVDDATA2|SFI5_RCVDDATA3|SFI5_XMITACLK2|SFI5_XMITACLK3|SFI5_XMITADATA2|SFI5_XMITADATA3|SFI5_XMITCCLK2|SFI5_XMITCCLK3|SFI5_XMITCDATA2|SFI5_XMITCDATA3|STM0_0|STM0_1|STM0_HDBX|STM1E_1|STM1E_0|STS1Eye|STS1Pulse|STS3|STS3_Max|TFI5_2|TFI5_3|USERMask|VIDEO270|VIDEO292M|VIDEO360|VSROC192|SAS1_5_IR|SAS1_5_CR|SAS1_5_XR|SAS1_5_IR_AASJ|SAS1_5_CR_AASJ|SAS1_5_XR_AASJ|SAS1_5_SATA|SAS3_0_IR|SAS3_0_CR|SAS3_0_XR|SAS3_0_IR_AASJ|SAS3_0_CR_AASJ|SAS3_0_XR_AASJ|SAS3_0_SATA}
- MASK:STANdard?
Info
ATARXG1(Serial ATA, G1 Rx 1.5 Gb/s).ATARXG2(Serial ATA, G2, Rx, 3.0 Gb/s).ATARXG3(Serial ATA, G3, Rx).ATATXG1(Serial ATA, G1 Tx, 1.5 Gb/s).ATATXG2(Serial ATA, G2 Tx, 3.0 Gb/s).H ATATXG3(Serial ATA, G3 Tx).CLOCKCoaxCLOCKSymmetricalD1D2DS0Contra(ITU-T, G703 (10/98), 64 kb/s).DS0Double(ITU-T, G703 (10/98), 64 kb/s).DS0Single(ITU-T, G703 (10/98), 64 kb/s).DS0Timing(ITU-T, G703 (10/98), 64 kb/s).DS1(ANSI T1.102-1993 (R1999), DS1, 1.544 Mb/s).DS1A(ANSI T1.102-1993 (R1999), DS1A, 2.048 Mb/s).DS1C(ANSI T1.102-1993 (R1999), DS1C, 3.152 Mb/s).DS2(ANSI T1.102-1993 (R1999), DS2, 6.312 Mb/s).DS2RATECoax(ITU-T, G703 (10/98), D2 Rate Coax, 6.312 Mb/s).DS2RATESymmetrical(ITU-T, G703 (10/98), D2 Rate Sym, 6.312 Mb/s).DS3(ANSI T1.102-1993 (R1999), DS3, 44.736 Mb/s).DS4NA(ANSI T1.102-1993 (R1999), DS4NA, 139.26 Mb/s).DS4NA_Max(ANSI T1.102-1993 (R1999), DSNA Max Output, 139.26 Mb.E1Coax(ITU-T, G703 (10/98), E1 Coax Pair, 2.048 Mb/s).E1Symmetrical(ITU-T, G703 (10/98), E1 Sym Pair, 2.048 Mb/s).E2(ITU-T, G703 (10/98), E2, 8.448 Mb/s).E3(ITU-T, G703 (10/98), E3, 34.368 Mb/s).E4_0(ITU-T, G703 (10/98), E4 Binary 0).E4_1(ITU-T, G703 (10/98), E4 Binary 1).ENET100FXENET100STP(IEEE Std 802.3 and ANSI X3.263-1995, 100 Base-Tx, STP, 125 Mb/s ).ENET100UTP(IEEE Std 802.3 and ANSI X3.263-1995, 100 Base-Tx, UTP, 125 Mb/s).ENET1000BCX_ATP2(1000B-CX Abs, TP2, 1.25 Gb/s).ENET1000BCX_ATP3(1000B-CX Abs, TP3, 1.25 Gb/s).ENET1000BCX_NTP2(1000B-CX Norm, TP2, 1.25 Gb/s).ENET1250(IEEE Std 802.3 and ANSI X3.263-1995, GB Ethernet, 1.25 Gb/s).ENETXAUI_FAR(10 Gigabit Attachment Unit Interface (XAUI), Far, 3.125 Gb/s).ENETXAUI_Near(10 Gigabit Attachment Unit Interface (XAUI), Near, 3,125 Gb/s).FC133(ANSI X3.230-1999 NCITS 1235D/Rev 11, Optical, 132.8 Mb/s).FC133E(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Electrical 132.8 Mb/s).FC266(ANSI X3.230-1999 NCITS 1235D/Rev 11, Optical, 265.6 Mb/s).FC266E(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Electrical, 132.8 Mb/s).FC531(ANSI X3.230-1999 NCITS 1235D/Rev 11, Optical, 531.2 Mb/s).FC531E(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Electrical, 531.2 Mb/s).FC1063(ANSI X3.230-1999 NCITS 1235D/Rev 11, Optical, 1.065 Gb/s).FC1063E(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Electrical, 1.0625 Gb/s).FC1063E_ABT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Beta, Transm).FC1063E_ADT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Beta, Transm).FC1063E_AGT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Gamma, Transm).FC1063E_NBT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Norm, Beta, Transm).FC1063E_NDT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Norm, Delta, Transm).FC1063E_NGT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Norm, Gamma, Transm).FC1063E_ABR(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Beta, Recv).FC1063E_ADR(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Delta, Recv).FC1063E_AGR(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Gamma, Recv).FC1063Draft(ANSI X3.230-1999 NCITS 1235D/Rev 11, Optical, Draft Rev 11).FC2125(ANSI X3.230-1999 NCITS 1235D/Rev 11, Optical, 2.125).FC2125E_ABT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Beta, Transm).FC2125E_ADT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Delta, Transm).FC2125E_AGT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Gamma, Transm).FC2125E_NBT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Norm, Beta, Transm).FC2125E_NDT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Norm, Delta, Transm).FC2125E_NGT(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Norm, Gamma, Transm).FC2125E_ABR(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Beta, Recv).FC2125E_ADR(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Delta, Recv).FC2125E_AGR(ANS1 X3.230-1999 NCITS 1235D/Rev 11, Abs, Gamma, Recv).FC4250E_ABT(ANS1 X3.230-1999 NCITS 1235D/Rev 4.0, Abs, Beta, Transm).FC4250E_ADT(ANS1 X3.230-1999 NCITS 1235D/Rev 4.0, Abs, Delta, Transm).FC4250E_AGT(ANS1 X3.230-1999 NCITS 1235D/Rev 4.0, Abs, Gamma, Transm).FC4250E_NBT(ANS1 X3.230-1999 NCITS 1235D/Rev 4.0, Norm, Beta, Transm).FC4250E_NDT(ANS1 X3.230-1999 NCITS 1235D/Rev 4.0, Norm, Delta, Transm).FC4250E_NGT(ANS1 X3.230-1999 NCITS 1235D/Rev 4.0, Norm, Gamma, Transm).FC4250E_ABR(ANS1 X3.230-1999 NCITS 1235D/Rev 4.0, Abs, Beta, Recv).FC4250E_ADR(ANS1 X3.230-1999 NCITS 1235D/Rev 4.0, Abs, Delta, Recv).FC4250E_AGR(ANS1 X3.230-1999 NCITS 1235D/Rev 4.0, Abs, Gamma, Recv).FST1(USB,FS:T1, 12 Mb/s).FST2(USB,FS:T2, 12 Mb/s).FST3(USB,FS:T3, 12 Mb/s).FST4(USB,FS:T4: 12 Mb/s).FST5(USB,FS:T5, 12 Mb/s).FST6(USB,FS:T6, 12 Mb/s).FW1394BS400B(IEEE 1394b, S400 Optical, 491.5 Mb/s).FW1394BS400BT1(IEEE 1394b, S400b T1, 491.5 Mb/s).FW1394BS400BT2(IEEE 1394b, S400b T2, 491.5 Mb/s).FW1394BS800B(IEEE 1394b, S800 Optical, 988.0 Mb/s).FW1394BS800BT1(IEEE 1394b, S800b T1, 983.0 Mb/s).FW1394BS800BT2(IEEE 1394b, S800b T2, 983.0 Mb/s).FW1394BS1600B(IEEE 1394b, S1600 Optical, 1.966 Gb/s).FW1394BS1600BT1(IEEE 1394b, S1600b T1, 1.966 Gb/s).FW1394BS1600BT2(IEEE 1394b, S1600b T2, 1.966 Gb/s).G703D1(ITU-T, G703 (10/98), DS1 Rate, 1.544 Mb/s).G703DS3(ITU-T, G703 (10/98).HST1(USB,HS:T1, 480 Mb/s) G703DS3 (ITU-T, G703 (10/98).HST2(USB,HS:T2, 480 Mb/s) G703DS3 (ITU-T, G703 (10/98).HST3(USB,HS:T3, 480 Mb/s).HST4(USB,HS:T4, 480 Mb/s).HST5(USB,HS:T5, 480 Mb/s).HST6(USB,HS:T6, 480 Mb/s).INF2_5G(InfiniBand, IBTA Spec 1.0a, 2.5 Optical, 2.5 Gb/s).INF2_5GE(InfiniBand, IBTA Spec 1.0a, 2.5 Electrical, 2.5 Gb/s).NONeOC1(GR 253-CORE Issue 3 9/21/2000 OC1/STM0, 51.84 Mb/s).OC3(GR 253-CORE Issue 3 9/21/2000 OC1/STM1, 155.52, Mb/s).OC12(GR 253-CORE Issue 3 9/21/2000 OC1/STM4, 622.08 Mb/s).OC48(GR 253-CORE Issue 3 9/21/2000 OC1/STM16, 2.4883 Gb/s.OC48_FEC(Forward Error Correction - CSA8000 mask, 2.666 Gb/s).PCIEXPRESS_Xmit(PCI Express Transmitter, 2.5 Gb/s).PCIEXPRESS_Rcv(PCI Express Receiver, 2.5 Gb/s).RATE32Mbit(ITU-T, G703 (10/98), 32.064 Mb/s).RATE97Mbit(ITU-T, G703 (10/98), 97 Mbit, 97.728 Mb/s).RIO_DRV1G(Rapid IO Driver, 1 Gb/s).RIO_DRV1_5G(Rapid IO Driver, 5 Gb/s).RIO_DRV2G(Rapid IO Driver, 2 Gb/s).RIO_DRV500M(Rapid IO Driver, 500 Mb/s).RIO_DRV750M(Rapid IO Driver, 750 Mb/s).RIO_EDRV1G(Rapid IO Extended Driver, 1 Gb/s).RIO_EDRV1_5G(Rapid IO Extended Driver, 1.5 Gb/s).RIO_EDRV2G(Rapid IO Extended Driver, 2 Gb/s).RIO_EDRV500M(Rapid IO Extended Driver, 500 Mb/s).RIO_EDRV750M(Rapid IO Extended Driver, 750 Mb/s).RIO_RCV500M(Rapid IO Receiver, 500 Mb/s).RIO_RCV750M(Rapid IO Receiver, 750 Mb/s).RIO_RCV1G(Rapid IO Receiver, 1 Gb/s).RIO_RCV1_5G(Rapid IO Receiver, 1.5 Gb/s).RIO_RCV2G(Rapid IO Receiver, 2 Gb/s).RIO_SERIAL_1G(Rapid IO Serial, 1.25 Gb/s).RIO_SERIAL_2G(Rapid IO Serial, 2.5 Gb/s).RIO_SERIAL_3G(Rapid IO Serial, 3.25 Gb/s).SFI5_XMITADATA2(SFI15 Transmit: Test Point A Data Signal 2, 2.488 Gb/s).SFI5_XMITCDATA2(SFI15 Transmit: Test Point C Data Signal 2, 2.488 Gb/s).SFI5_XMITACLK2(SFI15 Transmit: Test Point A Clock Signal 2, 2.488 Gb/s).SFI5_XMITCCLK2(SFI15 Transmit: Test Point C Clock Signal 2, 2.488 Gb/s).SFI5_RCVBDATA2(SFI15 Receive: Test Point B Data Signal 2, 2.488 Gb/s).SFI5_RCVDDATA2(SFI15 Receive: Test Point D Data Signal 2, 2.488 Gb/s).SFI5_RCVBCLK2(SFI15 Receive: Test Point B Clock Signal 2, 2.488 Gb/s).SFI5_RCVDCLK2(SFI15 Receive: Test Point D Clock Signal 2, 2.488 Gb/s).SFI5_XMITADATA3(SFI15 Transmit: Test Point A Data Signal 3, 3.125 Gb/s).SFI5_XMITCDATA3(SFI15 Transmit: Test Point C Data Signal 3, 3.125 Gb/s).SFI5_XMITACLK3(SFI15 Transmit: Test Point A Clock Signal 3, 3.125 Gb/s).SFI5_XMITCCLK3(SFI15 Transmit: Test Point C Clock Signal 3, 3.125 Gb/s).SFI5_RCVBDATA3(SFI15 Receive: Test Point B Data Signal 3, 3.125 Gb/s).SFI5_RCVDDATA3(SFI15 Receive: Test Point D Data Signal 3, 3.125 Gb/s).SFI5_RCVBCLK3(SFI15 Receive: Test Point B Clock Signal 3, 3.125 Gb/s).SFI5_RCVDCLK3(SFI15 Receive: Test Point D Clock Signal 3, 3.125 Gb/s.STM0_0(ITU-T, G703 (10/98), STM1E Binary 0).STM0_1(ITU-T, G703 (10/98), STM1E Binary 1).STM0_HDBXSTS1Eye(ANSI T1.102-1993 (R1999), STS-1 Eye, 51.84 Mb/s).STS1Pulse(ANSI T1.102-1993 (R1999), STS-1 Pulse, 51.84 Mb/s).STS3(ANSI T1.102-1993 (R1999), STS-3, 155.52 Mb/s).STS3_Max(ANSI T1.102-1993 (R1999), STS-3 Max Output, 155.52 Mb/s).TFI15_2(TFI-5, 2.488 Gb/s).TFI5_3(TFI-5, 3.1104 Gb/s).USERMaskVIDEO270VIDEO292MVIDEO360VSROC192(VSR OC192/STM64, 1.24416 Gb/s).
MaskStoponviolation
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:STOPOnviolation command.
Description
- This command stops the waveform acquisitions upon the first occurrence of a waveform
violation. The
MASK:ACTONEVENT:ENABLEcommand should be set to ON for this event to happen. After the event occursMASK:ACTONEVENT:ENABLEcommand will be set to OFF automatically. You can also specify an action to be performed when acquisitions are stopped by using the commands such asMASK:TEST:SAVEWFM,MASK:TEST:SAVEIMAGE,MASK:TEST:AUXOUT:FAILURE,MASK:TEST:HARDCOPY, orMASK:TEST:SRQ:FAILURE. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:STOPOnviolation?query. - Using the
.verify(value)method will send theMASK:STOPOnviolation?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:STOPOnviolation valuecommand.
SCPI Syntax
- MASK:STOPOnviolation {ON|OFF|<NR1>}
- MASK:STOPOnviolation?
Info
ONstops waveform acquisition on the first occurrence of a mask violation.OFFturns this feature off.<NR1>=0turns this feature off ; any other value turns it on.
MaskTest
¶
Bases: SCPICmdRead
The MASK:TESt command tree.
Usage
- Using the
.query()method will send theMASK:TESt?query. - Using the
.verify(value)method will send theMASK:TESt?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.aux: TheMASK:TESt:AUXcommand tree..beep: TheMASK:TESt:BEEPcommand tree..delay: TheMASK:TESt:DELaycommand..hardcopy: TheMASK:TESt:HARDCopycommand..log: TheMASK:TESt:LOGcommand tree..repeat: TheMASK:TESt:REPeatcommand..sample: TheMASK:TESt:SAMplecommand..savewfm: TheMASK:TESt:SAVEWFMcommand..srq: TheMASK:TESt:SRQcommand tree..state: TheMASK:TESt:STATEcommand..status: TheMASK:TESt:STATUScommand..stop: TheMASK:TESt:STOPcommand tree..threshold: TheMASK:TESt:THResholdcommand..waveform: TheMASK:TESt:WAVEformcommand.
aux
property
¶
aux: MaskTestAux
Return the MASK:TESt:AUX command tree.
Usage
- Using the
.query()method will send theMASK:TESt:AUX?query. - Using the
.verify(value)method will send theMASK:TESt:AUX?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.completion: TheMASK:TESt:AUX:COMPLetioncommand..failure: TheMASK:TESt:AUX:FAILurecommand.
beep
property
¶
beep: MaskTestBeep
Return the MASK:TESt:BEEP command tree.
Usage
- Using the
.query()method will send theMASK:TESt:BEEP?query. - Using the
.verify(value)method will send theMASK:TESt:BEEP?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.completion: TheMASK:TESt:BEEP:COMPLetioncommand..failure: TheMASK:TESt:BEEP:FAILurecommand.
delay
property
¶
delay: MaskTestDelay
Return the MASK:TESt:DELay command.
Description
- This command specifies the amount of time, in seconds, the instrument should wait after the start of pass/fail mask testing before it evaluates the waveforms. This command is useful if the test system requires some ‘settling’ time. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:TESt:DELay?query. - Using the
.verify(value)method will send theMASK:TESt:DELay?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:TESt:DELay valuecommand.
SCPI Syntax
- MASK:TESt:DELay <NR3>
- MASK:TESt:DELay?
Info
<NR3>is a floating point number that specifies the amount of time in seconds, to delay the start of the mask pass/fail test.
hardcopy
property
¶
hardcopy: MaskTestHardcopy
Return the MASK:TESt:HARDCopy command.
Description
- This command will cause the instrument to generate a screen shot to the default
printer as soon as a pass/fail mask test fails, using the current instrument hard copy
settings. See
HARDCOPY:ACTIVEPRINTERand other Hardcopy commands for more information on accessing printer settings. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:TESt:HARDCopy?query. - Using the
.verify(value)method will send theMASK:TESt:HARDCopy?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:TESt:HARDCopy valuecommand.
SCPI Syntax
- MASK:TESt:HARDCopy {ON|OFF|<NR1>}
- MASK:TESt:HARDCopy?
Info
ONturns on this feature, so that the instrument will generate a screen hard copy to the default printer upon failure.OFFturns off this feature.<NR1>= 0 turns off this feature; any other value turns it on.
log
property
¶
log: MaskTestLog
Return the MASK:TESt:LOG command tree.
Usage
- Using the
.query()method will send theMASK:TESt:LOG?query. - Using the
.verify(value)method will send theMASK:TESt:LOG?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.failure: TheMASK:TESt:LOG:FAILurecommand.
repeat
property
¶
repeat: MaskTestRepeat
Return the MASK:TESt:REPeat command.
Description
- This command causes the mask test cycle to continuously repeat upon the completion of the previous test cycle. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:TESt:REPeat?query. - Using the
.verify(value)method will send theMASK:TESt:REPeat?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:TESt:REPeat valuecommand.
SCPI Syntax
- MASK:TESt:REPeat {ON|OFF|<NR1>}
- MASK:TESt:REPeat?
Info
ONturns on this feature, so that the mask test cycle repeats continuously upon the completion of the previous test cycle.OFFturns off this feature.<NR1>is an integer. 0 turns off this feature; any other integer turns it on.
sample
property
¶
sample: MaskTestSample
Return the MASK:TESt:SAMple command.
Description
- This command sets or returns the minimum number of waveform database (WfmDB) points
the instrument can acquire before it stops a single sequence acquisition or stops
running a mask test. Hint: a bigger sample size can allow a greater throughput (more
waveforms to get acquired at a time). However, a very large sample size can slow down
the display update. So to speed up the display rate, consider reducing the sample
size. This command works the same as the
ACQUIRE:NUMSAMPLEScommand.
Usage
- Using the
.query()method will send theMASK:TESt:SAMple?query. - Using the
.verify(value)method will send theMASK:TESt:SAMple?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:TESt:SAMple valuecommand.
SCPI Syntax
- MASK:TESt:SAMple {<NR1>}
- MASK:TESt:SAMple?
Info
<NR1>the number of points to sample.
Sub-properties
.threshold: TheMASK:TESt:SAMple:THResholdcommand.
savewfm
property
¶
savewfm: MaskTestSavewfm
Return the MASK:TESt:SAVEWFM command.
Description
- This command copies the waveform data from all active channels to a file on a flash
memory device such as a USB stick or a network drive. See the command
FILESYSTEM:MKDIRand other File System commands for more information on saving to a file. TheMASK:ACTONEVENT:ENABLEcommand should be set to ON for this event to happen. After the event occursMASK:ACTONEVENT:ENABLEcommand will be set to OFF automatically. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:TESt:SAVEWFM?query. - Using the
.verify(value)method will send theMASK:TESt:SAVEWFM?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:TESt:SAVEWFM valuecommand.
SCPI Syntax
- MASK:TESt:SAVEWFM {ON|OFF|<NR1>}
- MASK:TESt:SAVEWFM?
Info
ONturns on this feature, so that waveform data from all active channels is copied to files upon test failure.OFFturns off this feature.<NR1>is an integer. 0 turns off this feature; any other value turns it on.
Sub-properties
.filename: TheMASK:TESt:SAVEWFM:FILENamecommand.
srq
property
¶
srq: MaskTestSrq
Return the MASK:TESt:SRQ command tree.
Usage
- Using the
.query()method will send theMASK:TESt:SRQ?query. - Using the
.verify(value)method will send theMASK:TESt:SRQ?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.completion: TheMASK:TESt:SRQ:COMPLetioncommand..failure: TheMASK:TESt:SRQ:FAILurecommand.
state
property
¶
state: MaskTestState
Return the MASK:TESt:STATE command.
Description
- This command turns the pass/fail mask test on or off. Most of the other
MASK:TESTcommands need to be executed before this command. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:TESt:STATE?query. - Using the
.verify(value)method will send theMASK:TESt:STATE?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:TESt:STATE valuecommand.
SCPI Syntax
- MASK:TESt:STATE {ON|OFF|<NR1>}
- MASK:TESt:STATE?
Info
ONturns the mask test on.OFFturns the mask test off.<NR1>is an integer. 0 turns the mask test off; any other integer turns it on.
status
property
¶
status: MaskTestStatus
Return the MASK:TESt:STATUS command.
Description
- This query-only command returns the pass/fail test status. This command returns one of: OFF, DELAY, PASSING, FAILING, PASSED, FAILED, and VIOLATION. In other words, it indicates the result of the pass/fail test. When the violation count exceeds the violation threshold, the status changes from Passing to Failed.
Usage
- Using the
.query()method will send theMASK:TESt:STATUS?query. - Using the
.verify(value)method will send theMASK:TESt:STATUS?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MASK:TESt:STATUS?
stop
property
¶
stop: MaskTestStop
Return the MASK:TESt:STOP command tree.
Usage
- Using the
.query()method will send theMASK:TESt:STOP?query. - Using the
.verify(value)method will send theMASK:TESt:STOP?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.failure: TheMASK:TESt:STOP:FAILurecommand.
threshold
property
¶
threshold: MaskTestThreshold
Return the MASK:TESt:THReshold command.
Description
- This command specifies the number of failed tested waveforms needed in a pass/fail mask test to cause the test status to change to ‘Failing’. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:TESt:THReshold?query. - Using the
.verify(value)method will send theMASK:TESt:THReshold?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:TESt:THReshold valuecommand.
SCPI Syntax
- MASK:TESt:THReshold <NR1>
- MASK:TESt:THReshold?
Info
<NR1>is an integer that specifies the number of tested waveform violations occurring in each mask test that will change the test status to ‘Failing’. The maximum number of failed tested waveforms that can be specified is 1E09. The default is 1.
waveform
property
¶
waveform: MaskTestWaveform
Return the MASK:TESt:WAVEform command.
Description
- This command specifies the number of waveforms the instrument should test during a pass/fail mask test. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:TESt:WAVEform?query. - Using the
.verify(value)method will send theMASK:TESt:WAVEform?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:TESt:WAVEform valuecommand.
SCPI Syntax
- MASK:TESt:WAVEform <NR1>
- MASK:TESt:WAVEform?
Info
<NR1>is an integer that specifies the number of waveforms to test. The maximum waveform count that can be specified is 1E09.
MaskTestAux
¶
Bases: SCPICmdRead
The MASK:TESt:AUX command tree.
Usage
- Using the
.query()method will send theMASK:TESt:AUX?query. - Using the
.verify(value)method will send theMASK:TESt:AUX?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.completion: TheMASK:TESt:AUX:COMPLetioncommand..failure: TheMASK:TESt:AUX:FAILurecommand.
completion
property
¶
completion: MaskTestAuxCompletion
Return the MASK:TESt:AUX:COMPLetion command.
Description
- This command sets or returns the
test:auxon pass/fail test completion mode. When enabled, this command causes the instrument to provide a TTL signal at theAux:Outport when the mask pass/fail status changes to ‘Failing’.
Usage
- Using the
.query()method will send theMASK:TESt:AUX:COMPLetion?query. - Using the
.verify(value)method will send theMASK:TESt:AUX:COMPLetion?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:TESt:AUX:COMPLetion valuecommand.
SCPI Syntax
- MASK:TESt:AUX:COMPLetion {ON|OFF|<NR1>}
- MASK:TESt:AUX:COMPLetion?
Info
<NR1>= 0 disables themask:test:aux:completionfunction; any other value enables it.OFFturns off the pass/failmask:test:auxon completion.ONturns on the pass/failmask:test:auxon completion.
failure
property
¶
failure: MaskTestAuxFailure
Return the MASK:TESt:AUX:FAILure command.
Description
- This command sets or returns the
test:auxstatus on pass/fail test failure mode. When enabled, this command causes the instrument to provide a TTL signal at the AuxOut port when the pass/fail status changes to ‘Failing’.
Usage
- Using the
.query()method will send theMASK:TESt:AUX:FAILure?query. - Using the
.verify(value)method will send theMASK:TESt:AUX:FAILure?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:TESt:AUX:FAILure valuecommand.
SCPI Syntax
- MASK:TESt:AUX:FAILure {ON|OFF|<NR1>}
- MASK:TESt:AUX:FAILure?
Info
<NR1>= 0 disables themask:test:aux:failurefunction; any other value enables it.OFFturns off the pass/failmask:test:auxon failure. This is the default.ONturns on the pass/failmask:test:auxon failure.
MaskTestAuxCompletion
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:TESt:AUX:COMPLetion command.
Description
- This command sets or returns the
test:auxon pass/fail test completion mode. When enabled, this command causes the instrument to provide a TTL signal at theAux:Outport when the mask pass/fail status changes to ‘Failing’.
Usage
- Using the
.query()method will send theMASK:TESt:AUX:COMPLetion?query. - Using the
.verify(value)method will send theMASK:TESt:AUX:COMPLetion?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:TESt:AUX:COMPLetion valuecommand.
SCPI Syntax
- MASK:TESt:AUX:COMPLetion {ON|OFF|<NR1>}
- MASK:TESt:AUX:COMPLetion?
Info
<NR1>= 0 disables themask:test:aux:completionfunction; any other value enables it.OFFturns off the pass/failmask:test:auxon completion.ONturns on the pass/failmask:test:auxon completion.
MaskTestAuxFailure
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:TESt:AUX:FAILure command.
Description
- This command sets or returns the
test:auxstatus on pass/fail test failure mode. When enabled, this command causes the instrument to provide a TTL signal at the AuxOut port when the pass/fail status changes to ‘Failing’.
Usage
- Using the
.query()method will send theMASK:TESt:AUX:FAILure?query. - Using the
.verify(value)method will send theMASK:TESt:AUX:FAILure?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:TESt:AUX:FAILure valuecommand.
SCPI Syntax
- MASK:TESt:AUX:FAILure {ON|OFF|<NR1>}
- MASK:TESt:AUX:FAILure?
Info
<NR1>= 0 disables themask:test:aux:failurefunction; any other value enables it.OFFturns off the pass/failmask:test:auxon failure. This is the default.ONturns on the pass/failmask:test:auxon failure.
MaskTestBeep
¶
Bases: SCPICmdRead
The MASK:TESt:BEEP command tree.
Usage
- Using the
.query()method will send theMASK:TESt:BEEP?query. - Using the
.verify(value)method will send theMASK:TESt:BEEP?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.completion: TheMASK:TESt:BEEP:COMPLetioncommand..failure: TheMASK:TESt:BEEP:FAILurecommand.
completion
property
¶
completion: MaskTestBeepCompletion
Return the MASK:TESt:BEEP:COMPLetion command.
Description
- This command sets or returns the beep on pass/fail test completion mode. When enabled, this command causes the instrument to emit a tone when the mask pass/fail test completes.
Usage
- Using the
.query()method will send theMASK:TESt:BEEP:COMPLetion?query. - Using the
.verify(value)method will send theMASK:TESt:BEEP:COMPLetion?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:TESt:BEEP:COMPLetion valuecommand.
SCPI Syntax
- MASK:TESt:BEEP:COMPLetion {ON|OFF|<NR1>}
- MASK:TESt:BEEP:COMPLetion?
Info
<NR1>= 0 turns off the pass/fail beep on completion, any other integer turns on the pass/fail beep on completion.OFFturns off the pass/fail beep on completion.ONturns on the pass/fail beep on completion.
failure
property
¶
failure: MaskTestBeepFailure
Return the MASK:TESt:BEEP:FAILure command.
Description
- This command sets or returns the beep status on pass/fail test failure mode. When enabled, this command causes the instrument to emit a tone when the pass/fail status changes to ‘Failing’.
Usage
- Using the
.query()method will send theMASK:TESt:BEEP:FAILure?query. - Using the
.verify(value)method will send theMASK:TESt:BEEP:FAILure?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:TESt:BEEP:FAILure valuecommand.
SCPI Syntax
- MASK:TESt:BEEP:FAILure {ON|OFF|<NR1>}
- MASK:TESt:BEEP:FAILure?
Info
<NR1>= 0 turns off the pass/fail beep on failure, and any other integer turns on the pass/fail beep on failure.OFFturns off the pass/fail beep on failure. This is the default.ONturns on the pass/fail beep on failure.
MaskTestBeepCompletion
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:TESt:BEEP:COMPLetion command.
Description
- This command sets or returns the beep on pass/fail test completion mode. When enabled, this command causes the instrument to emit a tone when the mask pass/fail test completes.
Usage
- Using the
.query()method will send theMASK:TESt:BEEP:COMPLetion?query. - Using the
.verify(value)method will send theMASK:TESt:BEEP:COMPLetion?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:TESt:BEEP:COMPLetion valuecommand.
SCPI Syntax
- MASK:TESt:BEEP:COMPLetion {ON|OFF|<NR1>}
- MASK:TESt:BEEP:COMPLetion?
Info
<NR1>= 0 turns off the pass/fail beep on completion, any other integer turns on the pass/fail beep on completion.OFFturns off the pass/fail beep on completion.ONturns on the pass/fail beep on completion.
MaskTestBeepFailure
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:TESt:BEEP:FAILure command.
Description
- This command sets or returns the beep status on pass/fail test failure mode. When enabled, this command causes the instrument to emit a tone when the pass/fail status changes to ‘Failing’.
Usage
- Using the
.query()method will send theMASK:TESt:BEEP:FAILure?query. - Using the
.verify(value)method will send theMASK:TESt:BEEP:FAILure?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:TESt:BEEP:FAILure valuecommand.
SCPI Syntax
- MASK:TESt:BEEP:FAILure {ON|OFF|<NR1>}
- MASK:TESt:BEEP:FAILure?
Info
<NR1>= 0 turns off the pass/fail beep on failure, and any other integer turns on the pass/fail beep on failure.OFFturns off the pass/fail beep on failure. This is the default.ONturns on the pass/fail beep on failure.
MaskTestDelay
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:TESt:DELay command.
Description
- This command specifies the amount of time, in seconds, the instrument should wait after the start of pass/fail mask testing before it evaluates the waveforms. This command is useful if the test system requires some ‘settling’ time. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:TESt:DELay?query. - Using the
.verify(value)method will send theMASK:TESt:DELay?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:TESt:DELay valuecommand.
SCPI Syntax
- MASK:TESt:DELay <NR3>
- MASK:TESt:DELay?
Info
<NR3>is a floating point number that specifies the amount of time in seconds, to delay the start of the mask pass/fail test.
MaskTestHardcopy
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:TESt:HARDCopy command.
Description
- This command will cause the instrument to generate a screen shot to the default printer as
soon as a pass/fail mask test fails, using the current instrument hard copy settings. See
HARDCOPY:ACTIVEPRINTERand other Hardcopy commands for more information on accessing printer settings. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:TESt:HARDCopy?query. - Using the
.verify(value)method will send theMASK:TESt:HARDCopy?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:TESt:HARDCopy valuecommand.
SCPI Syntax
- MASK:TESt:HARDCopy {ON|OFF|<NR1>}
- MASK:TESt:HARDCopy?
Info
ONturns on this feature, so that the instrument will generate a screen hard copy to the default printer upon failure.OFFturns off this feature.<NR1>= 0 turns off this feature; any other value turns it on.
MaskTestLog
¶
Bases: SCPICmdRead
The MASK:TESt:LOG command tree.
Usage
- Using the
.query()method will send theMASK:TESt:LOG?query. - Using the
.verify(value)method will send theMASK:TESt:LOG?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.failure: TheMASK:TESt:LOG:FAILurecommand.
failure
property
¶
failure: MaskTestLogFailure
Return the MASK:TESt:LOG:FAILure command.
Description
- This command sets or returns the log status on pass/fail test failure mode. When enabled, this command causes the instrument to log the current date and time to a file when the pass/fail status changes to ‘Failing’. The file name is determined from the current date and time. The user cannot change this name.
Usage
- Using the
.query()method will send theMASK:TESt:LOG:FAILure?query. - Using the
.verify(value)method will send theMASK:TESt:LOG:FAILure?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:TESt:LOG:FAILure valuecommand.
SCPI Syntax
- MASK:TESt:LOG:FAILure {ON|OFF|<NR1>}
- MASK:TESt:LOG:FAILure?
Info
<NR1>= 0 turns off the pass/fail log on failure, and any other integer turns on the pass/fail log on failure.OFFturns off the pass/fail log on failure. This is the default.ONturns on the pass/fail log on failure.
MaskTestLogFailure
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:TESt:LOG:FAILure command.
Description
- This command sets or returns the log status on pass/fail test failure mode. When enabled, this command causes the instrument to log the current date and time to a file when the pass/fail status changes to ‘Failing’. The file name is determined from the current date and time. The user cannot change this name.
Usage
- Using the
.query()method will send theMASK:TESt:LOG:FAILure?query. - Using the
.verify(value)method will send theMASK:TESt:LOG:FAILure?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:TESt:LOG:FAILure valuecommand.
SCPI Syntax
- MASK:TESt:LOG:FAILure {ON|OFF|<NR1>}
- MASK:TESt:LOG:FAILure?
Info
<NR1>= 0 turns off the pass/fail log on failure, and any other integer turns on the pass/fail log on failure.OFFturns off the pass/fail log on failure. This is the default.ONturns on the pass/fail log on failure.
MaskTestRepeat
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:TESt:REPeat command.
Description
- This command causes the mask test cycle to continuously repeat upon the completion of the previous test cycle. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:TESt:REPeat?query. - Using the
.verify(value)method will send theMASK:TESt:REPeat?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:TESt:REPeat valuecommand.
SCPI Syntax
- MASK:TESt:REPeat {ON|OFF|<NR1>}
- MASK:TESt:REPeat?
Info
ONturns on this feature, so that the mask test cycle repeats continuously upon the completion of the previous test cycle.OFFturns off this feature.<NR1>is an integer. 0 turns off this feature; any other integer turns it on.
MaskTestSample
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:TESt:SAMple command.
Description
- This command sets or returns the minimum number of waveform database (WfmDB) points the
instrument can acquire before it stops a single sequence acquisition or stops running a
mask test. Hint: a bigger sample size can allow a greater throughput (more waveforms to
get acquired at a time). However, a very large sample size can slow down the display
update. So to speed up the display rate, consider reducing the sample size. This command
works the same as the
ACQUIRE:NUMSAMPLEScommand.
Usage
- Using the
.query()method will send theMASK:TESt:SAMple?query. - Using the
.verify(value)method will send theMASK:TESt:SAMple?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:TESt:SAMple valuecommand.
SCPI Syntax
- MASK:TESt:SAMple {<NR1>}
- MASK:TESt:SAMple?
Info
<NR1>the number of points to sample.
Properties
.threshold: TheMASK:TESt:SAMple:THResholdcommand.
threshold
property
¶
threshold: MaskTestSampleThreshold
Return the MASK:TESt:SAMple:THReshold command.
Description
- This command sets or returns the minimum number of hits in mask regions needed to cause the pass/fail status to change from PASSING to FAILING. This affects the mask test when the instrument is acquiring in waveform database (WfmDB) mode.
Usage
- Using the
.query()method will send theMASK:TESt:SAMple:THReshold?query. - Using the
.verify(value)method will send theMASK:TESt:SAMple:THReshold?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:TESt:SAMple:THReshold valuecommand.
SCPI Syntax
- MASK:TESt:SAMple:THReshold {<NR1>}
- MASK:TESt:SAMple:THReshold?
Info
<NR1>is the number of hits that can happen when the test fails.
MaskTestSampleThreshold
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:TESt:SAMple:THReshold command.
Description
- This command sets or returns the minimum number of hits in mask regions needed to cause the pass/fail status to change from PASSING to FAILING. This affects the mask test when the instrument is acquiring in waveform database (WfmDB) mode.
Usage
- Using the
.query()method will send theMASK:TESt:SAMple:THReshold?query. - Using the
.verify(value)method will send theMASK:TESt:SAMple:THReshold?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:TESt:SAMple:THReshold valuecommand.
SCPI Syntax
- MASK:TESt:SAMple:THReshold {<NR1>}
- MASK:TESt:SAMple:THReshold?
Info
<NR1>is the number of hits that can happen when the test fails.
MaskTestSavewfm
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:TESt:SAVEWFM command.
Description
- This command copies the waveform data from all active channels to a file on a flash memory
device such as a USB stick or a network drive. See the command
FILESYSTEM:MKDIRand other File System commands for more information on saving to a file. TheMASK:ACTONEVENT:ENABLEcommand should be set to ON for this event to happen. After the event occursMASK:ACTONEVENT:ENABLEcommand will be set to OFF automatically. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:TESt:SAVEWFM?query. - Using the
.verify(value)method will send theMASK:TESt:SAVEWFM?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:TESt:SAVEWFM valuecommand.
SCPI Syntax
- MASK:TESt:SAVEWFM {ON|OFF|<NR1>}
- MASK:TESt:SAVEWFM?
Info
ONturns on this feature, so that waveform data from all active channels is copied to files upon test failure.OFFturns off this feature.<NR1>is an integer. 0 turns off this feature; any other value turns it on.
Properties
.filename: TheMASK:TESt:SAVEWFM:FILENamecommand.
filename
property
¶
filename: MaskTestSavewfmFilename
Return the MASK:TESt:SAVEWFM:FILEName command.
Description
- This command sets or returns the name of the directory and file to use with the
MASK:TEST:SAVEWFMcommand. It defines the directory the files will be put in (name comes from date and time).
Usage
- Using the
.query()method will send theMASK:TESt:SAVEWFM:FILEName?query. - Using the
.verify(value)method will send theMASK:TESt:SAVEWFM:FILEName?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:TESt:SAVEWFM:FILEName valuecommand.
SCPI Syntax
- MASK:TESt:SAVEWFM:FILEName <QString>
- MASK:TESt:SAVEWFM:FILEName?
Info
<QString>is a string representing the name of the file to save waveform data to.
MaskTestSavewfmFilename
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:TESt:SAVEWFM:FILEName command.
Description
- This command sets or returns the name of the directory and file to use with the
MASK:TEST:SAVEWFMcommand. It defines the directory the files will be put in (name comes from date and time).
Usage
- Using the
.query()method will send theMASK:TESt:SAVEWFM:FILEName?query. - Using the
.verify(value)method will send theMASK:TESt:SAVEWFM:FILEName?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:TESt:SAVEWFM:FILEName valuecommand.
SCPI Syntax
- MASK:TESt:SAVEWFM:FILEName <QString>
- MASK:TESt:SAVEWFM:FILEName?
Info
<QString>is a string representing the name of the file to save waveform data to.
MaskTestSrq
¶
Bases: SCPICmdRead
The MASK:TESt:SRQ command tree.
Usage
- Using the
.query()method will send theMASK:TESt:SRQ?query. - Using the
.verify(value)method will send theMASK:TESt:SRQ?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.completion: TheMASK:TESt:SRQ:COMPLetioncommand..failure: TheMASK:TESt:SRQ:FAILurecommand.
completion
property
¶
completion: MaskTestSrqCompletion
Return the MASK:TESt:SRQ:COMPLetion command.
Description
- This command causes the instrument to send an SRQ command when a pass/fail mask test
completes. Use the command
MASK:TEST:COMPLETION:CRITERIONto specify criterion. TheMASK:ACTONEVENT:ENABLEcommand should be set to ON for this event to happen. After the event occursMASK:ACTONEVENT:ENABLEcommand will be set to OFF automatically. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:TESt:SRQ:COMPLetion?query. - Using the
.verify(value)method will send theMASK:TESt:SRQ:COMPLetion?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:TESt:SRQ:COMPLetion valuecommand.
SCPI Syntax
- MASK:TESt:SRQ:COMPLetion {ON|OFF|<NR1>}
- MASK:TESt:SRQ:COMPLetion?
Info
ONturns on this feature, so that upon the completion of a mask test, the instrument will send an SRQ command (if registers are set to send SRQ when OPC is asserted).OFFturns off this feature.<NR1>is an integer. 0 turns off this feature; any other integer turns it on.
failure
property
¶
failure: MaskTestSrqFailure
Return the MASK:TESt:SRQ:FAILure command.
Description
- This command causes the instrument to send an SRQ command when a pass/fail mask test fails. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:TESt:SRQ:FAILure?query. - Using the
.verify(value)method will send theMASK:TESt:SRQ:FAILure?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:TESt:SRQ:FAILure valuecommand.
SCPI Syntax
- MASK:TESt:SRQ:FAILure {ON|OFF|<NR1>}
- MASK:TESt:SRQ:FAILure?
Info
ONturns on this feature, so that when a mask test fails, the instrument will send an SRQ command (if registers are set to send SRQ when OPC is asserted.OFFturns off this feature.<NR1>is an integer. 0 turns off this feature; any other integer turns it on.
MaskTestSrqCompletion
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:TESt:SRQ:COMPLetion command.
Description
- This command causes the instrument to send an SRQ command when a pass/fail mask test
completes. Use the command
MASK:TEST:COMPLETION:CRITERIONto specify criterion. TheMASK:ACTONEVENT:ENABLEcommand should be set to ON for this event to happen. After the event occursMASK:ACTONEVENT:ENABLEcommand will be set to OFF automatically. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:TESt:SRQ:COMPLetion?query. - Using the
.verify(value)method will send theMASK:TESt:SRQ:COMPLetion?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:TESt:SRQ:COMPLetion valuecommand.
SCPI Syntax
- MASK:TESt:SRQ:COMPLetion {ON|OFF|<NR1>}
- MASK:TESt:SRQ:COMPLetion?
Info
ONturns on this feature, so that upon the completion of a mask test, the instrument will send an SRQ command (if registers are set to send SRQ when OPC is asserted).OFFturns off this feature.<NR1>is an integer. 0 turns off this feature; any other integer turns it on.
MaskTestSrqFailure
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:TESt:SRQ:FAILure command.
Description
- This command causes the instrument to send an SRQ command when a pass/fail mask test fails. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:TESt:SRQ:FAILure?query. - Using the
.verify(value)method will send theMASK:TESt:SRQ:FAILure?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:TESt:SRQ:FAILure valuecommand.
SCPI Syntax
- MASK:TESt:SRQ:FAILure {ON|OFF|<NR1>}
- MASK:TESt:SRQ:FAILure?
Info
ONturns on this feature, so that when a mask test fails, the instrument will send an SRQ command (if registers are set to send SRQ when OPC is asserted.OFFturns off this feature.<NR1>is an integer. 0 turns off this feature; any other integer turns it on.
MaskTestState
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:TESt:STATE command.
Description
- This command turns the pass/fail mask test on or off. Most of the other
MASK:TESTcommands need to be executed before this command. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:TESt:STATE?query. - Using the
.verify(value)method will send theMASK:TESt:STATE?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:TESt:STATE valuecommand.
SCPI Syntax
- MASK:TESt:STATE {ON|OFF|<NR1>}
- MASK:TESt:STATE?
Info
ONturns the mask test on.OFFturns the mask test off.<NR1>is an integer. 0 turns the mask test off; any other integer turns it on.
MaskTestStatus
¶
Bases: SCPICmdRead
The MASK:TESt:STATUS command.
Description
- This query-only command returns the pass/fail test status. This command returns one of: OFF, DELAY, PASSING, FAILING, PASSED, FAILED, and VIOLATION. In other words, it indicates the result of the pass/fail test. When the violation count exceeds the violation threshold, the status changes from Passing to Failed.
Usage
- Using the
.query()method will send theMASK:TESt:STATUS?query. - Using the
.verify(value)method will send theMASK:TESt:STATUS?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MASK:TESt:STATUS?
MaskTestStop
¶
Bases: SCPICmdRead
The MASK:TESt:STOP command tree.
Usage
- Using the
.query()method will send theMASK:TESt:STOP?query. - Using the
.verify(value)method will send theMASK:TESt:STOP?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.failure: TheMASK:TESt:STOP:FAILurecommand.
failure
property
¶
failure: MaskTestStopFailure
Return the MASK:TESt:STOP:FAILure command.
Description
- This command sets or returns the stop status on pass/fail test failure mode. When enabled, this command causes the instrument to stop acquiring data when the pass/fail status changes to ‘Failing’. Repeat-on-completion mode has no effect.
Usage
- Using the
.query()method will send theMASK:TESt:STOP:FAILure?query. - Using the
.verify(value)method will send theMASK:TESt:STOP:FAILure?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:TESt:STOP:FAILure valuecommand.
SCPI Syntax
- MASK:TESt:STOP:FAILure {ON|OFF|<NR1>}
- MASK:TESt:STOP:FAILure?
Info
<NR1>= 0 turns off the pass/fail stop on failure, and any other integer turns on the pass/fail SRQ on failure.OFFturns off the pass/fail stop on failure. This is the default.ONturns on the pass/fail stop on failure.
MaskTestStopFailure
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:TESt:STOP:FAILure command.
Description
- This command sets or returns the stop status on pass/fail test failure mode. When enabled, this command causes the instrument to stop acquiring data when the pass/fail status changes to ‘Failing’. Repeat-on-completion mode has no effect.
Usage
- Using the
.query()method will send theMASK:TESt:STOP:FAILure?query. - Using the
.verify(value)method will send theMASK:TESt:STOP:FAILure?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:TESt:STOP:FAILure valuecommand.
SCPI Syntax
- MASK:TESt:STOP:FAILure {ON|OFF|<NR1>}
- MASK:TESt:STOP:FAILure?
Info
<NR1>= 0 turns off the pass/fail stop on failure, and any other integer turns on the pass/fail SRQ on failure.OFFturns off the pass/fail stop on failure. This is the default.ONturns on the pass/fail stop on failure.
MaskTestThreshold
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:TESt:THReshold command.
Description
- This command specifies the number of failed tested waveforms needed in a pass/fail mask test to cause the test status to change to ‘Failing’. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:TESt:THReshold?query. - Using the
.verify(value)method will send theMASK:TESt:THReshold?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:TESt:THReshold valuecommand.
SCPI Syntax
- MASK:TESt:THReshold <NR1>
- MASK:TESt:THReshold?
Info
<NR1>is an integer that specifies the number of tested waveform violations occurring in each mask test that will change the test status to ‘Failing’. The maximum number of failed tested waveforms that can be specified is 1E09. The default is 1.
MaskTestWaveform
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:TESt:WAVEform command.
Description
- This command specifies the number of waveforms the instrument should test during a pass/fail mask test. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:TESt:WAVEform?query. - Using the
.verify(value)method will send theMASK:TESt:WAVEform?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:TESt:WAVEform valuecommand.
SCPI Syntax
- MASK:TESt:WAVEform <NR1>
- MASK:TESt:WAVEform?
Info
<NR1>is an integer that specifies the number of waveforms to test. The maximum waveform count that can be specified is 1E09.
MaskUser
¶
Bases: SCPICmdRead
The MASK:USER command tree.
Usage
- Using the
.query()method will send theMASK:USER?query. - Using the
.verify(value)method will send theMASK:USER?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.amplitude: TheMASK:USER:AMPlitudecommand..bitrate: TheMASK:USER:BITRatecommand..hscale: TheMASK:USER:HSCAlecommand..htrigpos: TheMASK:USER:HTRIGPOScommand..label: TheMASK:USER:LABelcommand..patternbits: TheMASK:USER:PATTERNBITScommand..presampbits: TheMASK:USER:PRESAMPBITScommand..recordlength: TheMASK:USER:RECOrdlengthcommand..seg: TheMASK:USER:SEG<m>command..trigtosamp: TheMASK:USER:TRIGTOSAMPcommand..voffset: TheMASK:USER:VOFFSetcommand..vpos: TheMASK:USER:VPOScommand..vscale: TheMASK:USER:VSCAlecommand..width: TheMASK:USER:WIDthcommand.
amplitude
property
¶
amplitude: MaskUserAmplitude
Return the MASK:USER:AMPlitude command.
Description
- This command sets or returns the current mask’s nominal pulse amplitude in volts. The query form of this command returns the nominal pulse amplitude of the displayed mask. The set form of this command affects only the user mask, regardless of the current (displayed) mask.
Usage
- Using the
.query()method will send theMASK:USER:AMPlitude?query. - Using the
.verify(value)method will send theMASK:USER:AMPlitude?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:USER:AMPlitude valuecommand.
SCPI Syntax
- MASK:USER:AMPlitude <NR3>
- MASK:USER:AMPlitude?
Info
<NR3>is a floating number that sets the nominal pulse amplitude in volts.
bitrate
property
¶
bitrate: MaskUserBitrate
Return the MASK:USER:BITRate command.
Description
- This command sets or returns the bit rate for the user mask.
Usage
- Using the
.query()method will send theMASK:USER:BITRate?query. - Using the
.verify(value)method will send theMASK:USER:BITRate?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:USER:BITRate valuecommand.
SCPI Syntax
- MASK:USER:BITRate <NR1>
- MASK:USER:BITRate?
Info
<NR1>is a number that sets the bit rate of the user mask in bits per second.
hscale
property
¶
hscale: MaskUserHscale
Return the MASK:USER:HSCAle command.
Description
- This command specifies the nominal timing resolution, in time/division, to be used to draw a user-defined custom mask pulse shape. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:USER:HSCAle?query. - Using the
.verify(value)method will send theMASK:USER:HSCAle?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:USER:HSCAle valuecommand.
SCPI Syntax
- MASK:USER:HSCAle <NR3>
- MASK:USER:HSCAle?
Info
<NR3>is a floating point value that specifies the timing resolution used to a draw a user-defined custom mask pulse shape.
htrigpos
property
¶
htrigpos: MaskUserHtrigpos
Return the MASK:USER:HTRIGPOS command.
Description
- This command specifies the nominal trigger position (pulse leading edge), to be used to draw a user-defined custom mask, as a fraction of the display width. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:USER:HTRIGPOS?query. - Using the
.verify(value)method will send theMASK:USER:HTRIGPOS?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:USER:HTRIGPOS valuecommand.
SCPI Syntax
- MASK:USER:HTRIGPOS <NR3>
- MASK:USER:HTRIGPOS?
Info
<NR3>is a floating point number in the range of 0.0 to 1.0 that sets the trigger points as a fraction of the display width, referenced from the left edge of the graticule.
label
property
¶
label: MaskUserLabel
Return the MASK:USER:LABel command.
Description
- This command specifies a user-defined label for a custom mask.
Usage
- Using the
.query()method will send theMASK:USER:LABel?query. - Using the
.verify(value)method will send theMASK:USER:LABel?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:USER:LABel valuecommand.
SCPI Syntax
- MASK:USER:LABel <QString>
- MASK:USER:LABel?
patternbits
property
¶
patternbits: MaskUserPatternbits
Return the MASK:USER:PATTERNBITS command.
Description
- This command sets or returns the number of bits used for serial trigger for the User mask standard. For example, DS1 requires six bits, four leading zeros, a one, and a trailing zero. The query form of this command returns the serial bit value of the displayed mask. The set form of this command affects only the User mask, regardless of the current (displayed) mask.
Usage
- Using the
.query()method will send theMASK:USER:PATTERNBITS?query. - Using the
.verify(value)method will send theMASK:USER:PATTERNBITS?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:USER:PATTERNBITS valuecommand.
SCPI Syntax
- MASK:USER:PATTERNBITS <NR1>
- MASK:USER:PATTERNBITS?
Info
<NR1>is an integer that sets the number of bits.
presampbits
property
¶
presampbits: MaskUserPresampbits
Return the MASK:USER:PRESAMPBITS command.
Description
- This command sets or returns the number of bits before the (isolated one) pulse leading edge in the serial trigger pass/fail testing. For example, DS1 has four leading zeros. The query form of this command returns the presample bit value of the displayed mask. The set form of this command only affects the user mask, regardless of the current (displayed) mask.
Usage
- Using the
.query()method will send theMASK:USER:PRESAMPBITS?query. - Using the
.verify(value)method will send theMASK:USER:PRESAMPBITS?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:USER:PRESAMPBITS valuecommand.
SCPI Syntax
- MASK:USER:PRESAMPBITS <NR1>
- MASK:USER:PRESAMPBITS?
Info
<NR1>is an integer that sets the number of bits before the trigger pulse.
recordlength
property
¶
recordlength: MaskUserRecordlength
Return the MASK:USER:RECOrdlength command.
Description
- This command specifies the nominal record length to be used for pulse mask testing with a user-defined custom mask. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:USER:RECOrdlength?query. - Using the
.verify(value)method will send theMASK:USER:RECOrdlength?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:USER:RECOrdlength valuecommand.
SCPI Syntax
- MASK:USER:RECOrdlength <NR1>
- MASK:USER:RECOrdlength?
Info
<NR1>is an integer that sets the record length value to be used for pulse mask testing of a user-defined custom mask.
seg
property
¶
seg: dict[int, MaskUserSegItem]
Return the MASK:USER:SEG<m> command.
Description
- This command deletes the specified mask segment from the user mask, whether or not the user mask is the current mask. m is an integer that specifies the user mask segment number to delete from the user mask.
Usage
- Using the
.write(value)method will send theMASK:USER:SEG<m> valuecommand.
SCPI Syntax
- MASK:USER:SEG<m> DELEte
Info
DELEteremoves the specified segment from the mask.
Sub-properties
.nr_pt: TheMASK:USER:SEG<m>:NR_Ptcommand..points: TheMASK:USER:SEG<m>:POINTScommand.
trigtosamp
property
¶
trigtosamp: MaskUserTrigtosamp
Return the MASK:USER:TRIGTOSAMP command.
Description
- This command specifies the nominal time, in seconds, from the (leading edge) trigger position to the pulse bit sampling position, to be used for testing with a user-defined custom mask. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:USER:TRIGTOSAMP?query. - Using the
.verify(value)method will send theMASK:USER:TRIGTOSAMP?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:USER:TRIGTOSAMP valuecommand.
SCPI Syntax
- MASK:USER:TRIGTOSAMP <NR3>
- MASK:USER:TRIGTOSAMP?
Info
<NR3>is a floating point number that sets the time to the pulse bit sampling position.
voffset
property
¶
voffset: MaskUserVoffset
Return the MASK:USER:VOFFSet command.
Description
- This command specifies the nominal value, in volts, to be used to vertically offset the input channels for a user-defined custom mask. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:USER:VOFFSet?query. - Using the
.verify(value)method will send theMASK:USER:VOFFSet?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:USER:VOFFSet valuecommand.
SCPI Syntax
- MASK:USER:VOFFSet <NR3>
- MASK:USER:VOFFSet?
Info
<NR3>is a floating point number that sets the nominal vertical offset value, in volts.
vpos
property
¶
vpos: MaskUserVpos
Return the MASK:USER:VPOS command.
Description
- This command specifies the nominal value, in divisions, to be used to vertically position the input channels for a user-defined custom mask. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:USER:VPOS?query. - Using the
.verify(value)method will send theMASK:USER:VPOS?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:USER:VPOS valuecommand.
SCPI Syntax
- MASK:USER:VPOS <NR3>
- MASK:USER:VPOS?
Info
<NR3>is a floating point number that sets the nominal vertical position value in divisions.
vscale
property
¶
vscale: MaskUserVscale
Return the MASK:USER:VSCAle command.
Description
- This command specifies the nominal value, in volts per division, to be used to vertically scale the input channels for a user-defined custom mask. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:USER:VSCAle?query. - Using the
.verify(value)method will send theMASK:USER:VSCAle?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:USER:VSCAle valuecommand.
SCPI Syntax
- MASK:USER:VSCAle <NR3>
- MASK:USER:VSCAle?
Info
<NR3>is a floating point number that sets the nominal vertical scale value for the input channels for a user-defined custom mask.
width
property
¶
width: MaskUserWidth
Return the MASK:USER:WIDth command.
Description
- This command specifies the nominal bit width value, in seconds, to be used for a user-defined custom mask. This is the time of one bit of data where bit width = 1 / (data rate of the signal). A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:USER:WIDth?query. - Using the
.verify(value)method will send theMASK:USER:WIDth?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:USER:WIDth valuecommand.
SCPI Syntax
- MASK:USER:WIDth <NR3>
- MASK:USER:WIDth?
Info
<NR3>is a floating point number that indicates the nominal bit width value in seconds.
MaskUserAmplitude
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:USER:AMPlitude command.
Description
- This command sets or returns the current mask’s nominal pulse amplitude in volts. The query form of this command returns the nominal pulse amplitude of the displayed mask. The set form of this command affects only the user mask, regardless of the current (displayed) mask.
Usage
- Using the
.query()method will send theMASK:USER:AMPlitude?query. - Using the
.verify(value)method will send theMASK:USER:AMPlitude?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:USER:AMPlitude valuecommand.
SCPI Syntax
- MASK:USER:AMPlitude <NR3>
- MASK:USER:AMPlitude?
Info
<NR3>is a floating number that sets the nominal pulse amplitude in volts.
MaskUserBitrate
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:USER:BITRate command.
Description
- This command sets or returns the bit rate for the user mask.
Usage
- Using the
.query()method will send theMASK:USER:BITRate?query. - Using the
.verify(value)method will send theMASK:USER:BITRate?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:USER:BITRate valuecommand.
SCPI Syntax
- MASK:USER:BITRate <NR1>
- MASK:USER:BITRate?
Info
<NR1>is a number that sets the bit rate of the user mask in bits per second.
MaskUserHscale
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:USER:HSCAle command.
Description
- This command specifies the nominal timing resolution, in time/division, to be used to draw a user-defined custom mask pulse shape. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:USER:HSCAle?query. - Using the
.verify(value)method will send theMASK:USER:HSCAle?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:USER:HSCAle valuecommand.
SCPI Syntax
- MASK:USER:HSCAle <NR3>
- MASK:USER:HSCAle?
Info
<NR3>is a floating point value that specifies the timing resolution used to a draw a user-defined custom mask pulse shape.
MaskUserHtrigpos
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:USER:HTRIGPOS command.
Description
- This command specifies the nominal trigger position (pulse leading edge), to be used to draw a user-defined custom mask, as a fraction of the display width. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:USER:HTRIGPOS?query. - Using the
.verify(value)method will send theMASK:USER:HTRIGPOS?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:USER:HTRIGPOS valuecommand.
SCPI Syntax
- MASK:USER:HTRIGPOS <NR3>
- MASK:USER:HTRIGPOS?
Info
<NR3>is a floating point number in the range of 0.0 to 1.0 that sets the trigger points as a fraction of the display width, referenced from the left edge of the graticule.
MaskUserLabel
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:USER:LABel command.
Description
- This command specifies a user-defined label for a custom mask.
Usage
- Using the
.query()method will send theMASK:USER:LABel?query. - Using the
.verify(value)method will send theMASK:USER:LABel?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:USER:LABel valuecommand.
SCPI Syntax
- MASK:USER:LABel <QString>
- MASK:USER:LABel?
MaskUserPatternbits
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:USER:PATTERNBITS command.
Description
- This command sets or returns the number of bits used for serial trigger for the User mask standard. For example, DS1 requires six bits, four leading zeros, a one, and a trailing zero. The query form of this command returns the serial bit value of the displayed mask. The set form of this command affects only the User mask, regardless of the current (displayed) mask.
Usage
- Using the
.query()method will send theMASK:USER:PATTERNBITS?query. - Using the
.verify(value)method will send theMASK:USER:PATTERNBITS?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:USER:PATTERNBITS valuecommand.
SCPI Syntax
- MASK:USER:PATTERNBITS <NR1>
- MASK:USER:PATTERNBITS?
Info
<NR1>is an integer that sets the number of bits.
MaskUserPresampbits
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:USER:PRESAMPBITS command.
Description
- This command sets or returns the number of bits before the (isolated one) pulse leading edge in the serial trigger pass/fail testing. For example, DS1 has four leading zeros. The query form of this command returns the presample bit value of the displayed mask. The set form of this command only affects the user mask, regardless of the current (displayed) mask.
Usage
- Using the
.query()method will send theMASK:USER:PRESAMPBITS?query. - Using the
.verify(value)method will send theMASK:USER:PRESAMPBITS?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:USER:PRESAMPBITS valuecommand.
SCPI Syntax
- MASK:USER:PRESAMPBITS <NR1>
- MASK:USER:PRESAMPBITS?
Info
<NR1>is an integer that sets the number of bits before the trigger pulse.
MaskUserRecordlength
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:USER:RECOrdlength command.
Description
- This command specifies the nominal record length to be used for pulse mask testing with a user-defined custom mask. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:USER:RECOrdlength?query. - Using the
.verify(value)method will send theMASK:USER:RECOrdlength?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:USER:RECOrdlength valuecommand.
SCPI Syntax
- MASK:USER:RECOrdlength <NR1>
- MASK:USER:RECOrdlength?
Info
<NR1>is an integer that sets the record length value to be used for pulse mask testing of a user-defined custom mask.
MaskUserSegItem
¶
Bases: ValidatedDynamicNumberCmd, SCPICmdWrite, SCPICmdRead
The MASK:USER:SEG<m> command.
Description
- This command deletes the specified mask segment from the user mask, whether or not the user mask is the current mask. m is an integer that specifies the user mask segment number to delete from the user mask.
Usage
- Using the
.write(value)method will send theMASK:USER:SEG<m> valuecommand.
SCPI Syntax
- MASK:USER:SEG<m> DELEte
Info
DELEteremoves the specified segment from the mask.
Properties
.nr_pt: TheMASK:USER:SEG<m>:NR_Ptcommand..points: TheMASK:USER:SEG<m>:POINTScommand.
nr_pt
property
¶
nr_pt: MaskUserSegItemNrPt
Return the MASK:USER:SEG<m>:NR_Pt command.
Description
- This query-only command returns the number of points that make up the specified user mask segment. Each mask point consists of a pair of X-Y coordinates. m is an integer that specifies a user mask segment number.
Usage
- Using the
.query()method will send theMASK:USER:SEG<m>:NR_Pt?query. - Using the
.verify(value)method will send theMASK:USER:SEG<m>:NR_Pt?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MASK:USER:SEG<m>:NR_Pt?
points
property
¶
points: MaskUserSegItemPoints
Return the MASK:USER:SEG<m>:POINTS command.
Description
- This command sets or returns the X-Y user coordinates of all points in the specified user mask segment. The set form defines new points in the user mask, replacing any existing points in the specified user mask segment. It sets or returns the vertices for a particular segment in the selected mask. m is an integer that specifies the user mask segment number.
Usage
- Using the
.query()method will send theMASK:USER:SEG<m>:POINTS?query. - Using the
.verify(value)method will send theMASK:USER:SEG<m>:POINTS?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:USER:SEG<m>:POINTS valuecommand.
SCPI Syntax
- MASK:USER:SEG<m>:POINTS <NR3>, <NR3> [, <NR3>, <NR3>]
- MASK:USER:SEG<m>:POINTS?
Info
<NR3>refers to the coordinates of one of the vertices in the user mask. Each pair of numbers represents the horizontal and vertical coordinates of a mask segment vertex. The pairs must be listed in a counterclockwise order. If the vertical or horizontal scale or position is changed after this command and then the query form of this command is issued, the value returned from the instrument will not be the same. If just one pair is input, it is ignored and the user mask segment is marked as undefined. The default is not points in the user mask segment.
MaskUserSegItemNrPt
¶
Bases: SCPICmdRead
The MASK:USER:SEG<m>:NR_Pt command.
Description
- This query-only command returns the number of points that make up the specified user mask segment. Each mask point consists of a pair of X-Y coordinates. m is an integer that specifies a user mask segment number.
Usage
- Using the
.query()method will send theMASK:USER:SEG<m>:NR_Pt?query. - Using the
.verify(value)method will send theMASK:USER:SEG<m>:NR_Pt?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MASK:USER:SEG<m>:NR_Pt?
MaskUserSegItemPoints
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:USER:SEG<m>:POINTS command.
Description
- This command sets or returns the X-Y user coordinates of all points in the specified user mask segment. The set form defines new points in the user mask, replacing any existing points in the specified user mask segment. It sets or returns the vertices for a particular segment in the selected mask. m is an integer that specifies the user mask segment number.
Usage
- Using the
.query()method will send theMASK:USER:SEG<m>:POINTS?query. - Using the
.verify(value)method will send theMASK:USER:SEG<m>:POINTS?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:USER:SEG<m>:POINTS valuecommand.
SCPI Syntax
- MASK:USER:SEG<m>:POINTS <NR3>, <NR3> [, <NR3>, <NR3>]
- MASK:USER:SEG<m>:POINTS?
Info
<NR3>refers to the coordinates of one of the vertices in the user mask. Each pair of numbers represents the horizontal and vertical coordinates of a mask segment vertex. The pairs must be listed in a counterclockwise order. If the vertical or horizontal scale or position is changed after this command and then the query form of this command is issued, the value returned from the instrument will not be the same. If just one pair is input, it is ignored and the user mask segment is marked as undefined. The default is not points in the user mask segment.
MaskUserTrigtosamp
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:USER:TRIGTOSAMP command.
Description
- This command specifies the nominal time, in seconds, from the (leading edge) trigger position to the pulse bit sampling position, to be used for testing with a user-defined custom mask. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:USER:TRIGTOSAMP?query. - Using the
.verify(value)method will send theMASK:USER:TRIGTOSAMP?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:USER:TRIGTOSAMP valuecommand.
SCPI Syntax
- MASK:USER:TRIGTOSAMP <NR3>
- MASK:USER:TRIGTOSAMP?
Info
<NR3>is a floating point number that sets the time to the pulse bit sampling position.
MaskUserVoffset
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:USER:VOFFSet command.
Description
- This command specifies the nominal value, in volts, to be used to vertically offset the input channels for a user-defined custom mask. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:USER:VOFFSet?query. - Using the
.verify(value)method will send theMASK:USER:VOFFSet?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:USER:VOFFSet valuecommand.
SCPI Syntax
- MASK:USER:VOFFSet <NR3>
- MASK:USER:VOFFSet?
Info
<NR3>is a floating point number that sets the nominal vertical offset value, in volts.
MaskUserVpos
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:USER:VPOS command.
Description
- This command specifies the nominal value, in divisions, to be used to vertically position the input channels for a user-defined custom mask. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:USER:VPOS?query. - Using the
.verify(value)method will send theMASK:USER:VPOS?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:USER:VPOS valuecommand.
SCPI Syntax
- MASK:USER:VPOS <NR3>
- MASK:USER:VPOS?
Info
<NR3>is a floating point number that sets the nominal vertical position value in divisions.
MaskUserVscale
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:USER:VSCAle command.
Description
- This command specifies the nominal value, in volts per division, to be used to vertically scale the input channels for a user-defined custom mask. A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:USER:VSCAle?query. - Using the
.verify(value)method will send theMASK:USER:VSCAle?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:USER:VSCAle valuecommand.
SCPI Syntax
- MASK:USER:VSCAle <NR3>
- MASK:USER:VSCAle?
Info
<NR3>is a floating point number that sets the nominal vertical scale value for the input channels for a user-defined custom mask.
MaskUserWidth
¶
Bases: SCPICmdWrite, SCPICmdRead
The MASK:USER:WIDth command.
Description
- This command specifies the nominal bit width value, in seconds, to be used for a user-defined custom mask. This is the time of one bit of data where bit width = 1 / (data rate of the signal). A series of examples showing how to use mask commands for typical tasks is included in an appendix.
Usage
- Using the
.query()method will send theMASK:USER:WIDth?query. - Using the
.verify(value)method will send theMASK:USER:WIDth?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMASK:USER:WIDth valuecommand.
SCPI Syntax
- MASK:USER:WIDth <NR3>
- MASK:USER:WIDth?
Info
<NR3>is a floating point number that indicates the nominal bit width value in seconds.