Emitter

SCPI Commands :

PLATform:EMITter:ALIas
PLATform:EMITter:ANGLe
PLATform:EMITter:AZIMuth
PLATform:EMITter:BM
PLATform:EMITter:BMID
PLATform:EMITter:CLEar
PLATform:EMITter:DELete
PLATform:EMITter:ELEVation
PLATform:EMITter:HEIGht
PLATform:EMITter:RADius
PLATform:EMITter:ROLL
PLATform:EMITter:SELect
PLATform:EMITter:X
PLATform:EMITter:Y
PLATform:EMITter

class EmitterCls[source]

Emitter commands group definition. 24 total commands, 3 Subgroups, 15 group commands

clear() → None[source]

# SCPI: PLATform:EMITter:CLEar
driver.platform.emitter.clear()

Deletes all items from the list or the table.

clear_with_opc(opc_timeout_ms: int = -1) → None[source]

# SCPI: PLATform:EMITter:CLEar
driver.platform.emitter.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: PLATform:EMITter:DELete
driver.platform.emitter.delete(delete = 1.0)

Deletes the particular item.

param delete:

float

get_alias() → str[source]

# SCPI: PLATform:EMITter:ALIas
value: str = driver.platform.emitter.get_alias()

Sets an alias name for the selected platform emitter element.

return:

alias: string

get_angle() → float[source]

# SCPI: PLATform:EMITter:ANGLe
value: float = driver.platform.emitter.get_angle()

You can set the position of the selected emitter relative to the platform’s origin, using this command combined with method RsPulseSeq.Platform.Emitter.radius.

method RsPulseSeq.Platform.Emitter.angle sets the angle of the emitter element on the azimuth plane, relative to the platform’s heading.

method RsPulseSeq.Platform.Emitter.radius sets the distance of the emitter element on the azimuth plane, relative to the platform’s origin.

return:

angle: float Range: 0 to 360

get_azimuth() → float[source]

# SCPI: PLATform:EMITter:AZIMuth
value: float = driver.platform.emitter.get_azimuth()

Angle of the emitter element’s pointing direction relative to the platform’s heading.

return:

azimuth: float Range: 0 to 360

get_bm() → str[source]

# SCPI: PLATform:EMITter:BM
value: str = driver.platform.emitter.get_bm()

No command help available

return:

bm: No help available

get_bmid() → str[source]

# SCPI: PLATform:EMITter:BMID
value: str = driver.platform.emitter.get_bmid()

No command help available

return:

bmid: No help available

get_elevation() → float[source]

# SCPI: PLATform:EMITter:ELEVation
value: float = driver.platform.emitter.get_elevation()

Elevation of the emitter item’s pointing direction, relative to the azimuth plane.

return:

elevation: float Range: -90 to 90

get_height() → float[source]

# SCPI: PLATform:EMITter:HEIGht
value: float = driver.platform.emitter.get_height()

Height of the selected emitter element relative to the platform’s origin. Can be used, for example, to differentiate between:

Radars mounted on different parts of a ship or aircraft.

Various radars situated across a land-based radar installation.

return:

height: float Range: -500 to 500

get_radius() → float[source]

# SCPI: PLATform:EMITter:RADius
value: float = driver.platform.emitter.get_radius()

You can set the position of the selected emitter relative to the platform’s origin, using this command combined with method RsPulseSeq.Platform.Emitter.angle.

method RsPulseSeq.Platform.Emitter.angle sets the angle of the emitter element on the azimuth plane, relative to the platform’s heading.

method RsPulseSeq.Platform.Emitter.radius sets the distance of the emitter element on the azimuth plane, relative to the platform’s origin.

return:

radius: float Range: 0 to 2000

get_roll() → float[source]

# SCPI: PLATform:EMITter:ROLL
value: float = driver.platform.emitter.get_roll()

Roll of the emitter item’s pointing direction relative to the platform’s up direction. Can be used, for example, to simulate the emissions from a mast-mounted radar on a marine platform affected by wind.

return:

roll: float Range: -180 to 180

get_select() → float[source]

# SCPI: PLATform:EMITter:SELect
value: float = driver.platform.emitter.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_value() → str[source]

# SCPI: PLATform:EMITter
value: str = driver.platform.emitter.get_value()

The string must be unique within the repository. Letters, numbers, spaces and some special characters can be used.

INTRO_CMD_HELP: Examples of special characters:

Supported: !$% =?-+_.
Not supported: &/:{umlaut}{umlaut}{umlaut}

return:: emitter: string

get_x() → float[source]

# SCPI: PLATform:EMITter:X
value: float = driver.platform.emitter.get_x()

Set the position of the selected emitter relative to the platform’s origin, using this command combined with method RsPulseSeq.Platform.Emitter.y.

INTRO_CMD_HELP: X and Y represent the two principle axis of the platform.

The Y-axis represents the axis along the center-line of the platform. This axis:

Table Header:

Corresponds to its heading.

Passes through the origin.

The X-axis:

Table Header:

Is at right-angles to the Y-axis.

Passes through the origin.

method RsPulseSeq.Platform.Emitter.y sets the distance of the emitter element from the origin, along the Y-axis. Positive values are towards the heading.

method RsPulseSeq.Platform.Emitter.x sets the distance of the emitter element from the origin, along the X-axis.

return:

x: float Range: -2000 to 2000

get_y() → float[source]

# SCPI: PLATform:EMITter:Y
value: float = driver.platform.emitter.get_y()

Set the position of the selected emitter relative to the platform’s origin, using this command combined with method RsPulseSeq.Platform.Emitter.x.

INTRO_CMD_HELP: X and Y represent the two principle axis of the platform.

The Y-axis represents the axis along the center-line of the platform. This axis:

Table Header:

Corresponds to its heading.

Passes through the origin.

The X-axis:

Table Header:

Is at right-angles to the Y-axis.

Passes through the origin.

INTRO_CMD_HELP: X and Y represent the two principle axis of the platform.

method RsPulseSeq.Platform.Emitter.y sets the distance of the emitter element from the origin, along the Y-axis. Positive values are towards the heading. Step = 0.01 m

method RsPulseSeq.Platform.Emitter.x sets the distance of the emitter element from the origin, along the X-axis. Step = 0.01 m

return:

y: float Range: -2000 to 2000

set_alias(alias: str) → None[source]

# SCPI: PLATform:EMITter:ALIas
driver.platform.emitter.set_alias(alias = 'abc')

Sets an alias name for the selected platform emitter element.

param alias:

string

set_angle(angle: float) → None[source]

# SCPI: PLATform:EMITter:ANGLe
driver.platform.emitter.set_angle(angle = 1.0)

You can set the position of the selected emitter relative to the platform’s origin, using this command combined with method RsPulseSeq.Platform.Emitter.radius.

method RsPulseSeq.Platform.Emitter.angle sets the angle of the emitter element on the azimuth plane, relative to the platform’s heading.

method RsPulseSeq.Platform.Emitter.radius sets the distance of the emitter element on the azimuth plane, relative to the platform’s origin.

param angle:

float Range: 0 to 360

set_azimuth(azimuth: float) → None[source]

# SCPI: PLATform:EMITter:AZIMuth
driver.platform.emitter.set_azimuth(azimuth = 1.0)

Angle of the emitter element’s pointing direction relative to the platform’s heading.

param azimuth:

float Range: 0 to 360

set_bm(bm: str) → None[source]

# SCPI: PLATform:EMITter:BM
driver.platform.emitter.set_bm(bm = 'abc')

No command help available

param bm:

No help available

set_bmid(bmid: str) → None[source]

# SCPI: PLATform:EMITter:BMID
driver.platform.emitter.set_bmid(bmid = 'abc')

No command help available

param bmid:

No help available

set_elevation(elevation: float) → None[source]

# SCPI: PLATform:EMITter:ELEVation
driver.platform.emitter.set_elevation(elevation = 1.0)

Elevation of the emitter item’s pointing direction, relative to the azimuth plane.

param elevation:

float Range: -90 to 90

set_height(height: float) → None[source]

# SCPI: PLATform:EMITter:HEIGht
driver.platform.emitter.set_height(height = 1.0)

Height of the selected emitter element relative to the platform’s origin. Can be used, for example, to differentiate between:

Radars mounted on different parts of a ship or aircraft.

Various radars situated across a land-based radar installation.

param height:

float Range: -500 to 500

set_radius(radius: float) → None[source]

# SCPI: PLATform:EMITter:RADius
driver.platform.emitter.set_radius(radius = 1.0)

You can set the position of the selected emitter relative to the platform’s origin, using this command combined with method RsPulseSeq.Platform.Emitter.angle.

method RsPulseSeq.Platform.Emitter.angle sets the angle of the emitter element on the azimuth plane, relative to the platform’s heading.

method RsPulseSeq.Platform.Emitter.radius sets the distance of the emitter element on the azimuth plane, relative to the platform’s origin.

param radius:

float Range: 0 to 2000

set_roll(roll: float) → None[source]

# SCPI: PLATform:EMITter:ROLL
driver.platform.emitter.set_roll(roll = 1.0)

Roll of the emitter item’s pointing direction relative to the platform’s up direction. Can be used, for example, to simulate the emissions from a mast-mounted radar on a marine platform affected by wind.

param roll:

float Range: -180 to 180

set_select(select: float) → None[source]

# SCPI: PLATform:EMITter:SELect
driver.platform.emitter.set_select(select = 1.0)

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_value(emitter: str) → None[source]

# SCPI: PLATform:EMITter
driver.platform.emitter.set_value(emitter = 'abc')

The string must be unique within the repository. Letters, numbers, spaces and some special characters can be used.

INTRO_CMD_HELP: Examples of special characters:

Supported: !$% =?-+_.
Not supported: &/:{umlaut}{umlaut}{umlaut}

param emitter:: string

set_x(x: float) → None[source]

# SCPI: PLATform:EMITter:X
driver.platform.emitter.set_x(x = 1.0)

Set the position of the selected emitter relative to the platform’s origin, using this command combined with method RsPulseSeq.Platform.Emitter.y.

INTRO_CMD_HELP: X and Y represent the two principle axis of the platform.

The Y-axis represents the axis along the center-line of the platform. This axis:

Table Header:

Corresponds to its heading.

Passes through the origin.

The X-axis:

Table Header:

Is at right-angles to the Y-axis.

Passes through the origin.

INTRO_CMD_HELP: X and Y represent the two principle axis of the platform.

method RsPulseSeq.Platform.Emitter.y sets the distance of the emitter element from the origin, along the Y-axis. Positive values are towards the heading.

method RsPulseSeq.Platform.Emitter.x sets the distance of the emitter element from the origin, along the X-axis.

param x:

float Range: -2000 to 2000

set_y(y: float) → None[source]

# SCPI: PLATform:EMITter:Y
driver.platform.emitter.set_y(y = 1.0)

Set the position of the selected emitter relative to the platform’s origin, using this command combined with method RsPulseSeq.Platform.Emitter.x.

INTRO_CMD_HELP: X and Y represent the two principle axis of the platform.

The Y-axis represents the axis along the center-line of the platform. This axis:

Table Header:

Corresponds to its heading.

Passes through the origin.

The X-axis:

Table Header:

Is at right-angles to the Y-axis.

Passes through the origin.

INTRO_CMD_HELP: X and Y represent the two principle axis of the platform.

method RsPulseSeq.Platform.Emitter.y sets the distance of the emitter element from the origin, along the Y-axis. Positive values are towards the heading. Step = 0.01 m

method RsPulseSeq.Platform.Emitter.x sets the distance of the emitter element from the origin, along the X-axis. Step = 0.01 m

param y:

float Range: -2000 to 2000

Cloning the Group

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

Subgroups