fr.cnes.sirius.patrius.events.sensor

Class VisibilityFromStationDetector

java.lang.Object

fr.cnes.sirius.patrius.propagation.events.AbstractDetector

fr.cnes.sirius.patrius.events.sensor.AbstractDetectorWithTropoCorrection

fr.cnes.sirius.patrius.events.sensor.VisibilityFromStationDetector

All Implemented Interfaces:

EventDetector, Serializable

public class VisibilityFromStationDetector
extends AbstractDetectorWithTropoCorrection

Finder for satellite apparent entering in a station's field of view.

The tropospheric correction used can be set by the user.

The default implementation behavior is to continue propagation at raising and to stop propagation at setting. This can be changed by using one of the provided constructors.

Since:

1.1

Version:

$Id$

Author:

Thomas Trapier

See Also:

TroposphericCorrection, EventDetector, GeometricStationAntenna, Serialized Form

Concurrency :

not thread-safe

Concurrency comment :

the direct use of a not thread-safe Assembly makes this class not thread-safe itself

Nested Class Summary

Nested classes/interfaces inherited from interface fr.cnes.sirius.patrius.propagation.events.EventDetector

EventDetector.Action

Field Summary

Fields

Modifier and Type	Field and Description
static int	RAISING Flag for raising detection (slopeSelection = 0).
static int	RAISING_SETTING Flag for raising/setting detection (slopeSelection = 2).
static int	SETTING Flag for setting detection (slopeSelection = 1).

Fields inherited from class fr.cnes.sirius.patrius.propagation.events.AbstractDetector

DEFAULT_MAXCHECK, DEFAULT_THRESHOLD

Fields inherited from interface fr.cnes.sirius.patrius.propagation.events.EventDetector

DECREASING, INCREASING, INCREASING_DECREASING

Constructor Summary

Constructors

Constructor and Description
VisibilityFromStationDetector(GeometricStationAntenna stationModel, AngularCorrection correctionModel, double maxCheck, double threshold) Build a new apparent elevation detector with parameterizable tropospheric correction.
VisibilityFromStationDetector(GeometricStationAntenna stationModel, AngularCorrection correctionModel, double maxCheck, double threshold, EventDetector.Action raising, EventDetector.Action setting) Build a new apparent elevation detector with parameterizable tropospheric correction.
VisibilityFromStationDetector(GeometricStationAntenna stationModel, AngularCorrection correctionModel, double maxCheck, double threshold, EventDetector.Action raising, EventDetector.Action setting, boolean removeRaising, boolean removeSetting) Build a new apparent elevation detector with parameterizable tropospheric correction.
VisibilityFromStationDetector(GeometricStationAntenna stationModel, AngularCorrection correctionModel, int slopeSelection, double maxCheck, double threshold, EventDetector.Action action, boolean remove) Build a new apparent elevation detector with parameterizable tropospheric correction.
VisibilityFromStationDetector(TopocentricFrame topoFrame, double[][] azimElevMask, AngularCorrection correctionModel, double maxCheck, double threshold) Build a new apparent elevation detector with parameterizable tropospheric correction.
VisibilityFromStationDetector(TopocentricFrame topoFrame, double[][] azimElevMask, AngularCorrection correctionModel, double maxCheck, double threshold, EventDetector.Action raising, EventDetector.Action setting) Build a new apparent elevation detector with parameterizable tropospheric correction.
VisibilityFromStationDetector(TopocentricFrame topoFrame, double[][] azimElevMask, AngularCorrection correctionModel, double maxCheck, double threshold, EventDetector.Action raising, EventDetector.Action setting, boolean removeRaising, boolean removeSetting) Build a new apparent elevation detector with parameterizable tropospheric correction.

Method Summary

Modifier and Type	Method and Description
EventDetector	copy() A copy of the detector.
EventDetector.Action	eventOccurred(SpacecraftState s, boolean increasing, boolean forward) Handle "visibility from station" event and choose what to do next.
double	g(SpacecraftState s) Compute the value of the switching function.
EventDetector.Action	getActionAtRaising() Returns action at raising detection.
EventDetector.Action	getActionAtSetting() Returns action at setting detection.
BodyShape	getBodyShape() Getter for the Earth shape.
GeodeticPoint	getStationGeodeticPoint() Getter for the station geodetic point.
void	init(SpacecraftState s0, AbsoluteDate t) Initialize event handler at the start of a propagation.
boolean	removeAtRaising() Returns true if detection is removed after raising detection.
boolean	removeAtSetting() Returns true if detection is removed after setting detection.
boolean	shouldBeRemoved() This method is called after EventDetector.eventOccurred(fr.cnes.sirius.patrius.propagation.SpacecraftState, boolean, boolean) has been triggered.

Methods inherited from class fr.cnes.sirius.patrius.events.sensor.AbstractDetectorWithTropoCorrection

getCorrectedVector, getCorrection, getStation

Methods inherited from class fr.cnes.sirius.patrius.propagation.events.AbstractDetector

getMaxCheckInterval, getMaxIterationCount, getSlopeSelection, getThreshold, resetState

Methods inherited from class java.lang.Object

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

Field Detail

RAISING

public static final int RAISING

Flag for raising detection (slopeSelection = 0).

See Also:

Constant Field Values

SETTING

public static final int SETTING

Flag for setting detection (slopeSelection = 1).

See Also:

Constant Field Values

RAISING_SETTING

public static final int RAISING_SETTING

Flag for raising/setting detection (slopeSelection = 2).

See Also:

Constant Field Values

Constructor Detail

VisibilityFromStationDetector

public VisibilityFromStationDetector(TopocentricFrame topoFrame,
                                     double[][] azimElevMask,
                                     AngularCorrection correctionModel,
                                     double maxCheck,
                                     double threshold)

Build a new apparent elevation detector with parameterizable tropospheric correction.

The maximal interval between elevation 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 raising and to stop propagation at setting.

Parameters:

topoFrame - the station's topocentric frame

azimElevMask - azimElevMask the azimuth - elevation mask (rad)

correctionModel - the elevation correction model for the station (set null to ignore tropospheric correction)

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

VisibilityFromStationDetector

public VisibilityFromStationDetector(TopocentricFrame topoFrame,
                                     double[][] azimElevMask,
                                     AngularCorrection correctionModel,
                                     double maxCheck,
                                     double threshold,
                                     EventDetector.Action raising,
                                     EventDetector.Action setting)

Build a new apparent elevation detector with parameterizable tropospheric correction.

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

Parameters:

topoFrame - the station's topocentric frame

azimElevMask - azimElevMask the azimuth - elevation mask (rad)

correctionModel - the elevation correction model for the station (set null to ignore tropospheric correction)

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

raising - action performed when propagation at raising

setting - action performed when propagation at setting

VisibilityFromStationDetector

public VisibilityFromStationDetector(TopocentricFrame topoFrame,
                                     double[][] azimElevMask,
                                     AngularCorrection correctionModel,
                                     double maxCheck,
                                     double threshold,
                                     EventDetector.Action raising,
                                     EventDetector.Action setting,
                                     boolean removeRaising,
                                     boolean removeSetting)

Build a new apparent elevation detector with parameterizable tropospheric correction.

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

Parameters:

topoFrame - the station's topocentric frame

azimElevMask - azimElevMask the azimuth - elevation mask (rad)

correctionModel - the elevation correction model for the station (set null to ignore tropospheric correction)

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

raising - action performed when propagation at raising

setting - action performed when propagation at setting

removeRaising - true if detector should be removed at raising

removeSetting - true if detector should be removed at setting

VisibilityFromStationDetector

public VisibilityFromStationDetector(GeometricStationAntenna stationModel,
                                     AngularCorrection correctionModel,
                                     double maxCheck,
                                     double threshold)

Build a new apparent elevation detector with parameterizable tropospheric correction.

The maximal interval between elevation 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 raising and to stop propagation at setting.

Parameters:

stationModel - the station sensor geometric model

correctionModel - the elevation correction model for the station (set null to ignore tropospheric correction)

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

VisibilityFromStationDetector

public VisibilityFromStationDetector(GeometricStationAntenna stationModel,
                                     AngularCorrection correctionModel,
                                     double maxCheck,
                                     double threshold,
                                     EventDetector.Action raising,
                                     EventDetector.Action setting)

Build a new apparent elevation detector with parameterizable tropospheric correction.

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

Parameters:

stationModel - the station sensor geometric model

correctionModel - the elevation correction model for the station (set null to ignore tropospheric correction)

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

raising - action performed when propagation at raising

setting - action performed when propagation at setting

VisibilityFromStationDetector

public VisibilityFromStationDetector(GeometricStationAntenna stationModel,
                                     AngularCorrection correctionModel,
                                     double maxCheck,
                                     double threshold,
                                     EventDetector.Action raising,
                                     EventDetector.Action setting,
                                     boolean removeRaising,
                                     boolean removeSetting)

Build a new apparent elevation detector with parameterizable tropospheric correction.

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

Parameters:

stationModel - the station sensor geometric model

correctionModel - the elevation correction model for the station (set null to ignore tropospheric correction)

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

raising - action performed when propagation at raising

setting - action performed when propagation at setting

removeRaising - true if detector should be removed at raising

removeSetting - true if detector should be removed at setting

VisibilityFromStationDetector

public VisibilityFromStationDetector(GeometricStationAntenna stationModel,
                                     AngularCorrection correctionModel,
                                     int slopeSelection,
                                     double maxCheck,
                                     double threshold,
                                     EventDetector.Action action,
                                     boolean remove)

Build a new apparent elevation detector with parameterizable tropospheric correction.

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

Parameters:

stationModel - the station sensor geometric model

correctionModel - the elevation correction model for the station (set null to ignore tropospheric correction)

slopeSelection - slope selection

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

action - action performed when propagation at raising/setting depending on slope selection

remove - true if detector should be removed at raising/setting depending on slope selection

Method Detail

init

public void init(SpacecraftState s0,
                 AbsoluteDate t)

Initialize event handler at the start of a propagation.

This method is called once at the start of the propagation. It may be used by the event handler to initialize some internal data if needed.

Specified by:

init in interface EventDetector

Overrides:

init in class AbstractDetector

Parameters:

s0 - initial state

t - target time for the integration

eventOccurred

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

Handle "visibility from station" event and choose what to do next.

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.

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

Returns:

the action performed when propagation raising or setting.

Throws:

PatriusException - if some specific error occurs

shouldBeRemoved

public boolean shouldBeRemoved()

This method is called after EventDetector.eventOccurred(fr.cnes.sirius.patrius.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 PatriusException

Compute the value of the switching function.

This function measures the angular distance between the current apparent vector to the spacecraft and the border of the station's field of view. It is positive when the spacecraft is in the field

Specified by:

g in interface EventDetector

Specified by:

g in class AbstractDetector

Parameters:

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

Returns:

value of the switching function

Throws:

PatriusException - if some specific error occurs

copy

public EventDetector copy()

A copy of the detector. By default copy is deep. If not, detector javadoc will specify which attribute is not fully copied. In that case, the attribute reference is passed.

The following attributes are not deeply copied:

• correction: AngularCorrection
• station: GeometricStationAntenna

Returns:

a copy of the detector.

getStationGeodeticPoint

public GeodeticPoint getStationGeodeticPoint()

Getter for the station geodetic point.

Returns:

the station geodetic point.

getBodyShape

public BodyShape getBodyShape()

Getter for the Earth shape.

Returns:

the Earth shape.

getActionAtRaising

public EventDetector.Action getActionAtRaising()

Returns action at raising detection.

Returns:

action at raising detection

getActionAtSetting

public EventDetector.Action getActionAtSetting()

Returns action at setting detection.

Returns:

action at setting detection

removeAtRaising

public boolean removeAtRaising()

Returns true if detection is removed after raising detection.

Returns:

true if detection is removed after raising detection

removeAtSetting

public boolean removeAtSetting()

Returns true if detection is removed after setting detection.

Returns:

true if detection is removed after setting detection