Class YawCompensation
- java.lang.Object
-
- org.orekit.attitudes.GroundPointing
-
- org.orekit.attitudes.YawCompensation
-
- All Implemented Interfaces:
AttitudeProvider
,AttitudeProviderModifier
public class YawCompensation extends GroundPointing implements AttitudeProviderModifier
This class handles yaw compensation attitude provider.Yaw compensation is mainly used for Earth observation satellites. As a satellites moves along its track, the image of ground points move on the focal point of the optical sensor. This motion is a combination of the satellite motion, but also on the Earth rotation and on the current attitude (in particular if the pointing includes Roll or Pitch offset). In order to reduce geometrical distortion, the yaw angle is changed a little from the simple ground pointing attitude such that the apparent motion of ground points is along a prescribed axis (orthogonal to the optical sensors rows), taking into account all effects.
This attitude is implemented as a wrapper on top of an underlying ground pointing law that defines the roll and pitch angles.
Instances of this class are guaranteed to be immutable.
- Author:
- Véronique Pommier-Maurussane
- See Also:
GroundPointing
-
-
Constructor Summary
Constructors Constructor Description YawCompensation(Frame inertialFrame, GroundPointing groundPointingLaw)
Creates a new instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description <T extends CalculusFieldElement<T>>
FieldAttitude<T>getAttitude(FieldPVCoordinatesProvider<T> pvProv, FieldAbsoluteDate<T> date, Frame frame)
Compute the attitude corresponding to an orbital state.Attitude
getAttitude(PVCoordinatesProvider pvProv, AbsoluteDate date, Frame frame)
Compute the attitude corresponding to an orbital state.<T extends CalculusFieldElement<T>>
FieldAttitude<T>getBaseState(FieldPVCoordinatesProvider<T> pvProv, FieldAbsoluteDate<T> date, Frame frame)
Compute the base system state at given date, without compensation.Attitude
getBaseState(PVCoordinatesProvider pvProv, AbsoluteDate date, Frame frame)
Compute the base system state at given date, without compensation.<T extends CalculusFieldElement<T>>
TimeStampedFieldPVCoordinates<T>getTargetPV(FieldPVCoordinatesProvider<T> pvProv, FieldAbsoluteDate<T> date, Frame frame)
Compute the target point position/velocity in specified frame.TimeStampedPVCoordinates
getTargetPV(PVCoordinatesProvider pvProv, AbsoluteDate date, Frame frame)
Compute the target point position/velocity in specified frame.AttitudeProvider
getUnderlyingAttitudeProvider()
Get the underlying (ground pointing) attitude provider.<T extends CalculusFieldElement<T>>
TgetYawAngle(FieldPVCoordinatesProvider<T> pvProv, FieldAbsoluteDate<T> date, Frame frame)
Compute the yaw compensation angle at date.double
getYawAngle(PVCoordinatesProvider pvProv, AbsoluteDate date, Frame frame)
Compute the yaw compensation angle at date.-
Methods inherited from class org.orekit.attitudes.GroundPointing
getAttitudeRotation, getAttitudeRotation, getBodyFrame, getTargetPosition, getTargetPosition
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.orekit.attitudes.AttitudeProvider
getAttitudeRotation, getAttitudeRotation
-
-
-
-
Constructor Detail
-
YawCompensation
public YawCompensation(Frame inertialFrame, GroundPointing groundPointingLaw)
Creates a new instance.- Parameters:
inertialFrame
- frame in which orbital velocities are computedgroundPointingLaw
- ground pointing attitude provider without yaw compensation- Since:
- 7.1
-
-
Method Detail
-
getUnderlyingAttitudeProvider
public AttitudeProvider getUnderlyingAttitudeProvider()
Get the underlying (ground pointing) attitude provider.- Specified by:
getUnderlyingAttitudeProvider
in interfaceAttitudeProviderModifier
- Returns:
- underlying attitude provider, which in this case is a
GroundPointing
instance
-
getTargetPV
public TimeStampedPVCoordinates getTargetPV(PVCoordinatesProvider pvProv, AbsoluteDate date, Frame frame)
Compute the target point position/velocity in specified frame.- Specified by:
getTargetPV
in classGroundPointing
- Parameters:
pvProv
- provider for PV coordinatesdate
- date at which target point is requestedframe
- frame in which observed ground point should be provided- Returns:
- observed ground point position (element 0) and velocity (at index 1) in specified frame
-
getTargetPV
public <T extends CalculusFieldElement<T>> TimeStampedFieldPVCoordinates<T> getTargetPV(FieldPVCoordinatesProvider<T> pvProv, FieldAbsoluteDate<T> date, Frame frame)
Compute the target point position/velocity in specified frame.- Specified by:
getTargetPV
in classGroundPointing
- Type Parameters:
T
- type of the field elements- Parameters:
pvProv
- provider for PV coordinatesdate
- date at which target point is requestedframe
- frame in which observed ground point should be provided- Returns:
- observed ground point position (element 0) and velocity (at index 1) in specified frame
-
getBaseState
public Attitude getBaseState(PVCoordinatesProvider pvProv, AbsoluteDate date, Frame frame)
Compute the base system state at given date, without compensation.- Parameters:
pvProv
- provider for PV coordinatesdate
- date at which state is requestedframe
- reference frame from which attitude is computed- Returns:
- satellite base attitude state, i.e without compensation.
-
getBaseState
public <T extends CalculusFieldElement<T>> FieldAttitude<T> getBaseState(FieldPVCoordinatesProvider<T> pvProv, FieldAbsoluteDate<T> date, Frame frame)
Compute the base system state at given date, without compensation.- Type Parameters:
T
- type of the field elements- Parameters:
pvProv
- provider for PV coordinatesdate
- date at which state is requestedframe
- reference frame from which attitude is computed- Returns:
- satellite base attitude state, i.e without compensation.
- Since:
- 9.0
-
getAttitude
public Attitude getAttitude(PVCoordinatesProvider pvProv, AbsoluteDate date, Frame frame)
Compute the attitude corresponding to an orbital state.- Specified by:
getAttitude
in interfaceAttitudeProvider
- Overrides:
getAttitude
in classGroundPointing
- Parameters:
pvProv
- local position-velocity provider around current datedate
- current dateframe
- reference frame from which attitude is computed- Returns:
- attitude on the specified date and position-velocity state
-
getAttitude
public <T extends CalculusFieldElement<T>> FieldAttitude<T> getAttitude(FieldPVCoordinatesProvider<T> pvProv, FieldAbsoluteDate<T> date, Frame frame)
Compute the attitude corresponding to an orbital state.- Specified by:
getAttitude
in interfaceAttitudeProvider
- Overrides:
getAttitude
in classGroundPointing
- Type Parameters:
T
- type of the field elements- Parameters:
pvProv
- local position-velocity provider around current datedate
- current dateframe
- reference frame from which attitude is computed- Returns:
- attitude on the specified date and position-velocity state
-
getYawAngle
public double getYawAngle(PVCoordinatesProvider pvProv, AbsoluteDate date, Frame frame)
Compute the yaw compensation angle at date.- Parameters:
pvProv
- provider for PV coordinatesdate
- date at which compensation is requestedframe
- reference frame from which attitude is computed- Returns:
- yaw compensation angle for orbit.
-
getYawAngle
public <T extends CalculusFieldElement<T>> T getYawAngle(FieldPVCoordinatesProvider<T> pvProv, FieldAbsoluteDate<T> date, Frame frame)
Compute the yaw compensation angle at date.- Type Parameters:
T
- type of the field elements- Parameters:
pvProv
- provider for PV coordinatesdate
- date at which compensation is requestedframe
- reference frame from which attitude is computed- Returns:
- yaw compensation angle for orbit.
- Since:
- 9.0
-
-