fr.cnes.sirius.patrius.fieldsofview

Class EllipticField

java.lang.Object

fr.cnes.sirius.patrius.fieldsofview.EllipticField

All Implemented Interfaces:

IFieldOfView, IGeometricFieldOfView, Serializable

public final class EllipticField
extends Object
implements IGeometricFieldOfView

This class describes an elliptic field of view to be used in "instruments" part properties. It implements the IFieldOfView interface and provides the associated services.

Since:

1.2

Version:

$Id$

Author:

Rami Houdroge

See Also:

IFieldOfView, Serialized Form

Concurrency :

immutable

Constructor Summary

Constructors

Constructor and Description
EllipticField(String name, Vector3D origin, Vector3D mainDirection, Vector3D semiMajAxisDir, double angleA, double angleB) Constructor for an elliptic field of view.

Method Summary

Modifier and Type	Method and Description
double	getAngularDistance(Vector3D direction, AngularDistanceType method) 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.
String	getName()
boolean	isInTheField(Vector3D direction)
String	toString() Get a representation for this infinite oblique circular cone.

Methods inherited from class java.lang.Object

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

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

getAngularDistance

Constructor Detail

EllipticField

public EllipticField(String name,
                     Vector3D origin,
                     Vector3D mainDirection,
                     Vector3D semiMajAxisDir,
                     double angleA,
                     double angleB)

Constructor for an elliptic field of view.

Parameters:

name - the name of the field

origin - origin of the cone

mainDirection - the direction defining the center of the field

semiMajAxisDir - the direction defining the semi major axis of the field

angleA - the angular aperture along semi major axis (in rad)

angleB - the angular aperture along semi minor axis (in rad)

Throws:

IllegalArgumentException - if the origin is not correct

Method Detail

getAngularDistance

public double getAngularDistance(Vector3D direction,
                                 AngularDistanceType method)

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.

Specified by:

getAngularDistance in interface IGeometricFieldOfView

Parameters:

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

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

Returns:

the angular distance

getAngularOpening

public 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.

Specified by:

getAngularOpening in interface IGeometricFieldOfView

Parameters:

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

Returns:

the angular opening along the input direction

getMainDirection

public 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.

Specified by:

getMainDirection in interface IGeometricFieldOfView

Returns:

The main direction of the FOV

isInTheField

public boolean isInTheField(Vector3D direction)

Specified by:

isInTheField in interface IFieldOfView

Parameters:

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

Returns:

true if the direction is in the field

getName

public String getName()

Specified by:

getName in interface IFieldOfView

Returns:

the name of the field

toString

public String toString()

Get a representation for this infinite oblique circular cone. The given parameters are in the same order as in the constructor.

Overrides:

toString in class Object

Returns:

a representation for this infinite oblique circular cone