Package org.orekit.propagation.events

Class FieldElevationDetector<T extends CalculusFieldElement<T>>

java.lang.Object

org.orekit.propagation.events.FieldAbstractDetector<FieldElevationDetector<T>,T>

org.orekit.propagation.events.FieldElevationDetector<T>

Type Parameters:

T - type of the field elements

All Implemented Interfaces:

FieldEventDetector<T>

public class FieldElevationDetector<T extends CalculusFieldElement<T>>
extends FieldAbstractDetector<FieldElevationDetector<T>,T>

Finder for satellite raising/setting events that allows for the setting of azimuth and/or elevation bounds or a ground azimuth/elevation mask input. Each calculation be configured to use atmospheric refraction as well.

The default implementation behavior is to continue propagation at raising and to stop propagation at setting. This can be changed by calling FieldAbstractDetector.withHandler(FieldEventHandler) after construction.

Author:

Hank Grabowski

Field Summary

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

DEFAULT_MAX_ITER, DEFAULT_MAXCHECK, DEFAULT_THRESHOLD

Constructor Summary

Constructors

Modifier	Constructor	Description
	FieldElevationDetector(Field<T> field, TopocentricFrame topo)	Creates an instance of Elevation detector based on passed in topocentric frame and the minimum elevation angle.
protected	FieldElevationDetector(FieldAdaptableInterval<T> maxCheck, T threshold, int maxIter, FieldEventHandler<T> handler, double minElevation, ElevationMask mask, AtmosphericRefractionModel refractionModel, TopocentricFrame topo)	Deprecated. as of 12.2
protected	FieldElevationDetector(FieldEventDetectionSettings<T> detectionSettings, FieldEventHandler<T> handler, double minElevation, ElevationMask mask, AtmosphericRefractionModel refractionModel, TopocentricFrame topo)	Protected constructor with full parameters.
	FieldElevationDetector(T maxCheck, T threshold, TopocentricFrame topo)	Creates an instance of Elevation detector based on passed in topocentric frame and overrides of default maximal checking interval and convergence threshold values.

Method Summary

Modifier and Type	Method	Description
protected FieldElevationDetector<T>	create(FieldAdaptableInterval<T> newMaxCheck, T newThreshold, int newMaxIter, FieldEventHandler<T> newHandler)	Build a new instance.
T	g(FieldSpacecraftState<T> s)	Compute the value of the switching function.
ElevationMask	getElevationMask()	Returns the currently configured elevation mask.
double	getMinElevation()	Returns the currently configured minimum valid elevation value.
AtmosphericRefractionModel	getRefractionModel()	Returns the currently configured refraction model.
TopocentricFrame	getTopocentricFrame()	Returns the currently configured topocentric frame definitions.
FieldElevationDetector<T>	withConstantElevation(double newMinElevation)	Setup the minimum elevation for detection.
FieldElevationDetector<T>	withElevationMask(ElevationMask newElevationMask)	Setup the elevation mask for detection using the passed in mask object.
FieldElevationDetector<T>	withRefraction(AtmosphericRefractionModel newRefractionModel)	Setup the elevation detector to use an atmospheric refraction model in its calculations.

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

create, getDetectionSettings, getHandler, getMaxCheckInterval, getMaxIterationCount, getThreshold, init, isForward, withDetectionSettings, withHandler, withMaxCheck, withMaxCheck, withMaxIter, withThreshold

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.orekit.propagation.events.FieldEventDetector

finish

Constructor Detail

FieldElevationDetector

public FieldElevationDetector(Field<T> field,
                              TopocentricFrame topo)

Creates an instance of Elevation detector based on passed in topocentric frame and the minimum elevation angle.

uses default values for maximal checking interval (FieldAbstractDetector.DEFAULT_MAXCHECK) and convergence threshold (FieldAbstractDetector.DEFAULT_THRESHOLD).

Parameters:

field - type of the elements

topo - reference to a topocentric model

See Also:

withConstantElevation(double), withElevationMask(ElevationMask), withRefraction(AtmosphericRefractionModel)

FieldElevationDetector

public FieldElevationDetector(T maxCheck,
                              T threshold,
                              TopocentricFrame topo)

Creates an instance of Elevation detector based on passed in topocentric frame and overrides of default maximal checking interval and convergence threshold values.

Parameters:

maxCheck - maximum checking interval (s)

threshold - maximum divergence threshold (s)

topo - reference to a topocentric model

See Also:

withConstantElevation(double), withElevationMask(ElevationMask), withRefraction(AtmosphericRefractionModel)

FieldElevationDetector

protected FieldElevationDetector(FieldEventDetectionSettings<T> detectionSettings,
                                 FieldEventHandler<T> handler,
                                 double minElevation,
                                 ElevationMask mask,
                                 AtmosphericRefractionModel refractionModel,
                                 TopocentricFrame topo)

Protected constructor with full parameters.

This constructor is not public as users are expected to use the builder API with the various withXxx() methods to set up the instance in a readable manner without using a huge amount of parameters.

Parameters:

detectionSettings - detection settings

handler - event handler to call at event occurrences

minElevation - minimum elevation in radians (rad)

mask - reference to elevation mask

refractionModel - reference to refraction model

topo - reference to a topocentric model

Since:

12.2

FieldElevationDetector

@Deprecated
protected FieldElevationDetector(FieldAdaptableInterval<T> maxCheck,
                                 T threshold,
                                 int maxIter,
                                 FieldEventHandler<T> handler,
                                 double minElevation,
                                 ElevationMask mask,
                                 AtmosphericRefractionModel refractionModel,
                                 TopocentricFrame topo)

Deprecated.

as of 12.2

Protected constructor with full parameters.

This constructor is not public as users are expected to use the builder API with the various withXxx() methods to set up the instance in a readable manner without using a huge amount of parameters.

Parameters:

maxCheck - maximum checking interval

threshold - convergence threshold (s)

maxIter - maximum number of iterations in the event time search

handler - event handler to call at event occurrences

minElevation - minimum elevation in radians (rad)

mask - reference to elevation mask

refractionModel - reference to refraction model

topo - reference to a topocentric model

Method Detail

create

protected FieldElevationDetector<T> create(FieldAdaptableInterval<T> newMaxCheck,
                                           T newThreshold,
                                           int newMaxIter,
                                           FieldEventHandler<T> newHandler)

Build a new instance.

Specified by:

create in class FieldAbstractDetector<FieldElevationDetector<T extends CalculusFieldElement<T>>,T extends CalculusFieldElement<T>>

Parameters:

newMaxCheck - maximum checking interval

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

getElevationMask

public ElevationMask getElevationMask()

Returns the currently configured elevation mask.

Returns:

elevation mask (null if instance has been configured with withConstantElevation(double)

See Also:

withElevationMask(ElevationMask)

getMinElevation

public double getMinElevation()

Returns the currently configured minimum valid elevation value.

Returns:

minimum elevation value (Double.NaN if instance has been configured with withElevationMask(ElevationMask)

See Also:

withConstantElevation(double)

getRefractionModel

public AtmosphericRefractionModel getRefractionModel()

Returns the currently configured refraction model.

Returns:

refraction model

See Also:

withRefraction(AtmosphericRefractionModel)

getTopocentricFrame

public TopocentricFrame getTopocentricFrame()

Returns the currently configured topocentric frame definitions.

Returns:

topocentric frame definition

g

public T g(FieldSpacecraftState<T> s)

Compute the value of the switching function. This function measures the difference between the current elevation (and azimuth if necessary) and the reference mask or minimum value.

Parameters:

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

Returns:

value of the switching function

withConstantElevation

public FieldElevationDetector<T> withConstantElevation(double newMinElevation)

Setup the minimum elevation for detection.

This will override an elevation mask if it has been configured as such previously.

Parameters:

newMinElevation - minimum elevation for visibility in radians (rad)

Returns:

a new detector with updated configuration (the instance is not changed)

Since:

6.1

See Also:

getMinElevation()

withElevationMask

public FieldElevationDetector<T> withElevationMask(ElevationMask newElevationMask)

Setup the elevation mask for detection using the passed in mask object.

Parameters:

newElevationMask - elevation mask to use for the computation

Returns:

a new detector with updated configuration (the instance is not changed)

Since:

6.1

See Also:

getElevationMask()

withRefraction

public FieldElevationDetector<T> withRefraction(AtmosphericRefractionModel newRefractionModel)

Setup the elevation detector to use an atmospheric refraction model in its calculations.

To disable the refraction when copying an existing elevation detector, call this method with a null argument.

Parameters:

newRefractionModel - refraction model to use for the computation

Returns:

a new detector with updated configuration (the instance is not changed)

Since:

6.1

See Also:

getRefractionModel()