Movement

SCPI Commands :

SCENario:LOCalized:MOVement:ACCeleration
SCENario:LOCalized:MOVement:ALTitude
SCENario:LOCalized:MOVement:ANGLe
SCENario:LOCalized:MOVement:ATTitude
SCENario:LOCalized:MOVement:CLATitude
SCENario:LOCalized:MOVement:CLEar
SCENario:LOCalized:MOVement:CLONgitude
SCENario:LOCalized:MOVement:EAST
SCENario:LOCalized:MOVement:HEIGht
SCENario:LOCalized:MOVement:LATitude
SCENario:LOCalized:MOVement:LONGitude
SCENario:LOCalized:MOVement:NORTh
SCENario:LOCalized:MOVement:PITCh
SCENario:LOCalized:MOVement:RFRame
SCENario:LOCalized:MOVement:RMODe
SCENario:LOCalized:MOVement:ROLL
SCENario:LOCalized:MOVement:SMOothening
SCENario:LOCalized:MOVement:SPEed
SCENario:LOCalized:MOVement:SPINning
SCENario:LOCalized:MOVement:TYPE
SCENario:LOCalized:MOVement:VEHicle
SCENario:LOCalized:MOVement:WAYPoint
SCENario:LOCalized:MOVement:YAW

class MovementCls

Movement commands group definition. 26 total commands, 2 Subgroups, 23 group commands

clear() → None

# SCPI: SCENario:LOCalized:MOVement:CLEar
driver.scenario.localized.movement.clear()

Discards the waypoint and vehicle description file.

clear_with_opc(opc_timeout_ms: int = -1) → None

# SCPI: SCENario:LOCalized:MOVement:CLEar
driver.scenario.localized.movement.clear_with_opc()

Discards the waypoint and vehicle description file.

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.

get_acceleration() → float

# SCPI: SCENario:LOCalized:MOVement:ACCeleration
value: float = driver.scenario.localized.movement.get_acceleration()

Sets the acceleration of the moving emitter.

return:

acceleration: float Range: -100 to 100

get_altitude() → float

# SCPI: SCENario:LOCalized:MOVement:ALTitude
value: float = driver.scenario.localized.movement.get_altitude()

Use for defining the altitude of a moving emitter (line trajectory) on a georeferenced map. Use to define the altitude of the end-points of the line.

return:

altitude: float Range: -1e+09 to 1e+09

get_angle() → float

# SCPI: SCENario:LOCalized:MOVement:ANGLe
value: float = driver.scenario.localized.movement.get_angle()

Sets the arc angle and thus defines the arc length.

return:

angle: float Range: -360 to 360

get_attitude() → Attitude

# SCPI: SCENario:LOCalized:MOVement:ATTitude
value: enums.Attitude = driver.scenario.localized.movement.get_attitude()

Defines how the attitude information is defined.

return:

attitude: WAYPoint| MOTion| CONStant WAYPoint The attitude parameters are extracted from the selected waypoint file. MOTion Enables a constant rate of change of the roll. See method RsPulseSeq.Scenario.Localized.Movement.roll Constant The attitude is constant values.

get_clatitude() → float

# SCPI: SCENario:LOCalized:MOVement:CLATitude
value: float = driver.scenario.localized.movement.get_clatitude()

Use for defining the movement of an emitter (arc trajectory) on a georeferenced map. Use to define the center-point of the arc. Positive values represent DEGEast. Negative values represent DEGWest.

return:

clatitude: No help available

get_clongitude() → float

# SCPI: SCENario:LOCalized:MOVement:CLONgitude
value: float = driver.scenario.localized.movement.get_clongitude()

Use for defining the movement of an emitter (arc trajectory) on a georeferenced map. Use to define the center-point of the arc. Positive values represent DEGEast. Negative values represent DEGWest.

return:

clongitude: float Range: -180 to 180

get_east() → float

# SCPI: SCENario:LOCalized:MOVement:EAST
value: float = driver.scenario.localized.movement.get_east()

Sets the East/North coordinates of the emitter at the end of the movement.

return:

east: No help available

get_height() → float

# SCPI: SCENario:LOCalized:MOVement:HEIGht
value: float = driver.scenario.localized.movement.get_height()

Sets the height of the emitter at the end of the movement.

return:

height: float Range: -1e+09 to 1e+09

get_latitude() → float

# SCPI: SCENario:LOCalized:MOVement:LATitude
value: float = driver.scenario.localized.movement.get_latitude()

Use for defining the movement of an emitter (line trajectory) on a georeferenced map. Use to define the end-points of the line. Positive values represent DEGEast. Negative values represent DEGWest.

return:

latitude: No help available

get_longitude() → float

# SCPI: SCENario:LOCalized:MOVement:LONGitude
value: float = driver.scenario.localized.movement.get_longitude()

Use for defining the movement of an emitter (line trajectory) on a georeferenced map. Use to define the end-points of the line. Positive values represent DEGEast. Negative values represent DEGWest.

return:

longitude: float Range: -180 to 180

get_north() → float

# SCPI: SCENario:LOCalized:MOVement:NORTh
value: float = driver.scenario.localized.movement.get_north()

Sets the East/North coordinates of the emitter at the end of the movement.

return:

north: float Range: -1e+09 to 1e+09

get_pitch() → float

# SCPI: SCENario:LOCalized:MOVement:PITCh
value: float = driver.scenario.localized.movement.get_pitch()

Sets the angles of rotation in the corresponding direction.

return:

pitch: No help available

get_rframe() → MovementRframe

# SCPI: SCENario:LOCalized:MOVement:RFRame
value: enums.MovementRframe = driver.scenario.localized.movement.get_rframe()

Select the reference frame used to define the emitters coordinates.

return:

rframe: WGS| PZ

get_rmode() → MovementRmode

# SCPI: SCENario:LOCalized:MOVement:RMODe
value: enums.MovementRmode = driver.scenario.localized.movement.get_rmode()

Defines the behavior of the moving object when the end of the trajectory is reached.

return:

rmode: CYCLic| ROUNdtrip| ONEWay

get_roll() → float

# SCPI: SCENario:LOCalized:MOVement:ROLL
value: float = driver.scenario.localized.movement.get_roll()

Sets the angles of rotation in the corresponding direction.

return:

roll: float Range: -180 to 180

get_smoothening() → bool

# SCPI: SCENario:LOCalized:MOVement:SMOothening
value: bool = driver.scenario.localized.movement.get_smoothening()

If a vehicle description file is loaded, activates smoothening. See method RsPulseSeq.Scenario.Localized.Movement.Vfile. value.

return:

smoothening: ON| OFF| 1| 0

get_speed() → float

# SCPI: SCENario:LOCalized:MOVement:SPEed
value: float = driver.scenario.localized.movement.get_speed()

Sets the speed of the moving emitter.

return:

speed: float Range: 0 to 5999

get_spinning() → float

# SCPI: SCENario:LOCalized:MOVement:SPINning
value: float = driver.scenario.localized.movement.get_spinning()

No command help available

return:

spinning: No help available

get_type_py() → MovementType

# SCPI: SCENario:LOCalized:MOVement:TYPE
value: enums.MovementType = driver.scenario.localized.movement.get_type_py()

Defines the trajectory shape.

return:

type_py: LINE| ARC| WAYPoint| TRACe

get_vehicle() → VehicleMovement

# SCPI: SCENario:LOCalized:MOVement:VEHicle
value: enums.VehicleMovement = driver.scenario.localized.movement.get_vehicle()

Assigns the selected icon.

return:

vehicle: LVEHicle| SHIP| AIRPlane| STATionary| DEFault| CAR

get_waypoint() → str

# SCPI: SCENario:LOCalized:MOVement:WAYPoint
value: str = driver.scenario.localized.movement.get_waypoint()

Loads the selected waypoint file. To import and apply the files, send the command method RsPulseSeq.Scenario.Localized. Movement.ImportPy.set.

return:

waypoint: string Filename or complete file path, incl. file extension. Waypoint files must have the extension *.txt, *.kml or *.xtd. Example files are provided with the software. For description, see ‘Movement files’.

get_yaw() → float

# SCPI: SCENario:LOCalized:MOVement:YAW
value: float = driver.scenario.localized.movement.get_yaw()

Sets the angles of rotation in the corresponding direction.

return:

yaw: No help available

set_acceleration(acceleration: float) → None

# SCPI: SCENario:LOCalized:MOVement:ACCeleration
driver.scenario.localized.movement.set_acceleration(acceleration = 1.0)

Sets the acceleration of the moving emitter.

param acceleration:

float Range: -100 to 100

set_altitude(altitude: float) → None

# SCPI: SCENario:LOCalized:MOVement:ALTitude
driver.scenario.localized.movement.set_altitude(altitude = 1.0)

Use for defining the altitude of a moving emitter (line trajectory) on a georeferenced map. Use to define the altitude of the end-points of the line.

param altitude:

float Range: -1e+09 to 1e+09

set_angle(angle: float) → None

# SCPI: SCENario:LOCalized:MOVement:ANGLe
driver.scenario.localized.movement.set_angle(angle = 1.0)

Sets the arc angle and thus defines the arc length.

param angle:

float Range: -360 to 360

set_attitude(attitude: Attitude) → None

# SCPI: SCENario:LOCalized:MOVement:ATTitude
driver.scenario.localized.movement.set_attitude(attitude = enums.Attitude.CONStant)

Defines how the attitude information is defined.

param attitude:

WAYPoint| MOTion| CONStant WAYPoint The attitude parameters are extracted from the selected waypoint file. MOTion Enables a constant rate of change of the roll. See method RsPulseSeq.Scenario.Localized.Movement.roll Constant The attitude is constant values.

set_clatitude(clatitude: float) → None

# SCPI: SCENario:LOCalized:MOVement:CLATitude
driver.scenario.localized.movement.set_clatitude(clatitude = 1.0)

Use for defining the movement of an emitter (arc trajectory) on a georeferenced map. Use to define the center-point of the arc. Positive values represent DEGEast. Negative values represent DEGWest.

param clatitude:

float Range: -180 to 180

set_clongitude(clongitude: float) → None

# SCPI: SCENario:LOCalized:MOVement:CLONgitude
driver.scenario.localized.movement.set_clongitude(clongitude = 1.0)

Use for defining the movement of an emitter (arc trajectory) on a georeferenced map. Use to define the center-point of the arc. Positive values represent DEGEast. Negative values represent DEGWest.

param clongitude:

float Range: -180 to 180

set_east(east: float) → None

# SCPI: SCENario:LOCalized:MOVement:EAST
driver.scenario.localized.movement.set_east(east = 1.0)

Sets the East/North coordinates of the emitter at the end of the movement.

param east:

float Range: -1e+09 to 1e+09

set_height(height: float) → None

# SCPI: SCENario:LOCalized:MOVement:HEIGht
driver.scenario.localized.movement.set_height(height = 1.0)

Sets the height of the emitter at the end of the movement.

param height:

float Range: -1e+09 to 1e+09

set_latitude(latitude: float) → None

# SCPI: SCENario:LOCalized:MOVement:LATitude
driver.scenario.localized.movement.set_latitude(latitude = 1.0)

Use for defining the movement of an emitter (line trajectory) on a georeferenced map. Use to define the end-points of the line. Positive values represent DEGEast. Negative values represent DEGWest.

param latitude:

float Range: -180 to 180

set_longitude(longitude: float) → None

# SCPI: SCENario:LOCalized:MOVement:LONGitude
driver.scenario.localized.movement.set_longitude(longitude = 1.0)

Use for defining the movement of an emitter (line trajectory) on a georeferenced map. Use to define the end-points of the line. Positive values represent DEGEast. Negative values represent DEGWest.

param longitude:

float Range: -180 to 180

set_north(north: float) → None

# SCPI: SCENario:LOCalized:MOVement:NORTh
driver.scenario.localized.movement.set_north(north = 1.0)

Sets the East/North coordinates of the emitter at the end of the movement.

param north:

float Range: -1e+09 to 1e+09

set_pitch(pitch: float) → None

# SCPI: SCENario:LOCalized:MOVement:PITCh
driver.scenario.localized.movement.set_pitch(pitch = 1.0)

Sets the angles of rotation in the corresponding direction.

param pitch:

float Range: -180 to 180

set_rframe(rframe: MovementRframe) → None

# SCPI: SCENario:LOCalized:MOVement:RFRame
driver.scenario.localized.movement.set_rframe(rframe = enums.MovementRframe.PZ)

Select the reference frame used to define the emitters coordinates.

param rframe:

WGS| PZ

set_rmode(rmode: MovementRmode) → None

# SCPI: SCENario:LOCalized:MOVement:RMODe
driver.scenario.localized.movement.set_rmode(rmode = enums.MovementRmode.CYCLic)

Defines the behavior of the moving object when the end of the trajectory is reached.

param rmode:

CYCLic| ROUNdtrip| ONEWay

set_roll(roll: float) → None

# SCPI: SCENario:LOCalized:MOVement:ROLL
driver.scenario.localized.movement.set_roll(roll = 1.0)

Sets the angles of rotation in the corresponding direction.

param roll:

float Range: -180 to 180

set_smoothening(smoothening: bool) → None

# SCPI: SCENario:LOCalized:MOVement:SMOothening
driver.scenario.localized.movement.set_smoothening(smoothening = False)

If a vehicle description file is loaded, activates smoothening. See method RsPulseSeq.Scenario.Localized.Movement.Vfile. value.

param smoothening:

ON| OFF| 1| 0

set_speed(speed: float) → None

# SCPI: SCENario:LOCalized:MOVement:SPEed
driver.scenario.localized.movement.set_speed(speed = 1.0)

Sets the speed of the moving emitter.

param speed:

float Range: 0 to 5999

set_spinning(spinning: float) → None

# SCPI: SCENario:LOCalized:MOVement:SPINning
driver.scenario.localized.movement.set_spinning(spinning = 1.0)

No command help available

param spinning:

No help available

set_type_py(type_py: MovementType) → None

# SCPI: SCENario:LOCalized:MOVement:TYPE
driver.scenario.localized.movement.set_type_py(type_py = enums.MovementType.ARC)

Defines the trajectory shape.

param type_py:

LINE| ARC| WAYPoint| TRACe

set_vehicle(vehicle: VehicleMovement) → None

# SCPI: SCENario:LOCalized:MOVement:VEHicle
driver.scenario.localized.movement.set_vehicle(vehicle = enums.VehicleMovement.AIRPlane)

Assigns the selected icon.

param vehicle:

LVEHicle| SHIP| AIRPlane| STATionary| DEFault| CAR

set_waypoint(waypoint: str) → None

# SCPI: SCENario:LOCalized:MOVement:WAYPoint
driver.scenario.localized.movement.set_waypoint(waypoint = 'abc')

Loads the selected waypoint file. To import and apply the files, send the command method RsPulseSeq.Scenario.Localized. Movement.ImportPy.set.

param waypoint:

string Filename or complete file path, incl. file extension. Waypoint files must have the extension *.txt, *.kml or *.xtd. Example files are provided with the software. For description, see ‘Movement files’.

set_yaw(yaw: float) → None

# SCPI: SCENario:LOCalized:MOVement:YAW
driver.scenario.localized.movement.set_yaw(yaw = 1.0)

Sets the angles of rotation in the corresponding direction.

param yaw:

float Range: -180 to 180

Cloning the Group

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

Subgroups

• ImportPy
• Vfile