User Manual 3.3 Fields of view : Différence entre versions

De Wiki
Aller à : navigation, rechercher
m (Admin a déplacé la page Fields of view vers User Manual 3.3 Fields of view sans laisser de redirection)
(Methods)
 
(Une révision intermédiaire par le même utilisateur non affichée)
Ligne 33 : Ligne 33 :
  
 
=== Elliptic field ===
 
=== Elliptic field ===
This field is an infinite elliptic cone defined by two an angular aperture from a given origin. (Cf [SPC_FIELD_mainPage#HClasses EllipticField]).
+
This field is an infinite elliptic cone defined by two an angular aperture from a given origin. (Cf [[User Manual 3.3 Fields of view#Classes|EllipticField]]).
  
 
'''Nota :''' Angular distances are approximation. Moreover, if the user point is outside the cone and the closest point on the cone is its apex, then the angular distance return is <math>{-\pi \over 2}</math>).
 
'''Nota :''' Angular distances are approximation. Moreover, if the user point is outside the cone and the closest point on the cone is its apex, then the angular distance return is <math>{-\pi \over 2}</math>).
Ligne 126 : Ligne 126 :
  
 
=== Methods ===
 
=== Methods ===
All [SPC_FIELD_mainPage#HClasses fields] implement the IFieldOfView interface (see [{{JavaDoc3.3}}/fr/cnes/sirius/patrius/fieldsofview/IFieldOfView.html javadoc]).
+
All [[User Manual 3.3 Fields of view#Classes|fields]] implement the IFieldOfView interface (see [{{JavaDoc3.3}}/fr/cnes/sirius/patrius/fieldsofview/IFieldOfView.html javadoc]).
  
 
All fields can :
 
All fields can :

Version actuelle en date du 28 février 2018 à 16:42

Introduction

Scope

The fields of view are used to describe the instruments and sensors of a spacecraft : each of them has several fields of view and inhibition (the inhibition fields are also created as "fields of view" : they provide the same services). All the available fields are described thereafter.

Javadoc

All the fields of view and the associated interface are available in the package fr.cnes.sirius.patrius.fieldsofview

Library Javadoc
Basis Package fr.cnes.sirius.patrius.fieldsofview

Package Overview

All fields implement the IFieldOfView interface (all are not represented here).

Fields.PNG


Features Description

Omnidirectional field

This field is all the 3D space : any direction vector belongs to it. The angular distance to a vector has no sense here : this method always return 1 (the convention for a vector in the field being to return a positive value).

Circular field

This field is a right circular infinite cone defined by an angular aperture from a given direction.


Elliptic field

This field is an infinite elliptic cone defined by two an angular aperture from a given origin. (Cf EllipticField).

Nota : Angular distances are approximation. Moreover, if the user point is outside the cone and the closest point on the cone is its apex, then the angular distance return is [math]{-\pi \over 2}[/math]).

Rectangle field

This field is a rectangle infinite cone defined the same way as the identical object of the geometry section : a main direction vector, abn approximative U vector (to define the local frame) and two aperture angles (see the Infinite rectangle cone chapter for more details).

Pyramidal field

This field describes any pyramidal field defined by an array of directions. The field must be created with the directions (vectors) in the right order : the inside of the field is on the side of the positive cross vector of two consecutive vetcors i and i+1 of the list (and the last to the first).

Boolean field

This field is a boolean combination ("AND" or "OR") of two previously created fields.
A direction is in an "OR" field if it is at least in one of the two fields defining it.
A direction is in an "AND" field if it is in both of the two fields defining it.
Beware : the angular distance computed is approximative in some cases (for a direction in the field in an "OR" case, for a direction out of the field in an "AND" case), but the sign is always the right one, and the function is continuous around its zero (direction on the border of the field), so that it can be used fo events detection.

Invert field

The invert field is created from an existing one : and represent a field with a same border but an inverse definition of "in" and "out". The angular distance is so the opposite of the one of the original field.

Sector field

This field is a min/max longitude and min/max latitude aperture on the unit sphere.
It is defined by three vectors : the local "north pole" vector for this sphere, the min latitude- min longitude point vector (V1) and the max latitude - max longitude point vector (V2).
The angle from the pole vector to V1 must be greater than the angle from the pole vector to V2 (greater latitude). None of them can be aligned with or opposite to the "pole" vector (the field is undefined if V1 or V2 is on a pole).


SectorField.PNG

Azimuth-Elevation Field

This field is defined by an azimuth/elevation array. The border is then described by linear segments between these points. The inside of the field is the sector of the unitary sphere with greaters elevation than the border.
The angular distance to the field limit is not the exact shortest distance: it is the exact angular distance on the local meridian (difference of elevation of the target and the linear interpolated local elevation). Concerning the field of view, the limit between two consecutive points is NOT a great circle (i.e. planar) limit: it is linear in azimuth-elevation. The fields with planar limits are the Rectangle or Pyramidal fields.

Getting Started

Modèle:SpecialInclusion prefix=$theme sub section="GettingStarted"/

Contents

Interfaces

Interface Summary Javadoc
IFieldOfView Interface for all fields of view. ...

Classes

Class Summary Javadoc
OmnidirectionalField Field incuding all the 3D space. ...
CircularField Field described by a circular cone. ...
RectangleField Field described by a direction and two angles. ...
PyramidalField Field described by an ordered array of directions. ...
BooleanField Field defined by a boolean combination of two existing fields. ...
InvertField Field inverting an existing one. ...
EllipticField This class describes an elliptic field of view. ...
SectorField This class describes a "sector" field of view. ...
AzimuthElevationField This class describes a field of view defined by an azimuth/elevation array. ...

Methods

All fields implement the IFieldOfView interface (see javadoc).

All fields can :

  • return a boolean set to true if a user point (direction) is in the field,
  • compute the minimal angular distance between a user point (direction) to their border,
  • provide their name.

The associated methods are :

getAngularDistance( Vector3D ) : double
The convention is : the returned double is positive if the direction vector is in the field, negative otherwise, so it can be used directely by the event detector computations (the zero of the g function occurs when the direction comes in are goes out of the field).
// creation of a circular field of view
Vector3D axisVector = new Vector3D(2.0, 1.0, 3.0);
double apertureAngle = 1.2;
IFieldOfView field = new CircularFieldOfView(axisVector, apertureAngle);
 
// the direction
Vector3D direction = new Vector3D(1.0, 0.5, 2.0);
 
// angular distance to the direction
double angularDistance = field.getAngularDistance(direction);
isInTheField( Vector3D ) : boolean
Returns true if the direction vector is in the field, false otherwise.
// angular distance to the direction
boolean direction in field = field.isInTheField(direction);
getName( ) : String
Returns the String name of the field.

Tutorials

Tutorial 1

Modèle:SpecialInclusion prefix=$theme sub section="Tuto1"/

LightBulb.png Tips & Tricks

Modèle:SpecialInclusion prefix=$theme sub section="Tips"/