agi.foundation.geometry.shapes

(agi.foundation.core-2024r3.jar)

Class CustomSensorPattern

java.lang.Object

agi.foundation.geometry.shapes.Figure

agi.foundation.geometry.shapes.Solid

agi.foundation.geometry.shapes.SensorFieldOfView

agi.foundation.geometry.shapes.CustomSensorPattern

All Implemented Interfaces:

IServiceProvider

public class CustomSensorPattern
extends SensorFieldOfView

A custom SensorFieldOfView defined by a list of directions defining the outer perimeter of the field of view. See the Remarks section for more information.

The custom sensor pattern is defined by a list of directions specified using UnitSpherical coordinates. UnitSpherical defines a direction as two values: a clock angle and a cone angle. The clock angle, sometimes called azimuth, is the angle in the sensor's X-Y plane measured from the positive X-axis toward the positive Y-axis. The cone angle is the angle measured from the positive Z-axis toward the negative Z-axis. The sensor's boresight is down the positive Z-axis.

Constructor Summary

Constructors

Constructor and Description
CustomSensorPattern() Initializes a new instance.
CustomSensorPattern(List<UnitSpherical> directions) Initializes a new instance with the specified list of directions defining the custom sensor pattern.
CustomSensorPattern(List<UnitSpherical> directions, double radius) Initializes a new instance with the specified list of directions defining the custom sensor pattern.

Method Summary

Modifier and Type	Method and Description
boolean	encloses(Cartesian point) Indicates if the provided point is inside the volume.
List<UnitSpherical>	getDirections() Gets the list of directions that define the custom sensor pattern.
EnclosureDescriptionCollection	getEnclosureDescriptions() Gets the list of descriptions for the enclosure functions for this solid.
boolean	getIsConnected() Gets a value indicating whether the figure is connected.
SensorProjection	getProjection(Ellipsoid ellipsoid, KinematicTransformation ellipsoidToSensorTransformation, SensorProjectionOptions projectionOptions) Gets the projection of the sensor onto the front surface of a specified ellipsoid and onto a plane at a specified distance in space.
void	setDirections(List<UnitSpherical> value) Sets the list of directions that define the custom sensor pattern.

Methods inherited from class agi.foundation.geometry.shapes.SensorFieldOfView

getProjection, getRadius, getService, onRadiusChanged, setRadius

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CustomSensorPattern

public CustomSensorPattern()

Initializes a new instance. Directions (get / set) must be set before the new instance can be used.

CustomSensorPattern

public CustomSensorPattern(List<UnitSpherical> directions)

Initializes a new instance with the specified list of directions defining the custom sensor pattern.

Parameters:

directions - The list of directions that define the custom sensor pattern. The directions are vectors originating from the sensor's origin and expressed in the sensor's axes. See the Remarks section of the CustomSensorPattern reference documentation for more information.

CustomSensorPattern

public CustomSensorPattern(List<UnitSpherical> directions,
                           double radius)

Initializes a new instance with the specified list of directions defining the custom sensor pattern.

Parameters:

directions - The list of directions that define the custom sensor pattern. The directions are vectors originating from the sensor's origin and expressed in the sensor's axes. See the Remarks section of the CustomSensorPattern reference documentation for more information.

radius - The radial limit of the volume. This is the maximum range at which the sensor can detect a target.

Method Detail

getDirections

public final List<UnitSpherical> getDirections()

Gets the list of directions that define the custom sensor pattern. The directions are vectors originating from the sensor's origin and expressed in the sensor's axes. See the Remarks section of the CustomSensorPattern reference documentation for more information.

setDirections

public final void setDirections(List<UnitSpherical> value)

Sets the list of directions that define the custom sensor pattern. The directions are vectors originating from the sensor's origin and expressed in the sensor's axes. See the Remarks section of the CustomSensorPattern reference documentation for more information.

encloses

public boolean encloses(@Nonnull
                        Cartesian point)

Indicates if the provided point is inside the volume.

The point parameter must be expressed in the same coordinate frame that the volume is defined in.

Specified by:

encloses in class Solid

Parameters:

point - The point to evaluate.

Returns:

true if the point is inside the volume and false if the point lies on the boundary or outside of the volume.

getEnclosureDescriptions

public EnclosureDescriptionCollection getEnclosureDescriptions()

Gets the list of descriptions for the enclosure functions for this solid.

Specified by:

getEnclosureDescriptions in class Solid

Returns:

The list of enclosure descriptions.

getIsConnected

public boolean getIsConnected()

Gets a value indicating whether the figure is connected.

Specified by:

getIsConnected in class Figure

getProjection

public SensorProjection getProjection(Ellipsoid ellipsoid,
                                      @Nonnull
                                      KinematicTransformation ellipsoidToSensorTransformation,
                                      SensorProjectionOptions projectionOptions)

Gets the projection of the sensor onto the front surface of a specified ellipsoid and onto a plane at a specified distance in space.

Specified by:

getProjection in class SensorFieldOfView

Parameters:

ellipsoid - The ellipsoid on which the sensor is to be projected.

ellipsoidToSensorTransformation - The transformation from the reference frame of the ellipsoid to the reference frame of the sensor.

projectionOptions - The options controlling how the sensor is projected, or null to use defaults.

Returns:

The sensor projection.