SensorProjection

class ansys.stk.core.stkobjects.SensorProjection

Class defining the projection properties of a Sensor.

Overview

Methods

available_constraints	Return the available constraints.
enabled_constraints	Return the enabled constraints.
enable_constraint	Enable the constraint with the name given.
disable_constraint	Disables the constraint with the name given.
available_altitude_objects	Return the available altitude objects.

Properties

persistence	Length of time the sensor’s footprint remains visible during animation. Used to display sensor footprints for a specified period of time so that you can determine quickly and easily whether coverage requirements are being met. Uses Time Dimension.
forward_persistence	Specify whether persistence is to apply in a forward animation direction only.
project_at_altitude_object	The altitude of the object to which the sensor is projected (if this option for setting projection distance is selected).
intersection_type	The type of intersections to be shown. A member of the IntersectionType enumeration.
distance_type	The criterion used for determining the projection distance. A member of the SensorProjectionDistanceType enumeration.
distance_data	Value of the criterion used for determining the projection distance.
fill_persistence	Specify whether to display the sensor’s footprints as filled areas on the surface of the central body.
use_constraints	Specify whether to evaluate the effect of various constraints on visibility along all possible lines of sight within the field of view.
show_on_2d_map	Show Projection on 2D map.
use_distance	Opt whether the sensor’s field-of-view crossings at specified distances are to be computed and displayed in the 2D Graphics window.
display_times_hides_persistence	Specify whether to allow display times to affect the sensor’s persistence on/off state.

Examples

Sensor Persistence

# Sensor sensor: Sensor object
projection = sensor.graphics.projection
projection.persistence = 7200  # sec
projection.forward_persistence = True
projection.fill_persistence = True
sensor.graphics.show_fill = True
sensor.graphics.percent_translucency = 50

Import detail

from ansys.stk.core.stkobjects import SensorProjection

Property detail

property SensorProjection.persistence: float

Length of time the sensor’s footprint remains visible during animation. Used to display sensor footprints for a specified period of time so that you can determine quickly and easily whether coverage requirements are being met. Uses Time Dimension.

property SensorProjection.forward_persistence: bool

Specify whether persistence is to apply in a forward animation direction only.

property SensorProjection.project_at_altitude_object: str

The altitude of the object to which the sensor is projected (if this option for setting projection distance is selected).

property SensorProjection.intersection_type: IntersectionType

The type of intersections to be shown. A member of the IntersectionType enumeration.

property SensorProjection.distance_type: SensorProjectionDistanceType

The criterion used for determining the projection distance. A member of the SensorProjectionDistanceType enumeration.

property SensorProjection.distance_data: IDisplayDistance

Value of the criterion used for determining the projection distance.

property SensorProjection.fill_persistence: bool

Specify whether to display the sensor’s footprints as filled areas on the surface of the central body.

property SensorProjection.use_constraints: bool

Specify whether to evaluate the effect of various constraints on visibility along all possible lines of sight within the field of view.

property SensorProjection.show_on_2d_map: bool

Show Projection on 2D map.

property SensorProjection.use_distance: bool

Opt whether the sensor’s field-of-view crossings at specified distances are to be computed and displayed in the 2D Graphics window.

property SensorProjection.display_times_hides_persistence: bool

Specify whether to allow display times to affect the sensor’s persistence on/off state.

Method detail

SensorProjection.available_constraints(self) → list

Return the available constraints.

Returns:

list

SensorProjection.enabled_constraints(self) → list

Return the enabled constraints.

Returns:

list

SensorProjection.enable_constraint(self, constraint_name: str) → None

Enable the constraint with the name given.

Parameters:

constraint_name : str

Returns:

None

SensorProjection.disable_constraint(self, constraint_name: str) → None

Disables the constraint with the name given.

Parameters:

constraint_name : str

Returns:

None

SensorProjection.available_altitude_objects(self) → list

Return the available altitude objects.

Returns:

list