fr.cnes.sirius.patrius.events.detectors

Class AbstractStationToSatDetector

java.lang.Object

fr.cnes.sirius.patrius.events.AbstractDetector

fr.cnes.sirius.patrius.events.detectors.AbstractSignalPropagationDetector

fr.cnes.sirius.patrius.events.detectors.AbstractStationToSatDetector

All Implemented Interfaces:

EventDetector, Serializable

Direct Known Subclasses:

StationToSatMutualVisibilityDetector, VisibilityFromStationDetector

public abstract class AbstractStationToSatDetector
extends AbstractSignalPropagationDetector

Abstract event detector using a station elevation correction.

Since:

1.2

Version:

$Id$

Author:

Thomas Trapier

See Also:

Serialized Form

Concurrency :

not thread-safe

Concurrency comment :

The use of frames makes this class not thread-safe.

Nested Class Summary

Nested classes/interfaces inherited from class fr.cnes.sirius.patrius.events.detectors.AbstractSignalPropagationDetector

AbstractSignalPropagationDetector.EventDatationType, AbstractSignalPropagationDetector.PropagationDelayType

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

EventDetector.Action

Field Summary

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

actionAtEntry, actionAtExit, DEFAULT_MAXCHECK, DEFAULT_MAXITER, DEFAULT_THRESHOLD, removeAtEntry, removeAtExit, shouldBeRemovedFlag

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

DECREASING, INCREASING, INCREASING_DECREASING

Constructor Summary

Constructors

Modifier

Constructor and Description

protected

AbstractStationToSatDetector(GeometricStationAntenna stationModel, AngularCorrection correctionModel, SensorModel sensorModel, boolean withMasking, double maxCheck, double threshold, EventDetector.Action entry, EventDetector.Action exit, boolean removeEntry, boolean removeExit, int slopeSelection, VisibilityFromStationDetector.LinkType linkTypeIn) Constructor for the abstract event detector using a station elevation correction.

Method Summary

Modifier and Type	Method and Description
double	g(SpacecraftState state) Compute the value of the switching function.
Assembly	getAssembly() Get the assembly.
protected Vector3D	getCorrectedVector(SpacecraftState s) Compute the apparent vector from the station to the spacecraft with tropospheric effects.
AngularCorrection	getCorrection() Get the correction.
VisibilityFromStationDetector.LinkType	getLinkType() Returns the type of link (it can be uplink or downlink).
protected double	getMinMaskingDistance(SpacecraftState s, SensorModel model, AbsoluteDate stationDate) Computes minimum masking distance by either body or spacecraft defined in sensor model.
SensorModel	getSensor() Get the sensor.
GeometricStationAntenna	getStation() Get the station.
boolean	isMaskingCheck() True if masking are taken into account.

Methods inherited from class fr.cnes.sirius.patrius.events.detectors.AbstractSignalPropagationDetector

getEmitter, getEpsilonSignalPropagation, getEventDatationType, getInertialFrame, getLinkTypeHandler, getMaxIterSignalPropagation, getOtherDate, getPropagationDelayType, getReceiver, getSignalEmissionDate, getSignalEmissionDate, getSignalReceptionDate, getSignalReceptionDate, setEpsilonSignalPropagation, setMaxIterSignalPropagation, setPropagationDelayType

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

eventOccurred, filterEvent, getActionAtEntry, getActionAtExit, getMaxCheckInterval, getMaxIterationCount, getSlopeSelection, getThreshold, init, isRemoveAtEntry, isRemoveAtExit, logEventsOverTimeInterval, resetState, setMaxCheckInterval, setMaxIter, shouldBeRemoved

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.cnes.sirius.patrius.events.EventDetector

copy

Constructor Detail

AbstractStationToSatDetector

protected AbstractStationToSatDetector(GeometricStationAntenna stationModel,
                                       AngularCorrection correctionModel,
                                       SensorModel sensorModel,
                                       boolean withMasking,
                                       double maxCheck,
                                       double threshold,
                                       EventDetector.Action entry,
                                       EventDetector.Action exit,
                                       boolean removeEntry,
                                       boolean removeExit,
                                       int slopeSelection,
                                       VisibilityFromStationDetector.LinkType linkTypeIn)

Constructor for the abstract event detector using a station elevation 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 geometric model of the ground station antenna

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

sensorModel - sensor model of the spacecraft used for masking computations (not used otherwise, can be set to null). The sensor model of the main part frame of the assembly must have a parent frame! Make sure that the main target of this sensor model is the above station!

withMasking - set true to compute maskings of spacecraft's sensor by occulting bodies: in this case, there is no visibility if one of the masking bodies of the sensor is between the spacecraft and the station

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

entry - action performed when entering the visibility zone

exit - action performed when exiting the visibility zone

removeEntry - true if detector should be removed when entering the visibility zone

removeExit - true if detector should be removed when exiting the visibility zone

slopeSelection - slope selection

linkTypeIn - the type of link (it can be uplink or downlink)

Method Detail

g

public double g(SpacecraftState state)
         throws PatriusException

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.

Visibility from station only.

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

More calculations are performed in case masking check is asked for: the distance between spacecraft's sensor line of sight and the occulting object is computed. This distance is positive if no masking occurs, negative otherwise.

Specified by:

g in interface EventDetector

Specified by:

g in class AbstractDetector

Parameters:

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

Returns:

value of the switching function

Throws:

PatriusException - if some specific error occurs

getCorrectedVector

protected Vector3D getCorrectedVector(SpacecraftState s)
                               throws PatriusException

Compute the apparent vector from the station to the spacecraft with tropospheric effects.

Parameters:

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

Returns:

the apparent vector from the station to the spacecraft with tropospheric effects

Throws:

PatriusException - if some specific error occurs

getMinMaskingDistance

protected double getMinMaskingDistance(SpacecraftState s,
                                       SensorModel model,
                                       AbsoluteDate stationDate)
                                throws PatriusException

Computes minimum masking distance by either body or spacecraft defined in sensor model.

Parameters:

s - spacecraft state

model - spacecraft sensor model

stationDate - station date

Returns:

minimum masking distance by either body or spacecraft defined in sensor model

Throws:

PatriusException - thrown if computation failed

getStation

public GeometricStationAntenna getStation()

Get the station.

Returns:

the station antenna geometric model

getCorrection

public AngularCorrection getCorrection()

Get the correction.

Returns:

the correction

getLinkType

public VisibilityFromStationDetector.LinkType getLinkType()

Returns the type of link (it can be uplink or downlink).

Returns:

the type of link (it can be uplink or downlink)

getSensor

public SensorModel getSensor()

Get the sensor.

Returns:

the sensor

getAssembly

public Assembly getAssembly()

Get the assembly.

Returns:

the assembly

isMaskingCheck

public boolean isMaskingCheck()

True if masking are taken into account.

Returns:

true if masking are taken into account, false otherwise