org.orekit.propagation.events
Class DihedralFieldOfViewDetector

java.lang.Object
  org.orekit.propagation.events.AbstractDetector
      org.orekit.propagation.events.DihedralFieldOfViewDetector

All Implemented Interfaces:

Serializable, EventDetector

public class DihedralFieldOfViewDetector
extends AbstractDetector

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 using provided constructors.

Author:

Véronique Pommier-Maurussane

See Also:

Propagator.addEventDetector(EventDetector), CircularFieldOfViewDetector, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.orekit.propagation.events.EventDetector

EventDetector.Action

Field Summary

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

DEFAULT_MAXCHECK, DEFAULT_THRESHOLD

Fields inherited from interface org.orekit.propagation.events.EventDetector

DECREASING, INCREASING, INCREASING_DECREASING

Constructor Summary

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

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

DihedralFieldOfViewDetector(PVCoordinatesProvider pvTarget, Vector3D center, Vector3D axis1, double halfAperture1, Vector3D axis2, double halfAperture2, double maxCheck, EventDetector.Action entry, EventDetector.Action exit)
Build a new instance.

DihedralFieldOfViewDetector(PVCoordinatesProvider pvTarget, Vector3D center, Vector3D axis1, double halfAperture1, Vector3D axis2, double halfAperture2, double maxCheck, EventDetector.Action entry, EventDetector.Action exit, boolean removeEntry, boolean removeExit)
Build a new instance.

DihedralFieldOfViewDetector(PVCoordinatesProvider pvTarget, Vector3D center, Vector3D axis1, double halfAperture1, Vector3D axis2, double halfAperture2, double maxCheck, EventDetector.Action entry, EventDetector.Action exit, boolean removeEntry, boolean removeExit, double epsilon)
Build a new instance.

DihedralFieldOfViewDetector(PVCoordinatesProvider pvTarget, Vector3D center, Vector3D axis1, double halfAperture1, Vector3D axis2, double halfAperture2, double maxCheck, EventDetector.Action entry, EventDetector.Action exit, double epsilon)
Build a new instance.

Method Summary

EventDetector.Action	eventOccurred(SpacecraftState s, boolean increasing, boolean forward) Handle an fov event and choose what to do next.
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 .
boolean	shouldBeRemoved() This method is called after EventDetector.eventOccurred(org.orekit.propagation.SpacecraftState, boolean, boolean) has been triggered.

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

getMaxCheckInterval, getMaxIterationCount, getSlopeSelection, getThreshold, init, resetState

Methods inherited from class java.lang.Object

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

Constructor Detail

DihedralFieldOfViewDetector

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

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.

The default implementation behavior is to continue propagation at entry and to stop propagation at exit.

Parameters:

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

maxCheck - maximal interval in seconds

Throws:

OrekitException - if vectors center and axis1 or center and axis2 are not strictly orthogonal

DihedralFieldOfViewDetector

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

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.

The default implementation behavior is to continue propagation at entry and to stop propagation at exit.

Parameters:

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

maxCheck - maximal interval in seconds

epsilon - threshold determining if vectors are orthogonal or not

Throws:

OrekitException - if vectors center and axis1 or center and axis2 are not orthogonal regarding epsilon

DihedralFieldOfViewDetector

public DihedralFieldOfViewDetector(PVCoordinatesProvider pvTarget,
                                   Vector3D center,
                                   Vector3D axis1,
                                   double halfAperture1,
                                   Vector3D axis2,
                                   double halfAperture2,
                                   double maxCheck,
                                   EventDetector.Action entry,
                                   EventDetector.Action exit)
                            throws OrekitException

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:

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

maxCheck - maximal interval in seconds

entry - action performed at fov entry

exit - action performed at fov exit

Throws:

OrekitException - if vectors center and axis1 or center and axis2 are not strictly orthogonal

DihedralFieldOfViewDetector

public DihedralFieldOfViewDetector(PVCoordinatesProvider pvTarget,
                                   Vector3D center,
                                   Vector3D axis1,
                                   double halfAperture1,
                                   Vector3D axis2,
                                   double halfAperture2,
                                   double maxCheck,
                                   EventDetector.Action entry,
                                   EventDetector.Action exit,
                                   boolean removeEntry,
                                   boolean removeExit)
                            throws OrekitException

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:

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

maxCheck - maximal interval in seconds

entry - action performed at fov entry

exit - action performed at fov exit

removeEntry - true if detector should be removed at fov entry

removeExit - true if detector should be removed at fov exit

Throws:

OrekitException - if vectors center and axis1 or center and axis2 are not strictly orthogonal

Since:

3.1

DihedralFieldOfViewDetector

public DihedralFieldOfViewDetector(PVCoordinatesProvider pvTarget,
                                   Vector3D center,
                                   Vector3D axis1,
                                   double halfAperture1,
                                   Vector3D axis2,
                                   double halfAperture2,
                                   double maxCheck,
                                   EventDetector.Action entry,
                                   EventDetector.Action exit,
                                   double epsilon)
                            throws OrekitException

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:

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

maxCheck - maximal interval in seconds

entry - action performed at fov entry

exit - action performed at fov exit

epsilon - threshold determining if vectors are orthogonal or not

Throws:

OrekitException - if vectors center and axis1 or center and axis2 are not orthogonal regarding epsilon

DihedralFieldOfViewDetector

public DihedralFieldOfViewDetector(PVCoordinatesProvider pvTarget,
                                   Vector3D center,
                                   Vector3D axis1,
                                   double halfAperture1,
                                   Vector3D axis2,
                                   double halfAperture2,
                                   double maxCheck,
                                   EventDetector.Action entry,
                                   EventDetector.Action exit,
                                   boolean removeEntry,
                                   boolean removeExit,
                                   double epsilon)
                            throws OrekitException

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:

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

maxCheck - maximal interval in seconds

entry - action performed at fov entry

exit - action performed at fov exit

removeEntry - true if detector should be removed at fov entry

removeExit - true if detector should be removed at fov exit

epsilon - threshold determining if vectors are orthogonal or not

Throws:

OrekitException - if vectors center and axis1 or center and axis2 are not orthogonal regarding epsilon

Method Detail

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

eventOccurred

public EventDetector.Action eventOccurred(SpacecraftState s,
                                          boolean increasing,
                                          boolean forward)
                                   throws OrekitException

Handle an fov event and choose what to do next.

The default implementation behavior is to continue propagation at entry and to stop propagation at exit. This can be changed by overriding the eventOccurred method in a derived class.

Specified by:

eventOccurred in interface EventDetector

Specified by:

eventOccurred in class AbstractDetector

Parameters:

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

increasing - if true, the value of the switching function increases when times increases around event, i.e. target enters the fov (note that increase is measured with respect to physical time, not with respect to propagation which may go backward in time)

forward - if true, the integration variable (time) increases during integration.

Returns:

the action performed at fov entry or exit.

Throws:

OrekitException - if some specific error occurs

shouldBeRemoved

public boolean shouldBeRemoved()

This method is called after EventDetector.eventOccurred(org.orekit.propagation.SpacecraftState, boolean, boolean) has been triggered. It returns true if the current detector should be removed after first event detection. WARNING: this method can be called only once a event has been triggered. Before, the value is not available.

Specified by:

shouldBeRemoved in interface EventDetector

Specified by:

shouldBeRemoved in class AbstractDetector

Returns:

true if the current detector should be removed after first event detection

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

Parameters:

s - the current state information: date, kinematics, attitude for forces and events computation, mass provider, and additional states

Returns:

value of the switching function

Throws:

OrekitException - if some specific error occurs