Scan

SCPI Commands :

SCAN:CATalog
SCAN:COMMent
SCAN:CREate
SCAN:NAME
SCAN:REMove
SCAN:SELect
SCAN:STEering
SCAN:TYPE
class ScanCls[source]

Scan commands group definition. 89 total commands, 10 Subgroups, 8 group commands

get_catalog() → str[source]
# SCPI: SCAN:CATalog
value: str = driver.scan.get_catalog()

Queries the available repository elements in the database.

return:

catalog: string

get_comment() → str[source]
# SCPI: SCAN:COMMent
value: str = driver.scan.get_comment()

Adds a description to the selected repository element.

return:

comment: string

get_name() → str[source]
# SCPI: SCAN:NAME
value: str = driver.scan.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() → str[source]
# SCPI: SCAN:SELect
value: str = driver.scan.get_select()

Selects the repository element to which the subsequent commands apply.

return:

select: string Element name, as defined with the …:CREate or …:NAME command. To query the existing elements, use the …:CATalog? command. For example, method RsPulseSeq.Repository.catalog.

get_steering() → bool[source]
# SCPI: SCAN:STEering
value: bool = driver.scan.get_steering()

Defines whether electronic steering is used. Electronic steering is only available for scan types that use phased array antennas.

return:

steering: ON| OFF| 1| 0

get_type_py() → ScanType[source]
# SCPI: SCAN:TYPE
value: enums.ScanType = driver.scan.get_type_py()

Sets the scan type.

return:

type_py: CIRCular| SECTor| RASTer| CONical| HELical| SPIRal| LSW| SIN| CUSTom| LISSajous

set_comment(comment: str) → None[source]
# SCPI: SCAN:COMMent
driver.scan.set_comment(comment = 'abc')

Adds a description to the selected repository element.

param comment:

string

set_create(create: str) → None[source]
# SCPI: SCAN:CREate
driver.scan.set_create(create = 'abc')

Creates a repository element with the selected name.

param create:

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

set_name(name: str) → None[source]
# SCPI: SCAN:NAME
driver.scan.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_remove(remove: str) → None[source]
# SCPI: SCAN:REMove
driver.scan.set_remove(remove = 'abc')

Removes the selected element from the workspace. The element must not reference any child elements. Remove the referenced elements first.

param remove:

No help available

set_select(select: str) → None[source]
# SCPI: SCAN:SELect
driver.scan.set_select(select = 'abc')

Selects the repository element to which the subsequent commands apply.

param select:

string Element name, as defined with the …:CREate or …:NAME command. To query the existing elements, use the …:CATalog? command. For example, method RsPulseSeq.Repository.catalog.

set_steering(steering: bool) → None[source]
# SCPI: SCAN:STEering
driver.scan.set_steering(steering = False)

Defines whether electronic steering is used. Electronic steering is only available for scan types that use phased array antennas.

param steering:

ON| OFF| 1| 0

set_type_py(type_py: ScanType) → None[source]
# SCPI: SCAN:TYPE
driver.scan.set_type_py(type_py = enums.ScanType.CIRCular)

Sets the scan type.

param type_py:

CIRCular| SECTor| RASTer| CONical| HELical| SPIRal| LSW| SIN| CUSTom| LISSajous

Cloning the Group

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

Subgroups