Beam

SCPI Commands :

EMITter:MODE:BEAM:CLEar
EMITter:MODE:BEAM:COUNt
EMITter:MODE:BEAM:DELete
EMITter:MODE:BEAM:NAME
EMITter:MODE:BEAM:SELect
EMITter:MODE:BEAM:SEQuence
EMITter:MODE:BEAM:STATe

class BeamCls

Beam commands group definition. 11 total commands, 2 Subgroups, 7 group commands

clear() → None

# SCPI: EMITter:MODE:BEAM:CLEar
driver.emitter.mode.beam.clear()

Deletes all items from the list or the table.

clear_with_opc(opc_timeout_ms: int = -1) → None

# SCPI: EMITter:MODE:BEAM:CLEar
driver.emitter.mode.beam.clear_with_opc()

Deletes all items from the list or the table.

Same as clear, but waits for the operation to complete before continuing further. Use the RsPulseSeq.utilities.opc_timeout_set() to set the timeout value.

param opc_timeout_ms:

Maximum time to wait in milliseconds, valid only for this call.

delete(delete: float) → None

# SCPI: EMITter:MODE:BEAM:DELete
driver.emitter.mode.beam.delete(delete = 1.0)

Deletes the particular item.

param delete:

float

get_count() → float

# SCPI: EMITter:MODE:BEAM:COUNt
value: float = driver.emitter.mode.beam.get_count()

Queries the number of existing items.

return:

count: integer

get_name() → str

# SCPI: EMITter:MODE:BEAM:NAME
value: str = driver.emitter.mode.beam.get_name()

Renames the selected repository element.

return:

name: string Must be unique for the particular type of repository elements. May contain empty spaces.

get_select() → float

# SCPI: EMITter:MODE:BEAM:SELect
value: float = driver.emitter.mode.beam.get_select()

Selects the item to which the subsequent commands apply.

return:

select: float Item number within the range 1 to …:COUNt. For example, method RsPulseSeq.Sequence.Item.count. Range: 1 to 4096

get_sequence() → str

# SCPI: EMITter:MODE:BEAM:SEQuence
value: str = driver.emitter.mode.beam.get_sequence()

Assigns a pulse sequence, see method RsPulseSeq.Sequence.create.

return:

sequence: string

get_state() → bool

# SCPI: EMITter:MODE:BEAM:STATe
value: bool = driver.emitter.mode.beam.get_state()

Activates a beam.

return:

state: ON| OFF| 1| 0

set_name(name: str) → None

# SCPI: EMITter:MODE:BEAM:NAME
driver.emitter.mode.beam.set_name(name = 'abc')

Renames the selected repository element.

param name:

string Must be unique for the particular type of repository elements. May contain empty spaces.

set_select(select: float) → None

# SCPI: EMITter:MODE:BEAM:SELect
driver.emitter.mode.beam.set_select(select = 1.0)

Selects the item to which the subsequent commands apply.

param select:

float Item number within the range 1 to …:COUNt. For example, method RsPulseSeq.Sequence.Item.count. Range: 1 to 4096

set_sequence(sequence: str) → None

# SCPI: EMITter:MODE:BEAM:SEQuence
driver.emitter.mode.beam.set_sequence(sequence = 'abc')

Assigns a pulse sequence, see method RsPulseSeq.Sequence.create.

param sequence:

string

set_state(state: bool) → None

# SCPI: EMITter:MODE:BEAM:STATe
driver.emitter.mode.beam.set_state(state = False)

Activates a beam.

param state:

ON| OFF| 1| 0

Cloning the Group

# Create a clone of the original group, that exists independently
group2 = driver.emitter.mode.beam.clone()

Subgroups

• Add
• Offset