Skip to content

Commit

Permalink
wobble() docs and site update
Browse files Browse the repository at this point in the history
  • Loading branch information
attipaci committed Jan 3, 2025
1 parent b28fd07 commit cf3ca00
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
7 changes: 4 additions & 3 deletions include/novas.h
Original file line number Diff line number Diff line change
Expand Up @@ -612,11 +612,12 @@ enum novas_cio_location_type {
* @sa WOBBLE_ITRS_TO_TIRS
*/
enum novas_wobble_direction {
/// use for wobble() to change from ITRS (actual rotating Earth) to Pseudo Earth Fixed (PEF).
/// use for wobble() to change from ITRS (actual rotating Earth) to Pseudo Earth Fixed (PEF) /
/// TIRS.
WOBBLE_ITRS_TO_PEF = 0,

/// use for wobble() to change from Pseudo Earth Fixed (PEF) to ITRS (actual rotating Earth).
/// (You can use any non-zero value as well.)
/// use for wobble() to change from Pseudo Earth Fixed (PEF) / TIRS to ITRS (actual rotating
/// Earth).
WOBBLE_PEF_TO_ITRS
};

Expand Down
11 changes: 6 additions & 5 deletions src/novas.c
Original file line number Diff line number Diff line change
Expand Up @@ -2779,10 +2779,11 @@ int spin(double angle, const double *in, double *out) {
/**
* Corrects a vector in the ITRS (rotating Earth-fixed system) for polar motion, and also
* corrects the longitude origin (by a tiny amount) to the Terrestrial Intermediate Origin
* (TIO). The ITRS vector is thereby transformed to the terrestrial intermediate system,
* based on the true (rotational) equator and TIO. Because the true equator is the plane
* orthogonal to the direction of the Celestial Intermediate Pole (CIP), the components of
* the output vector are referred to z and x axes toward the CIP and TIO, respectively.
* (TIO). The ITRS vector is thereby transformed to the terrestrial intermediate reference
* system (TIRS) or Pseudo Earth Fixed (PEF), based on the true (rotational) equator and TIO;
* or vice versa. Because the true equator is the plane orthogonal to the direction of the
* Celestial Intermediate Pole (CIP), the components of the output vector are referred to z
* and x axes toward the CIP and TIO, respectively.
*
* REFERENCES:
* <ol>
Expand All @@ -2791,7 +2792,7 @@ int spin(double angle, const double *in, double *out) {
* </ol>
*
* @param jd_tt [day] Terrestrial Time (TT) based Julian date.
* @param direction WOBBLE_ITRS_TO_PEF (0) or WOBBLE_PEF_TO_ITRS (1; or nonzero)
* @param direction WOBBLE_ITRS_TO_PEF (0) or WOBBLE_PEF_TO_ITRS (nonzero)
* @param xp [arcsec] Conventionally-defined X coordinate of Celestial Intermediate
* Pole with respect to ITRS pole, in arcseconds.
* @param yp [arcsec] Conventionally-defined Y coordinate of Celestial Intermediate
Expand Down

0 comments on commit cf3ca00

Please sign in to comment.