Antenna

SCPI Commands :

RECeiver:ANTenna:ALIas
RECeiver:ANTenna:BM
RECeiver:ANTenna:CLEar
RECeiver:ANTenna:DELete
RECeiver:ANTenna:GAIN
RECeiver:ANTenna:PATTern
RECeiver:ANTenna:SCAN
RECeiver:ANTenna:SELect

class AntennaCls

Antenna commands group definition. 17 total commands, 3 Subgroups, 8 group commands

clear() → None

# SCPI: RECeiver:ANTenna:CLEar
driver.receiver.antenna.clear()

Deletes all items from the list or the table.

clear_with_opc(opc_timeout_ms: int = -1) → None

# SCPI: RECeiver:ANTenna:CLEar
driver.receiver.antenna.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() → None

# SCPI: RECeiver:ANTenna:DELete
driver.receiver.antenna.delete()

Deletes the particular item.

delete_with_opc(opc_timeout_ms: int = -1) → None

# SCPI: RECeiver:ANTenna:DELete
driver.receiver.antenna.delete_with_opc()

Deletes the particular item.

Same as delete, 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.

get_alias() → str

# SCPI: RECeiver:ANTenna:ALIas
value: str = driver.receiver.antenna.get_alias()

Sets an alias name for the selected antenna element.

return:

alias: string

get_bm() → str

# SCPI: RECeiver:ANTenna:BM
value: str = driver.receiver.antenna.get_bm()

No command help available

return:

bm: No help available

get_gain() → float

# SCPI: RECeiver:ANTenna:GAIN
value: float = driver.receiver.antenna.get_gain()

Sets the gain of the individual antenna element.

return:

gain: float Range: -120 to 120

get_pattern() → str

# SCPI: RECeiver:ANTenna:PATTern
value: str = driver.receiver.antenna.get_pattern()

Assigns an existing antenna pattern, see method RsPulseSeq.Antenna.catalog.

return:

pattern: string

get_scan() → str

# SCPI: RECeiver:ANTenna:SCAN
value: str = driver.receiver.antenna.get_scan()

Sets the antenna scan.

return:

scan: string

get_select() → float

# SCPI: RECeiver:ANTenna:SELect
value: float = driver.receiver.antenna.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

set_alias(alias: str) → None

# SCPI: RECeiver:ANTenna:ALIas
driver.receiver.antenna.set_alias(alias = 'abc')

Sets an alias name for the selected antenna element.

param alias:

string

set_bm(bm: str) → None

# SCPI: RECeiver:ANTenna:BM
driver.receiver.antenna.set_bm(bm = 'abc')

No command help available

param bm:

No help available

set_gain(gain: float) → None

# SCPI: RECeiver:ANTenna:GAIN
driver.receiver.antenna.set_gain(gain = 1.0)

Sets the gain of the individual antenna element.

param gain:

float Range: -120 to 120

set_pattern(pattern: str) → None

# SCPI: RECeiver:ANTenna:PATTern
driver.receiver.antenna.set_pattern(pattern = 'abc')

Assigns an existing antenna pattern, see method RsPulseSeq.Antenna.catalog.

param pattern:

string

set_scan(scan: str) → None

# SCPI: RECeiver:ANTenna:SCAN
driver.receiver.antenna.set_scan(scan = 'abc')

Sets the antenna scan.

param scan:

string

set_select(select: float) → None

# SCPI: RECeiver:ANTenna:SELect
driver.receiver.antenna.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

Cloning the Group

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

Subgroups

• Add
• Direction
• Position