[python source code]

eyemask

The eyemask commands module.

These commands are used in the following models: TekScopePC

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

Please report an issue if one is found.

Commands and Queries 
- EYEMASK:MASK<x>:COUNt:HITS?
- EYEMASK:MASK<x>:COUNt:SEG<y>:HITS?
- EYEMASK:MASK<x>:CREATor?
- EYEMASK:MASK<x>:ENAbled {ON|OFF}
- EYEMASK:MASK<x>:ENAbled?
- EYEMASK:MASK<x>:MASKOffset:HORizontal:AUTOfit?
- EYEMASK:MASK<x>:MASKfile <Qstring>
- EYEMASK:MASK<x>:MASKfile?
- EYEMASK:MASK<x>:TESt:SAMple:THReshold <NR1>
- EYEMASK:MASK<x>:TESt:SAMple:THReshold?
- EYEMASK:MASK<x>:TESt:STATUS?

Eyemask

Bases: SCPICmdRead

The EYEMASK command tree.

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

mask property 

mask: dict[int, EyemaskMaskItem]

Return the EYEMASK:MASK<x> command tree.

Usage
  • Using the .query() method will send the EYEMASK:MASK<x>? query.
  • Using the .verify(value) method will send the EYEMASK:MASK<x>? query and raise an AssertionError if the returned value does not match value.
Info
  • MASK<x> is the number of the specified mask test in an eye diagram plot.
Sub-properties
  • .count: The EYEMASK:MASK<x>:COUNt command tree.
  • .creator: The EYEMASK:MASK<x>:CREATor command.
  • .enabled: The EYEMASK:MASK<x>:ENAbled command.
  • .maskoffset: The EYEMASK:MASK<x>:MASKOffset command tree.
  • .maskfile: The EYEMASK:MASK<x>:MASKfile command.
  • .test: The EYEMASK:MASK<x>:TESt command tree.

EyemaskMaskItem

Bases: ValidatedDynamicNumberCmd, SCPICmdRead

The EYEMASK:MASK<x> command tree.

Usage
  • Using the .query() method will send the EYEMASK:MASK<x>? query.
  • Using the .verify(value) method will send the EYEMASK:MASK<x>? query and raise an AssertionError if the returned value does not match value.
Info
  • MASK<x> is the number of the specified mask test in an eye diagram plot.
Properties
  • .count: The EYEMASK:MASK<x>:COUNt command tree.
  • .creator: The EYEMASK:MASK<x>:CREATor command.
  • .enabled: The EYEMASK:MASK<x>:ENAbled command.
  • .maskoffset: The EYEMASK:MASK<x>:MASKOffset command tree.
  • .maskfile: The EYEMASK:MASK<x>:MASKfile command.
  • .test: The EYEMASK:MASK<x>:TESt command tree.

count property 

count: EyemaskMaskItemCount

Return the EYEMASK:MASK<x>:COUNt command tree.

Usage
  • Using the .query() method will send the EYEMASK:MASK<x>:COUNt? query.
  • Using the .verify(value) method will send the EYEMASK:MASK<x>:COUNt? query and raise an AssertionError if the returned value does not match value.
Info
  • MASK<x> is the number of the specified mask test in an eye diagram plot.
Sub-properties
  • .hits: The EYEMASK:MASK<x>:COUNt:HITS command.
  • .seg: The EYEMASK:MASK<x>:COUNt:SEG<y> command tree.

creator property 

creator: EyemaskMaskItemCreator

Return the EYEMASK:MASK<x>:CREATor command.

Description
  • This query-only command returns the name of the eye diagram plot that created the mask.
Usage
  • Using the .query() method will send the EYEMASK:MASK<x>:CREATor? query.
  • Using the .verify(value) method will send the EYEMASK:MASK<x>:CREATor? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- EYEMASK:MASK<x>:CREATor?
Info
  • MASK<x> is the number of the specified mask test (or mask test plot?).

enabled property 

enabled: EyemaskMaskItemEnabled

Return the EYEMASK:MASK<x>:ENAbled command.

Description
  • This command enables or disables eye mask testing in the specified plot.
Usage
  • Using the .query() method will send the EYEMASK:MASK<x>:ENAbled? query.
  • Using the .verify(value) method will send the EYEMASK:MASK<x>:ENAbled? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the EYEMASK:MASK<x>:ENAbled value command.
SCPI Syntax 
- EYEMASK:MASK<x>:ENAbled {ON|OFF}
- EYEMASK:MASK<x>:ENAbled?
Info
  • MASK<x> is the number of the specified mask test (or mask test plot?).

maskfile property 

maskfile: EyemaskMaskItemMaskfile

Return the EYEMASK:MASK<x>:MASKfile command.

Description
  • This command sets or queries the current mask definition file name for the specified mask test.
Usage
  • Using the .query() method will send the EYEMASK:MASK<x>:MASKfile? query.
  • Using the .verify(value) method will send the EYEMASK:MASK<x>:MASKfile? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the EYEMASK:MASK<x>:MASKfile value command.
SCPI Syntax 
- EYEMASK:MASK<x>:MASKfile <Qstring>
- EYEMASK:MASK<x>:MASKfile?
Info
  • <x> is the number of the specified mask test (or mask test plot?).
  • <Qstring> is a quoted string that defines the file path that specifies the location of the mask file to use, in the format ‘[]‘. Specifying a path is optional. If no path is entered, the instrument will search in the current working directory as set in FILESYSTEM:CWD.

maskoffset property 

maskoffset: EyemaskMaskItemMaskoffset

Return the EYEMASK:MASK<x>:MASKOffset command tree.

Usage
  • Using the .query() method will send the EYEMASK:MASK<x>:MASKOffset? query.
  • Using the .verify(value) method will send the EYEMASK:MASK<x>:MASKOffset? query and raise an AssertionError if the returned value does not match value.
Sub-properties
  • .horizontal: The EYEMASK:MASK<x>:MASKOffset:HORizontal command tree.

test property 

test: EyemaskMaskItemTest

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

Usage
  • Using the .query() method will send the EYEMASK:MASK<x>:TESt? query.
  • Using the .verify(value) method will send the EYEMASK:MASK<x>:TESt? query and raise an AssertionError if the returned value does not match value.
Info
  • MASK<x> is the number of the specified mask test (or mask test plot?).
Sub-properties
  • .sample: The EYEMASK:MASK<x>:TESt:SAMple command tree.
  • .status: The EYEMASK:MASK<x>:TESt:STATUS command.

EyemaskMaskItemCount

Bases: SCPICmdRead

The EYEMASK:MASK<x>:COUNt command tree.

Usage
  • Using the .query() method will send the EYEMASK:MASK<x>:COUNt? query.
  • Using the .verify(value) method will send the EYEMASK:MASK<x>:COUNt? query and raise an AssertionError if the returned value does not match value.
Info
  • MASK<x> is the number of the specified mask test in an eye diagram plot.
Properties
  • .hits: The EYEMASK:MASK<x>:COUNt:HITS command.
  • .seg: The EYEMASK:MASK<x>:COUNt:SEG<y> command tree.

hits property 

hits: EyemaskMaskItemCountHits

Return the EYEMASK:MASK<x>:COUNt:HITS command.

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

seg property 

seg: dict[int, EyemaskMaskItemCountSegItem]

Return the EYEMASK:MASK<x>:COUNt:SEG<y> command tree.

Usage
  • Using the .query() method will send the EYEMASK:MASK<x>:COUNt:SEG<y>? query.
  • Using the .verify(value) method will send the EYEMASK:MASK<x>:COUNt:SEG<y>? query and raise an AssertionError if the returned value does not match value.
Info
  • MASK<x> is the number of the specified mask test (or mask test plot?).
  • SEG<y> is the number of the mask segment for which to return hit violations data.
Sub-properties
  • .hits: The EYEMASK:MASK<x>:COUNt:SEG<y>:HITS command.

EyemaskMaskItemCountHits

Bases: SCPICmdRead

The EYEMASK:MASK<x>:COUNt:HITS command.

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

EyemaskMaskItemCountSegItem

Bases: ValidatedDynamicNumberCmd, SCPICmdRead

The EYEMASK:MASK<x>:COUNt:SEG<y> command tree.

Usage
  • Using the .query() method will send the EYEMASK:MASK<x>:COUNt:SEG<y>? query.
  • Using the .verify(value) method will send the EYEMASK:MASK<x>:COUNt:SEG<y>? query and raise an AssertionError if the returned value does not match value.
Info
  • MASK<x> is the number of the specified mask test (or mask test plot?).
  • SEG<y> is the number of the mask segment for which to return hit violations data.
Properties
  • .hits: The EYEMASK:MASK<x>:COUNt:SEG<y>:HITS command.

hits property 

hits: EyemaskMaskItemCountSegItemHits

Return the EYEMASK:MASK<x>:COUNt:SEG<y>:HITS command.

Description
  • This command returns the number of hit violations for the specified segment (area).
Usage
  • Using the .query() method will send the EYEMASK:MASK<x>:COUNt:SEG<y>:HITS? query.
  • Using the .verify(value) method will send the EYEMASK:MASK<x>:COUNt:SEG<y>:HITS? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- EYEMASK:MASK<x>:COUNt:SEG<y>:HITS?
Info
  • MASK<x> is the number of the specified mask test (or mask test plot?).
  • SEG<y> is the number of the mask segment for which to return hit violations data.

EyemaskMaskItemCountSegItemHits

Bases: SCPICmdRead

The EYEMASK:MASK<x>:COUNt:SEG<y>:HITS command.

Description
  • This command returns the number of hit violations for the specified segment (area).
Usage
  • Using the .query() method will send the EYEMASK:MASK<x>:COUNt:SEG<y>:HITS? query.
  • Using the .verify(value) method will send the EYEMASK:MASK<x>:COUNt:SEG<y>:HITS? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- EYEMASK:MASK<x>:COUNt:SEG<y>:HITS?
Info
  • MASK<x> is the number of the specified mask test (or mask test plot?).
  • SEG<y> is the number of the mask segment for which to return hit violations data.

EyemaskMaskItemCreator

Bases: SCPICmdRead

The EYEMASK:MASK<x>:CREATor command.

Description
  • This query-only command returns the name of the eye diagram plot that created the mask.
Usage
  • Using the .query() method will send the EYEMASK:MASK<x>:CREATor? query.
  • Using the .verify(value) method will send the EYEMASK:MASK<x>:CREATor? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- EYEMASK:MASK<x>:CREATor?
Info
  • MASK<x> is the number of the specified mask test (or mask test plot?).

EyemaskMaskItemEnabled

Bases: SCPICmdWrite, SCPICmdRead

The EYEMASK:MASK<x>:ENAbled command.

Description
  • This command enables or disables eye mask testing in the specified plot.
Usage
  • Using the .query() method will send the EYEMASK:MASK<x>:ENAbled? query.
  • Using the .verify(value) method will send the EYEMASK:MASK<x>:ENAbled? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the EYEMASK:MASK<x>:ENAbled value command.
SCPI Syntax 
- EYEMASK:MASK<x>:ENAbled {ON|OFF}
- EYEMASK:MASK<x>:ENAbled?
Info
  • MASK<x> is the number of the specified mask test (or mask test plot?).

EyemaskMaskItemMaskfile

Bases: SCPICmdWrite, SCPICmdRead

The EYEMASK:MASK<x>:MASKfile command.

Description
  • This command sets or queries the current mask definition file name for the specified mask test.
Usage
  • Using the .query() method will send the EYEMASK:MASK<x>:MASKfile? query.
  • Using the .verify(value) method will send the EYEMASK:MASK<x>:MASKfile? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the EYEMASK:MASK<x>:MASKfile value command.
SCPI Syntax 
- EYEMASK:MASK<x>:MASKfile <Qstring>
- EYEMASK:MASK<x>:MASKfile?
Info
  • <x> is the number of the specified mask test (or mask test plot?).
  • <Qstring> is a quoted string that defines the file path that specifies the location of the mask file to use, in the format ‘[]‘. Specifying a path is optional. If no path is entered, the instrument will search in the current working directory as set in FILESYSTEM:CWD.

EyemaskMaskItemMaskoffset

Bases: SCPICmdRead

The EYEMASK:MASK<x>:MASKOffset command tree.

Usage
  • Using the .query() method will send the EYEMASK:MASK<x>:MASKOffset? query.
  • Using the .verify(value) method will send the EYEMASK:MASK<x>:MASKOffset? query and raise an AssertionError if the returned value does not match value.
Properties
  • .horizontal: The EYEMASK:MASK<x>:MASKOffset:HORizontal command tree.

horizontal property 

horizontal: EyemaskMaskItemMaskoffsetHorizontal

Return the EYEMASK:MASK<x>:MASKOffset:HORizontal command tree.

Usage
  • Using the .query() method will send the EYEMASK:MASK<x>:MASKOffset:HORizontal? query.
  • Using the .verify(value) method will send the EYEMASK:MASK<x>:MASKOffset:HORizontal? query and raise an AssertionError if the returned value does not match value.
Sub-properties
  • .autofit: The EYEMASK:MASK<x>:MASKOffset:HORizontal:AUTOfit command.

EyemaskMaskItemMaskoffsetHorizontal

Bases: SCPICmdRead

The EYEMASK:MASK<x>:MASKOffset:HORizontal command tree.

Usage
  • Using the .query() method will send the EYEMASK:MASK<x>:MASKOffset:HORizontal? query.
  • Using the .verify(value) method will send the EYEMASK:MASK<x>:MASKOffset:HORizontal? query and raise an AssertionError if the returned value does not match value.
Properties
  • .autofit: The EYEMASK:MASK<x>:MASKOffset:HORizontal:AUTOfit command.

autofit property 

autofit: EyemaskMaskItemMaskoffsetHorizontalAutofit

Return the EYEMASK:MASK<x>:MASKOffset:HORizontal:AUTOfit command.

Description
  • This command returns the mask offset value in the specified mask in seconds. The mask test number is specified by
Usage
  • Using the .query() method will send the EYEMASK:MASK<x>:MASKOffset:HORizontal:AUTOfit? query.
  • Using the .verify(value) method will send the EYEMASK:MASK<x>:MASKOffset:HORizontal:AUTOfit? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- EYEMASK:MASK<x>:MASKOffset:HORizontal:AUTOfit?

EyemaskMaskItemMaskoffsetHorizontalAutofit

Bases: SCPICmdRead

The EYEMASK:MASK<x>:MASKOffset:HORizontal:AUTOfit command.

Description
  • This command returns the mask offset value in the specified mask in seconds. The mask test number is specified by
Usage
  • Using the .query() method will send the EYEMASK:MASK<x>:MASKOffset:HORizontal:AUTOfit? query.
  • Using the .verify(value) method will send the EYEMASK:MASK<x>:MASKOffset:HORizontal:AUTOfit? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- EYEMASK:MASK<x>:MASKOffset:HORizontal:AUTOfit?

EyemaskMaskItemTest

Bases: SCPICmdRead

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

Usage
  • Using the .query() method will send the EYEMASK:MASK<x>:TESt? query.
  • Using the .verify(value) method will send the EYEMASK:MASK<x>:TESt? query and raise an AssertionError if the returned value does not match value.
Info
  • MASK<x> is the number of the specified mask test (or mask test plot?).
Properties
  • .sample: The EYEMASK:MASK<x>:TESt:SAMple command tree.
  • .status: The EYEMASK:MASK<x>:TESt:STATUS command.

sample property 

sample: EyemaskMaskItemTestSample

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

Usage
  • Using the .query() method will send the EYEMASK:MASK<x>:TESt:SAMple? query.
  • Using the .verify(value) method will send the EYEMASK:MASK<x>:TESt:SAMple? query and raise an AssertionError if the returned value does not match value.
Info
  • MASK<x> is the number of the specified mask test (or mask test plot?).
Sub-properties
  • .threshold: The EYEMASK:MASK<x>:TESt:SAMple:THReshold command.

status property 

status: EyemaskMaskItemTestStatus

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

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

EyemaskMaskItemTestSample

Bases: SCPICmdRead

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

Usage
  • Using the .query() method will send the EYEMASK:MASK<x>:TESt:SAMple? query.
  • Using the .verify(value) method will send the EYEMASK:MASK<x>:TESt:SAMple? query and raise an AssertionError if the returned value does not match value.
Info
  • MASK<x> is the number of the specified mask test (or mask test plot?).
Properties
  • .threshold: The EYEMASK:MASK<x>:TESt:SAMple:THReshold command.

threshold property 

threshold: EyemaskMaskItemTestSampleThreshold

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

Description
  • This command sets or queries the total number of hit violations that will cause a mask test failure.
Usage
  • Using the .query() method will send the EYEMASK:MASK<x>:TESt:SAMple:THReshold? query.
  • Using the .verify(value) method will send the EYEMASK:MASK<x>:TESt:SAMple:THReshold? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the EYEMASK:MASK<x>:TESt:SAMple:THReshold value command.
SCPI Syntax 
- EYEMASK:MASK<x>:TESt:SAMple:THReshold <NR1>
- EYEMASK:MASK<x>:TESt:SAMple:THReshold?
Info
  • MASK<x> is the number of the specified mask test (or mask test plot?).
  • <NR1> is a positive integer indicating the number of mask hits required to cause a fail condition for that mask test.

EyemaskMaskItemTestSampleThreshold

Bases: SCPICmdWrite, SCPICmdRead

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

Description
  • This command sets or queries the total number of hit violations that will cause a mask test failure.
Usage
  • Using the .query() method will send the EYEMASK:MASK<x>:TESt:SAMple:THReshold? query.
  • Using the .verify(value) method will send the EYEMASK:MASK<x>:TESt:SAMple:THReshold? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the EYEMASK:MASK<x>:TESt:SAMple:THReshold value command.
SCPI Syntax 
- EYEMASK:MASK<x>:TESt:SAMple:THReshold <NR1>
- EYEMASK:MASK<x>:TESt:SAMple:THReshold?
Info
  • MASK<x> is the number of the specified mask test (or mask test plot?).
  • <NR1> is a positive integer indicating the number of mask hits required to cause a fail condition for that mask test.

EyemaskMaskItemTestStatus

Bases: SCPICmdRead

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

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