math
¶
The math commands module.
These commands are used in the following models: MSO2
THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED.
Please report an issue if one is found.
Commands and Queries
- MATH:ADDNew <QString>
- MATH:DELete <QString>
- MATH:LIST?
- MATH:MATH<x>:AVG:MODE {ON|OFF|<NR1>}
- MATH:MATH<x>:AVG:MODE?
- MATH:MATH<x>:AVG:WEIGht <NR1>
- MATH:MATH<x>:AVG:WEIGht?
- MATH:MATH<x>:CAN:SUPPortedfields {DATa}
- MATH:MATH<x>:CAN:SUPPortedfields?
- MATH:MATH<x>:DEFine <QString>
- MATH:MATH<x>:DEFine?
- MATH:MATH<x>:FUNCtion {ADD|SUBtract|MULTiply|DIVide}
- MATH:MATH<x>:FUNCtion?
- MATH:MATH<x>:GATing {NONE|SCREEN|CURSor}
- MATH:MATH<x>:GATing?
- MATH:MATH<x>:I2C:SUPPortedfields {DATa}
- MATH:MATH<x>:I2C:SUPPortedfields?
- MATH:MATH<x>:INTERpolation {ON|OFF}
- MATH:MATH<x>:INTERpolation?
- MATH:MATH<x>:LABel:COLor <QString>
- MATH:MATH<x>:LABel:COLor?
- MATH:MATH<x>:LABel:FONT:BOLD {ON|OFF|<NR1>}
- MATH:MATH<x>:LABel:FONT:BOLD?
- MATH:MATH<x>:LABel:FONT:ITALic {ON|OFF|<NR1>}
- MATH:MATH<x>:LABel:FONT:ITALic?
- MATH:MATH<x>:LABel:FONT:SIZE <NR1>
- MATH:MATH<x>:LABel:FONT:SIZE?
- MATH:MATH<x>:LABel:FONT:TYPE <QString>
- MATH:MATH<x>:LABel:FONT:TYPE?
- MATH:MATH<x>:LABel:FONT:UNDERline {ON|OFF|<NR1>}
- MATH:MATH<x>:LABel:FONT:UNDERline?
- MATH:MATH<x>:LABel:NAMe <QString>
- MATH:MATH<x>:LABel:NAMe?
- MATH:MATH<x>:LABel:XPOS <NR1>
- MATH:MATH<x>:LABel:XPOS?
- MATH:MATH<x>:LABel:YPOS <NR1>
- MATH:MATH<x>:LABel:YPOS?
- MATH:MATH<x>:LIN:SUPPortedfields {DATa}
- MATH:MATH<x>:LIN:SUPPortedfields?
- MATH:MATH<x>:PARallel:SUPPortedfields {DATa}
- MATH:MATH<x>:PARallel:SUPPortedfields?
- MATH:MATH<x>:RS232C:SUPPortedfields {DATa|TXData|RXData}
- MATH:MATH<x>:RS232C:SUPPortedfields?
- MATH:MATH<x>:SENT:SUPPortedfields {FCData|FCDFirst|FCDTwo|SDATa}
- MATH:MATH<x>:SENT:SUPPortedfields?
- MATH:MATH<x>:SIGNeddata {ON|OFF}
- MATH:MATH<x>:SIGNeddata?
- MATH:MATH<x>:SOUrce1 {CH<x>|MATH<x>|REF<x>}
- MATH:MATH<x>:SOUrce1?
- MATH:MATH<x>:SPECTral:WINdow {RECTANGular|HAMMing|HANNing|BLACKMANHarris|KAISERBessel|GAUSSian|FLATTOP2|TEKEXPonential}
- MATH:MATH<x>:SPECTral:WINdow?
- MATH:MATH<x>:SPI:SUPPortedfields {DATa|MOSIdata|MISOdata}
- MATH:MATH<x>:SPI:SUPPortedfields?
- MATH:MATH<x>:TYPe {BASic|FFT|ADVanced}
- MATH:MATH<x>:TYPe?
- MATH:MATH<x>:VUNIT <QString>
Math
¶
Bases: SCPICmdRead
The MATH command tree.
Usage
- Using the
.query()method will send theMATH?query. - Using the
.verify(value)method will send theMATH?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.addnew: TheMATH:ADDNewcommand..delete: TheMATH:DELetecommand..list: TheMATH:LISTcommand..math: TheMATH:MATH<x>command tree.
addnew
property
¶
addnew: MathAddnew
Return the MATH:ADDNew command.
Description
- This command adds the specified math.
Usage
- Using the
.write(value)method will send theMATH:ADDNew valuecommand.
SCPI Syntax
- MATH:ADDNew <QString>
Info
<QString>is the quoted string specifying the math waveform to add. The argument is of the form ‘MATH‘, where is ≥1.
delete
property
¶
delete: MathDelete
Return the MATH:DELete command.
Description
- This command deletes the specified math.
Usage
- Using the
.write(value)method will send theMATH:DELete valuecommand.
SCPI Syntax
- MATH:DELete <QString>
Info
<QString>is a quoted string specifying the math waveform to delete. The quoted string is of the form ‘MATH‘, where is ≥1.
list
property
¶
list: MathList
Return the MATH:LIST command.
Description
- This query returns a comma separated list of all currently defined math waveforms.
Usage
- Using the
.query()method will send theMATH:LIST?query. - Using the
.verify(value)method will send theMATH:LIST?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MATH:LIST?
math
property
¶
math: dict[int, MathMathItem]
Return the MATH:MATH<x> command tree.
Usage
- Using the
.query()method will send theMATH:MATH<x>?query. - Using the
.verify(value)method will send theMATH:MATH<x>?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.avg: TheMATH:MATH<x>:AVGcommand tree..can: TheMATH:MATH<x>:CANcommand tree..define: TheMATH:MATH<x>:DEFinecommand..function: TheMATH:MATH<x>:FUNCtioncommand..gating: TheMATH:MATH<x>:GATingcommand..i2c: TheMATH:MATH<x>:I2Ccommand tree..interpolation: TheMATH:MATH<x>:INTERpolationcommand..label: TheMATH:MATH<x>:LABelcommand tree..lin: TheMATH:MATH<x>:LINcommand tree..parallel: TheMATH:MATH<x>:PARallelcommand tree..rs232c: TheMATH:MATH<x>:RS232Ccommand tree..sent: TheMATH:MATH<x>:SENTcommand tree..signeddata: TheMATH:MATH<x>:SIGNeddatacommand..source1: TheMATH:MATH<x>:SOUrce1command..spectral: TheMATH:MATH<x>:SPECTralcommand tree..spi: TheMATH:MATH<x>:SPIcommand tree..type: TheMATH:MATH<x>:TYPecommand..vunit: TheMATH:MATH<x>:VUNITcommand.
MathAddnew
¶
Bases: SCPICmdWrite
The MATH:ADDNew command.
Description
- This command adds the specified math.
Usage
- Using the
.write(value)method will send theMATH:ADDNew valuecommand.
SCPI Syntax
- MATH:ADDNew <QString>
Info
<QString>is the quoted string specifying the math waveform to add. The argument is of the form ‘MATH‘, where is ≥1.
MathDelete
¶
Bases: SCPICmdWrite
The MATH:DELete command.
Description
- This command deletes the specified math.
Usage
- Using the
.write(value)method will send theMATH:DELete valuecommand.
SCPI Syntax
- MATH:DELete <QString>
Info
<QString>is a quoted string specifying the math waveform to delete. The quoted string is of the form ‘MATH‘, where is ≥1.
MathList
¶
Bases: SCPICmdRead
The MATH:LIST command.
Description
- This query returns a comma separated list of all currently defined math waveforms.
Usage
- Using the
.query()method will send theMATH:LIST?query. - Using the
.verify(value)method will send theMATH:LIST?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- MATH:LIST?
MathMathItem
¶
Bases: ValidatedDynamicNumberCmd, SCPICmdRead
The MATH:MATH<x> command tree.
Usage
- Using the
.query()method will send theMATH:MATH<x>?query. - Using the
.verify(value)method will send theMATH:MATH<x>?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.avg: TheMATH:MATH<x>:AVGcommand tree..can: TheMATH:MATH<x>:CANcommand tree..define: TheMATH:MATH<x>:DEFinecommand..function: TheMATH:MATH<x>:FUNCtioncommand..gating: TheMATH:MATH<x>:GATingcommand..i2c: TheMATH:MATH<x>:I2Ccommand tree..interpolation: TheMATH:MATH<x>:INTERpolationcommand..label: TheMATH:MATH<x>:LABelcommand tree..lin: TheMATH:MATH<x>:LINcommand tree..parallel: TheMATH:MATH<x>:PARallelcommand tree..rs232c: TheMATH:MATH<x>:RS232Ccommand tree..sent: TheMATH:MATH<x>:SENTcommand tree..signeddata: TheMATH:MATH<x>:SIGNeddatacommand..source1: TheMATH:MATH<x>:SOUrce1command..spectral: TheMATH:MATH<x>:SPECTralcommand tree..spi: TheMATH:MATH<x>:SPIcommand tree..type: TheMATH:MATH<x>:TYPecommand..vunit: TheMATH:MATH<x>:VUNITcommand.
avg
property
¶
avg: MathMathItemAvg
Return the MATH:MATH<x>:AVG command tree.
Usage
- Using the
.query()method will send theMATH:MATH<x>:AVG?query. - Using the
.verify(value)method will send theMATH:MATH<x>:AVG?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.mode: TheMATH:MATH<x>:AVG:MODEcommand..weight: TheMATH:MATH<x>:AVG:WEIGhtcommand.
can
property
¶
can: MathMathItemCan
Return the MATH:MATH<x>:CAN command tree.
Usage
- Using the
.query()method will send theMATH:MATH<x>:CAN?query. - Using the
.verify(value)method will send theMATH:MATH<x>:CAN?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.supportedfields: TheMATH:MATH<x>:CAN:SUPPortedfieldscommand.
define
property
¶
define: MathMathItemDefine
Return the MATH:MATH<x>:DEFine command.
Description
- This command allows you to define new waveforms using mathematical expressions. The query form of this command returns the math definition for the specified math waveform. The math waveform is specified by x. You can specify a math expression from waveforms, measurements and scalar sources, functions, operands, and numerical constants. Math expressions can be simple, such as Ch1, which specifies that a waveform should show the signal source of Channel 1 with no mathematical computation. Math expressions can also be complex, consisting of 100 plus characters and comprising many sources (including other math waveforms), functions, and operands. As an example, you can enter the expression Log(Ch1+Ch2), which specifies that the signals from channels 1 and 2 are to be algebraically added, and the base 10 log of the sum is to be shown as the final math waveform.
Usage
- Using the
.query()method will send theMATH:MATH<x>:DEFine?query. - Using the
.verify(value)method will send theMATH:MATH<x>:DEFine?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:DEFine valuecommand.
SCPI Syntax
- MATH:MATH<x>:DEFine <QString>
- MATH:MATH<x>:DEFine?
Info
<QString>quoted string argument is the mathematical expression that defines the waveform.MATH:MATH<x>:DEFINE?is for use when theMATH:MATH<x>:TYPEis ADVANCED.
function
property
¶
function: MathMathItemFunction
Return the MATH:MATH<x>:FUNCtion command.
Description
- This command sets or queries the basic math arithmetic function. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:FUNCtion?query. - Using the
.verify(value)method will send theMATH:MATH<x>:FUNCtion?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:FUNCtion valuecommand.
SCPI Syntax
- MATH:MATH<x>:FUNCtion {ADD|SUBtract|MULTiply|DIVide}
- MATH:MATH<x>:FUNCtion?
Info
ADDsets the basic math function to add.SUBtractsets the basic math function to subtract.MULTiplysets the basic math function to multiply.DIVidesets the basic math function to divide.
gating
property
¶
gating: MathMathItemGating
Return the MATH:MATH<x>:GATing command.
Description
- This command specifies or returns the gating setting. It only applies to Math FFT plots. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:GATing?query. - Using the
.verify(value)method will send theMATH:MATH<x>:GATing?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:GATing valuecommand.
SCPI Syntax
- MATH:MATH<x>:GATing {NONE|SCREEN|CURSor}
- MATH:MATH<x>:GATing?
Info
NONEturns off math gating.SCREENturns on gating, using the left and right edges of the screen.CURSorlimits math to the portion of the waveform between the vertical bar cursors, even if they are off screen.
i2c
property
¶
i2c: MathMathItemI2c
Return the MATH:MATH<x>:I2C command tree.
Usage
- Using the
.query()method will send theMATH:MATH<x>:I2C?query. - Using the
.verify(value)method will send theMATH:MATH<x>:I2C?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.supportedfields: TheMATH:MATH<x>:I2C:SUPPortedfieldscommand.
interpolation
property
¶
interpolation: MathMathItemInterpolation
Return the MATH:MATH<x>:INTERpolation command.
Description
- This command sets or queries whether sinc interpolation is enabled for math on bus source. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:INTERpolation?query. - Using the
.verify(value)method will send theMATH:MATH<x>:INTERpolation?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:INTERpolation valuecommand.
SCPI Syntax
- MATH:MATH<x>:INTERpolation {ON|OFF}
- MATH:MATH<x>:INTERpolation?
Info
ONindicates that the sinc interpolation is used for math waveform.OFFindicates no interpolation is used for math waveform. Waveform will appear ‘stair-steppy’ in this case.
label
property
¶
label: MathMathItemLabel
Return the MATH:MATH<x>:LABel command tree.
Usage
- Using the
.query()method will send theMATH:MATH<x>:LABel?query. - Using the
.verify(value)method will send theMATH:MATH<x>:LABel?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.color: TheMATH:MATH<x>:LABel:COLorcommand..font: TheMATH:MATH<x>:LABel:FONTcommand tree..name: TheMATH:MATH<x>:LABel:NAMecommand..xpos: TheMATH:MATH<x>:LABel:XPOScommand..ypos: TheMATH:MATH<x>:LABel:YPOScommand.
lin
property
¶
lin: MathMathItemLin
Return the MATH:MATH<x>:LIN command tree.
Usage
- Using the
.query()method will send theMATH:MATH<x>:LIN?query. - Using the
.verify(value)method will send theMATH:MATH<x>:LIN?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.supportedfields: TheMATH:MATH<x>:LIN:SUPPortedfieldscommand.
parallel
property
¶
parallel: MathMathItemParallel
Return the MATH:MATH<x>:PARallel command tree.
Usage
- Using the
.query()method will send theMATH:MATH<x>:PARallel?query. - Using the
.verify(value)method will send theMATH:MATH<x>:PARallel?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.supportedfields: TheMATH:MATH<x>:PARallel:SUPPortedfieldscommand.
rs232c
property
¶
rs232c: MathMathItemRs232c
Return the MATH:MATH<x>:RS232C command tree.
Usage
- Using the
.query()method will send theMATH:MATH<x>:RS232C?query. - Using the
.verify(value)method will send theMATH:MATH<x>:RS232C?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.supportedfields: TheMATH:MATH<x>:RS232C:SUPPortedfieldscommand.
sent
property
¶
sent: MathMathItemSent
Return the MATH:MATH<x>:SENT command tree.
Usage
- Using the
.query()method will send theMATH:MATH<x>:SENT?query. - Using the
.verify(value)method will send theMATH:MATH<x>:SENT?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.supportedfields: TheMATH:MATH<x>:SENT:SUPPortedfieldscommand.
signeddata
property
¶
signeddata: MathMathItemSigneddata
Return the MATH:MATH<x>:SIGNeddata command.
Description
- This command sets or queries value to denote that bus field is decoded as signed/unsigned data for math on bus source. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:SIGNeddata?query. - Using the
.verify(value)method will send theMATH:MATH<x>:SIGNeddata?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:SIGNeddata valuecommand.
SCPI Syntax
- MATH:MATH<x>:SIGNeddata {ON|OFF}
- MATH:MATH<x>:SIGNeddata?
Info
ONindicates that the bus field is decoded as signed data for drawing the math waveform.OFFindicates that the bus field is decoded as unsigned data for drawing the math waveform.
source1
property
¶
source1: MathMathItemSource1
Return the MATH:MATH<x>:SOUrce1 command.
Description
- This command sets or queries the specified math source. This command sets the Basic
Math components in the user interface, with two sources and a function. You would also
need to set the math type to Basic to see the change in the user interface, but this
will not effect the programmable interface. The math waveform and source are specified
by x. When the
MATH:MATH<x>:TYPEis set to BASIC, SOURCE1 and SOURCE2 can be used.
Usage
- Using the
.query()method will send theMATH:MATH<x>:SOUrce1?query. - Using the
.verify(value)method will send theMATH:MATH<x>:SOUrce1?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:SOUrce1 valuecommand.
SCPI Syntax
- MATH:MATH<x>:SOUrce1 {CH<x>|MATH<x>|REF<x>}
- MATH:MATH<x>:SOUrce1?
Info
MATH<x>specifies the math number.1specifies the source number.CH<x>specifies the source as channel.MATH<x>specifies the source as math.REF<x>specifies the source as reference.
spectral
property
¶
spectral: MathMathItemSpectral
Return the MATH:MATH<x>:SPECTral command tree.
Usage
- Using the
.query()method will send theMATH:MATH<x>:SPECTral?query. - Using the
.verify(value)method will send theMATH:MATH<x>:SPECTral?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.window: TheMATH:MATH<x>:SPECTral:WINdowcommand.
spi
property
¶
spi: MathMathItemSpi
Return the MATH:MATH<x>:SPI command tree.
Usage
- Using the
.query()method will send theMATH:MATH<x>:SPI?query. - Using the
.verify(value)method will send theMATH:MATH<x>:SPI?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.supportedfields: TheMATH:MATH<x>:SPI:SUPPortedfieldscommand.
type
property
¶
type: MathMathItemType
Return the MATH:MATH<x>:TYPe command.
Description
- This command sets or queries the math type. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:TYPe?query. - Using the
.verify(value)method will send theMATH:MATH<x>:TYPe?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:TYPe valuecommand.
SCPI Syntax
- MATH:MATH<x>:TYPe {BASic|FFT|ADVanced}
- MATH:MATH<x>:TYPe?
Info
BASicset the type to basic math.FFTsets the type to FFT math, which can use any live analog or reference waveform in the time domain. NOTE. You can also use FFT as part of a math expression by declaring the type.ADVancedsets the type to advanced math.
vunit
property
¶
vunit: MathMathItemVunit
Return the MATH:MATH<x>:VUNIT command.
Description
- This command specifies or returns the math custom vertical units. The math waveform is specified by x.
Usage
- Using the
.write(value)method will send theMATH:MATH<x>:VUNIT valuecommand.
SCPI Syntax
- MATH:MATH<x>:VUNIT <QString>
Info
<QString>is the custom vertical units.
MathMathItemAvg
¶
Bases: SCPICmdRead
The MATH:MATH<x>:AVG command tree.
Usage
- Using the
.query()method will send theMATH:MATH<x>:AVG?query. - Using the
.verify(value)method will send theMATH:MATH<x>:AVG?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.mode: TheMATH:MATH<x>:AVG:MODEcommand..weight: TheMATH:MATH<x>:AVG:WEIGhtcommand.
mode
property
¶
mode: MathMathItemAvgMode
Return the MATH:MATH<x>:AVG:MODE command.
Description
- This command sets or queries the math average mode flag. If the flag is set to 1, math averaging is turned on. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:AVG:MODE?query. - Using the
.verify(value)method will send theMATH:MATH<x>:AVG:MODE?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:AVG:MODE valuecommand.
SCPI Syntax
- MATH:MATH<x>:AVG:MODE {ON|OFF|<NR1>}
- MATH:MATH<x>:AVG:MODE?
Info
<NR1>= 0 turns off average mode, and any other integer turns on average mode.OFFturns off average mode.ONturns on average mode.
weight
property
¶
weight: MathMathItemAvgWeight
Return the MATH:MATH<x>:AVG:WEIGht command.
Description
- This command sets or queries the number of acquisitions at which the averaging algorithm will begin exponential averaging. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:AVG:WEIGht?query. - Using the
.verify(value)method will send theMATH:MATH<x>:AVG:WEIGht?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:AVG:WEIGht valuecommand.
SCPI Syntax
- MATH:MATH<x>:AVG:WEIGht <NR1>
- MATH:MATH<x>:AVG:WEIGht?
Info
<NR1>is the number of acquisitions at which the averaging algorithm will begin exponential averaging.
MathMathItemAvgMode
¶
Bases: SCPICmdWrite, SCPICmdRead
The MATH:MATH<x>:AVG:MODE command.
Description
- This command sets or queries the math average mode flag. If the flag is set to 1, math averaging is turned on. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:AVG:MODE?query. - Using the
.verify(value)method will send theMATH:MATH<x>:AVG:MODE?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:AVG:MODE valuecommand.
SCPI Syntax
- MATH:MATH<x>:AVG:MODE {ON|OFF|<NR1>}
- MATH:MATH<x>:AVG:MODE?
Info
<NR1>= 0 turns off average mode, and any other integer turns on average mode.OFFturns off average mode.ONturns on average mode.
MathMathItemAvgWeight
¶
Bases: SCPICmdWrite, SCPICmdRead
The MATH:MATH<x>:AVG:WEIGht command.
Description
- This command sets or queries the number of acquisitions at which the averaging algorithm will begin exponential averaging. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:AVG:WEIGht?query. - Using the
.verify(value)method will send theMATH:MATH<x>:AVG:WEIGht?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:AVG:WEIGht valuecommand.
SCPI Syntax
- MATH:MATH<x>:AVG:WEIGht <NR1>
- MATH:MATH<x>:AVG:WEIGht?
Info
<NR1>is the number of acquisitions at which the averaging algorithm will begin exponential averaging.
MathMathItemCan
¶
Bases: SCPICmdRead
The MATH:MATH<x>:CAN command tree.
Usage
- Using the
.query()method will send theMATH:MATH<x>:CAN?query. - Using the
.verify(value)method will send theMATH:MATH<x>:CAN?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.supportedfields: TheMATH:MATH<x>:CAN:SUPPortedfieldscommand.
supportedfields
property
¶
supportedfields: MathMathItemCanSupportedfields
Return the MATH:MATH<x>:CAN:SUPPortedfields command.
Description
- This command sets or queries the field type for the math for the bus source for CAN bus. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:CAN:SUPPortedfields?query. - Using the
.verify(value)method will send theMATH:MATH<x>:CAN:SUPPortedfields?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:CAN:SUPPortedfields valuecommand.
SCPI Syntax
- MATH:MATH<x>:CAN:SUPPortedfields {DATa}
- MATH:MATH<x>:CAN:SUPPortedfields?
Info
DATasets the field type to DATa.
MathMathItemCanSupportedfields
¶
Bases: SCPICmdWrite, SCPICmdRead
The MATH:MATH<x>:CAN:SUPPortedfields command.
Description
- This command sets or queries the field type for the math for the bus source for CAN bus. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:CAN:SUPPortedfields?query. - Using the
.verify(value)method will send theMATH:MATH<x>:CAN:SUPPortedfields?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:CAN:SUPPortedfields valuecommand.
SCPI Syntax
- MATH:MATH<x>:CAN:SUPPortedfields {DATa}
- MATH:MATH<x>:CAN:SUPPortedfields?
Info
DATasets the field type to DATa.
MathMathItemDefine
¶
Bases: SCPICmdWrite, SCPICmdRead
The MATH:MATH<x>:DEFine command.
Description
- This command allows you to define new waveforms using mathematical expressions. The query form of this command returns the math definition for the specified math waveform. The math waveform is specified by x. You can specify a math expression from waveforms, measurements and scalar sources, functions, operands, and numerical constants. Math expressions can be simple, such as Ch1, which specifies that a waveform should show the signal source of Channel 1 with no mathematical computation. Math expressions can also be complex, consisting of 100 plus characters and comprising many sources (including other math waveforms), functions, and operands. As an example, you can enter the expression Log(Ch1+Ch2), which specifies that the signals from channels 1 and 2 are to be algebraically added, and the base 10 log of the sum is to be shown as the final math waveform.
Usage
- Using the
.query()method will send theMATH:MATH<x>:DEFine?query. - Using the
.verify(value)method will send theMATH:MATH<x>:DEFine?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:DEFine valuecommand.
SCPI Syntax
- MATH:MATH<x>:DEFine <QString>
- MATH:MATH<x>:DEFine?
Info
<QString>quoted string argument is the mathematical expression that defines the waveform.MATH:MATH<x>:DEFINE?is for use when theMATH:MATH<x>:TYPEis ADVANCED.
MathMathItemFunction
¶
Bases: SCPICmdWrite, SCPICmdRead
The MATH:MATH<x>:FUNCtion command.
Description
- This command sets or queries the basic math arithmetic function. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:FUNCtion?query. - Using the
.verify(value)method will send theMATH:MATH<x>:FUNCtion?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:FUNCtion valuecommand.
SCPI Syntax
- MATH:MATH<x>:FUNCtion {ADD|SUBtract|MULTiply|DIVide}
- MATH:MATH<x>:FUNCtion?
Info
ADDsets the basic math function to add.SUBtractsets the basic math function to subtract.MULTiplysets the basic math function to multiply.DIVidesets the basic math function to divide.
MathMathItemGating
¶
Bases: SCPICmdWrite, SCPICmdRead
The MATH:MATH<x>:GATing command.
Description
- This command specifies or returns the gating setting. It only applies to Math FFT plots. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:GATing?query. - Using the
.verify(value)method will send theMATH:MATH<x>:GATing?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:GATing valuecommand.
SCPI Syntax
- MATH:MATH<x>:GATing {NONE|SCREEN|CURSor}
- MATH:MATH<x>:GATing?
Info
NONEturns off math gating.SCREENturns on gating, using the left and right edges of the screen.CURSorlimits math to the portion of the waveform between the vertical bar cursors, even if they are off screen.
MathMathItemI2c
¶
Bases: SCPICmdRead
The MATH:MATH<x>:I2C command tree.
Usage
- Using the
.query()method will send theMATH:MATH<x>:I2C?query. - Using the
.verify(value)method will send theMATH:MATH<x>:I2C?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.supportedfields: TheMATH:MATH<x>:I2C:SUPPortedfieldscommand.
supportedfields
property
¶
supportedfields: MathMathItemI2cSupportedfields
Return the MATH:MATH<x>:I2C:SUPPortedfields command.
Description
- This command sets or queries the field type for the math for the bus source for I2C bus. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:I2C:SUPPortedfields?query. - Using the
.verify(value)method will send theMATH:MATH<x>:I2C:SUPPortedfields?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:I2C:SUPPortedfields valuecommand.
SCPI Syntax
- MATH:MATH<x>:I2C:SUPPortedfields {DATa}
- MATH:MATH<x>:I2C:SUPPortedfields?
Info
DATasets the field type to DATa.
MathMathItemI2cSupportedfields
¶
Bases: SCPICmdWrite, SCPICmdRead
The MATH:MATH<x>:I2C:SUPPortedfields command.
Description
- This command sets or queries the field type for the math for the bus source for I2C bus. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:I2C:SUPPortedfields?query. - Using the
.verify(value)method will send theMATH:MATH<x>:I2C:SUPPortedfields?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:I2C:SUPPortedfields valuecommand.
SCPI Syntax
- MATH:MATH<x>:I2C:SUPPortedfields {DATa}
- MATH:MATH<x>:I2C:SUPPortedfields?
Info
DATasets the field type to DATa.
MathMathItemInterpolation
¶
Bases: SCPICmdWrite, SCPICmdRead
The MATH:MATH<x>:INTERpolation command.
Description
- This command sets or queries whether sinc interpolation is enabled for math on bus source. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:INTERpolation?query. - Using the
.verify(value)method will send theMATH:MATH<x>:INTERpolation?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:INTERpolation valuecommand.
SCPI Syntax
- MATH:MATH<x>:INTERpolation {ON|OFF}
- MATH:MATH<x>:INTERpolation?
Info
ONindicates that the sinc interpolation is used for math waveform.OFFindicates no interpolation is used for math waveform. Waveform will appear ‘stair-steppy’ in this case.
MathMathItemLabel
¶
Bases: SCPICmdRead
The MATH:MATH<x>:LABel command tree.
Usage
- Using the
.query()method will send theMATH:MATH<x>:LABel?query. - Using the
.verify(value)method will send theMATH:MATH<x>:LABel?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.color: TheMATH:MATH<x>:LABel:COLorcommand..font: TheMATH:MATH<x>:LABel:FONTcommand tree..name: TheMATH:MATH<x>:LABel:NAMecommand..xpos: TheMATH:MATH<x>:LABel:XPOScommand..ypos: TheMATH:MATH<x>:LABel:YPOScommand.
color
property
¶
color: MathMathItemLabelColor
Return the MATH:MATH<x>:LABel:COLor command.
Description
- This command sets or queries color of the specified math’s label. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:LABel:COLor?query. - Using the
.verify(value)method will send theMATH:MATH<x>:LABel:COLor?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:LABel:COLor valuecommand.
SCPI Syntax
- MATH:MATH<x>:LABel:COLor <QString>
- MATH:MATH<x>:LABel:COLor?
Info
<QString> is the color of the label. To return the color to the default color, send an empty string as in this example::MATH:MATH1:LABEL:COLOR‘’.
font
property
¶
font: MathMathItemLabelFont
Return the MATH:MATH<x>:LABel:FONT command tree.
Usage
- Using the
.query()method will send theMATH:MATH<x>:LABel:FONT?query. - Using the
.verify(value)method will send theMATH:MATH<x>:LABel:FONT?query and raise an AssertionError if the returned value does not matchvalue.
Sub-properties
.bold: TheMATH:MATH<x>:LABel:FONT:BOLDcommand..italic: TheMATH:MATH<x>:LABel:FONT:ITALiccommand..size: TheMATH:MATH<x>:LABel:FONT:SIZEcommand..type: TheMATH:MATH<x>:LABel:FONT:TYPEcommand..underline: TheMATH:MATH<x>:LABel:FONT:UNDERlinecommand.
name
property
¶
name: MathMathItemLabelName
Return the MATH:MATH<x>:LABel:NAMe command.
Description
- This command sets or queries the label string, which is used for annotating the math waveform on the screen. The math waveform to which the label is attached is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:LABel:NAMe?query. - Using the
.verify(value)method will send theMATH:MATH<x>:LABel:NAMe?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:LABel:NAMe valuecommand.
SCPI Syntax
- MATH:MATH<x>:LABel:NAMe <QString>
- MATH:MATH<x>:LABel:NAMe?
Info
<QString>specifies the label to annotate the math waveform.
xpos
property
¶
xpos: MathMathItemLabelXpos
Return the MATH:MATH<x>:LABel:XPOS command.
Description
- This command sets or queries the X position of the specified math label. Maths are specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:LABel:XPOS?query. - Using the
.verify(value)method will send theMATH:MATH<x>:LABel:XPOS?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:LABel:XPOS valuecommand.
SCPI Syntax
- MATH:MATH<x>:LABel:XPOS <NR1>
- MATH:MATH<x>:LABel:XPOS?
Info
<NR1>is the location (in pixels) where the label for the selected math waveform is displayed, relative to the left edge of the display.
ypos
property
¶
ypos: MathMathItemLabelYpos
Return the MATH:MATH<x>:LABel:YPOS command.
Description
- This command sets or queries the y-position of the specified math label. The Math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:LABel:YPOS?query. - Using the
.verify(value)method will send theMATH:MATH<x>:LABel:YPOS?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:LABel:YPOS valuecommand.
SCPI Syntax
- MATH:MATH<x>:LABel:YPOS <NR1>
- MATH:MATH<x>:LABel:YPOS?
Info
<NR1>is the location (in pixels) where the label for the selected math waveform is displayed, relative to the baseline of the waveform.
MathMathItemLabelColor
¶
Bases: SCPICmdWrite, SCPICmdRead
The MATH:MATH<x>:LABel:COLor command.
Description
- This command sets or queries color of the specified math’s label. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:LABel:COLor?query. - Using the
.verify(value)method will send theMATH:MATH<x>:LABel:COLor?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:LABel:COLor valuecommand.
SCPI Syntax
- MATH:MATH<x>:LABel:COLor <QString>
- MATH:MATH<x>:LABel:COLor?
Info
<QString> is the color of the label. To return the color to the default color, send an empty string as in this example::MATH:MATH1:LABEL:COLOR‘’.
MathMathItemLabelFont
¶
Bases: SCPICmdRead
The MATH:MATH<x>:LABel:FONT command tree.
Usage
- Using the
.query()method will send theMATH:MATH<x>:LABel:FONT?query. - Using the
.verify(value)method will send theMATH:MATH<x>:LABel:FONT?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.bold: TheMATH:MATH<x>:LABel:FONT:BOLDcommand..italic: TheMATH:MATH<x>:LABel:FONT:ITALiccommand..size: TheMATH:MATH<x>:LABel:FONT:SIZEcommand..type: TheMATH:MATH<x>:LABel:FONT:TYPEcommand..underline: TheMATH:MATH<x>:LABel:FONT:UNDERlinecommand.
bold
property
¶
Return the MATH:MATH<x>:LABel:FONT:BOLD command.
Description
- This command sets or queries the bold state of the specified math label. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:LABel:FONT:BOLD?query. - Using the
.verify(value)method will send theMATH:MATH<x>:LABel:FONT:BOLD?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:LABel:FONT:BOLD valuecommand.
SCPI Syntax
- MATH:MATH<x>:LABel:FONT:BOLD {ON|OFF|<NR1>}
- MATH:MATH<x>:LABel:FONT:BOLD?
Info
<NR1>= 0 turns off bold, and any other integer turns on bold.OFFturns off bold.ONturns on bold.
italic
property
¶
italic: MathMathItemLabelFontItalic
Return the MATH:MATH<x>:LABel:FONT:ITALic command.
Description
- This command sets or queries italic state of the specified math label. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:LABel:FONT:ITALic?query. - Using the
.verify(value)method will send theMATH:MATH<x>:LABel:FONT:ITALic?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:LABel:FONT:ITALic valuecommand.
SCPI Syntax
- MATH:MATH<x>:LABel:FONT:ITALic {ON|OFF|<NR1>}
- MATH:MATH<x>:LABel:FONT:ITALic?
Info
<NR1>= 0 turns off italic, and any other integer turns on italic.OFFturns off italic.ONturns on italic.
size
property
¶
Return the MATH:MATH<x>:LABel:FONT:SIZE command.
Description
- This command sets or queries font size of the specified math label. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:LABel:FONT:SIZE?query. - Using the
.verify(value)method will send theMATH:MATH<x>:LABel:FONT:SIZE?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:LABel:FONT:SIZE valuecommand.
SCPI Syntax
- MATH:MATH<x>:LABel:FONT:SIZE <NR1>
- MATH:MATH<x>:LABel:FONT:SIZE?
Info
<NR1>is the font size of the specified math label.
type
property
¶
Return the MATH:MATH<x>:LABel:FONT:TYPE command.
Description
- This command sets or queries font type of the specified math label, such as Arial or Times New Roman. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:LABel:FONT:TYPE?query. - Using the
.verify(value)method will send theMATH:MATH<x>:LABel:FONT:TYPE?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:LABel:FONT:TYPE valuecommand.
SCPI Syntax
- MATH:MATH<x>:LABel:FONT:TYPE <QString>
- MATH:MATH<x>:LABel:FONT:TYPE?
Info
<QString>is the name of the font type.
underline
property
¶
underline: MathMathItemLabelFontUnderline
Return the MATH:MATH<x>:LABel:FONT:UNDERline command.
Description
- This command sets or queries the underline state of the specified math label. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:LABel:FONT:UNDERline?query. - Using the
.verify(value)method will send theMATH:MATH<x>:LABel:FONT:UNDERline?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:LABel:FONT:UNDERline valuecommand.
SCPI Syntax
- MATH:MATH<x>:LABel:FONT:UNDERline {ON|OFF|<NR1>}
- MATH:MATH<x>:LABel:FONT:UNDERline?
Info
<NR1>= 0 turns off underline, and any other integer turns on underline.OFFturns off underline.ONturns on underline.
MathMathItemLabelFontBold
¶
Bases: SCPICmdWrite, SCPICmdRead
The MATH:MATH<x>:LABel:FONT:BOLD command.
Description
- This command sets or queries the bold state of the specified math label. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:LABel:FONT:BOLD?query. - Using the
.verify(value)method will send theMATH:MATH<x>:LABel:FONT:BOLD?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:LABel:FONT:BOLD valuecommand.
SCPI Syntax
- MATH:MATH<x>:LABel:FONT:BOLD {ON|OFF|<NR1>}
- MATH:MATH<x>:LABel:FONT:BOLD?
Info
<NR1>= 0 turns off bold, and any other integer turns on bold.OFFturns off bold.ONturns on bold.
MathMathItemLabelFontItalic
¶
Bases: SCPICmdWrite, SCPICmdRead
The MATH:MATH<x>:LABel:FONT:ITALic command.
Description
- This command sets or queries italic state of the specified math label. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:LABel:FONT:ITALic?query. - Using the
.verify(value)method will send theMATH:MATH<x>:LABel:FONT:ITALic?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:LABel:FONT:ITALic valuecommand.
SCPI Syntax
- MATH:MATH<x>:LABel:FONT:ITALic {ON|OFF|<NR1>}
- MATH:MATH<x>:LABel:FONT:ITALic?
Info
<NR1>= 0 turns off italic, and any other integer turns on italic.OFFturns off italic.ONturns on italic.
MathMathItemLabelFontSize
¶
Bases: SCPICmdWrite, SCPICmdRead
The MATH:MATH<x>:LABel:FONT:SIZE command.
Description
- This command sets or queries font size of the specified math label. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:LABel:FONT:SIZE?query. - Using the
.verify(value)method will send theMATH:MATH<x>:LABel:FONT:SIZE?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:LABel:FONT:SIZE valuecommand.
SCPI Syntax
- MATH:MATH<x>:LABel:FONT:SIZE <NR1>
- MATH:MATH<x>:LABel:FONT:SIZE?
Info
<NR1>is the font size of the specified math label.
MathMathItemLabelFontType
¶
Bases: SCPICmdWrite, SCPICmdRead
The MATH:MATH<x>:LABel:FONT:TYPE command.
Description
- This command sets or queries font type of the specified math label, such as Arial or Times New Roman. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:LABel:FONT:TYPE?query. - Using the
.verify(value)method will send theMATH:MATH<x>:LABel:FONT:TYPE?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:LABel:FONT:TYPE valuecommand.
SCPI Syntax
- MATH:MATH<x>:LABel:FONT:TYPE <QString>
- MATH:MATH<x>:LABel:FONT:TYPE?
Info
<QString>is the name of the font type.
MathMathItemLabelFontUnderline
¶
Bases: SCPICmdWrite, SCPICmdRead
The MATH:MATH<x>:LABel:FONT:UNDERline command.
Description
- This command sets or queries the underline state of the specified math label. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:LABel:FONT:UNDERline?query. - Using the
.verify(value)method will send theMATH:MATH<x>:LABel:FONT:UNDERline?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:LABel:FONT:UNDERline valuecommand.
SCPI Syntax
- MATH:MATH<x>:LABel:FONT:UNDERline {ON|OFF|<NR1>}
- MATH:MATH<x>:LABel:FONT:UNDERline?
Info
<NR1>= 0 turns off underline, and any other integer turns on underline.OFFturns off underline.ONturns on underline.
MathMathItemLabelName
¶
Bases: SCPICmdWrite, SCPICmdRead
The MATH:MATH<x>:LABel:NAMe command.
Description
- This command sets or queries the label string, which is used for annotating the math waveform on the screen. The math waveform to which the label is attached is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:LABel:NAMe?query. - Using the
.verify(value)method will send theMATH:MATH<x>:LABel:NAMe?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:LABel:NAMe valuecommand.
SCPI Syntax
- MATH:MATH<x>:LABel:NAMe <QString>
- MATH:MATH<x>:LABel:NAMe?
Info
<QString>specifies the label to annotate the math waveform.
MathMathItemLabelXpos
¶
Bases: SCPICmdWrite, SCPICmdRead
The MATH:MATH<x>:LABel:XPOS command.
Description
- This command sets or queries the X position of the specified math label. Maths are specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:LABel:XPOS?query. - Using the
.verify(value)method will send theMATH:MATH<x>:LABel:XPOS?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:LABel:XPOS valuecommand.
SCPI Syntax
- MATH:MATH<x>:LABel:XPOS <NR1>
- MATH:MATH<x>:LABel:XPOS?
Info
<NR1>is the location (in pixels) where the label for the selected math waveform is displayed, relative to the left edge of the display.
MathMathItemLabelYpos
¶
Bases: SCPICmdWrite, SCPICmdRead
The MATH:MATH<x>:LABel:YPOS command.
Description
- This command sets or queries the y-position of the specified math label. The Math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:LABel:YPOS?query. - Using the
.verify(value)method will send theMATH:MATH<x>:LABel:YPOS?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:LABel:YPOS valuecommand.
SCPI Syntax
- MATH:MATH<x>:LABel:YPOS <NR1>
- MATH:MATH<x>:LABel:YPOS?
Info
<NR1>is the location (in pixels) where the label for the selected math waveform is displayed, relative to the baseline of the waveform.
MathMathItemLin
¶
Bases: SCPICmdRead
The MATH:MATH<x>:LIN command tree.
Usage
- Using the
.query()method will send theMATH:MATH<x>:LIN?query. - Using the
.verify(value)method will send theMATH:MATH<x>:LIN?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.supportedfields: TheMATH:MATH<x>:LIN:SUPPortedfieldscommand.
supportedfields
property
¶
supportedfields: MathMathItemLinSupportedfields
Return the MATH:MATH<x>:LIN:SUPPortedfields command.
Description
- This command sets or queries the field type for the math for the bus source for LIN bus. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:LIN:SUPPortedfields?query. - Using the
.verify(value)method will send theMATH:MATH<x>:LIN:SUPPortedfields?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:LIN:SUPPortedfields valuecommand.
SCPI Syntax
- MATH:MATH<x>:LIN:SUPPortedfields {DATa}
- MATH:MATH<x>:LIN:SUPPortedfields?
Info
DATasets the field type to DATa.
MathMathItemLinSupportedfields
¶
Bases: SCPICmdWrite, SCPICmdRead
The MATH:MATH<x>:LIN:SUPPortedfields command.
Description
- This command sets or queries the field type for the math for the bus source for LIN bus. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:LIN:SUPPortedfields?query. - Using the
.verify(value)method will send theMATH:MATH<x>:LIN:SUPPortedfields?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:LIN:SUPPortedfields valuecommand.
SCPI Syntax
- MATH:MATH<x>:LIN:SUPPortedfields {DATa}
- MATH:MATH<x>:LIN:SUPPortedfields?
Info
DATasets the field type to DATa.
MathMathItemParallel
¶
Bases: SCPICmdRead
The MATH:MATH<x>:PARallel command tree.
Usage
- Using the
.query()method will send theMATH:MATH<x>:PARallel?query. - Using the
.verify(value)method will send theMATH:MATH<x>:PARallel?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.supportedfields: TheMATH:MATH<x>:PARallel:SUPPortedfieldscommand.
supportedfields
property
¶
supportedfields: MathMathItemParallelSupportedfields
Return the MATH:MATH<x>:PARallel:SUPPortedfields command.
Description
- This command sets or queries the field type for the math for the bus source for PARallel bus. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:PARallel:SUPPortedfields?query. - Using the
.verify(value)method will send theMATH:MATH<x>:PARallel:SUPPortedfields?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:PARallel:SUPPortedfields valuecommand.
SCPI Syntax
- MATH:MATH<x>:PARallel:SUPPortedfields {DATa}
- MATH:MATH<x>:PARallel:SUPPortedfields?
Info
DATasets the field type to DATa.
MathMathItemParallelSupportedfields
¶
Bases: SCPICmdWrite, SCPICmdRead
The MATH:MATH<x>:PARallel:SUPPortedfields command.
Description
- This command sets or queries the field type for the math for the bus source for PARallel bus. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:PARallel:SUPPortedfields?query. - Using the
.verify(value)method will send theMATH:MATH<x>:PARallel:SUPPortedfields?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:PARallel:SUPPortedfields valuecommand.
SCPI Syntax
- MATH:MATH<x>:PARallel:SUPPortedfields {DATa}
- MATH:MATH<x>:PARallel:SUPPortedfields?
Info
DATasets the field type to DATa.
MathMathItemRs232c
¶
Bases: SCPICmdRead
The MATH:MATH<x>:RS232C command tree.
Usage
- Using the
.query()method will send theMATH:MATH<x>:RS232C?query. - Using the
.verify(value)method will send theMATH:MATH<x>:RS232C?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.supportedfields: TheMATH:MATH<x>:RS232C:SUPPortedfieldscommand.
supportedfields
property
¶
supportedfields: MathMathItemRs232cSupportedfields
Return the MATH:MATH<x>:RS232C:SUPPortedfields command.
Description
- This command sets or queries the field type for the math for the bus source for RS232C bus. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:RS232C:SUPPortedfields?query. - Using the
.verify(value)method will send theMATH:MATH<x>:RS232C:SUPPortedfields?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:RS232C:SUPPortedfields valuecommand.
SCPI Syntax
- MATH:MATH<x>:RS232C:SUPPortedfields {DATa|TXData|RXData}
- MATH:MATH<x>:RS232C:SUPPortedfields?
Info
DATasets the field type to DATa.TXDatasets the field type to TXData. TXData field can be set when RS232 Bus configuration for Data Inputs is set to Two.RXDatasets the field type to RXData. RXData field can be set when RS232 Bus configuration for Data Inputs is set to Two.
MathMathItemRs232cSupportedfields
¶
Bases: SCPICmdWrite, SCPICmdRead
The MATH:MATH<x>:RS232C:SUPPortedfields command.
Description
- This command sets or queries the field type for the math for the bus source for RS232C bus. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:RS232C:SUPPortedfields?query. - Using the
.verify(value)method will send theMATH:MATH<x>:RS232C:SUPPortedfields?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:RS232C:SUPPortedfields valuecommand.
SCPI Syntax
- MATH:MATH<x>:RS232C:SUPPortedfields {DATa|TXData|RXData}
- MATH:MATH<x>:RS232C:SUPPortedfields?
Info
DATasets the field type to DATa.TXDatasets the field type to TXData. TXData field can be set when RS232 Bus configuration for Data Inputs is set to Two.RXDatasets the field type to RXData. RXData field can be set when RS232 Bus configuration for Data Inputs is set to Two.
MathMathItemSent
¶
Bases: SCPICmdRead
The MATH:MATH<x>:SENT command tree.
Usage
- Using the
.query()method will send theMATH:MATH<x>:SENT?query. - Using the
.verify(value)method will send theMATH:MATH<x>:SENT?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.supportedfields: TheMATH:MATH<x>:SENT:SUPPortedfieldscommand.
supportedfields
property
¶
supportedfields: MathMathItemSentSupportedfields
Return the MATH:MATH<x>:SENT:SUPPortedfields command.
Description
- This command sets or queries the field type for the math for the bus source for SENT bus. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:SENT:SUPPortedfields?query. - Using the
.verify(value)method will send theMATH:MATH<x>:SENT:SUPPortedfields?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:SENT:SUPPortedfields valuecommand.
SCPI Syntax
- MATH:MATH<x>:SENT:SUPPortedfields {FCData|FCDFirst|FCDTwo|SDATa}
- MATH:MATH<x>:SENT:SUPPortedfields?
Info
FCDatasets the field type to FCData. FCData field is available to select when SENT Bus configuration for Fast Data Channels is set to 2.FCDFirstsets the field type to FCDFirst.FCDTwosets the field type to FCDTwo.SDATasets the field type to SDATa. SDATa is available when SENT Bus configuration for Slow Channel is not None.
MathMathItemSentSupportedfields
¶
Bases: SCPICmdWrite, SCPICmdRead
The MATH:MATH<x>:SENT:SUPPortedfields command.
Description
- This command sets or queries the field type for the math for the bus source for SENT bus. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:SENT:SUPPortedfields?query. - Using the
.verify(value)method will send theMATH:MATH<x>:SENT:SUPPortedfields?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:SENT:SUPPortedfields valuecommand.
SCPI Syntax
- MATH:MATH<x>:SENT:SUPPortedfields {FCData|FCDFirst|FCDTwo|SDATa}
- MATH:MATH<x>:SENT:SUPPortedfields?
Info
FCDatasets the field type to FCData. FCData field is available to select when SENT Bus configuration for Fast Data Channels is set to 2.FCDFirstsets the field type to FCDFirst.FCDTwosets the field type to FCDTwo.SDATasets the field type to SDATa. SDATa is available when SENT Bus configuration for Slow Channel is not None.
MathMathItemSigneddata
¶
Bases: SCPICmdWrite, SCPICmdRead
The MATH:MATH<x>:SIGNeddata command.
Description
- This command sets or queries value to denote that bus field is decoded as signed/unsigned data for math on bus source. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:SIGNeddata?query. - Using the
.verify(value)method will send theMATH:MATH<x>:SIGNeddata?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:SIGNeddata valuecommand.
SCPI Syntax
- MATH:MATH<x>:SIGNeddata {ON|OFF}
- MATH:MATH<x>:SIGNeddata?
Info
ONindicates that the bus field is decoded as signed data for drawing the math waveform.OFFindicates that the bus field is decoded as unsigned data for drawing the math waveform.
MathMathItemSource1
¶
Bases: SCPICmdWrite, SCPICmdRead
The MATH:MATH<x>:SOUrce1 command.
Description
- This command sets or queries the specified math source. This command sets the Basic Math
components in the user interface, with two sources and a function. You would also need to
set the math type to Basic to see the change in the user interface, but this will not
effect the programmable interface. The math waveform and source are specified by x. When
the
MATH:MATH<x>:TYPEis set to BASIC, SOURCE1 and SOURCE2 can be used.
Usage
- Using the
.query()method will send theMATH:MATH<x>:SOUrce1?query. - Using the
.verify(value)method will send theMATH:MATH<x>:SOUrce1?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:SOUrce1 valuecommand.
SCPI Syntax
- MATH:MATH<x>:SOUrce1 {CH<x>|MATH<x>|REF<x>}
- MATH:MATH<x>:SOUrce1?
Info
MATH<x>specifies the math number.1specifies the source number.CH<x>specifies the source as channel.MATH<x>specifies the source as math.REF<x>specifies the source as reference.
MathMathItemSpectral
¶
Bases: SCPICmdRead
The MATH:MATH<x>:SPECTral command tree.
Usage
- Using the
.query()method will send theMATH:MATH<x>:SPECTral?query. - Using the
.verify(value)method will send theMATH:MATH<x>:SPECTral?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.window: TheMATH:MATH<x>:SPECTral:WINdowcommand.
window
property
¶
window: MathMathItemSpectralWindow
Return the MATH:MATH<x>:SPECTral:WINdow command.
Description
- This command sets or queries the window function used to apply the specified FFT window to the input data for the specified math waveform. The Math waveform is specified by x. A spectral window determines what the filter shape of the spectral analyzer will be in the frequency domain. It can be described by a mathematical function that is multiplied point-by-point times the input data to the spectral analyzer. Following is a list of arguments that specify the window function used to multiply the input data. The windows are listed in the order of their ability to resolve frequencies (resolution bandwidth).
Usage
- Using the
.query()method will send theMATH:MATH<x>:SPECTral:WINdow?query. - Using the
.verify(value)method will send theMATH:MATH<x>:SPECTral:WINdow?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:SPECTral:WINdow valuecommand.
SCPI Syntax
- MATH:MATH<x>:SPECTral:WINdow {RECTANGular|HAMMing|HANNing|BLACKMANHarris|KAISERBessel|GAUSSian|FLATTOP2|TEKEXPonential}
- MATH:MATH<x>:SPECTral:WINdow?
Info
RECTANGularwindow function is equivalent to multiplying all gate data by one.HAMMingwindow function is based on a cosine series.HANNingwindow function is based on a cosine series.BLACKMANHarriswindow function is based on a cosine series.KAISERBesselwindow function is based on a cosine series.GAUSSianwindow function has the best localization characteristics in the joint time/frequency plane.FLATTOP2window function is a cosine series window with a flattened frequency response lobe.TEKEXPonentialwindow has an exponential nonsymmetrical shape in the time domain and a triangular shape in the frequency domain.
MathMathItemSpectralWindow
¶
Bases: SCPICmdWrite, SCPICmdRead
The MATH:MATH<x>:SPECTral:WINdow command.
Description
- This command sets or queries the window function used to apply the specified FFT window to the input data for the specified math waveform. The Math waveform is specified by x. A spectral window determines what the filter shape of the spectral analyzer will be in the frequency domain. It can be described by a mathematical function that is multiplied point-by-point times the input data to the spectral analyzer. Following is a list of arguments that specify the window function used to multiply the input data. The windows are listed in the order of their ability to resolve frequencies (resolution bandwidth).
Usage
- Using the
.query()method will send theMATH:MATH<x>:SPECTral:WINdow?query. - Using the
.verify(value)method will send theMATH:MATH<x>:SPECTral:WINdow?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:SPECTral:WINdow valuecommand.
SCPI Syntax
- MATH:MATH<x>:SPECTral:WINdow {RECTANGular|HAMMing|HANNing|BLACKMANHarris|KAISERBessel|GAUSSian|FLATTOP2|TEKEXPonential}
- MATH:MATH<x>:SPECTral:WINdow?
Info
RECTANGularwindow function is equivalent to multiplying all gate data by one.HAMMingwindow function is based on a cosine series.HANNingwindow function is based on a cosine series.BLACKMANHarriswindow function is based on a cosine series.KAISERBesselwindow function is based on a cosine series.GAUSSianwindow function has the best localization characteristics in the joint time/frequency plane.FLATTOP2window function is a cosine series window with a flattened frequency response lobe.TEKEXPonentialwindow has an exponential nonsymmetrical shape in the time domain and a triangular shape in the frequency domain.
MathMathItemSpi
¶
Bases: SCPICmdRead
The MATH:MATH<x>:SPI command tree.
Usage
- Using the
.query()method will send theMATH:MATH<x>:SPI?query. - Using the
.verify(value)method will send theMATH:MATH<x>:SPI?query and raise an AssertionError if the returned value does not matchvalue.
Properties
.supportedfields: TheMATH:MATH<x>:SPI:SUPPortedfieldscommand.
supportedfields
property
¶
supportedfields: MathMathItemSpiSupportedfields
Return the MATH:MATH<x>:SPI:SUPPortedfields command.
Description
- This command sets or queries the field type for the math for the bus source for SPI bus. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:SPI:SUPPortedfields?query. - Using the
.verify(value)method will send theMATH:MATH<x>:SPI:SUPPortedfields?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:SPI:SUPPortedfields valuecommand.
SCPI Syntax
- MATH:MATH<x>:SPI:SUPPortedfields {DATa|MOSIdata|MISOdata}
- MATH:MATH<x>:SPI:SUPPortedfields?
Info
DATasets the field type to DATa.MOSIdatasets the field type to MOSIdata. MOSIdata field is available to select when SPI Bus configuration for Data Inputs is set to Two.MISOdatasets the field type to MISOdata. MISOdata field is available to select when SPI Bus configuration for Data Inputs is set to Two.
MathMathItemSpiSupportedfields
¶
Bases: SCPICmdWrite, SCPICmdRead
The MATH:MATH<x>:SPI:SUPPortedfields command.
Description
- This command sets or queries the field type for the math for the bus source for SPI bus. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:SPI:SUPPortedfields?query. - Using the
.verify(value)method will send theMATH:MATH<x>:SPI:SUPPortedfields?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:SPI:SUPPortedfields valuecommand.
SCPI Syntax
- MATH:MATH<x>:SPI:SUPPortedfields {DATa|MOSIdata|MISOdata}
- MATH:MATH<x>:SPI:SUPPortedfields?
Info
DATasets the field type to DATa.MOSIdatasets the field type to MOSIdata. MOSIdata field is available to select when SPI Bus configuration for Data Inputs is set to Two.MISOdatasets the field type to MISOdata. MISOdata field is available to select when SPI Bus configuration for Data Inputs is set to Two.
MathMathItemType
¶
Bases: SCPICmdWrite, SCPICmdRead
The MATH:MATH<x>:TYPe command.
Description
- This command sets or queries the math type. The math waveform is specified by x.
Usage
- Using the
.query()method will send theMATH:MATH<x>:TYPe?query. - Using the
.verify(value)method will send theMATH:MATH<x>:TYPe?query and raise an AssertionError if the returned value does not matchvalue. - Using the
.write(value)method will send theMATH:MATH<x>:TYPe valuecommand.
SCPI Syntax
- MATH:MATH<x>:TYPe {BASic|FFT|ADVanced}
- MATH:MATH<x>:TYPe?
Info
BASicset the type to basic math.FFTsets the type to FFT math, which can use any live analog or reference waveform in the time domain. NOTE. You can also use FFT as part of a math expression by declaring the type.ADVancedsets the type to advanced math.
MathMathItemVunit
¶
Bases: SCPICmdWrite
The MATH:MATH<x>:VUNIT command.
Description
- This command specifies or returns the math custom vertical units. The math waveform is specified by x.
Usage
- Using the
.write(value)method will send theMATH:MATH<x>:VUNIT valuecommand.
SCPI Syntax
- MATH:MATH<x>:VUNIT <QString>
Info
<QString>is the custom vertical units.