Package org.orekit.frames

Interface LOF

All Known Subinterfaces:
EncounterLOF
All Known Implementing Classes:
AbstractEncounterLOF, DefaultEncounterLOF, LocalMagneticFieldFrame, LOFType, ValsecchiEncounterFrame
public interface LOF
Interface for local orbital frame.
Author:
Vincent Cucchietti, Jérôme Tabeaud

  • Method Details

    • rotationFromLOFInToLOFOut

      static <T extends CalculusFieldElement<T>> FieldRotation<T> rotationFromLOFInToLOFOut(Field<T> field, LOF in, LOF out, FieldAbsoluteDate<T> date, FieldPVCoordinates<T> pv)
      Get the rotation from input to output local orbital frame.

      This rotation does not include any time derivatives. If first time derivatives (i.e. rotation rate) is needed as well, the full transformFromLOFInToLOFOut(LOF, LOF, FieldAbsoluteDate, FieldPVCoordinates) method must be called and the complete rotation transform must be extracted from it.

      Type Parameters:
      T - type of the field elements
      Parameters:
      field - field to which the elements belong
      in - input commonly used local orbital frame
      out - output commonly used local orbital frame
      date - date of the rotation
      pv - position-velocity of the spacecraft in some inertial frame
      Returns:
      rotation from input to output local orbital frame
      Since:
      11.3

    • transformFromLOFInToLOFOut

      static <T extends CalculusFieldElement<T>> FieldTransform<T> transformFromLOFInToLOFOut(LOF in, LOF out, FieldAbsoluteDate<T> date, FieldPVCoordinates<T> pv)
      Get the transform from input to output local orbital frame.
      Type Parameters:
      T - type of the field elements
      Parameters:
      in - input commonly used local orbital frame
      out - output commonly used local orbital frame
      date - date of the transform
      pv - position-velocity of the spacecraft in some inertial frame
      Returns:
      rotation from input to output local orbital frame.
      Since:
      11.3

    • rotationFromLOFInToLOFOut

      static Rotation rotationFromLOFInToLOFOut(LOF in, LOF out, AbsoluteDate date, PVCoordinates pv)
      Get the rotation from input to output local orbital frame.

      This rotation does not include any time derivatives. If first time derivatives (i.e. rotation rate) is needed as well, the full transformFromLOFInToLOFOut(LOF, LOF, AbsoluteDate, PVCoordinates) method must be called and the complete rotation transform must be extracted from it.

      Parameters:
      in - input commonly used local orbital frame
      out - output commonly used local orbital frame
      date - date of the rotation
      pv - position-velocity of the spacecraft in some inertial frame
      Returns:
      rotation from input to output local orbital frame.
      Since:
      11.3

    • transformFromLOFInToLOFOut

      static Transform transformFromLOFInToLOFOut(LOF in, LOF out, AbsoluteDate date, PVCoordinates pv)
      Get the transform from input to output local orbital frame.
      Parameters:
      in - input commonly used local orbital frame
      out - output commonly used local orbital frame
      date - date of the transform
      pv - position-velocity of the spacecraft in some inertial frame
      Returns:
      rotation from input to output local orbital frame
      Since:
      11.3

    • rotationFromLOF

      default <T extends CalculusFieldElement<T>> FieldRotation<T> rotationFromLOF(Field<T> field, LOF fromLOF, FieldAbsoluteDate<T> date, FieldPVCoordinates<T> pv)
      Get the rotation from input local orbital frame to the instance.

      This rotation does not include any time derivatives. If first time derivatives (i.e. rotation rate) is needed as well, the full transformFromLOF(LOF, FieldAbsoluteDate, FieldPVCoordinates) method must be called and the complete rotation transform must be extracted from it.

      Type Parameters:
      T - type of the field elements
      Parameters:
      field - field to which the elements belong
      fromLOF - input local orbital frame
      date - date of the rotation
      pv - position-velocity of the spacecraft in some inertial frame
      Returns:
      rotation from input local orbital frame to the instance
      Since:
      11.3

    • transformFromLOF

      default <T extends CalculusFieldElement<T>> FieldTransform<T> transformFromLOF(LOF fromLOF, FieldAbsoluteDate<T> date, FieldPVCoordinates<T> pv)
      Get the rotation from input commonly used local orbital frame to the instance.
      Type Parameters:
      T - type of the field elements
      Parameters:
      fromLOF - input local orbital frame
      date - date of the transform
      pv - position-velocity of the spacecraft in some inertial frame
      Returns:
      rotation from input local orbital frame to the instance
      Since:
      11.3

    • transformFromInertial

      default <T extends CalculusFieldElement<T>> FieldTransform<T> transformFromInertial(FieldAbsoluteDate<T> date, FieldPVCoordinates<T> pv)
      Get the transform from an inertial frame defining position-velocity and the local orbital frame.
      Type Parameters:
      T - type of the fields elements
      Parameters:
      date - current date
      pv - position-velocity of the spacecraft in some inertial frame
      Returns:
      transform from the frame where position-velocity are defined to local orbital frame
      Since:
      9.0

    • transformToInertial

      default <T extends CalculusFieldElement<T>> FieldTransform<T> transformToInertial(FieldAbsoluteDate<T> date, FieldPVCoordinates<T> pv)
      Get the transform from the local orbital frame to the inertial frame.
      Type Parameters:
      T - type of the fields elements
      Parameters:
      date - current date
      pv - position-velocity of the spacecraft in the inertial frame
      Returns:
      transform from local orbital frame to the corresponding inertial frame.
      Since:
      14.0

    • rotationFromInertial

      <T extends CalculusFieldElement<T>> FieldRotation<T> rotationFromInertial(Field<T> field, FieldAbsoluteDate<T> date, FieldPVCoordinates<T> pv)
      Get the rotation from inertial frame to local orbital frame.

      This rotation does not include any time derivatives. If first time derivatives (i.e. rotation rate) is needed as well, the full transformFromInertial(FieldAbsoluteDate, FieldPVCoordinates) method must be called and the complete rotation transform must be extracted from it.

      Type Parameters:
      T - type of the field elements
      Parameters:
      field - field to which the elements belong
      date - date of the rotation
      pv - position-velocity of the spacecraft in some inertial frame
      Returns:
      rotation from inertial frame to local orbital frame
      Since:
      9.0

    • rotationToInertial

      default <T extends CalculusFieldElement<T>> FieldRotation<T> rotationToInertial(Field<T> field, FieldAbsoluteDate<T> date, FieldPVCoordinates<T> pv)
      Get the rotation from local orbital frame to inertial frame.

      This rotation does not include any time derivatives. If first time derivatives (i.e. rotation rate) is needed as well, the full transformFromInertial method must be called and the complete rotation transform must be extracted from it.

      Type Parameters:
      T - type of the field elements
      Parameters:
      field - field to which the elements belong
      date - date of the rotation
      pv - position-velocity of the spacecraft in some inertial frame
      Returns:
      rotation from local orbital frame to inertial frame
      Since:
      14.0

    • rotationFromLOF

      default Rotation rotationFromLOF(LOF fromLOF, AbsoluteDate date, PVCoordinates pv)
      Get the rotation from input local orbital frame to the instance.

      This rotation does not include any time derivatives. If first time derivatives (i.e. rotation rate) is needed as well, the full transformFromLOF(LOF, AbsoluteDate, PVCoordinates) method must be called and the complete rotation transform must be extracted from it.

      Parameters:
      fromLOF - input local orbital frame
      date - date of the rotation
      pv - position-velocity of the spacecraft in some inertial frame
      Returns:
      rotation from input local orbital frame to the instance
      Since:
      11.3

    • transformFromLOF

      default Transform transformFromLOF(LOF fromLOF, AbsoluteDate date, PVCoordinates pv)
      Get the rotation from input local orbital frame to the instance.
      Parameters:
      fromLOF - input local orbital frame
      date - date of the transform
      pv - position-velocity of the spacecraft in some inertial frame
      Returns:
      rotation from input local orbital frame to the instance
      Since:
      11.3

    • transformFromInertial

      default Transform transformFromInertial(AbsoluteDate date, PVCoordinates pv)
      Get the transform from an inertial frame defining position-velocity and the local orbital frame.
      Parameters:
      date - current date
      pv - position-velocity of the spacecraft in some inertial frame
      Returns:
      transform from the frame where position-velocity are defined to local orbital frame

    • transformToInertial

      default Transform transformToInertial(AbsoluteDate date, PVCoordinates pv)
      Get the transform from the local orbital frame to the inertial frame.
      Parameters:
      date - current date
      pv - position-velocity of the spacecraft in the inertial frame
      Returns:
      transform from local orbital frame to the corresponding inertial frame.
      Since:
      14.0

    • rotationFromInertial

      Rotation rotationFromInertial(AbsoluteDate date, PVCoordinates pv)
      Get the rotation from inertial frame to local orbital frame.

      This rotation does not include any time derivatives. If first time derivatives (i.e. rotation rate) is needed as well, the full transformFromInertial method must be called and the complete rotation transform must be extracted from it.

      Parameters:
      date - date of the rotation
      pv - position-velocity of the spacecraft in some inertial frame
      Returns:
      rotation from inertial frame to local orbital frame

    • rotationToInertial

      default Rotation rotationToInertial(AbsoluteDate date, PVCoordinates pv)
      Get the rotation from local orbital frame to inertial frame.

      This rotation does not include any time derivatives. If first time derivatives (i.e. rotation rate) is needed as well, the full transformFromInertial method must be called and the complete rotation transform must be extracted from it.

      Parameters:
      date - date of the rotation
      pv - position-velocity of the spacecraft in some inertial frame
      Returns:
      rotation from local orbital frame to inertial frame
      Since:
      14.0

    • isQuasiInertial

      default boolean isQuasiInertial()
      Get flag that indicates if current local orbital frame shall be treated as pseudo-inertial.
      Returns:
      flag that indicates if current local orbital frame shall be treated as pseudo-inertial

    • getName

      String getName()
      Get name of the local orbital frame.
      Returns:
      name of the local orbital frame