org.orekit.propagation.events

Class DihedralFieldOfViewDetector

java.lang.Object

org.orekit.propagation.events.AbstractDetector<DihedralFieldOfViewDetector>

org.orekit.propagation.events.DihedralFieldOfViewDetector

All Implemented Interfaces:

Serializable, EventDetector

public class DihedralFieldOfViewDetector
extends AbstractDetector<DihedralFieldOfViewDetector>

Finder for body entering/exiting dihedral FOV events.

This class finds dihedral field of view events (i.e. body entry and exit in FOV).

The default implementation behavior is to continue propagation at entry and to stop propagation at exit. This can be changed by calling AbstractDetector.withHandler(EventHandler) after construction.

Author:

Véronique Pommier-Maurussane

See Also:

Propagator.addEventDetector(EventDetector), CircularFieldOfViewDetector, Serialized Form

Field Summary

Fields inherited from class org.orekit.propagation.events.AbstractDetector

DEFAULT_MAX_ITER, DEFAULT_MAXCHECK, DEFAULT_THRESHOLD

Constructor Summary

Constructors

Constructor and Description
DihedralFieldOfViewDetector(double maxCheck, PVCoordinatesProvider pvTarget, Vector3D center, Vector3D axis1, double halfAperture1, Vector3D axis2, double halfAperture2) Build a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
protected DihedralFieldOfViewDetector	create(double newMaxCheck, double newThreshold, int newMaxIter, EventHandler<DihedralFieldOfViewDetector> newHandler) Build a new instance.
double	g(SpacecraftState s) Compute the value of the switching function.
Vector3D	getAxis1() Get the direction of FOV 1st dihedral axis.
Vector3D	getAxis2() Get the direction of FOV 2nd dihedral axis.
Vector3D	getCenter() Get the direction of FOV center.
double	getHalfAperture1() Get the half aperture angle of FOV 1st dihedra.
double	getHalfAperture2() Get the half aperture angle of FOV 2nd dihedra.
PVCoordinatesProvider	getPVTarget() Get the position/velocity provider of the target .

Methods inherited from class org.orekit.propagation.events.AbstractDetector

eventOccurred, getHandler, getMaxCheckInterval, getMaxIterationCount, getThreshold, init, resetState, withHandler, withMaxCheck, withMaxIter, withThreshold

Methods inherited from class java.lang.Object

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

Constructor Detail

DihedralFieldOfViewDetector

public DihedralFieldOfViewDetector(double maxCheck,
                           PVCoordinatesProvider pvTarget,
                           Vector3D center,
                           Vector3D axis1,
                           double halfAperture1,
                           Vector3D axis2,
                           double halfAperture2)

Build a new instance.

The maximal interval between distance to FOV boundary checks should be smaller than the half duration of the minimal pass to handle, otherwise some short passes could be missed.

Parameters:

maxCheck - maximal interval in seconds

pvTarget - Position/velocity provider of the considered target

center - Direction of the FOV center

axis1 - FOV dihedral axis 1

halfAperture1 - FOV dihedral half aperture angle 1

axis2 - FOV dihedral axis 2

halfAperture2 - FOV dihedral half aperture angle 2

Method Detail

create

protected DihedralFieldOfViewDetector create(double newMaxCheck,
                                 double newThreshold,
                                 int newMaxIter,
                                 EventHandler<DihedralFieldOfViewDetector> newHandler)

Build a new instance.

Specified by:

create in class AbstractDetector<DihedralFieldOfViewDetector>

Parameters:

newMaxCheck - maximum checking interval (s)

newThreshold - convergence threshold (s)

newMaxIter - maximum number of iterations in the event time search

newHandler - event handler to call at event occurrences

Returns:

a new instance of the appropriate sub-type

getPVTarget

public PVCoordinatesProvider getPVTarget()

Get the position/velocity provider of the target .

Returns:

the position/velocity provider of the target

getCenter

public Vector3D getCenter()

Get the direction of FOV center.

Returns:

the direction of FOV center

getAxis1

public Vector3D getAxis1()

Get the direction of FOV 1st dihedral axis.

Returns:

the direction of FOV 1st dihedral axis

getHalfAperture1

public double getHalfAperture1()

Get the half aperture angle of FOV 1st dihedra.

Returns:

the half aperture angle of FOV 1st dihedras

getHalfAperture2

public double getHalfAperture2()

Get the half aperture angle of FOV 2nd dihedra.

Returns:

the half aperture angle of FOV 2nd dihedras

getAxis2

public Vector3D getAxis2()

Get the direction of FOV 2nd dihedral axis.

Returns:

the direction of FOV 2nd dihedral axis

g

public double g(SpacecraftState s)
         throws OrekitException

Compute the value of the switching function. This function must be continuous (at least in its roots neighborhood), as the integrator will need to find its roots to locate the events. g function value is the target signed distance to the closest FOV boundary. It is positive inside the FOV, and negative outside.

Specified by:

g in interface EventDetector

Specified by:

g in class AbstractDetector<DihedralFieldOfViewDetector>

Parameters:

s - the current state information: date, kinematics, attitude

Returns:

value of the switching function

Throws:

OrekitException - if some specific error occurs