Localized

SCPI Commands :

SCENario:LOCalized:ALIas
SCENario:LOCalized:CLEar
SCENario:LOCalized:CURRent
SCENario:LOCalized:DELete
SCENario:LOCalized:DISTance
SCENario:LOCalized:ENABle
SCENario:LOCalized:FREQuency
SCENario:LOCalized:LDELay
SCENario:LOCalized:LEVel
SCENario:LOCalized:PRIority
SCENario:LOCalized:SELect
SCENario:LOCalized:SEQuence
SCENario:LOCalized:THReshold
SCENario:LOCalized:TYPE
class LocalizedCls[source]

Localized commands group definition. 146 total commands, 13 Subgroups, 14 group commands

clear() None[source]
# SCPI: SCENario:LOCalized:CLEar
driver.scenario.localized.clear()

Deletes all items from the list or the table.

clear_with_opc(opc_timeout_ms: int = -1) None[source]
# SCPI: SCENario:LOCalized:CLEar
driver.scenario.localized.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[source]
# SCPI: SCENario:LOCalized:DELete
driver.scenario.localized.delete(delete = 1.0)

Deletes the particular item.

param delete:

float

get_alias() str[source]
# SCPI: SCENario:LOCalized:ALIas
value: str = driver.scenario.localized.get_alias()

Enters an alias name.

return:

alias: string

get_current() float[source]
# SCPI: SCENario:LOCalized:CURRent
value: float = driver.scenario.localized.get_current()

Sets the sequence/emitter that is used by the scenario.

return:

current: float Number of the sequence/emitter in the list with multiple sequences

get_distance() float[source]
# SCPI: SCENario:LOCalized:DISTance
value: float = driver.scenario.localized.get_distance()

Sets the distance to the receiver.

return:

distance: float Range: 0 to 1e+09, Unit: m

get_enable() bool[source]
# SCPI: SCENario:LOCalized:ENABle
value: bool = driver.scenario.localized.get_enable()

If enabled, the PDW list is included in the output file.

return:

enable: ON| OFF| 1| 0

get_frequency() float[source]
# SCPI: SCENario:LOCalized:FREQuency
value: float = driver.scenario.localized.get_frequency()

Sets the frequency for the selected emitter.

return:

frequency: No help available

get_ldelay() float[source]
# SCPI: SCENario:LOCalized:LDELay
value: float = driver.scenario.localized.get_ldelay()

If interleaving is enabled, shifts the processing of the selected PDW list in time.

return:

ldelay: float Range: -1e+09 to 1e+09

get_level() float[source]
# SCPI: SCENario:LOCalized:LEVel
value: float = driver.scenario.localized.get_level()

Adds a level offset.

return:

level: float Range: -200 to 0

get_priority() float[source]
# SCPI: SCENario:LOCalized:PRIority
value: float = driver.scenario.localized.get_priority()

Sets the priority of the selected PDW list , where the higher the value the higher the priority.

return:

priority: float Range: 1 to 100

get_select() float[source]
# SCPI: SCENario:LOCalized:SELect
value: float = driver.scenario.localized.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[source]
# SCPI: SCENario:LOCalized:SEQuence
value: str = driver.scenario.localized.get_sequence()

Assigns a sequence to the background signal.

return:

sequence: string

get_threshold() float[source]
# SCPI: SCENario:LOCalized:THReshold
value: float = driver.scenario.localized.get_threshold()

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

return:

threshold: float Range: -100 to 0

get_type_py() DfType[source]
# SCPI: SCENario:LOCalized:TYPE
value: enums.DfType = driver.scenario.localized.get_type_py()

Defines whether an emitter/interferer is configured.

return:

type_py: EMITter | | WAVeform

set_alias(alias: str) None[source]
# SCPI: SCENario:LOCalized:ALIas
driver.scenario.localized.set_alias(alias = 'abc')

Enters an alias name.

param alias:

string

set_current(current: float) None[source]
# SCPI: SCENario:LOCalized:CURRent
driver.scenario.localized.set_current(current = 1.0)

Sets the sequence/emitter that is used by the scenario.

param current:

float Number of the sequence/emitter in the list with multiple sequences

set_distance(distance: float) None[source]
# SCPI: SCENario:LOCalized:DISTance
driver.scenario.localized.set_distance(distance = 1.0)

Sets the distance to the receiver.

param distance:

float Range: 0 to 1e+09, Unit: m

set_enable(enable: bool) None[source]
# SCPI: SCENario:LOCalized:ENABle
driver.scenario.localized.set_enable(enable = False)

If enabled, the PDW list is included in the output file.

param enable:

ON| OFF| 1| 0

set_ldelay(ldelay: float) None[source]
# SCPI: SCENario:LOCalized:LDELay
driver.scenario.localized.set_ldelay(ldelay = 1.0)

If interleaving is enabled, shifts the processing of the selected PDW list in time.

param ldelay:

float Range: -1e+09 to 1e+09

set_level(level: float) None[source]
# SCPI: SCENario:LOCalized:LEVel
driver.scenario.localized.set_level(level = 1.0)

Adds a level offset.

param level:

float Range: -200 to 0

set_priority(priority: float) None[source]
# SCPI: SCENario:LOCalized:PRIority
driver.scenario.localized.set_priority(priority = 1.0)

Sets the priority of the selected PDW list , where the higher the value the higher the priority.

param priority:

float Range: 1 to 100

set_select(select: float) None[source]
# SCPI: SCENario:LOCalized:SELect
driver.scenario.localized.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[source]
# SCPI: SCENario:LOCalized:SEQuence
driver.scenario.localized.set_sequence(sequence = 'abc')

Assigns a sequence to the background signal.

param sequence:

string

set_threshold(threshold: float) None[source]
# SCPI: SCENario:LOCalized:THReshold
driver.scenario.localized.set_threshold(threshold = 1.0)

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

param threshold:

float Range: -100 to 0

set_type_py(type_py: DfType) None[source]
# SCPI: SCENario:LOCalized:TYPE
driver.scenario.localized.set_type_py(type_py = enums.DfType.BACKground)

Defines whether an emitter/interferer is configured.

param type_py:

EMITter | | WAVeform

Cloning the Group

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

Subgroups