fr.cnes.sirius.patrius.fieldsofview

Class EllipticField

java.lang.Object

fr.cnes.sirius.patrius.fieldsofview.EllipticField

All Implemented Interfaces:

IFieldOfView, Serializable

public final class EllipticField
extends Object
implements IFieldOfView

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 majorSemiAxisDirection, double angleA, double angleB) Constructor for an elliptic field of view.

Method Summary

Modifier and Type	Method and Description
double	getAngularDistance(Vector3D direction) Computes the angular distance between a vector and the border of the field.
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

Constructor Detail

EllipticField

public EllipticField(String name,
                     Vector3D origin,
                     Vector3D mainDirection,
                     Vector3D majorSemiAxisDirection,
                     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

majorSemiAxisDirection - 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)

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 some of the fields (ComplexField), that value can be approximative : see particular javadoc of each class.

Specified by:

getAngularDistance in interface IFieldOfView

Parameters:

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

Returns:

the angular distance

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