fr.cnes.sirius.patrius.forces.radiation

Class LightingRatio

java.lang.Object

fr.cnes.sirius.patrius.forces.radiation.LightingRatio

All Implemented Interfaces:

Serializable

public class LightingRatio
extends Object
implements Serializable

Class computing the lighting ratio in the interval [0; 1], used for EclipseDetector and SolarRadiationPressure:

• 0: occulted body is entirely hidden by occulting body
• 1: occulted body is fully visible from object.
• Between 0 and 1: occulted body is partly visible from object.

The lighting ratio is the percentage of occulted body visible from spacecraft.

Signal propagation can be taken into account.

Computation hypothesis:

• Occulted body is spherical
• Occulting body can have any shape, but computation is made using a sphere of radius the "apparent occulting radius" which is the angular radius of the occulting body in the direction of occulted body.

Since:

4.13

Author:

Emmanuel Bignon

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LightingRatio(BodyShape occultingBody, PVCoordinatesProvider occultedBody, double occultedRadius) Constructor.

Method Summary

Modifier and Type	Method and Description
double	compute(PVCoordinatesProvider pv, AbsoluteDate date) Compute lighting ratio.
double	computeExtended(PVCoordinatesProvider pv, AbsoluteDate date) Compute extended lighting ratio.
double	getEpsilonSignalPropagation() Getter for the epsilon for signal propagation when signal propagation is taken into account.
Frame	getInertialFrame() Getter for the inertial frame used for signal propagation computation.
int	getMaxIterSignalPropagation() Getter for the maximum number of iterations for signal propagation when signal propagation is taken into account.
AbstractSignalPropagationDetector.PropagationDelayType	getPropagationDelayType() Getter for the propagation delay type.
void	setEpsilonSignalPropagation(double epsilon) Setter for the epsilon for signal propagation when signal propagation is taken into account. This epsilon (in s) directly reflect the accuracy of signal propagation (1s of accuracy = 3E8m of accuracy on distance between emitter and receiver)
void	setMaxIterSignalPropagation(int maxIterSignalPropagationIn) Setter for the maximum number of iterations for signal propagation when signal propagation is taken into account.
void	setPropagationDelayType(AbstractSignalPropagationDetector.PropagationDelayType propagationDelayTypeIn, Frame frameIn) Setter for the propagation delay computation type.

Methods inherited from class java.lang.Object

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

Constructor Detail

LightingRatio

public LightingRatio(BodyShape occultingBody,
                     PVCoordinatesProvider occultedBody,
                     double occultedRadius)

Constructor.

Parameters:

occultingBody - occulting body

occultedBody - occulted body PV

occultedRadius - occulted body radius

Method Detail

compute

public double compute(PVCoordinatesProvider pv,
                      AbsoluteDate date)
               throws PatriusException

Compute lighting ratio.

• 0: occulted body is entirely hidden by occulting body
• 1: occulted body is fully visible from object.
• Between 0 and 1: occulted body is partly visible from object.

Parameters:

pv - pv of spacecraft

date - spacecraft date

Returns:

lighting ratio in [0; 1]

Throws:

PatriusException - thrown if computation failed

computeExtended

public double computeExtended(PVCoordinatesProvider pv,
                              AbsoluteDate date)
                       throws PatriusException

Compute extended lighting ratio.

• Smaller than 0: occulted body is entirely hidden by occulting body. Lighting ratio set to angle to start partial eclipse from total eclipse (negative value).
• larger than 1: occulted body is fully visible from object. Lighting ratio set 1 + angle to start partial eclipse from no eclipse.
• Between 0 and 1: occulted body is partly visible from object.

Parameters:

pv - pv of spacecraft

date - spacecraft date

Returns:

lighting ratio in [0; 1]

Throws:

PatriusException - thrown if computation failed

getPropagationDelayType

public AbstractSignalPropagationDetector.PropagationDelayType getPropagationDelayType()

Getter for the propagation delay type.

Returns:

the propagation delay type

setPropagationDelayType

public void setPropagationDelayType(AbstractSignalPropagationDetector.PropagationDelayType propagationDelayTypeIn,
                                    Frame frameIn)

Setter for the propagation delay computation type. Warning: check Javadoc of detector to see if detector takes into account propagation time delay. if not, signals are always considered instantaneous. The provided frame is used to compute the signal propagation when delay is taken into account.

Parameters:

propagationDelayTypeIn - Propagation delay type used in events computation

frameIn - Frame to use for signal propagation with delay (may be null if propagation delay type is considered instantaneous). Warning: the usage of a pseudo inertial frame is tolerated, however it will lead to some inaccuracies due to the non-invariance of the frame with respect to time. For this reason, it is suggested to use the ICRF frame or a frame which is frozen with respect to the ICRF.

Throws:

IllegalArgumentException - if the provided frame is not pseudo inertial.

getInertialFrame

public Frame getInertialFrame()

Getter for the inertial frame used for signal propagation computation.

Returns:

the inertial frame

getEpsilonSignalPropagation

public double getEpsilonSignalPropagation()

Getter for the epsilon for signal propagation when signal propagation is taken into account.

Returns:

the epsilon for signal propagation when signal propagation is taken into account

setEpsilonSignalPropagation

public void setEpsilonSignalPropagation(double epsilon)

Setter for the epsilon for signal propagation when signal propagation is taken into account.
This epsilon (in s) directly reflect the accuracy of signal propagation (1s of accuracy = 3E8m of accuracy on distance between emitter and receiver)

Parameters:

epsilon - Epsilon for the signal propagation

getMaxIterSignalPropagation

public int getMaxIterSignalPropagation()

Getter for the maximum number of iterations for signal propagation when signal propagation is taken into account.

Returns:

the maximum number of iterations for signal propagation

setMaxIterSignalPropagation

public void setMaxIterSignalPropagation(int maxIterSignalPropagationIn)

Setter for the maximum number of iterations for signal propagation when signal propagation is taken into account.

Parameters:

maxIterSignalPropagationIn - Maximum number of iterations for signal propagation