Output

SCPI Commands :

SCENario:OUTPut:CLIPping
SCENario:OUTPut:FORMat
SCENario:OUTPut:FREQuency
SCENario:OUTPut:LEVel
SCENario:OUTPut:MTMode
SCENario:OUTPut:MTTHreads
SCENario:OUTPut:MULTithread
SCENario:OUTPut:PATH
SCENario:OUTPut:RUNMode
SCENario:OUTPut:TARGet
SCENario:OUTPut:THReshold

class OutputCls

Output commands group definition. 27 total commands, 7 Subgroups, 11 group commands

get_clipping() → float

# SCPI: SCENario:OUTPut:CLIPping
value: float = driver.scenario.output.get_clipping()

Sets a maximum level to limit the dynamic range of the signal. Pulses at levels above this threshold are reduced (clipped) to the configured level.

return:

clipping: float Range: -100 to 20, Unit: dBm

get_format_py() → OutFormat

# SCPI: SCENario:OUTPut:FORMat
value: enums.OutFormat = driver.scenario.output.get_format_py()

Sets the type of the generated waveform file.

return:

format_py: WV| MSW

get_frequency() → float

# SCPI: SCENario:OUTPut:FREQuency
value: float = driver.scenario.output.get_frequency()

Sets the carrier RF frequency of the generated signal.

return:

frequency: float Range: 1000 to 1e+11

get_level() → float

# SCPI: SCENario:OUTPut:LEVel
value: float = driver.scenario.output.get_level()

Sets the reference level used by the calculation of the pulse envelope.

return:

level: float Range: -130 to 30

get_mt_mode() → AutoManualMode

# SCPI: SCENario:OUTPut:MTMode
value: enums.AutoManualMode = driver.scenario.output.get_mt_mode()

If multithreading is enabled with method RsPulseSeq.Scenario.Output.multithread, sets the mode to use for multithreading.

return:

mt_mode: AUTO| MANual

get_mt_threads() → float

# SCPI: SCENario:OUTPut:MTTHreads
value: float = driver.scenario.output.get_mt_threads()

In manual mode, sets the required number of threads for the signal calculation.

return:

mt_threads: float Range: 0 to 1000

get_multithread() → bool

# SCPI: SCENario:OUTPut:MULTithread
value: bool = driver.scenario.output.get_multithread()

Enable to optmize the calculation speed.

return:

multithread: ON| OFF| 1| 0

get_path() → str

# SCPI: SCENario:OUTPut:PATH
value: str = driver.scenario.output.get_path()

Sets the directory the generated waveform is stored in.

return:

path: string File path

get_run_mode() → RepeatMode

# SCPI: SCENario:OUTPut:RUNMode
value: enums.RepeatMode = driver.scenario.output.get_run_mode()

Defines the way the generated signal is processed.

return:

run_mode: CONTinuous| SINGle

get_target() → TargetOut

# SCPI: SCENario:OUTPut:TARGet
value: enums.TargetOut = driver.scenario.output.get_target()

Defines whether the software creates an ARB file or transfers the generated waveform to a connected physical generator. To assign a generator, use the command method RsPulseSeq.Scenario.Generator.value. To set the name and the directory the ARB file is stored in, use the command method RsPulseSeq.Scenario.Output.path.

return:

target: INSTrument| FILE

get_threshold() → float

# SCPI: SCENario:OUTPut:THReshold
value: float = driver.scenario.output.get_threshold()

Sets a threshold. Pulses at levels below this threshold are omitted.

return:

threshold: float Range: -100 to 0

set_clipping(clipping: float) → None

# SCPI: SCENario:OUTPut:CLIPping
driver.scenario.output.set_clipping(clipping = 1.0)

Sets a maximum level to limit the dynamic range of the signal. Pulses at levels above this threshold are reduced (clipped) to the configured level.

param clipping:

float Range: -100 to 20, Unit: dBm

set_format_py(format_py: OutFormat) → None

# SCPI: SCENario:OUTPut:FORMat
driver.scenario.output.set_format_py(format_py = enums.OutFormat.ESEQencing)

Sets the type of the generated waveform file.

param format_py:

WV| MSW

set_frequency(frequency: float) → None

# SCPI: SCENario:OUTPut:FREQuency
driver.scenario.output.set_frequency(frequency = 1.0)

Sets the carrier RF frequency of the generated signal.

param frequency:

float Range: 1000 to 1e+11

set_level(level: float) → None

# SCPI: SCENario:OUTPut:LEVel
driver.scenario.output.set_level(level = 1.0)

Sets the reference level used by the calculation of the pulse envelope.

param level:

float Range: -130 to 30

set_mt_mode(mt_mode: AutoManualMode) → None

# SCPI: SCENario:OUTPut:MTMode
driver.scenario.output.set_mt_mode(mt_mode = enums.AutoManualMode.AUTO)

If multithreading is enabled with method RsPulseSeq.Scenario.Output.multithread, sets the mode to use for multithreading.

param mt_mode:

AUTO| MANual

set_mt_threads(mt_threads: float) → None

# SCPI: SCENario:OUTPut:MTTHreads
driver.scenario.output.set_mt_threads(mt_threads = 1.0)

In manual mode, sets the required number of threads for the signal calculation.

param mt_threads:

float Range: 0 to 1000

set_multithread(multithread: bool) → None

# SCPI: SCENario:OUTPut:MULTithread
driver.scenario.output.set_multithread(multithread = False)

Enable to optmize the calculation speed.

param multithread:

ON| OFF| 1| 0

set_path(path: str) → None

# SCPI: SCENario:OUTPut:PATH
driver.scenario.output.set_path(path = 'abc')

Sets the directory the generated waveform is stored in.

param path:

string File path

set_run_mode(run_mode: RepeatMode) → None

# SCPI: SCENario:OUTPut:RUNMode
driver.scenario.output.set_run_mode(run_mode = enums.RepeatMode.CONTinuous)

Defines the way the generated signal is processed.

param run_mode:

CONTinuous| SINGle

set_target(target: TargetOut) → None

# SCPI: SCENario:OUTPut:TARGet
driver.scenario.output.set_target(target = enums.TargetOut.FILE)

Defines whether the software creates an ARB file or transfers the generated waveform to a connected physical generator. To assign a generator, use the command method RsPulseSeq.Scenario.Generator.value. To set the name and the directory the ARB file is stored in, use the command method RsPulseSeq.Scenario.Output.path.

param target:

INSTrument| FILE

set_threshold(threshold: float) → None

# SCPI: SCENario:OUTPut:THReshold
driver.scenario.output.set_threshold(threshold = 1.0)

Sets a threshold. Pulses at levels below this threshold are omitted.

param threshold:

float Range: -100 to 0

Cloning the Group

# Create a clone of the original group, that exists independently
group2 = driver.scenario.output.clone()

Subgroups

• Arb
  • Details
• Clock
  • Auto
• Duration
• Marker
  • Scenario
• Recall
• Reset
• Supress