Function

SCPI Command :

[SENSe]:ESPectrum<sb>:RANGe<ri>:LIMit<li>:RELative:STOP:FUNCtion

class FunctionCls

Function commands group definition. 1 total commands, 0 Subgroups, 1 group commands

get(subBlock=SubBlock.Default, rangePy=RangePy.Default, limitIx=LimitIx.Default) → RsFsw.enums.FunctionA

# SCPI: [SENSe]:ESPectrum<sb>:RANGe<ri>:LIMit<li>:RELative:STOP:FUNCtion
value: enums.FunctionA = driver.sense.espectrum.range.limit.relative.stop.function.get(subBlock = repcap.SubBlock.Default, rangePy = repcap.RangePy.Default, limitIx = repcap.LimitIx.Default)

Enables the use of a function when defining the relative limit for a SEM range.

param subBlock

optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Espectrum’)

param rangePy

optional repeated capability selector. Default value: Ix1 (settable in the interface ‘Range’)

param limitIx

optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Limit’)

return

function: OFF | MAX Defines the function to be used to determine the relative limit line stop value MAX The maximum of the relative and the absolute level is used as the limit stop value. Use the [SENSe:]ESPectrumsb:RANGeri:LIMitli:RELative:STOP and [SENSe:]ESPectrumsb:RANGeri:LIMitli:RELative:STOP:ABS commands to define these values. OFF No function is used, the relative limit line is defined by a fixed relative stop value. Use the [SENSe:]ESPectrumsb:RANGeri:LIMitli:RELative:STOP command to define this value.

set(function: RsFsw.enums.FunctionA, subBlock=SubBlock.Default, rangePy=RangePy.Default, limitIx=LimitIx.Default) → None

# SCPI: [SENSe]:ESPectrum<sb>:RANGe<ri>:LIMit<li>:RELative:STOP:FUNCtion
driver.sense.espectrum.range.limit.relative.stop.function.set(function = enums.FunctionA.MAX, subBlock = repcap.SubBlock.Default, rangePy = repcap.RangePy.Default, limitIx = repcap.LimitIx.Default)

Enables the use of a function when defining the relative limit for a SEM range.

param function

OFF | MAX Defines the function to be used to determine the relative limit line stop value MAX The maximum of the relative and the absolute level is used as the limit stop value. Use the [SENSe:]ESPectrumsb:RANGeri:LIMitli:RELative:STOP and [SENSe:]ESPectrumsb:RANGeri:LIMitli:RELative:STOP:ABS commands to define these values. OFF No function is used, the relative limit line is defined by a fixed relative stop value. Use the [SENSe:]ESPectrumsb:RANGeri:LIMitli:RELative:STOP command to define this value.

param subBlock

optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Espectrum’)

param rangePy

optional repeated capability selector. Default value: Ix1 (settable in the interface ‘Range’)

param limitIx

optional repeated capability selector. Default value: Nr1 (settable in the interface ‘Limit’)