fr.cnes.sirius.patrius.fieldsofview

Interface IGeometricFieldOfView

All Superinterfaces:

IFieldOfView, Serializable

All Known Implementing Classes:

CircularField, EllipticField, RectangleField

public interface IGeometricFieldOfView
extends IFieldOfView

This interface specifies the generic concept of IFieldOfView with conical shapes based on a polygonal section. For such models, a main direction can be defined as the Vector3D, from the center of the FOV, passing through the center of each section of the cone.

Since:

4.14

Version:

4.14

Author:

Tommaso Capano

Method Summary

Modifier and Type	Method and Description
default double	getAngularDistance(Vector3D direction) Computes the angular distance between a vector and the border of the field.
double	getAngularDistance(Vector3D direction, AngularDistanceType type) Computes the angular distance between a vector and the border of the field.
double	getAngularOpening(Vector3D directionIn) Get the angular opening of the Field Of View (FOV) over a given direction.
Vector3D	getMainDirection() Get the main direction of the geometrical FOV.

Methods inherited from interface fr.cnes.sirius.patrius.fieldsofview.IFieldOfView

getName, isInTheField

Method Detail

getMainDirection

Vector3D getMainDirection()

Get the main direction of the geometrical FOV. For every orthogonal section of the FOV, the main direction contains the center of such section.

Returns:

The main direction of the FOV

getAngularDistance

double getAngularDistance(Vector3D direction,
                          AngularDistanceType type)

Computes the angular distance between a vector and the border of the field. The result is positive if the direction is in the field, negative otherwise.

Several methods can be defined for the computation. The user can choose the more appropriate one from the enum AngularDistanceType.

Parameters:

direction - the direction vector (expressed in the topocentric coordinate system of the object)

type - Defines the method to compute the distance from the enum AngularDistanceType

Returns:

the angular distance

getAngularDistance

default double getAngularDistance(Vector3D direction)

Computes the angular distance between a vector and the border of the field. The result is positive if the direction is in the field, negative otherwise.

For a geometric FOV, the distance can be computed in several ways. This signature uses the AngularDistanceType.MINIMAL method by default.

Specified by:

getAngularDistance in interface IFieldOfView

Parameters:

direction - the direction vector (expressed in the topocentric coordinate system of the object)

Returns:

the angular distance

getAngularOpening

double getAngularOpening(Vector3D directionIn)

Get the angular opening of the Field Of View (FOV) over a given direction. Considering the half-plane containing both the main direction of the FOV and the input direction, the angular opening is defined as the angle between the main direction and the intersection of the FOV border with the half-plane.

Parameters:

directionIn - the direction vector (expressed in the topocentric coordinate system of the object)

Returns:

the angular opening along the input direction