PyramidalField (patrimoine de base SIRIUS 4.11 API)

java.lang.Object
- fr.cnes.sirius.patrius.fieldsofview.PyramidalField

All Implemented Interfaces:

IFieldOfView, Serializable
```
public final class PyramidalField
extends Object
implements IFieldOfView
```
This class describes a pyramidal field of view defined a list of vectors (its edges) cone, to be used in "instruments" part properties. It implements the IFieldOfView interface and so provides the associated services.

Since:

1.2

Version:

$Id$

Author:

Thomas Trapier

See Also:

IFieldOfView, Serialized Form

Concurrency :

immutable

Constructor Summary

Constructors
Modifier	Constructor and Description
	`PyramidalField(String name, Vector3D[] directions)` Constructor for a pyramidal field of view.
	`PyramidalField(String name, Vector3D[] directions, boolean checkIntersectingFaces)` Constructor for a pyramidal field of view.
`protected`	`PyramidalField(String name, Vector3D[] directions, PolyhedronsSet polyhedronIn)` Constructor for a pyramidal field of view.
`protected`	`PyramidalField(String name, Vector3D[] directions, PolyhedronsSet polyhedronIn, boolean checkIntersectingFaces)` Protected constructor for a pyramidal field of view.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IDirection[]`	`computeSideDirections(Frame frame)` Retrieve the directions delimiting the pyramidal field of view.
`boolean`	`equals(PyramidalField otherFov, double angularTol)` Check the equality between this and a provided `PyramidalField`.
`double`	`getAngularDistance(Vector3D direction)` Computes the angular distance between a vector and the border of the field.
`PyramidalField`	`getComplementaryFieldOfView()` Build the complementary field of view of this.
`PyramidalField`	`getIntersectionWith(PyramidalField otherFov)` Build a new `PyramidalField` from the intersection between this field of view and the provided one.
`String`	`getName()`
`Vector3D[]`	`getSideAxis()` Get the side axis of the field of view.
`PyramidalField`	`getUnionWith(PyramidalField otherFov)` Build a new `PyramidalField` from the union between this field of view and the provided one.
`boolean`	`isConvex()` Indicates whether or not this field of view is convex.
`boolean`	`isIntersectingFaces()` Indicates whether or not the faces of this field intersect each other.
`boolean`	`isInTheField(PyramidalField otherFov)` Indicates whether or not the provided `PyramidalField` is included in this one.
`boolean`	`isInTheField(Vector3D direction)`
`static boolean`	`turnClockwise(PyramidalField fov)` Assess if the side axes of the entered field of view turn clockwise or counter-clockwise, from a sensor's/user's point of view. Calculation is perfomed only once for a field, meaning that it is performed if it has never been, and returns the previously calculated result otherwise. Field's attribute alreadyComputed is updated for this purpose.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PyramidalField
```
public PyramidalField(String name,
                      Vector3D[] directions)
```
    Constructor for a pyramidal field of view.
    
    Parameters:
    
    name - the name of the field
    
    directions - the directions defining the border of the field. They must be given in the right order : from the vector i to the vector i + 1, the inside of the field is on the side of the positive cross vector v(i) * v(i+1)
  - PyramidalField
```
protected PyramidalField(String name,
                         Vector3D[] directions,
                         PolyhedronsSet polyhedronIn)
```
    Constructor for a pyramidal field of view.
    
    Parameters:
    
    name - the name of the field
    
    directions - the directions defining the border of the field. They must be given in the right order : from the vector i to the vector i + 1, the inside of the field is on the side of the positive cross vector v(i) * v(i+1)
    
    polyhedronIn - the polyhedron modelizing the field of view
  - PyramidalField
```
public PyramidalField(String name,
                      Vector3D[] directions,
                      boolean checkIntersectingFaces)
```
    Constructor for a pyramidal field of view.
    
    Parameters:
    
    name - the name of the field
    
    directions - the directions defining the border of the field. They must be given in the right order : from the vector i to the vector i + 1, the inside of the field is on the side of the positive cross vector v(i) * v(i+1)
    
    checkIntersectingFaces - flag that indicates if a verification on the field of view has to be performed: if yes, an exception is thrown if any field's face crosses any other face
  - PyramidalField
```
protected PyramidalField(String name,
                         Vector3D[] directions,
                         PolyhedronsSet polyhedronIn,
                         boolean checkIntersectingFaces)
```
    Protected constructor for a pyramidal field of view.
    
    Parameters:
    
    name - the name of the field
    
    directions - the directions defining the border of the field. They must be given in the right order : from the vector i to the vector i + 1, the inside of the field is on the side of the positive cross vector v(i) * v(i+1)
    
    polyhedronIn - the polyhedron modelizing the field of view
    
    checkIntersectingFaces - flag that indicates if a verification on the field of view has to be performed: if yes, an exception is thrown if any field's face crosses any other face
- 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
  - getSideAxis
```
public Vector3D[] getSideAxis()
```
    Get the side axis of the field of view.
    
    Returns:
    
    the side axis of the field of view
  - isConvex
```
public boolean isConvex()
```
    Indicates whether or not this field of view is convex.
    
    Returns:
    
    true if this field is convex
  - isIntersectingFaces
```
public boolean isIntersectingFaces()
```
    Indicates whether or not the faces of this field intersect each other.
    
    Returns:
    
    true if the faces of this field intersect each other
  - equals
```
public boolean equals(PyramidalField otherFov,
                      double angularTol)
```
    Check the equality between this and a provided PyramidalField. The side axis are assumed to be sorted in the same order. To be equal, both objects must have the same number of side axis and side axis at same index position must be colinear within a given tolerance.
    
    Parameters:
    
    otherFov - the other pyramidal field
    
    angularTol - the numerical tolerance to check the colinearity between side axis
    
    Returns:
    
    true if both pyramidal field are equal within the tolerance
  - isInTheField
```
public boolean isInTheField(PyramidalField otherFov)
```
    Indicates whether or not the provided PyramidalField is included in this one. The condition is respected if every side axis of the other field of view are contained in this one and if every side axis of this one are outside the other pyramidal field.
    Note: The second condition is verified only if this field of view is not convex.
    
    Note: By convention the result is true if the provided PyramidalField is null.
    
    Parameters:
    
    otherFov - the other field of view.
    
    Returns:
    
    true if this field of view contains the other one
  - getComplementaryFieldOfView
```
public PyramidalField getComplementaryFieldOfView()
```
    Build the complementary field of view of this. The side axis are sorted in reverse order.
    
    Returns:
    
    the complementary field of view
  - getIntersectionWith
```
public PyramidalField getIntersectionWith(PyramidalField otherFov)
                                   throws PatriusException
```
    Build a new PyramidalField from the intersection between this field of view and the provided one.
    
    Parameters:
    
    otherFov - the other field of view.
    
    Returns:
    
    the intersection between the fields of view
    
    Throws:
    
    PatriusException - thrown if an error occurs with the binary space partition. Such error can occur if one of the fields is concave and leads to several intersections.
  - getUnionWith
```
public PyramidalField getUnionWith(PyramidalField otherFov)
                            throws PatriusException
```
    Build a new PyramidalField from the union between this field of view and the provided one.
    
    Parameters:
    
    otherFov - the other field of view.
    
    Returns:
    
    the union between the fields of view
    
    Throws:
    
    PatriusException - thrown if an error occurs with the binary space partition. Such error can occur if the two fields are disjointed or if one of them is concave and leads to a hole in the middle of the theoretical resulting field.
  - computeSideDirections
```
public IDirection[] computeSideDirections(Frame frame)
```
    Retrieve the directions delimiting the pyramidal field of view.
    
    Parameters:
    
    frame - the reference frame in which the vectors will be defined as constant
    
    Returns:
    
    the directions delimiting the pyramidal field of view.
  - turnClockwise
```
public static final boolean turnClockwise(PyramidalField fov)
```
    Assess if the side axes of the entered field of view turn clockwise or counter-clockwise, from a sensor's/user's point of view.
    Calculation is perfomed only once for a field, meaning that it is performed if it has never been, and returns the previously calculated result otherwise.
    Field's attribute alreadyComputed is updated for this purpose.
    
    Parameters:
    
    fov - input field of view (expected to be well-formed, i.e. its faces do not cross with each other)
    
    Returns:
    
    true if the field of view turns clockwise, false if counter-clockwise

Class PyramidalField

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PyramidalField

PyramidalField

PyramidalField

PyramidalField

Method Detail

getAngularDistance

isInTheField

getName

getSideAxis

isConvex

isIntersectingFaces

equals

isInTheField

getComplementaryFieldOfView

getIntersectionWith

getUnionWith

computeSideDirections

turnClockwise