Engee documentation

radarScenario

Creates a radar scenario.

Library

EngeeRadars

Description

Function radarScenario creates a radar scenario object. The RL scenario simulates a three-dimensional environment containing multiple platforms. Platforms are objects that need to be modeled, such as airplanes, ground vehicles, or ships. Some platforms have sensors such as radar, locator or infrared sensor. Other platforms act as a source or reflector of signals.

Fill in the RL script by calling the function platform for each platform that needs to be added. You can model platforms as points or parallelepipeds by giving the argument Dimensions when calling a function platform. The platforms have signatures with properties specific to the type of sensor, such as the RADAR cross-section for RADAR sensors.

Syntax

Function call

  • scene = radarScenario() — creates an empty radar scenario scene, whose properties are set by default.

  • scene = radarScenario(IsEarthCentered=true) — creates an empty radar scenario in a geocentric orbit.

  • scene = radarScenario(Name=Value) — sets properties specified by one or more arguments of the type «name-value». Unspecified properties retain their default values.

Arguments

Input arguments «name-value»

Specify optional argument pairs as Name=Value, where Name — the name of the argument, and Value — the appropriate value. You can specify multiple pairs «name-value».

# IsEarthCentered — activation of the reference system and trajectories in geocentric orbit

+ false (by default) | true

Details

The ability to set a reference frame and trajectories in a geocentric orbit:

  • false — the trajectories of the platforms should be defined as Cartesian states.

  • true — the trajectories of the platforms should be defined as geodetic states.

Argument IsEarthCentered You can only set it when creating an RL script.

Типы данных

Bool

# UpdateRate — frequency of simulation updates

+ 10 (by default) | scalar

Details

The frequency of simulation updates, set as a non-negative scalar in Hz.

  • If the argument is set as a positive scalar, the script progresses in time increments. , where — the value of the argument UpdateRate.

  • If the value is set for the argument 0 The simulation proceeds to the next scheduled sampling interval of any installed sensors or emitters. For example, if the script has two sensors with a refresh rate 2 Hz and 5 Hz, then the first seven simulation updates will occur in 0, 0.2, 0.4, 0.5, 0.6, 0.8 and 1.0 seconds, respectively.

Типы данных

Float64

# SimulationTime — current simulation time

+ 0 (by default) | scalar

Details

The current simulation time, set as a positive scalar in seconds.

This argument is read-only.
Типы данных

Float64

# StopTime — simulation stop time

+ Inf (default) | scalar

Details

The simulation stop time, set as a positive scalar in seconds. The simulation stops when any of the following conditions are met:

  • The stop time has been reached.

  • Any platform reaches the end of its trajectory.

Типы данных

Float64

# SimulationStatus — simulation status

+ NotStarted | InProgress | Completed

Details

Simulation status, set to one of the following values:

  • NotStarted — the simulation has not started.

  • InProgress — simulation started, and the script has not reached the status Completed.

  • Completed — the script reaches the stop time specified in the argument StopTime, or any object platform in the scenario, it reaches the end of its trajectory.

This argument is read-only.

# Platforms — platforms in the scenario

+ the tuple

Details

Platforms in the script that are returned as a tuple of objects platform. The number of elements in the tuple is equal to the number of platforms in the scenario. To add a platform to the script, use the function platform.

This argument is read-only.

# InitialAdvance — initial value

+ "Zero" (by default) | "UpdateInterval"

Details

Initial value, set to one of the following values:

  • "Zero" — scenario modeling starts from a point in time 0.

  • "UpdateInterval" — scenario modeling starts from a point in time , where — the value of a non-zero argument UpdateRate. If for an argument UpdateRate the value is set 0 then the scenario simulation ignores the argument InitialAdvance and it starts from the moment of time 0.

Типы данных

String

Output arguments

# scene — radar scenario

+ object

Details

The object of the radar scenario.