PIM Master™ Passive Intermodulation Analyzer with Site Master™ Cable & Antenna Analyzer Option Programming Manual : PIM Analyzer Programming Commands : :CALCulate Subsystem
 
:CALCulate Subsystem
The commands in this subsystem process data that have been collected via the SENSe subsystem.
:CALCulate:DTPMeas:CABLoss
:CALCulate:DTPMeas:CABLoss?
Title
DTP cable loss
Description
Sets and queries DTP cable loss in dB/current distance unit.
Parameter
Cable loss in units of dB/distance
Parameter range is 0 dB/ft to 5 dB/ft (0 dB/m to 16.404 dB/m).
Default Value
None. If no value is sent, then no action occurs. To verify that a value has been received, follow the command with a query.
Example
To set the cable loss to 0.1 dB/ft:
:CALCulate:DTPMeas:CABLoss 0.1
To query the cable loss:
:CALC:DTPM:CABL?
Front Panel Access
Distance, More, Cable Loss
 
:CALCulate:DTPMeas:DISPlay:RESOlution
:CALCulate:DTPMeas:DISPlay:RESOlution?
Title
DTP data points
Description
Sets and queries DTP data points.
Parameter
128, 255
Default Value
None. If no value is sent, then no action occurs. To verify that a value has been received, follow the command with a query.
Example
To set the data point to 128:
:CALCulate:DTPMeas:DISPlay:RESOlution 128
To query the data point setting:
:CALC:DTPM:DISP:RESO?
Front Panel Access
Distance, DTP Aid, Data Points
 
:CALCulate:DTPMeas:DMAX?
Title
DTP maximum measurable distance
Description
Queries DTP maximum measurable distance in current distance unit as set by :CALCulate:DTPMeas:UNIT FEET|METers.
Parameter
None
Default Value
None
Example
To query the DTP maximum measurable distance:
:CALC:DTPM:DMAX?
Related Command
:CALCulate:DTPMeas:STARt|STOP
:CALC:DTPM:STAR|STOP?
:CALCulate:DTPMeas:UNIT?
Front Panel Access
Distance, DTP Aid, Stop Distance (Dmax)
 
:CALCulate:DTPMeas:FRESolution?
Title
DTP fault resolution
Description
Queries DTP fault resolution in current distance unit as set by :CALCulate:DTPMeas:UNIT FEET|METers.
Parameter
None
Default Value
None
Example
To query the DTP fault resolution:
:CALC:DTPM:FRES?
Front Panel Access
NA
 
:CALCulate:DTPMeas:PVELocity
:CALCulate:DTPMeas:PVELocity?
Title
DTP cable propagation velocity index
Description
Sets and queries DTP cable propagation velocity index.
Parameter
0.1 to 1.0
Default Value
None. If no value is sent, then no action occurs. To verify that a value has been received, follow the command with a query.
Example
To set the cable propagation velocity index to 0.75:
:CALCulate:DTPMeas:PVELocity 0.75
To query the cable propagation velocity index:
:CALC:DTPM:PVEL?
Front Panel Access
Distance, DTP Aid, Propagation Velocity
:CALCulate:DTPMeas:REFerence:AMPLitude
:CALCulate:DTPMeas:REFerence:AMPLitude?
Title
DTP Reference Line Amplitude
Description
Sets and queries the amplitude of the reference line in DTP mode in the current units (dBm by default).
Parameter
0 to –260
Parameter Type
<float>
Default Value
None. If no value is sent, then no action occurs. To verify that a value has been received, follow the command with a query.
Example
To set the reference line to –100 dBm:
:CALCulate:DTPMeas:REFerence:AMPLitude –100
To query the reference line amplitude:
:CALC:DTPM:REF:AMPL?
Front Panel Access
Shift‑Limit (6), Amplitude
:CALCulate:DTPMeas:REFerence[:STATe] OFF|ON|0|1
:CALCulate:DTPMeas:REFerence[:STATe]?
Title
DTP Reference Line State
Description
Turns the reference line ON or OFF. If the value is set to ON or to 1, then the reference line is ON. If the value is set to OFF or to 0, then the reference line is OFF.
The query version of the command returns 0 or 1.
Parameter
OFF|ON|0|1
Parameter Type
<char>
Default Value
None
Example
To turn On the reference line:
:CALCulate:DTPMeas:REFerence ON
:CALCulate:DTPMeas:REFerence:STATe ON
:CALCulate:DTPMeas:REFerence:STATe 1
To turn Off the reference line:
:CALCulate:DTPMeas:REFerence OFF
:CALCulate:DTPMeas:REFerence:STATe 0
:CALCulate:DTPMeas:REFerence 0
To query the reference line state:
:CALC:DTPM:REF?
:CALC:DTPM:REF:STAT?
Front Panel Access
Shift‑Limit (6), On/Off
:CALCulate:DTPMeas:STARt n m|n ft
:CALCulate:DTPMeas:STARt?
Title
DTP Distance Start Setup
Description
Sets the DTP distance start. Parameters are n m for meters and n ft for feet. Queries return a value in the unit set by :CALCulate:DTPMeas:UNIT, and convert the value if necessary.
Parameter
n m|n ft
Default Value
The default unit is meters.
Example
To set the DTP start distance to 10 feet:
:CALCulate:DTPMeas:STARt 10 ft
To set the DTP start distance to 10 meters:
:CALCulate:DTPMeas:STARt 10
To query the DTP start distance:
:CALC:DTPM:STAR?
Related Commands
:CALCulate:DTPMeas:UNIT FEET
:CALCulate:DTPMeas:STOP 100 ft
:CALC:DTPM:STOP?
:CALCulate:DTPMeas:DMAX?
Front Panel Access
Distance, DTP Aid, Start Distance
:CALCulate:DTPMeas:STOP
:CALCulate:DTPMeas:STOP?
Title
DTP Distance Stop Setup
Description
Sets and queries DTP distance stop. Parameters are m for meters and ft for feet.
Parameter
m|ft
Default Value
Values in meters
Example
To set the DTP stop distance to 100 feet:
:CALCulate:DTPMeas:STOP 100 ft
To query the DTP stop distance:
:CALC:DTPM:STOP?
Related Command
:CALCulate:DTPMeas:STARt 10 ft
:CALC:DTPM:STAR?
:CALCulate:DTPMeas:DMAX?
Front Panel Access
Distance, DTP Aid, Stop Distance
:CALCulate:DTPMeas:UNIT METers|FEET
:CALCulate:DTPMeas:UNIT?
Title
DTP distance unit
Description
Sets and queries DTP distance unit. Parameters are METers for meters and FEET for feet.
Parameter
METers|FEET
Default Value
None. If no value is sent, then no action occurs. To verify that a value has been received, follow the command with a query.
Example
To set the unit to meter:
:CALCulate:DTPMeas:UNIT METers
:CALC:DTPM:UNIT MET
To query the distance unit:
:CALC:DTPM:UNIT?
Front Panel Access
Distance, Units
 
:CALCulate:DTPMeas:WINDow RECTangular|NSLobe|NSLobe|NSLobe
:CALCulate:DTPMeas:WINDow?
Title
DTP Windowing
Description
Sets and queries the type of windowing in order of increasing side lobe reduction. Windowing settings are: rectangular, nominal side lobe, low side lobe, and minimum side lobe.
Parameter
RECTangular = Rectangular Windowing
NSLobe = Nominal Side Lobe Windowing
LSLobe = Low Side Lobe Windowing
MSLobe = Minimum Side Lobe Windowing
Default Value
None. If no value is sent, then no action occurs. To verify that a value has been received, follow the command with a query.
Example
To set the Nominal Side Lobe Windowing:
:CALCulate:DTPMeas:WINDow NSLobe
To query the type of Windowing:
:CALC:DTPM:WIND?
2-Port Mode
Required.
Front Panel Access
Distance, More, Window
 
:CALCulate:LIMit:ALARm OFF|ON|0|1
:CALCulate:LIMit:ALARm?
Title
Upper Limit Alarm On/Off
Description
Sets and queries limit alarm for PIM vs. Time and Swept PIM measurement types. This alarm is associated only with the upper limit. Lower limit does not have an associated alarm.
Parameter
Limit Alarm OFF|ON|0|1
Parameter Type
<boolean>
Default Value
Off
Example
To set the limit alarm:
:CALCulate:LIMit:ALARm 1
To query the limit alarm:
:CALC:LIM:ALAR?
Front Panel Access
Shift‑Limit (6), Limit Alarm
 
:CALCulate:LIMit:AMPLitude
:CALCulate:LIMit:AMPLitude?
Title
Set Limit Amplitude
Description
Sets and queries limit amplitude for PIM vs. Time and Swept PIM measurement types. The amplitude will be associated with the currently selected limit (upper/lower). The amplitude reference level range is –50 dBm to –140 dBm. The upper and lower limits may be set to values outside the reference level range; however, such settings are of no practical value.
Parameter
Magnitude (dBm)
Resolution
0.1 dB
Default Value
None. If no value is sent, then no action occurs. To verify that a value has been received, follow the command with a query.
Example
To set the limit amplitude to –120 dBm:
:CALCulate:LIMit:AMPLitude –120
To query the limit amplitude:
:CALC:LIM:AMPL?
Front Panel Access
Shift‑Limit (6), Limit Move, Amplitude
 
:CALCulate:LIMit:FAIL?
Title
Upper Limit Fail Check
Description
Checks if current trace data is failing Upper Limit dBm setting. If one or more trace points fail, then the condition would indicate fail for a response. Parameters are 0 | 1 (1 for pass and 0 for fail).
Parameter
None
Default Value
None
Example
To query if the current trace data is failing Upper Limit dBm setting:
:CALC:LIM:FAIL?
Front Panel Access
NA, no direct access
Adjusting Limit Amplitude shows a number display change to red when the limit line falls below the highest trace data point.
:CALCulate:LIMit[:STATe] OFF|ON|0|1
:CALCulate:LIMit[:STATe]?
Title
Limit State
Description
Turns the limit line ON or OFF. If the value is set to ON or to 1, then the currently selected limit line is ON. If the value is set to OFF or to 0, then the currently selected limit line is OFF. The query version of the command returns a 1 if the currently selected limit line is ON and returns a 0 if it is OFF.
Parameter
OFF|ON|0|1
Parameter Type
<boolean>
Default Value
OFF
Example
To turn on the limit line:
:CALCulate:LIMit ON
:CALCulate:LIMit:STATe ON
:CALCulate:LIMit:STATe 1
To turn off the limit line:
:CALCulate:LIMit OFF
:CALCulate:LIMit:STATe 0
:CALCulate:LIMit 0
To query the limit line state:
:CALCul:LIM?
:CALC:LIM:STAT?
Front Panel Access
Shift‑Limit (6), Limit On/Off
:CALCulate:LIMit:TYPe
:CALCulate:LIMit:TYPe?
Title
Limit Type Selection
Description
Sets and queries limits for PIM vs. Time and Swept PIM measurement types. Selections are Upper/Lower.
Parameter
Limit value (0 = Upper, 1 = Lower)
Default Value
None. If no value is sent, then no action occurs. To verify that a value has been received, follow the command with a query.
Example
To set the upper limit:
:CALCulate:LIMit:TYPe 0
To query the limit type:
:CALC:LIM:TYP?
Front Panel Access
Shift‑Limit (6), Limit
 
:CALCulate:LIMit:VALue
Title
Limit Value Magnitude Change
Description
Adds a magnitude change to the existing limit magnitude for PIM vs. Time and Swept PIM measurement types.
Parameter
Magnitude (dB)
Resolution
0.1 dB
Default Value
None
Example
To decrease the currently selected limit magnitude by 5 dB:
:CALCulate:LIMit:VALue –5
Related Command
To query the limit amplitude:
:CALC:LIM:AMPL?
Front Panel Access
Shift‑Limit (6), Limit Move, Move Limit U/D
 
:CALCulate:MARKer:AOFF
Title
Turn All Markers Off
Description
Turns off all markers
Example
To turn Off all markers:
:CALC:MARK:AOFF
Front Panel Access
Marker, More, All Markers Off
:CALCulate:MARKer{1|2|3|4|5|6}:DELTa[:STATe] OFF|ON|0|1
:CALCulate:MARKer{1|2|3|4|5|6}:DELTa[:STATe]?
Title
Delta Marker State
Description
Sets the specified delta marker on or off. The query returns the state of the specified delta marker 0 or 1.
Parameter
OFF|ON|0|1
Parameter Type
<boolean>
Default Value
OFF
Example
To turn on the delta marker #3:
:CALCulate:MARKer3:DELTa ON
:CALCulate:MARKer3:DELTa 1
:CALCulate:MARKer3:DELTa:STATe ON
:CALCulate:MARKer3:DELTa:STATe 1
To turn off delta marker #6:
:CALCulate:MARKer6:DELTa OFF
:CALCulate:MARKer6:DELTa:STATe OFF
:CALCulate:MARKer6:DELTa:STATe 0
To query the state of delta marker #2:
:CALC:MARK2:DELT?
:CALC:MARK2:DELT:STAT?
Front Panel Access
Marker, Delta On Off
 
 
:CALCulate:MARKer{1|2|3|4|5|6}:DELTa:TRACe 0|1
:CALCulate:MARKer{1|2|3|4|5|6}:DELTa:TRACe?
Title
Delta Marker Trace
Description
Sets the specified delta marker to a desired trace. Valid only for Swept PIM mode.
Parameter
0|1
Default Value
None. If no value is sent, then no action occurs. To verify that a value has been received, follow the command with a query.
Example
To set delta marker #1 onto the fixed F2 sweep (Sweep #2):
:CALCulate:MARKer1:DELTa:TRACe 1
To set delta marker #2 onto the fixed F1 sweep (Sweep #1):
:CALC:MARK2:DELT:TRAC 0
To query which trace delta marker #6 is on:
:CALC:MARK6:DELT:TRAC?
Front Panel Access
Marker, Marker, M#, Delta, Swap Marker Trace
 
:CALCulate:MARKer{1|2|3|4|5|6}:DELTa:X <x-parameter>
:CALCulate:MARKer{1|2|3|4|5|6}:DELTa:X?
Title
Delta Marker X Value
Description
Sets the location of the delta marker on the x‑axis at the specified location <x‑parameter> + the reference marker x‑axis. <x‑parameter> is defined in the current x‑axis units. The query version of the command returns the location of the delta marker on the x‑axis.
Parameter
<x‑parameter>
Default Unit
Current x‑axis unit
Example
If both the reference and delta marker #1 are currently at 1 GHz on the x‑axis, then send the command below to set the delta marker #1 to 2 GHz on the x‑axis:
:CALCulate:MARKer1:DELTa:X 1GHz
Related Command
:CALCulate:MARKer[1]|2|3|4|5|6:X
Front Panel Access
Marker, [Marker 1/2/3/4/5/6], Delta On, Arrow buttons
 
:CALCulate:MARKer{1|2|3|4|5|6}:DELTa:Y?
Title
Delta Marker Read Y Value
Description
Reads the current Y value for the specified delta marker. The units are the units of the y‑axis.
Default Unit
Current y‑axis unit
Example
To query the Y value of delta marker #6:
:CALC:MARK6:DELT:Y?
Front Panel Access
NA
:CALCulate:MARKer{1|2|3|4|5|6}[:STATe] OFF|ON|0|1
:CALCulate:MARKer{1|2|3|4|5|6}[:STATe]?
Title
Marker State
Description
Sets the specified marker on or off.
Parameter
OFF|ON|0|1
Parameter Type
<boolean>
Default Value
OFF
Example
To turn off reference marker #1:
:CALCulate:MARKer1:STATe OFF
To query the state of marker #6:
:CALC:MARK6:STAT?
Front Panel Access
Marker, Marker, M#, On/Off
:CALCulate:MARKer{1|2|3|4|5|6}:TRACe 0|1
:CALCulate:MARKer{1|2|3|4|5|6}:TRACe?
Title
Marker Trace
Description
Sets the specified marker to a desired trace. Valid only for Swept PIM mode.
Parameter
0|1
Default Value
None. If no value is sent, then no action occurs. To verify that a value has been received, follow the command with a query.
Example
To set marker #1 onto the fixed F2 sweep (Sweep #2):
:CALCulate:MARKer1:TRACe 1
To set marker #2 onto the fixed F1 sweep (Sweep #1):
:CALC:MARK2:TRAC 0
To query which trace marker #6 is on:
:CALC:MARK6:TRAC?
Front Panel Access
Marker, Marker, M#, Swap Marker Trace
:CALCulate:MARKer{1|2|3|4|5|6}:X <x-parameter>
:CALCulate:MARKer{1|2|3|4|5|6}:X?
Title
Marker X Value
Description
Sets the location of the marker on the x‑axis at the specified location. <x‑parameter> is defined in the current x‑axis units. The query version of the command returns the location of the marker on the x‑axis. Note that the marker is snapped to the data point closest to the specified value. If the specified marker is not On, then it is set to On. In Swept PIM, Marker 1 is always On, but remains at trace peak and cannot be moved. The query command reports the x‑axis position for Swept PIM.
Parameter
<x‑parameter>
Default Unit
seconds in PIM versus Time measurement type
meters or feet in DTP measurement type
hertz in Swept PIM measurement type (query only)
Example
(In PIM vs. Time, DTP, or Swept PIM) To query the X value of reference marker #3:
:CALC:MARK3:X?
(In PIM vs. Time) To set reference marker #3 to 1.5 seconds on the x-axis:
:CALCulate:MARKer3:X 1.5
:CALCulate:MARKer3:X 1.5s
(In PIM vs. Time) To set reference marker #1 to 25 µs:
:CALCulate:MARKer:X 25
:CALCulate:MARKer1:X 25µs
(In DTP) To set reference marker #1 to 15 ft on the x-axis:
:CALCulate:MARKer:X 15
:CALCulate:MARKer1:X 15ft
To query the location of the marker on the x-axis:
:CALC:MARK:X?
Front Panel Access
Marker, [Marker 1/2/3/4/5/6]
:CALCulate:MARKer{1|2|3|4|5|6}:Y?
Title
Marker Read Y Value
Description
Reads the current Y value for the specified marker. The units are the units of the y‑axis.
Default Unit
Current y‑axis unit
Example
To query the Y value of reference marker #4:
:CALC:MARK4:Y?
Front Panel Access
N/A
:CALCulate:SCALe:UNIT DBM|DBC
:CALCulate:SCALe:UNIT?
Title
Scale Unit
Description
Sets and queries the scale unit for PIM vs. Time, Distance‑to‑PIM, and Swept PIM.
Parameter
DBM|DBC
Default Value
None. If no value is sent, then no action occurs. To verify that a value has been received, follow the command with a query.
Example
To set the unit to dBm:
:CALCulate:SCALe:UNIT DBM
:CALC:SCAL:UNIT DBM
To query the scale unit:
:CALC:SCAL:UNIT?
Front Panel Access
Amplitude, Units
:CALCulate:SPECtrum:MAXHold
:CALCulate:SPECtrum:MAXHold?
Title
Spectrum View Max Hold
Description
Enables or disables Max Hold for Spectrum View mode.
Parameter
OFF|ON|0|1
Parameter Type
<boolean>
Default Value
None. If no value is sent, then no action occurs. To verify that a value has been received, follow the command with a query.
Example
To enable Max Hold:
CALCulate:SPECtrum:MAXHold ON
To query the state of Max Hold:
CALC:SPEC:MAXH?
Front Panel Access
In Spectrum View mode
Measurements, Max Hold or Shift-5 (Trace), Max Hold.