[python source code]

mask

The mask commands module.

These commands are used in the following models: DPO7AX, LPD6, MSO4, MSO4B, MSO5, MSO5B, MSO5LP, MSO6, MSO6B

THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED.

Please report an issue if one is found.

Commands and Queries 
- MASK:DELete <QString>
- MASK:MASK<x>:COUNT:HITS?
- MASK:MASK<x>:COUNT:SEG<x>:HITS?
- MASK:MASK<x>:COUNT?
- MASK:MASK<x>:DEFinedby {SEGments|TOLerances}
- MASK:MASK<x>:DEFinedby?
- MASK:MASK<x>:DISplay {ON|OFF}
- MASK:MASK<x>:DISplay?
- MASK:MASK<x>:LIST?
- MASK:MASK<x>:SEG<x>:POINTS
- MASK:MASK<x>:SEG<x>:POINTS?
- MASK:MASK<x>:SOUrce {CH<x>|REF<x>|MATH<x>|RFvsTime}
- MASK:MASK<x>:SOUrce?
- MASK:MASK<x>:TESt:CTHReshold <NR1>
- MASK:MASK<x>:TESt:CTHReshold?
- MASK:MASK<x>:TESt:STATE {ON|OFF}
- MASK:MASK<x>:TESt:STATE?
- MASK:MASK<x>:TESt:STATUS?
- MASK:MASK<x>:TESt:THReshold <NR1>
- MASK:MASK<x>:TESt:THReshold?
- MASK:MASK<x>:TOLerance:HABSolute <NR3>
- MASK:MASK<x>:TOLerance:HABSolute?
- MASK:MASK<x>:TOLerance:HORizontal <NR3>
- MASK:MASK<x>:TOLerance:HORizontal?
- MASK:MASK<x>:TOLerance:UPDatenow
- MASK:MASK<x>:TOLerance:VABSolute <NR3>
- MASK:MASK<x>:TOLerance:VABSolute?
- MASK:MASK<x>:TOLerance:VERTical <NR3>
- MASK:MASK<x>:TOLerance:VERTical?
- MASK:MASK<x>:TTYPe {SCReen|ABSolute}
- MASK:MASK<x>:TTYPe?
- MASK:TESt:WAVEforms <NR1>
- MASK:TESt:WAVEforms?

Mask

Bases: SCPICmdRead

The MASK command tree.

Usage
  • Using the .query() method will send the MASK? query.
  • Using the .verify(value) method will send the MASK? query and raise an AssertionError if the returned value does not match value.
Properties
  • .delete: The MASK:DELete command.
  • .mask: The MASK:MASK<x> command tree.
  • .test: The MASK:TESt command tree.

delete property 

delete: MaskDelete

Return the MASK:DELete command.

Description
  • This command deletes all mask segments of the specified mask test.
Usage
  • Using the .write(value) method will send the MASK:DELete value command.
SCPI Syntax 
- MASK:DELete <QString>
Info
  • <QString> specifies the mask test. This argument is enclosed in quotes and must be formatted as ‘mask‘.

mask property 

mask: dict[int, MaskMaskItem]

Return the MASK:MASK<x> command tree.

Usage
  • Using the .query() method will send the MASK:MASK<x>? query.
  • Using the .verify(value) method will send the MASK:MASK<x>? query and raise an AssertionError if the returned value does not match value.
Info
  • MASK<x> specifies the mask test.
Sub-properties
  • .count: The MASK:MASK<x>:COUNT command.
  • .definedby: The MASK:MASK<x>:DEFinedby command.
  • .display: The MASK:MASK<x>:DISplay command.
  • .list: The MASK:MASK<x>:LIST command.
  • .seg: The MASK:MASK<x>:SEG<x> command tree.
  • .source: The MASK:MASK<x>:SOUrce command.
  • .test: The MASK:MASK<x>:TESt command tree.
  • .tolerance: The MASK:MASK<x>:TOLerance command tree.
  • .ttype: The MASK:MASK<x>:TTYPe command.

test property 

test: MaskTest

Return the MASK:TESt command tree.

Usage
  • Using the .query() method will send the MASK:TESt? query.
  • Using the .verify(value) method will send the MASK:TESt? query and raise an AssertionError if the returned value does not match value.
Sub-properties
  • .waveforms: The MASK:TESt:WAVEforms command.

MaskDelete

Bases: SCPICmdWrite

The MASK:DELete command.

Description
  • This command deletes all mask segments of the specified mask test.
Usage
  • Using the .write(value) method will send the MASK:DELete value command.
SCPI Syntax 
- MASK:DELete <QString>
Info
  • <QString> specifies the mask test. This argument is enclosed in quotes and must be formatted as ‘mask‘.

MaskMaskItem

Bases: ValidatedDynamicNumberCmd, SCPICmdRead

The MASK:MASK<x> command tree.

Usage
  • Using the .query() method will send the MASK:MASK<x>? query.
  • Using the .verify(value) method will send the MASK:MASK<x>? query and raise an AssertionError if the returned value does not match value.
Info
  • MASK<x> specifies the mask test.
Properties
  • .count: The MASK:MASK<x>:COUNT command.
  • .definedby: The MASK:MASK<x>:DEFinedby command.
  • .display: The MASK:MASK<x>:DISplay command.
  • .list: The MASK:MASK<x>:LIST command.
  • .seg: The MASK:MASK<x>:SEG<x> command tree.
  • .source: The MASK:MASK<x>:SOUrce command.
  • .test: The MASK:MASK<x>:TESt command tree.
  • .tolerance: The MASK:MASK<x>:TOLerance command tree.
  • .ttype: The MASK:MASK<x>:TTYPe command.

count property 

count: MaskMaskItemCount

Return the MASK:MASK<x>:COUNT command.

Description
  • This command returns the total number of mask hits in all segments and the number of mask hits in each individual mask segment for the specified mask test.
Usage
  • Using the .query() method will send the MASK:MASK<x>:COUNT? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:COUNT? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- MASK:MASK<x>:COUNT?
Info
  • MASK<x> specifies the mask test.
Sub-properties
  • .hits: The MASK:MASK<x>:COUNT:HITS command.
  • .seg: The MASK:MASK<x>:COUNT:SEG<x> command tree.

definedby property 

definedby: MaskMaskItemDefinedby

Return the MASK:MASK<x>:DEFinedby command.

Description
  • This command sets or queries whether the specified mask is defined by segments or tolerances. Segment masks are defined by one or more polygons. Tolerance masks are defined by specified horizontal and vertical tolerances around the mask source.
Usage
  • Using the .query() method will send the MASK:MASK<x>:DEFinedby? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:DEFinedby? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the MASK:MASK<x>:DEFinedby value command.
SCPI Syntax 
- MASK:MASK<x>:DEFinedby {SEGments|TOLerances}
- MASK:MASK<x>:DEFinedby?
Info
  • MASK<x> specifies the mask number.
  • SEGments defines the mask by segments.
  • TOLerances defines the mask by horizontal and vertical tolerances around mask source.

display property 

display: MaskMaskItemDisplay

Return the MASK:MASK<x>:DISplay command.

Description
  • This command sets or queries the display state of the mask used for the specified mask test.
Usage
  • Using the .query() method will send the MASK:MASK<x>:DISplay? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:DISplay? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the MASK:MASK<x>:DISplay value command.
SCPI Syntax 
- MASK:MASK<x>:DISplay {ON|OFF}
- MASK:MASK<x>:DISplay?
Info
  • MASK<x> specifies the mask test.
  • ON sets the display state of the specified mask to on.
  • OFF sets the display state of the specified mask to off.

list property 

list: MaskMaskItemList

Return the MASK:MASK<x>:LIST command.

Description
  • This command queries the list of segments in the mask used by the specified mask test.
Usage
  • Using the .query() method will send the MASK:MASK<x>:LIST? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:LIST? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- MASK:MASK<x>:LIST?
Info
  • MASK<x> specifies the mask test.

seg property 

seg: dict[int, MaskMaskItemSegItem]

Return the MASK:MASK<x>:SEG<x> command tree.

Usage
  • Using the .query() method will send the MASK:MASK<x>:SEG<x>? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:SEG<x>? query and raise an AssertionError if the returned value does not match value.
Info
  • MASK<x> specifies the mask test.
  • SEG<x> specifies the mask segment.
Sub-properties
  • .points: The MASK:MASK<x>:SEG<x>:POINTS command.

source property 

source: MaskMaskItemSource

Return the MASK:MASK<x>:SOUrce command.

Description
  • This command sets or queries analog source for the specified mask test.
Usage
  • Using the .query() method will send the MASK:MASK<x>:SOUrce? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:SOUrce? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the MASK:MASK<x>:SOUrce value command.
SCPI Syntax 
- MASK:MASK<x>:SOUrce {CH<x>|REF<x>|MATH<x>|RFvsTime}
- MASK:MASK<x>:SOUrce?
Info
  • MASK<x> specifies the mask test.
  • CH<x> specifies an analog channel as source.
  • MATH<x> specifies a math channel as source.
  • REF<x> specifies a reference waveform as the source.
  • RFvsTime specifies a RF vs Time as the source.

test property 

test: MaskMaskItemTest

Return the MASK:MASK<x>:TESt command tree.

Usage
  • Using the .query() method will send the MASK:MASK<x>:TESt? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:TESt? query and raise an AssertionError if the returned value does not match value.
Info
  • MASK<x> specifies the mask test.
Sub-properties
  • .cthreshold: The MASK:MASK<x>:TESt:CTHReshold command.
  • .state: The MASK:MASK<x>:TESt:STATE command.
  • .status: The MASK:MASK<x>:TESt:STATUS command.
  • .threshold: The MASK:MASK<x>:TESt:THReshold command.

tolerance property 

tolerance: MaskMaskItemTolerance

Return the MASK:MASK<x>:TOLerance command tree.

Usage
  • Using the .query() method will send the MASK:MASK<x>:TOLerance? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:TOLerance? query and raise an AssertionError if the returned value does not match value.
Info
  • MASK<x> specifies the mask number.
Sub-properties
  • .habsolute: The MASK:MASK<x>:TOLerance:HABSolute command.
  • .horizontal: The MASK:MASK<x>:TOLerance:HORizontal command.
  • .updatenow: The MASK:MASK<x>:TOLerance:UPDatenow command.
  • .vabsolute: The MASK:MASK<x>:TOLerance:VABSolute command.
  • .vertical: The MASK:MASK<x>:TOLerance:VERTical command.

ttype property 

ttype: MaskMaskItemTtype

Return the MASK:MASK<x>:TTYPe command.

Description
  • This command sets or queries the type of tolerance values used when defining a tolerance mask.
Usage
  • Using the .query() method will send the MASK:MASK<x>:TTYPe? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:TTYPe? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the MASK:MASK<x>:TTYPe value command.
SCPI Syntax 
- MASK:MASK<x>:TTYPe {SCReen|ABSolute}
- MASK:MASK<x>:TTYPe?
Info
  • MASK<x> specifies the mask test.
  • SCReen indicates that the horizontal and vertical mask tolerances are defined in relative units of graticule divisions. There are always 10 horizontal divisions and 10 vertical divisions on the scope waveform display. When the tolerance type is SCReen, the tolerance values set by the HORizontal and VERTical commands are used to define the tolerance mask when an UPDatenow command is sent.
  • ABSolute indicates that the horizontal and vertical mask tolerances are defined in the absolute units of the mask source waveform. These units are normally seconds and volts respectively. When the tolerance type is ABSolute, the tolerance values set by the HABSolute and VABSolute commands are used to define the tolerance mask when an UPDatenow command is sent.

MaskMaskItemCount

Bases: SCPICmdRead

The MASK:MASK<x>:COUNT command.

Description
  • This command returns the total number of mask hits in all segments and the number of mask hits in each individual mask segment for the specified mask test.
Usage
  • Using the .query() method will send the MASK:MASK<x>:COUNT? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:COUNT? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- MASK:MASK<x>:COUNT?
Info
  • MASK<x> specifies the mask test.
Properties
  • .hits: The MASK:MASK<x>:COUNT:HITS command.
  • .seg: The MASK:MASK<x>:COUNT:SEG<x> command tree.

hits property 

hits: MaskMaskItemCountHits

Return the MASK:MASK<x>:COUNT:HITS command.

Description
  • This command returns the total number of mask hits in all mask segments for the specified mask test.
Usage
  • Using the .query() method will send the MASK:MASK<x>:COUNT:HITS? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:COUNT:HITS? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- MASK:MASK<x>:COUNT:HITS?
Info
  • MASK<x> specifies the mask test.

seg property 

seg: dict[int, MaskMaskItemCountSegItem]

Return the MASK:MASK<x>:COUNT:SEG<x> command tree.

Usage
  • Using the .query() method will send the MASK:MASK<x>:COUNT:SEG<x>? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:COUNT:SEG<x>? query and raise an AssertionError if the returned value does not match value.
Info
  • MASK<x> specifies the mask test.
  • SEG<x> specifies the mask segment.
Sub-properties
  • .hits: The MASK:MASK<x>:COUNT:SEG<x>:HITS command.

MaskMaskItemCountHits

Bases: SCPICmdRead

The MASK:MASK<x>:COUNT:HITS command.

Description
  • This command returns the total number of mask hits in all mask segments for the specified mask test.
Usage
  • Using the .query() method will send the MASK:MASK<x>:COUNT:HITS? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:COUNT:HITS? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- MASK:MASK<x>:COUNT:HITS?
Info
  • MASK<x> specifies the mask test.

MaskMaskItemCountSegItem

Bases: ValidatedDynamicNumberCmd, SCPICmdRead

The MASK:MASK<x>:COUNT:SEG<x> command tree.

Usage
  • Using the .query() method will send the MASK:MASK<x>:COUNT:SEG<x>? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:COUNT:SEG<x>? query and raise an AssertionError if the returned value does not match value.
Info
  • MASK<x> specifies the mask test.
  • SEG<x> specifies the mask segment.
Properties
  • .hits: The MASK:MASK<x>:COUNT:SEG<x>:HITS command.

hits property 

hits: MaskMaskItemCountSegItemHits

Return the MASK:MASK<x>:COUNT:SEG<x>:HITS command.

Description
  • The command returns the total number of mask hits in the specified mask segment of the specified mask test.
Usage
  • Using the .query() method will send the MASK:MASK<x>:COUNT:SEG<x>:HITS? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:COUNT:SEG<x>:HITS? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- MASK:MASK<x>:COUNT:SEG<x>:HITS?
Info
  • MASK<x> specifies the mask test.
  • SEG<x> specifies the mask segment.

MaskMaskItemCountSegItemHits

Bases: SCPICmdRead

The MASK:MASK<x>:COUNT:SEG<x>:HITS command.

Description
  • The command returns the total number of mask hits in the specified mask segment of the specified mask test.
Usage
  • Using the .query() method will send the MASK:MASK<x>:COUNT:SEG<x>:HITS? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:COUNT:SEG<x>:HITS? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- MASK:MASK<x>:COUNT:SEG<x>:HITS?
Info
  • MASK<x> specifies the mask test.
  • SEG<x> specifies the mask segment.

MaskMaskItemDefinedby

Bases: SCPICmdWrite, SCPICmdRead

The MASK:MASK<x>:DEFinedby command.

Description
  • This command sets or queries whether the specified mask is defined by segments or tolerances. Segment masks are defined by one or more polygons. Tolerance masks are defined by specified horizontal and vertical tolerances around the mask source.
Usage
  • Using the .query() method will send the MASK:MASK<x>:DEFinedby? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:DEFinedby? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the MASK:MASK<x>:DEFinedby value command.
SCPI Syntax 
- MASK:MASK<x>:DEFinedby {SEGments|TOLerances}
- MASK:MASK<x>:DEFinedby?
Info
  • MASK<x> specifies the mask number.
  • SEGments defines the mask by segments.
  • TOLerances defines the mask by horizontal and vertical tolerances around mask source.

MaskMaskItemDisplay

Bases: SCPICmdWrite, SCPICmdRead

The MASK:MASK<x>:DISplay command.

Description
  • This command sets or queries the display state of the mask used for the specified mask test.
Usage
  • Using the .query() method will send the MASK:MASK<x>:DISplay? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:DISplay? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the MASK:MASK<x>:DISplay value command.
SCPI Syntax 
- MASK:MASK<x>:DISplay {ON|OFF}
- MASK:MASK<x>:DISplay?
Info
  • MASK<x> specifies the mask test.
  • ON sets the display state of the specified mask to on.
  • OFF sets the display state of the specified mask to off.

MaskMaskItemList

Bases: SCPICmdRead

The MASK:MASK<x>:LIST command.

Description
  • This command queries the list of segments in the mask used by the specified mask test.
Usage
  • Using the .query() method will send the MASK:MASK<x>:LIST? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:LIST? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- MASK:MASK<x>:LIST?
Info
  • MASK<x> specifies the mask test.

MaskMaskItemSegItem

Bases: ValidatedDynamicNumberCmd, SCPICmdRead

The MASK:MASK<x>:SEG<x> command tree.

Usage
  • Using the .query() method will send the MASK:MASK<x>:SEG<x>? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:SEG<x>? query and raise an AssertionError if the returned value does not match value.
Info
  • MASK<x> specifies the mask test.
  • SEG<x> specifies the mask segment.
Properties
  • .points: The MASK:MASK<x>:SEG<x>:POINTS command.

points property 

points: MaskMaskItemSegItemPoints

Return the MASK:MASK<x>:SEG<x>:POINTS command.

Description
  • This command sets or queries the X/Y coordinates of all points in the designated mask segment. Mask vertices are in time/volts (currently limited to 1024 characters). The set form defines new points in the mask, replacing any existing points.
Usage
  • Using the .query() method will send the MASK:MASK<x>:SEG<x>:POINTS? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:SEG<x>:POINTS? query and raise an AssertionError if the returned value does not match value.
  • Using the .write() method will send the MASK:MASK<x>:SEG<x>:POINTS command.
SCPI Syntax 
- MASK:MASK<x>:SEG<x>:POINTS
- MASK:MASK<x>:SEG<x>:POINTS?
Info
  • MASK<x> specifies the mask test.
  • SEG<x> specifies the mask segment.

MaskMaskItemSegItemPoints

Bases: SCPICmdWriteNoArguments, SCPICmdRead

The MASK:MASK<x>:SEG<x>:POINTS command.

Description
  • This command sets or queries the X/Y coordinates of all points in the designated mask segment. Mask vertices are in time/volts (currently limited to 1024 characters). The set form defines new points in the mask, replacing any existing points.
Usage
  • Using the .query() method will send the MASK:MASK<x>:SEG<x>:POINTS? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:SEG<x>:POINTS? query and raise an AssertionError if the returned value does not match value.
  • Using the .write() method will send the MASK:MASK<x>:SEG<x>:POINTS command.
SCPI Syntax 
- MASK:MASK<x>:SEG<x>:POINTS
- MASK:MASK<x>:SEG<x>:POINTS?
Info
  • MASK<x> specifies the mask test.
  • SEG<x> specifies the mask segment.

MaskMaskItemSource

Bases: SCPICmdWrite, SCPICmdRead

The MASK:MASK<x>:SOUrce command.

Description
  • This command sets or queries analog source for the specified mask test.
Usage
  • Using the .query() method will send the MASK:MASK<x>:SOUrce? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:SOUrce? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the MASK:MASK<x>:SOUrce value command.
SCPI Syntax 
- MASK:MASK<x>:SOUrce {CH<x>|REF<x>|MATH<x>|RFvsTime}
- MASK:MASK<x>:SOUrce?
Info
  • MASK<x> specifies the mask test.
  • CH<x> specifies an analog channel as source.
  • MATH<x> specifies a math channel as source.
  • REF<x> specifies a reference waveform as the source.
  • RFvsTime specifies a RF vs Time as the source.

MaskMaskItemTest

Bases: SCPICmdRead

The MASK:MASK<x>:TESt command tree.

Usage
  • Using the .query() method will send the MASK:MASK<x>:TESt? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:TESt? query and raise an AssertionError if the returned value does not match value.
Info
  • MASK<x> specifies the mask test.
Properties
  • .cthreshold: The MASK:MASK<x>:TESt:CTHReshold command.
  • .state: The MASK:MASK<x>:TESt:STATE command.
  • .status: The MASK:MASK<x>:TESt:STATUS command.
  • .threshold: The MASK:MASK<x>:TESt:THReshold command.

cthreshold property 

cthreshold: MaskMaskItemTestCthreshold

Return the MASK:MASK<x>:TESt:CTHReshold command.

Description
  • This command sets or queries the number of consecutive waveform violations needed for the specified mask test to change from PASS to FAIL.
Usage
  • Using the .query() method will send the MASK:MASK<x>:TESt:CTHReshold? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:TESt:CTHReshold? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the MASK:MASK<x>:TESt:CTHReshold value command.
SCPI Syntax 
- MASK:MASK<x>:TESt:CTHReshold <NR1>
- MASK:MASK<x>:TESt:CTHReshold?
Info
  • MASK<x> specifies the mask test.
  • <NR1> specifies the threshold value.

state property 

state: MaskMaskItemTestState

Return the MASK:MASK<x>:TESt:STATE command.

Description
  • This command sets or queries the state of the specified mask test.
Usage
  • Using the .query() method will send the MASK:MASK<x>:TESt:STATE? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:TESt:STATE? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the MASK:MASK<x>:TESt:STATE value command.
SCPI Syntax 
- MASK:MASK<x>:TESt:STATE {ON|OFF}
- MASK:MASK<x>:TESt:STATE?
Info
  • MASK<x> specifies the mask test.
  • ON sets the mask test state to ON. When the state is ON the Pass/Fail status and hit count information are reset and the mask test is started.
  • OFF sets the mask test state to OFF. When the mask test completes the state is set to OFF.

status property 

status: MaskMaskItemTestStatus

Return the MASK:MASK<x>:TESt:STATUS command.

Description
  • This command returns the status of the specified mask test.
Usage
  • Using the .query() method will send the MASK:MASK<x>:TESt:STATUS? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:TESt:STATUS? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- MASK:MASK<x>:TESt:STATUS?
Info
  • MASK<x> specifies the mask test.

threshold property 

threshold: MaskMaskItemTestThreshold

Return the MASK:MASK<x>:TESt:THReshold command.

Description
  • This command sets or queries the number of waveform violations needed for the specified mask test to change from PASS to FAIL.
Usage
  • Using the .query() method will send the MASK:MASK<x>:TESt:THReshold? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:TESt:THReshold? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the MASK:MASK<x>:TESt:THReshold value command.
SCPI Syntax 
- MASK:MASK<x>:TESt:THReshold <NR1>
- MASK:MASK<x>:TESt:THReshold?
Info
  • MASK<x> specifies the mask test.
  • <NR1> specifies the threshold value.

MaskMaskItemTestCthreshold

Bases: SCPICmdWrite, SCPICmdRead

The MASK:MASK<x>:TESt:CTHReshold command.

Description
  • This command sets or queries the number of consecutive waveform violations needed for the specified mask test to change from PASS to FAIL.
Usage
  • Using the .query() method will send the MASK:MASK<x>:TESt:CTHReshold? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:TESt:CTHReshold? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the MASK:MASK<x>:TESt:CTHReshold value command.
SCPI Syntax 
- MASK:MASK<x>:TESt:CTHReshold <NR1>
- MASK:MASK<x>:TESt:CTHReshold?
Info
  • MASK<x> specifies the mask test.
  • <NR1> specifies the threshold value.

MaskMaskItemTestState

Bases: SCPICmdWrite, SCPICmdRead

The MASK:MASK<x>:TESt:STATE command.

Description
  • This command sets or queries the state of the specified mask test.
Usage
  • Using the .query() method will send the MASK:MASK<x>:TESt:STATE? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:TESt:STATE? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the MASK:MASK<x>:TESt:STATE value command.
SCPI Syntax 
- MASK:MASK<x>:TESt:STATE {ON|OFF}
- MASK:MASK<x>:TESt:STATE?
Info
  • MASK<x> specifies the mask test.
  • ON sets the mask test state to ON. When the state is ON the Pass/Fail status and hit count information are reset and the mask test is started.
  • OFF sets the mask test state to OFF. When the mask test completes the state is set to OFF.

MaskMaskItemTestStatus

Bases: SCPICmdRead

The MASK:MASK<x>:TESt:STATUS command.

Description
  • This command returns the status of the specified mask test.
Usage
  • Using the .query() method will send the MASK:MASK<x>:TESt:STATUS? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:TESt:STATUS? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- MASK:MASK<x>:TESt:STATUS?
Info
  • MASK<x> specifies the mask test.

MaskMaskItemTestThreshold

Bases: SCPICmdWrite, SCPICmdRead

The MASK:MASK<x>:TESt:THReshold command.

Description
  • This command sets or queries the number of waveform violations needed for the specified mask test to change from PASS to FAIL.
Usage
  • Using the .query() method will send the MASK:MASK<x>:TESt:THReshold? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:TESt:THReshold? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the MASK:MASK<x>:TESt:THReshold value command.
SCPI Syntax 
- MASK:MASK<x>:TESt:THReshold <NR1>
- MASK:MASK<x>:TESt:THReshold?
Info
  • MASK<x> specifies the mask test.
  • <NR1> specifies the threshold value.

MaskMaskItemTolerance

Bases: SCPICmdRead

The MASK:MASK<x>:TOLerance command tree.

Usage
  • Using the .query() method will send the MASK:MASK<x>:TOLerance? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:TOLerance? query and raise an AssertionError if the returned value does not match value.
Info
  • MASK<x> specifies the mask number.
Properties
  • .habsolute: The MASK:MASK<x>:TOLerance:HABSolute command.
  • .horizontal: The MASK:MASK<x>:TOLerance:HORizontal command.
  • .updatenow: The MASK:MASK<x>:TOLerance:UPDatenow command.
  • .vabsolute: The MASK:MASK<x>:TOLerance:VABSolute command.
  • .vertical: The MASK:MASK<x>:TOLerance:VERTical command.

habsolute property 

habsolute: MaskMaskItemToleranceHabsolute

Return the MASK:MASK<x>:TOLerance:HABSolute command.

Description
  • This command sets or queries the mask horizontal tolerance in absolute units of seconds. This value is used when the mask TTYPe is set to ABSolute and the UPDatenow command is sent.
Usage
  • Using the .query() method will send the MASK:MASK<x>:TOLerance:HABSolute? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:TOLerance:HABSolute? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the MASK:MASK<x>:TOLerance:HABSolute value command.
SCPI Syntax 
- MASK:MASK<x>:TOLerance:HABSolute <NR3>
- MASK:MASK<x>:TOLerance:HABSolute?
Info
  • MASK<x> specifies the mask number.
  • <NR3> is the tolerance in units of seconds. The maximum time is the equivalent of one horizontal graticule division.

horizontal property 

horizontal: MaskMaskItemToleranceHorizontal

Return the MASK:MASK<x>:TOLerance:HORizontal command.

Description
  • This command sets or queries the mask horizontal tolerance.
Usage
  • Using the .query() method will send the MASK:MASK<x>:TOLerance:HORizontal? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:TOLerance:HORizontal? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the MASK:MASK<x>:TOLerance:HORizontal value command.
SCPI Syntax 
- MASK:MASK<x>:TOLerance:HORizontal <NR3>
- MASK:MASK<x>:TOLerance:HORizontal?
Info
  • MASK<x> specifies the mask test.
  • <NR3> is the tolerance in units of graticule divisions. The maximum is 1 division.

updatenow property 

updatenow: MaskMaskItemToleranceUpdatenow

Return the MASK:MASK<x>:TOLerance:UPDatenow command.

Description
  • This command causes the tolerance mask to be recalculated with the current horizontal and vertical tolerances.
Usage
  • Using the .write() method will send the MASK:MASK<x>:TOLerance:UPDatenow command.
SCPI Syntax 
- MASK:MASK<x>:TOLerance:UPDatenow
Info
  • MASK<x> specifies the mask test.

vabsolute property 

vabsolute: MaskMaskItemToleranceVabsolute

Return the MASK:MASK<x>:TOLerance:VABSolute command.

Description
  • This command sets or queries the mask vertical tolerance in absolute units of the mask source (generally volts). This value is used when the mask TTYPe is set to ABSolute and the UPDatenow command is sent.
Usage
  • Using the .query() method will send the MASK:MASK<x>:TOLerance:VABSolute? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:TOLerance:VABSolute? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the MASK:MASK<x>:TOLerance:VABSolute value command.
SCPI Syntax 
- MASK:MASK<x>:TOLerance:VABSolute <NR3>
- MASK:MASK<x>:TOLerance:VABSolute?
Info
  • MASK<x> specifies the mask test.
  • <NR3> is the tolerance in units of the mask source. Most traces in the waveform window have vertical units of volts, but other units such as amps or degrees are possible. The maximum value is the equivalent of one vertical graticule division.

vertical property 

vertical: MaskMaskItemToleranceVertical

Return the MASK:MASK<x>:TOLerance:VERTical command.

Description
  • This command sets or queries the mask vertical tolerance.
Usage
  • Using the .query() method will send the MASK:MASK<x>:TOLerance:VERTical? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:TOLerance:VERTical? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the MASK:MASK<x>:TOLerance:VERTical value command.
SCPI Syntax 
- MASK:MASK<x>:TOLerance:VERTical <NR3>
- MASK:MASK<x>:TOLerance:VERTical?
Info
  • MASK<x> specifies the mask number.
  • <NR3> is the tolerance in units of graticule divisions. The maximum is 1 division.

MaskMaskItemToleranceHabsolute

Bases: SCPICmdWrite, SCPICmdRead

The MASK:MASK<x>:TOLerance:HABSolute command.

Description
  • This command sets or queries the mask horizontal tolerance in absolute units of seconds. This value is used when the mask TTYPe is set to ABSolute and the UPDatenow command is sent.
Usage
  • Using the .query() method will send the MASK:MASK<x>:TOLerance:HABSolute? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:TOLerance:HABSolute? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the MASK:MASK<x>:TOLerance:HABSolute value command.
SCPI Syntax 
- MASK:MASK<x>:TOLerance:HABSolute <NR3>
- MASK:MASK<x>:TOLerance:HABSolute?
Info
  • MASK<x> specifies the mask number.
  • <NR3> is the tolerance in units of seconds. The maximum time is the equivalent of one horizontal graticule division.

MaskMaskItemToleranceHorizontal

Bases: SCPICmdWrite, SCPICmdRead

The MASK:MASK<x>:TOLerance:HORizontal command.

Description
  • This command sets or queries the mask horizontal tolerance.
Usage
  • Using the .query() method will send the MASK:MASK<x>:TOLerance:HORizontal? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:TOLerance:HORizontal? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the MASK:MASK<x>:TOLerance:HORizontal value command.
SCPI Syntax 
- MASK:MASK<x>:TOLerance:HORizontal <NR3>
- MASK:MASK<x>:TOLerance:HORizontal?
Info
  • MASK<x> specifies the mask test.
  • <NR3> is the tolerance in units of graticule divisions. The maximum is 1 division.

MaskMaskItemToleranceUpdatenow

Bases: SCPICmdWriteNoArguments

The MASK:MASK<x>:TOLerance:UPDatenow command.

Description
  • This command causes the tolerance mask to be recalculated with the current horizontal and vertical tolerances.
Usage
  • Using the .write() method will send the MASK:MASK<x>:TOLerance:UPDatenow command.
SCPI Syntax 
- MASK:MASK<x>:TOLerance:UPDatenow
Info
  • MASK<x> specifies the mask test.

MaskMaskItemToleranceVabsolute

Bases: SCPICmdWrite, SCPICmdRead

The MASK:MASK<x>:TOLerance:VABSolute command.

Description
  • This command sets or queries the mask vertical tolerance in absolute units of the mask source (generally volts). This value is used when the mask TTYPe is set to ABSolute and the UPDatenow command is sent.
Usage
  • Using the .query() method will send the MASK:MASK<x>:TOLerance:VABSolute? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:TOLerance:VABSolute? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the MASK:MASK<x>:TOLerance:VABSolute value command.
SCPI Syntax 
- MASK:MASK<x>:TOLerance:VABSolute <NR3>
- MASK:MASK<x>:TOLerance:VABSolute?
Info
  • MASK<x> specifies the mask test.
  • <NR3> is the tolerance in units of the mask source. Most traces in the waveform window have vertical units of volts, but other units such as amps or degrees are possible. The maximum value is the equivalent of one vertical graticule division.

MaskMaskItemToleranceVertical

Bases: SCPICmdWrite, SCPICmdRead

The MASK:MASK<x>:TOLerance:VERTical command.

Description
  • This command sets or queries the mask vertical tolerance.
Usage
  • Using the .query() method will send the MASK:MASK<x>:TOLerance:VERTical? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:TOLerance:VERTical? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the MASK:MASK<x>:TOLerance:VERTical value command.
SCPI Syntax 
- MASK:MASK<x>:TOLerance:VERTical <NR3>
- MASK:MASK<x>:TOLerance:VERTical?
Info
  • MASK<x> specifies the mask number.
  • <NR3> is the tolerance in units of graticule divisions. The maximum is 1 division.

MaskMaskItemTtype

Bases: SCPICmdWrite, SCPICmdRead

The MASK:MASK<x>:TTYPe command.

Description
  • This command sets or queries the type of tolerance values used when defining a tolerance mask.
Usage
  • Using the .query() method will send the MASK:MASK<x>:TTYPe? query.
  • Using the .verify(value) method will send the MASK:MASK<x>:TTYPe? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the MASK:MASK<x>:TTYPe value command.
SCPI Syntax 
- MASK:MASK<x>:TTYPe {SCReen|ABSolute}
- MASK:MASK<x>:TTYPe?
Info
  • MASK<x> specifies the mask test.
  • SCReen indicates that the horizontal and vertical mask tolerances are defined in relative units of graticule divisions. There are always 10 horizontal divisions and 10 vertical divisions on the scope waveform display. When the tolerance type is SCReen, the tolerance values set by the HORizontal and VERTical commands are used to define the tolerance mask when an UPDatenow command is sent.
  • ABSolute indicates that the horizontal and vertical mask tolerances are defined in the absolute units of the mask source waveform. These units are normally seconds and volts respectively. When the tolerance type is ABSolute, the tolerance values set by the HABSolute and VABSolute commands are used to define the tolerance mask when an UPDatenow command is sent.

MaskTest

Bases: SCPICmdRead

The MASK:TESt command tree.

Usage
  • Using the .query() method will send the MASK:TESt? query.
  • Using the .verify(value) method will send the MASK:TESt? query and raise an AssertionError if the returned value does not match value.
Properties
  • .waveforms: The MASK:TESt:WAVEforms command.

waveforms property 

waveforms: MaskTestWaveforms

Return the MASK:TESt:WAVEforms command.

Description
  • This command sets or queries the number of waveform acquisitions to test during mask testing. The number of waveforms applies to all mask tests.
Usage
  • Using the .query() method will send the MASK:TESt:WAVEforms? query.
  • Using the .verify(value) method will send the MASK:TESt:WAVEforms? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the MASK:TESt:WAVEforms value command.
SCPI Syntax 
- MASK:TESt:WAVEforms <NR1>
- MASK:TESt:WAVEforms?
Info
  • <NR1> specifies the number of waveform acquisitions.

MaskTestWaveforms

Bases: SCPICmdWrite, SCPICmdRead

The MASK:TESt:WAVEforms command.

Description
  • This command sets or queries the number of waveform acquisitions to test during mask testing. The number of waveforms applies to all mask tests.
Usage
  • Using the .query() method will send the MASK:TESt:WAVEforms? query.
  • Using the .verify(value) method will send the MASK:TESt:WAVEforms? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the MASK:TESt:WAVEforms value command.
SCPI Syntax 
- MASK:TESt:WAVEforms <NR1>
- MASK:TESt:WAVEforms?
Info
  • <NR1> specifies the number of waveform acquisitions.