Ipm

SCPI Commands :

IPM:CATalog
IPM:COMMent
IPM:CREate
IPM:EQUation
IPM:NAME
IPM:REMove
IPM:SELect
IPM:TYPE
IPM:UNIT

class IpmCls[source]

Ipm commands group definition. 66 total commands, 9 Subgroups, 9 group commands

get_catalog() → str[source]

# SCPI: IPM:CATalog
value: str = driver.ipm.get_catalog()

Queries the available repository elements in the database.

return:

catalog: string

get_comment() → str[source]

# SCPI: IPM:COMMent
value: str = driver.ipm.get_comment()

Adds a description to the selected repository element.

return:

comment: string

get_equation() → str[source]

# SCPI: IPM:EQUation
value: str = driver.ipm.get_equation()

Defines the IPM shape as a function.

return:

equation: string

get_name() → str[source]

# SCPI: IPM:NAME
value: str = driver.ipm.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: IPM:SELect
value: str = driver.ipm.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_type_py() → IpmType[source]

# SCPI: IPM:TYPE
value: enums.IpmType = driver.ipm.get_type_py()

Sets the shape of the profile.

return:

type_py: STEPs| WAVeform| RLISt| LIST| SHAPe| RANDom| EQUation| PLUGin| RSTep| BINomial

get_unit() → Units[source]

# SCPI: IPM:UNIT
value: enums.Units = driver.ipm.get_unit()

Sets the units of the profile.

return:

unit: NONE| SEConds| HERTz| DB| DEGRees| PERCent

set_comment(comment: str) → None[source]

# SCPI: IPM:COMMent
driver.ipm.set_comment(comment = 'abc')

Adds a description to the selected repository element.

param comment:

string

set_create(create: str) → None[source]

# SCPI: IPM:CREate
driver.ipm.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_equation(equation: str) → None[source]

# SCPI: IPM:EQUation
driver.ipm.set_equation(equation = 'abc')

Defines the IPM shape as a function.

param equation:

string

set_name(name: str) → None[source]

# SCPI: IPM:NAME
driver.ipm.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: IPM:REMove
driver.ipm.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: IPM:SELect
driver.ipm.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_type_py(type_py: IpmType) → None[source]

# SCPI: IPM:TYPE
driver.ipm.set_type_py(type_py = enums.IpmType.BINomial)

Sets the shape of the profile.

param type_py:

STEPs| WAVeform| RLISt| LIST| SHAPe| RANDom| EQUation| PLUGin| RSTep| BINomial

set_unit(unit: Units) → None[source]

# SCPI: IPM:UNIT
driver.ipm.set_unit(unit = enums.Units.DB)

Sets the units of the profile.

param unit:

NONE| SEConds| HERTz| DB| DEGRees| PERCent

Cloning the Group

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

Subgroups