vega.uplink.pointing.PtrParameters

Class PhaseAngle

java.lang.Object

CompositeDataset

vega.uplink.pointing.PointingElement

vega.uplink.pointing.PtrParameters.PhaseAngle

public class PhaseAngle
extends PointingElement

Rule that fixes the degree of freedom around the boresight.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALIGN_TAG align
static java.lang.String	ALIGN_YCGSC_SUN_NORMAL_DELTA_TIME_TAG deltaTime
static java.lang.String	ALIGN_YCGSC_SUN_NORMAL_START_TIME_TAG refEpoch
static java.lang.String	ALIGN_YCGSC_SUN_NORMAL_TAG alignYCGSCSunNormal
static java.lang.String	ANGLE_TAG angle
static java.lang.String	FLIP_START_TIME_TAG flipStartTime
static java.lang.String	FLIP_TAG flip
static java.lang.String	FLIP_TYPE_TAG flipType
static java.lang.String	FRAME_TAG frame
static java.lang.String	INERTIAL_AXIS_TAG inertialAxis
static java.lang.String	PHASEANGLE_TAG phaseAngle
static java.lang.String	POWER_OPTIMIZED_TAG powerOptimised
static java.lang.String	REF_TAG ref
static java.lang.String	SC_AXIS_TAG SCAxis
static java.lang.String	UNITS_TAG units
static java.lang.String	X_TAG x
static java.lang.String	Y_TAG y
static java.lang.String	YDIR_TAG yDir
static java.lang.String	Z_TAG z

Constructor Summary

Constructors

Constructor and Description
PhaseAngle() The power optimised roll places the SC-y-axis at a 90 deg angle relative to the SC to Sun direction.
PhaseAngle(java.lang.Boolean yDir) The power optimised roll places the SC-y-axis at a 90 deg angle relative to the SC to Sun direction.
PhaseAngle(java.lang.Boolean yDir, float angle) The power optimised roll places the SC-y-axis at a certain angle relative to the SC to Sun direction.
PhaseAngle(java.lang.Boolean yDir, java.lang.String units, float angle) The power optimised roll places the SC-y-axis at a certain angle relative to the SC to Sun direction.
PhaseAngle(java.util.Date rEpoch, float deltaTime) Align the SC Y axis with the normal of CGSC-Sun plane: The projections of SC +Y-axis and the cross product of the SC to CG and SC to Sun direction into the plane perpendicular to the boresights are aligned.
PhaseAngle(java.util.Date tRef, java.lang.String yRot)
PhaseAngle(java.util.Date rEpoch, java.lang.String deltaTimeUnits, float deltaTime) Align the SC Y axis with the normal of CGSC-Sun plane: The projections of SC +Y-axis and the cross product of the SC to CG and SC to Sun direction into the plane perpendicular to the boresights are aligned.
PhaseAngle(PointingElement org)
PhaseAngle(java.lang.String sCAxysFrame, float sCAxysx, float sCAxysy, float sCAxysz, java.lang.String inertialAxysFrame, float inertialAxysx, float inertialAxysy, float inertialAxysz) Align SC axis with certain inertial direction.
PhaseAngle(java.lang.String tRef, java.lang.String yRot) Flip: This phase angle is used to support comet fly-bys that contain the sun direction in the fly-by plane.
PhaseAngle(java.lang.String rEpoch, java.lang.String deltaTimeUnits, java.lang.String deltaTime) Align the SC Y axis with the normal of CGSC-Sun plane: The projections of SC +Y-axis and the cross product of the SC to CG and SC to Sun direction into the plane perpendicular to the boresights are aligned.

Method Summary

Methods

Modifier and Type	Method and Description
PhaseAngle	copy()
float	getAngle()
float	getAngle(java.lang.String unit)
java.lang.String	getAngleUnit()
float	getDeltaTime() For Align the SC Y axis with the normal of CGSC-Sun plane, get the delta time
float	getDeltaTime(java.lang.String unit) For Align the SC Y axis with the normal of CGSC-Sun plane, get the delta time in the given unit
java.lang.String	getDeltaTimeUnit()
java.util.Date	getFlipeStartTime()
java.lang.String	getFlipType() Get the flip type
java.util.Date	getReferenceEpoch() Get the reference epoch for Align the SC Y axis with the normal of CGSC-Sun plane
java.lang.String	getUnit(java.lang.String field)
void	setAngle(java.lang.String units, float angle) For Power Optimised Phase Angle, set the angle parameter.
void	setAngle(java.lang.String units, java.lang.String angle) For Power Optimised Phase Angle, set the angle parameter.
void	setDeltaTime(long value)
void	setDeltaTime(long value, java.lang.String units)
void	setDeltaTime(java.lang.String value, java.lang.String units)
void	setFlipStartTime(java.util.Date time) Set the flip start time for the flip type PhaseAngle.
void	setReferenceEpoch(java.util.Date epoch)
void	setReferenceEpoch(java.lang.String epoch)
void	setYDir(boolean yDir) For Power Optimised Phase Angle, set the yDir parameter.

Methods inherited from class vega.uplink.pointing.PointingElement

addAttribute, addChild, asDataset, copyFrom, equals, getAttribute, getAttributes, getChild, getChildren, getDescription, getFirstLevelTextContent, getName, getValue, hasAttributtes, hasChildren, readFrom, regenerate, removeAttribute, removeAttribute, setDescription, setValue, toString, toStringParameter, toXml, validate

Methods inherited from class java.lang.Object

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

Field Detail

PHASEANGLE_TAG

public static java.lang.String PHASEANGLE_TAG

phaseAngle

REF_TAG

public static java.lang.String REF_TAG

ref

FLIP_TAG

public static java.lang.String FLIP_TAG

flip

FLIP_START_TIME_TAG

public static java.lang.String FLIP_START_TIME_TAG

flipStartTime

FLIP_TYPE_TAG

public static java.lang.String FLIP_TYPE_TAG

flipType

ALIGN_YCGSC_SUN_NORMAL_TAG

public static java.lang.String ALIGN_YCGSC_SUN_NORMAL_TAG

alignYCGSCSunNormal

ALIGN_YCGSC_SUN_NORMAL_START_TIME_TAG

public static java.lang.String ALIGN_YCGSC_SUN_NORMAL_START_TIME_TAG

refEpoch

ALIGN_YCGSC_SUN_NORMAL_DELTA_TIME_TAG

public static java.lang.String ALIGN_YCGSC_SUN_NORMAL_DELTA_TIME_TAG

deltaTime

POWER_OPTIMIZED_TAG

public static java.lang.String POWER_OPTIMIZED_TAG

powerOptimised

YDIR_TAG

public static java.lang.String YDIR_TAG

yDir

ALIGN_TAG

public static java.lang.String ALIGN_TAG

align

ANGLE_TAG

public static java.lang.String ANGLE_TAG

angle

UNITS_TAG

public static java.lang.String UNITS_TAG

units

SC_AXIS_TAG

public static java.lang.String SC_AXIS_TAG

SCAxis

X_TAG

public static java.lang.String X_TAG

x

Y_TAG

public static java.lang.String Y_TAG

y

Z_TAG

public static java.lang.String Z_TAG

z

FRAME_TAG

public static java.lang.String FRAME_TAG

frame

INERTIAL_AXIS_TAG

public static java.lang.String INERTIAL_AXIS_TAG

inertialAxis

Constructor Detail

PhaseAngle

public PhaseAngle(PointingElement org)

PhaseAngle

public PhaseAngle(java.lang.String tRef,
          java.lang.String yRot)

Flip: This phase angle is used to support comet fly-bys that contain the sun direction in the fly-by plane. Before the flip either the plus or minus Y-axis are aligned with orbital pole of the SC wrt. the comet projected in the plane perpendicular to the boresight. During the flip the SC rotates 180deg around the boresight such that the opposite axis than before the flip is aligned with the orbital pole. When this phase angle is used, the selected 2014-12-01T00:00:00 pyPosRot boresight must be in the SC-x-z-plane. The type of flip (element ) indicates whether the SC plus Y axis (“py”)or the minus Y axis (“my”) is aligned with the orbital pole before the flip and whether the rotation during the flip is a positive (“PosRot”) or negative (“NegRot”) rotation around the boresight. Thus there are four different values for the ref-attribute of the element: pyPosRot pyNegRot myPosRot myNegRot The flip start time is specified in the element. For all type of flips the flip duration is 60min.

Parameters:

tRef - Flip Start Time

yRot - Flip type (pyPosRot,pyNegRot,myPosRot or myNegRot)

PhaseAngle

public PhaseAngle(java.lang.String rEpoch,
          java.lang.String deltaTimeUnits,
          java.lang.String deltaTime)

Align the SC Y axis with the normal of CGSC-Sun plane: The projections of SC +Y-axis and the cross product of the SC to CG and SC to Sun direction into the plane perpendicular to the boresights are aligned. The cross product is calculated for a fixed instant in time that is given by the sum refEpoch and deltaTime. For that epoch the SC to CG and SC to Sun direction must not be aligned.

Parameters:

rEpoch -

deltaTime -

deltaTimeUnits -

PhaseAngle

public PhaseAngle(java.util.Date rEpoch,
          java.lang.String deltaTimeUnits,
          float deltaTime)

Align the SC Y axis with the normal of CGSC-Sun plane: The projections of SC +Y-axis and the cross product of the SC to CG and SC to Sun direction into the plane perpendicular to the boresights are aligned. The cross product is calculated for a fixed instant in time that is given by the sum refEpoch and deltaTime. For that epoch the SC to CG and SC to Sun direction must not be aligned.

Parameters:

rEpoch -

deltaTime -

deltaTimeUnits -

PhaseAngle

public PhaseAngle(java.util.Date rEpoch,
          float deltaTime)

Align the SC Y axis with the normal of CGSC-Sun plane: The projections of SC +Y-axis and the cross product of the SC to CG and SC to Sun direction into the plane perpendicular to the boresights are aligned. The cross product is calculated for a fixed instant in time that is given by the sum refEpoch and deltaTime. For that epoch the SC to CG and SC to Sun direction must not be aligned. The delta time units is assumed to be minutes.

Parameters:

rEpoch -

deltaTime -

PhaseAngle

public PhaseAngle(java.util.Date tRef,
          java.lang.String yRot)

PhaseAngle

public PhaseAngle(java.lang.Boolean yDir,
          java.lang.String units,
          float angle)

The power optimised roll places the SC-y-axis at a certain angle relative to the SC to Sun direction. The SC-y-axis is along (i.e. has positive projection on) the cross product of boresight and SC to Sun direction, if the parameter yDir is set to true. For yDir set to false it is towards minus the cross product. The default value for yDir is set to true. It is recommended that this phaseAngle representation is only selected, when the sun direction is between 30deg and 150deg from the inertial pointing direction (otherwise the pointing can have high rates).

Parameters:

yDir - YDir

units - Angle units

angle - Angle

PhaseAngle

public PhaseAngle(java.lang.Boolean yDir,
          float angle)

The power optimised roll places the SC-y-axis at a certain angle relative to the SC to Sun direction. The SC-y-axis is along (i.e. has positive projection on) the cross product of boresight and SC to Sun direction, if the parameter yDir is set to true. For yDir set to false it is towards minus the cross product. The default value for yDir is set to true. It is recommended that this phaseAngle representation is only selected, when the sun direction is between 30deg and 150deg from the inertial pointing direction (otherwise the pointing can have high rates). The angle unit is assumed to be deg

Parameters:

yDir - YDir

angle - Angle

PhaseAngle

public PhaseAngle(java.lang.Boolean yDir)

The power optimised roll places the SC-y-axis at a 90 deg angle relative to the SC to Sun direction. The SC-y-axis is along (i.e. has positive projection on) the cross product of boresight and SC to Sun direction, if the parameter yDir is set to true. For yDir set to false it is towards minus the cross product. The default value for yDir is set to true. It is recommended that this phaseAngle representation is only selected, when the sun direction is between 30deg and 150deg from the inertial pointing direction (otherwise the pointing can have high rates).

Parameters:

yDir -

PhaseAngle

public PhaseAngle()

The power optimised roll places the SC-y-axis at a 90 deg angle relative to the SC to Sun direction. yDir is set to true, so the SC-y-axis is along (i.e. has positive projection on) the cross product of boresight and SC to Sun direction. It is recommended that this phaseAngle representation is only selected, when the sun direction is between 30deg and 150deg from the inertial pointing direction (otherwise the pointing can have high rates).

PhaseAngle

public PhaseAngle(java.lang.String sCAxysFrame,
          float sCAxysx,
          float sCAxysy,
          float sCAxysz,
          java.lang.String inertialAxysFrame,
          float inertialAxysx,
          float inertialAxysy,
          float inertialAxysz)

Align SC axis with certain inertial direction. The rotation angle around the boresight is chosen such that the projections of the vectors SCAxis and inertialAxis projected in the plane perpendicular to the boresight are aligned. The SCAxis and inertialAxis must not be parallel to the boresight. For the SC and inertial axis references to predefined axes are allowed. For the duration of the pointing, it is recommended that the selected inertial axis is between 30 and 150deg from the inertial pointing direction (otherwise the pointing can have high rates).

Parameters:

sCAxys - Frame Spacecraft axys reference frame

sCAxysx - X Spacecraft Axis

sCAxysy - Y Spacecraft Axis

sCAxysz - Z Spacecraft Axis

inertialAxysFrame - Inertial axis reference frame

inertialAxysx - X Inertial Axis

inertialAxysy - Y Inertial axis

inertialAxysz - Z Inertial axis

Method Detail

copy

public PhaseAngle copy()

Overrides:

copy in class PointingElement

getReferenceEpoch

public java.util.Date getReferenceEpoch()

Get the reference epoch for Align the SC Y axis with the normal of CGSC-Sun plane

Returns:

getDeltaTime

public float getDeltaTime()

For Align the SC Y axis with the normal of CGSC-Sun plane, get the delta time

Returns:

Delta Time

getDeltaTime

public float getDeltaTime(java.lang.String unit)

For Align the SC Y axis with the normal of CGSC-Sun plane, get the delta time in the given unit

Parameters:

unit - the desired unit

Returns:

Delta Time

getDeltaTimeUnit

public java.lang.String getDeltaTimeUnit()

setDeltaTime

public void setDeltaTime(java.lang.String value,
                java.lang.String units)

setDeltaTime

public void setDeltaTime(long value,
                java.lang.String units)

setDeltaTime

public void setDeltaTime(long value)

setReferenceEpoch

public void setReferenceEpoch(java.lang.String epoch)

setReferenceEpoch

public void setReferenceEpoch(java.util.Date epoch)

getUnit

public java.lang.String getUnit(java.lang.String field)

getFlipType

public java.lang.String getFlipType()

Get the flip type

Returns:

getFlipeStartTime

public java.util.Date getFlipeStartTime()

setYDir

public void setYDir(boolean yDir)

For Power Optimised Phase Angle, set the yDir parameter. if the parameter yDir is set to true The SC-y-axis is along (i.e. has positive projection on) the cross product of boresight and SC to Sun direction. For yDir set to false it is towards minus the cross product.

Parameters:

yDir -

setAngle

public void setAngle(java.lang.String units,
            java.lang.String angle)

For Power Optimised Phase Angle, set the angle parameter. The power optimised roll places the SC-y-axis at a certain angle relative to the SC to Sun direction.

Parameters:

units - The units for the angle, for example deg

angle - The angle parameter, for example 90

setAngle

public void setAngle(java.lang.String units,
            float angle)

For Power Optimised Phase Angle, set the angle parameter. The power optimised roll places the SC-y-axis at a certain angle relative to the SC to Sun direction.

Parameters:

units - The units for the angle, for example deg

angle - The angle parameter, for example 90

getAngle

public float getAngle()

getAngleUnit

public java.lang.String getAngleUnit()

getAngle

public float getAngle(java.lang.String unit)

setFlipStartTime

public void setFlipStartTime(java.util.Date time)

Set the flip start time for the flip type PhaseAngle. It is specified in the element. For all type of flips the flip duration is 60min.

Parameters:

time -