Waveform

SCPI Commands :

WAVeform:CATalog
WAVeform:COMMent
WAVeform:CREate
WAVeform:NAME
WAVeform:REMove
WAVeform:SELect
WAVeform:SIGCont
WAVeform:TYPE

class WaveformCls[source]

Waveform commands group definition. 30 total commands, 8 Subgroups, 8 group commands

get_catalog() → str[source]

# SCPI: WAVeform:CATalog
value: str = driver.waveform.get_catalog()

Queries the available repository elements in the database.

return:

catalog: string

get_comment() → str[source]

# SCPI: WAVeform:COMMent
value: str = driver.waveform.get_comment()

Adds a description to the selected repository element.

return:

comment: string

get_name() → str[source]

# SCPI: WAVeform:NAME
value: str = driver.waveform.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: WAVeform:SELect
value: str = driver.waveform.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_sig_cont() → SigCont[source]

# SCPI: WAVeform:SIGCont
value: enums.SigCont = driver.waveform.get_sig_cont()

Defines the waveform signal type.

return:

sig_cont: PULSe| COMM

get_type_py() → WaveformType[source]

# SCPI: WAVeform:TYPE
value: enums.WaveformType = driver.waveform.get_type_py()

Sets the type of the waveform.

return:

type_py: CW| NOISe| WAVeform| USER| BEMitter| MT| PDW| AIF| APDW| IQDW

set_comment(comment: str) → None[source]

# SCPI: WAVeform:COMMent
driver.waveform.set_comment(comment = 'abc')

Adds a description to the selected repository element.

param comment:

string

set_create(create: str) → None[source]

# SCPI: WAVeform:CREate
driver.waveform.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: WAVeform:NAME
driver.waveform.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: WAVeform:REMove
driver.waveform.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: WAVeform:SELect
driver.waveform.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_sig_cont(sig_cont: SigCont) → None[source]

# SCPI: WAVeform:SIGCont
driver.waveform.set_sig_cont(sig_cont = enums.SigCont.COMM)

Defines the waveform signal type.

param sig_cont:

PULSe| COMM

set_type_py(type_py: WaveformType) → None[source]

# SCPI: WAVeform:TYPE
driver.waveform.set_type_py(type_py = enums.WaveformType.AIF)

Sets the type of the waveform.

param type_py:

CW| NOISe| WAVeform| USER| BEMitter| MT| PDW| AIF| APDW| IQDW

Cloning the Group

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

Subgroups