From 281180db2483d3c1d51bd137e387fe553aa52ad1 Mon Sep 17 00:00:00 2001 From: Don Cross Date: Thu, 8 Dec 2022 16:16:41 -0500 Subject: [PATCH] Use consistent descriptions of EQJ, ECL. Use consistent wording for these two orientation systems: EQJ = J2000 mean equator ECL = J2000 mean ecliptic --- demo/browser/astronomy.browser.js | 32 ++++++++--------- demo/nodejs/astronomy.js | 32 ++++++++--------- demo/nodejs/calendar/astronomy.ts | 32 ++++++++--------- demo/python/astronomy.py | 34 +++++++++---------- generate/template/astronomy.c | 30 ++++++++-------- generate/template/astronomy.cs | 32 ++++++++--------- generate/template/astronomy.kt | 32 ++++++++--------- generate/template/astronomy.py | 34 +++++++++---------- generate/template/astronomy.ts | 32 ++++++++--------- source/c/README.md | 30 ++++++++-------- source/c/astronomy.c | 30 ++++++++-------- source/csharp/README.md | 32 ++++++++--------- source/csharp/astronomy.cs | 32 ++++++++--------- source/js/README.md | 32 ++++++++--------- source/js/astronomy.browser.js | 32 ++++++++--------- source/js/astronomy.d.ts | 32 ++++++++--------- source/js/astronomy.js | 32 ++++++++--------- source/js/astronomy.ts | 32 ++++++++--------- source/js/esm/astronomy.js | 32 ++++++++--------- source/kotlin/README.md | 22 ++++++------ source/kotlin/doc/-axis-info/index.md | 2 +- source/kotlin/doc/bary-state.md | 2 +- source/kotlin/doc/ecliptic-geo-moon.md | 2 +- source/kotlin/doc/helio-state.md | 2 +- source/kotlin/doc/index.md | 22 ++++++------ source/kotlin/doc/lagrange-point.md | 2 +- source/kotlin/doc/rotation-ecl-eqd.md | 2 +- source/kotlin/doc/rotation-ecl-eqj.md | 2 +- source/kotlin/doc/rotation-ecl-hor.md | 2 +- source/kotlin/doc/rotation-eqd-ecl.md | 2 +- source/kotlin/doc/rotation-eqd-eqj.md | 2 +- source/kotlin/doc/rotation-eqj-ecl.md | 2 +- source/kotlin/doc/rotation-eqj-eqd.md | 2 +- source/kotlin/doc/rotation-eqj-gal.md | 2 +- source/kotlin/doc/rotation-eqj-hor.md | 2 +- source/kotlin/doc/rotation-gal-eqj.md | 2 +- source/kotlin/doc/rotation-hor-ecl.md | 2 +- .../github/cosinekitty/astronomy/astronomy.kt | 32 ++++++++--------- source/python/README.md | 34 +++++++++---------- source/python/astronomy/astronomy.py | 34 +++++++++---------- 40 files changed, 391 insertions(+), 391 deletions(-) diff --git a/demo/browser/astronomy.browser.js b/demo/browser/astronomy.browser.js index 44b47490..66d2209e 100644 --- a/demo/browser/astronomy.browser.js +++ b/demo/browser/astronomy.browser.js @@ -2830,7 +2830,7 @@ exports.GeoMoon = GeoMoon; * Astronomy on the Personal Computer * by Montenbruck and Pfleger. * - * To calculate an equatorial J2000 vector instead, use {@link GeoMoon}. + * To calculate a J2000 mean equator vector instead, use {@link GeoMoon}. * * @param {FlexibleDateTime} date * The date and time for which to calculate the Moon's position. @@ -3919,7 +3919,7 @@ function ExportState(terse, time) { * * Given a body and a time, calculates the barycentric position and velocity * vectors for the center of that body at that time. - * The vectors are expressed in equatorial J2000 coordinates (EQJ). + * The vectors are expressed in J2000 mean equator coordinates (EQJ). * * @param {Body} body * The celestial body whose barycentric state vector is to be calculated. @@ -3970,7 +3970,7 @@ exports.BaryState = BaryState; * * Given a body and a time, calculates the position and velocity * vectors for the center of that body at that time, relative to the center of the Sun. - * The vectors are expressed in equatorial J2000 coordinates (EQJ). + * The vectors are expressed in J2000 mean equator coordinates (EQJ). * If you need the position vector only, it is more efficient to call {@link HelioVector}. * The Sun's center is a non-inertial frame of reference. In other words, the Sun * experiences acceleration due to gravitational forces, mostly from the larger @@ -6426,7 +6426,7 @@ function RotateState(rotation, state) { } exports.RotateState = RotateState; /** - * @brief Calculates a rotation matrix from equatorial J2000 (EQJ) to ecliptic J2000 (ECL). + * @brief Calculates a rotation matrix from J2000 mean equator (EQJ) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6448,7 +6448,7 @@ function Rotation_EQJ_ECL() { } exports.Rotation_EQJ_ECL = Rotation_EQJ_ECL; /** - * @brief Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial J2000 (EQJ). + * @brief Calculates a rotation matrix from J2000 mean ecliptic (ECL) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6470,7 +6470,7 @@ function Rotation_ECL_EQJ() { } exports.Rotation_ECL_EQJ = Rotation_ECL_EQJ; /** - * @brief Calculates a rotation matrix from equatorial J2000 (EQJ) to equatorial of-date (EQD). + * @brief Calculates a rotation matrix from J2000 mean equator (EQJ) to equatorial of-date (EQD). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6491,7 +6491,7 @@ function Rotation_EQJ_EQD(time) { } exports.Rotation_EQJ_EQD = Rotation_EQJ_EQD; /** - * @brief Calculates a rotation matrix from equatorial of-date (EQD) to equatorial J2000 (EQJ). + * @brief Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6602,7 +6602,7 @@ function Rotation_HOR_EQJ(time, observer) { } exports.Rotation_HOR_EQJ = Rotation_HOR_EQJ; /** - * @brief Calculates a rotation matrix from equatorial J2000 (EQJ) to horizontal (HOR). + * @brief Calculates a rotation matrix from J2000 mean equator (EQJ) to horizontal (HOR). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6631,7 +6631,7 @@ function Rotation_EQJ_HOR(time, observer) { } exports.Rotation_EQJ_HOR = Rotation_EQJ_HOR; /** - * @brief Calculates a rotation matrix from equatorial of-date (EQD) to ecliptic J2000 (ECL). + * @brief Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6651,7 +6651,7 @@ function Rotation_EQD_ECL(time) { } exports.Rotation_EQD_ECL = Rotation_EQD_ECL; /** - * @brief Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial of-date (EQD). + * @brief Calculates a rotation matrix from J2000 mean ecliptic (ECL) to equatorial of-date (EQD). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6670,7 +6670,7 @@ function Rotation_ECL_EQD(time) { } exports.Rotation_ECL_EQD = Rotation_ECL_EQD; /** - * @brief Calculates a rotation matrix from ecliptic J2000 (ECL) to horizontal (HOR). + * @brief Calculates a rotation matrix from J2000 mean ecliptic (ECL) to horizontal (HOR). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6701,7 +6701,7 @@ function Rotation_ECL_HOR(time, observer) { } exports.Rotation_ECL_HOR = Rotation_ECL_HOR; /** - * @brief Calculates a rotation matrix from horizontal (HOR) to ecliptic J2000 (ECL). + * @brief Calculates a rotation matrix from horizontal (HOR) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6723,7 +6723,7 @@ function Rotation_HOR_ECL(time, observer) { } exports.Rotation_HOR_ECL = Rotation_HOR_ECL; /** - * @brief Calculates a rotation matrix from equatorial J2000 (EQJ) to galactic (GAL). + * @brief Calculates a rotation matrix from J2000 mean equator (EQJ) to galactic (GAL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6745,7 +6745,7 @@ function Rotation_EQJ_GAL() { } exports.Rotation_EQJ_GAL = Rotation_EQJ_GAL; /** - * @brief Calculates a rotation matrix from galactic (GAL) to equatorial J2000 (EQJ). + * @brief Calculates a rotation matrix from galactic (GAL) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -8891,7 +8891,7 @@ exports.NextMoonNode = NextMoonNode; * α0, δ0, and W, respectively, from * [Report of the IAU Working Group on Cartographic Coordinates and Rotational Elements: 2015](https://astropedia.astrogeology.usgs.gov/download/Docs/WGCCRE/WGCCRE2015reprint.pdf). * The field `north` is a unit vector pointing in the direction of the body's north pole. - * It is expressed in the equatorial J2000 system (EQJ). + * It is expressed in the J2000 mean equator system (EQJ). * * @property {number} ra * The J2000 right ascension of the body's north pole direction, in sidereal hours. @@ -9118,7 +9118,7 @@ exports.RotationAxis = RotationAxis; * 5 = the Lagrange point 60 degrees behind the minor body's orbital position. * * The function returns the state vector for the selected Lagrange point - * in equatorial J2000 coordinates (EQJ), with respect to the center of the + * in J2000 mean equator coordinates (EQJ), with respect to the center of the * major body. * * To calculate Sun/Earth Lagrange points, pass in `Body.Sun` for `major_body` diff --git a/demo/nodejs/astronomy.js b/demo/nodejs/astronomy.js index 2d30c590..6643c77c 100644 --- a/demo/nodejs/astronomy.js +++ b/demo/nodejs/astronomy.js @@ -2829,7 +2829,7 @@ exports.GeoMoon = GeoMoon; * Astronomy on the Personal Computer * by Montenbruck and Pfleger. * - * To calculate an equatorial J2000 vector instead, use {@link GeoMoon}. + * To calculate a J2000 mean equator vector instead, use {@link GeoMoon}. * * @param {FlexibleDateTime} date * The date and time for which to calculate the Moon's position. @@ -3918,7 +3918,7 @@ function ExportState(terse, time) { * * Given a body and a time, calculates the barycentric position and velocity * vectors for the center of that body at that time. - * The vectors are expressed in equatorial J2000 coordinates (EQJ). + * The vectors are expressed in J2000 mean equator coordinates (EQJ). * * @param {Body} body * The celestial body whose barycentric state vector is to be calculated. @@ -3969,7 +3969,7 @@ exports.BaryState = BaryState; * * Given a body and a time, calculates the position and velocity * vectors for the center of that body at that time, relative to the center of the Sun. - * The vectors are expressed in equatorial J2000 coordinates (EQJ). + * The vectors are expressed in J2000 mean equator coordinates (EQJ). * If you need the position vector only, it is more efficient to call {@link HelioVector}. * The Sun's center is a non-inertial frame of reference. In other words, the Sun * experiences acceleration due to gravitational forces, mostly from the larger @@ -6425,7 +6425,7 @@ function RotateState(rotation, state) { } exports.RotateState = RotateState; /** - * @brief Calculates a rotation matrix from equatorial J2000 (EQJ) to ecliptic J2000 (ECL). + * @brief Calculates a rotation matrix from J2000 mean equator (EQJ) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6447,7 +6447,7 @@ function Rotation_EQJ_ECL() { } exports.Rotation_EQJ_ECL = Rotation_EQJ_ECL; /** - * @brief Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial J2000 (EQJ). + * @brief Calculates a rotation matrix from J2000 mean ecliptic (ECL) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6469,7 +6469,7 @@ function Rotation_ECL_EQJ() { } exports.Rotation_ECL_EQJ = Rotation_ECL_EQJ; /** - * @brief Calculates a rotation matrix from equatorial J2000 (EQJ) to equatorial of-date (EQD). + * @brief Calculates a rotation matrix from J2000 mean equator (EQJ) to equatorial of-date (EQD). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6490,7 +6490,7 @@ function Rotation_EQJ_EQD(time) { } exports.Rotation_EQJ_EQD = Rotation_EQJ_EQD; /** - * @brief Calculates a rotation matrix from equatorial of-date (EQD) to equatorial J2000 (EQJ). + * @brief Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6601,7 +6601,7 @@ function Rotation_HOR_EQJ(time, observer) { } exports.Rotation_HOR_EQJ = Rotation_HOR_EQJ; /** - * @brief Calculates a rotation matrix from equatorial J2000 (EQJ) to horizontal (HOR). + * @brief Calculates a rotation matrix from J2000 mean equator (EQJ) to horizontal (HOR). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6630,7 +6630,7 @@ function Rotation_EQJ_HOR(time, observer) { } exports.Rotation_EQJ_HOR = Rotation_EQJ_HOR; /** - * @brief Calculates a rotation matrix from equatorial of-date (EQD) to ecliptic J2000 (ECL). + * @brief Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6650,7 +6650,7 @@ function Rotation_EQD_ECL(time) { } exports.Rotation_EQD_ECL = Rotation_EQD_ECL; /** - * @brief Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial of-date (EQD). + * @brief Calculates a rotation matrix from J2000 mean ecliptic (ECL) to equatorial of-date (EQD). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6669,7 +6669,7 @@ function Rotation_ECL_EQD(time) { } exports.Rotation_ECL_EQD = Rotation_ECL_EQD; /** - * @brief Calculates a rotation matrix from ecliptic J2000 (ECL) to horizontal (HOR). + * @brief Calculates a rotation matrix from J2000 mean ecliptic (ECL) to horizontal (HOR). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6700,7 +6700,7 @@ function Rotation_ECL_HOR(time, observer) { } exports.Rotation_ECL_HOR = Rotation_ECL_HOR; /** - * @brief Calculates a rotation matrix from horizontal (HOR) to ecliptic J2000 (ECL). + * @brief Calculates a rotation matrix from horizontal (HOR) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6722,7 +6722,7 @@ function Rotation_HOR_ECL(time, observer) { } exports.Rotation_HOR_ECL = Rotation_HOR_ECL; /** - * @brief Calculates a rotation matrix from equatorial J2000 (EQJ) to galactic (GAL). + * @brief Calculates a rotation matrix from J2000 mean equator (EQJ) to galactic (GAL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6744,7 +6744,7 @@ function Rotation_EQJ_GAL() { } exports.Rotation_EQJ_GAL = Rotation_EQJ_GAL; /** - * @brief Calculates a rotation matrix from galactic (GAL) to equatorial J2000 (EQJ). + * @brief Calculates a rotation matrix from galactic (GAL) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -8890,7 +8890,7 @@ exports.NextMoonNode = NextMoonNode; * α0, δ0, and W, respectively, from * [Report of the IAU Working Group on Cartographic Coordinates and Rotational Elements: 2015](https://astropedia.astrogeology.usgs.gov/download/Docs/WGCCRE/WGCCRE2015reprint.pdf). * The field `north` is a unit vector pointing in the direction of the body's north pole. - * It is expressed in the equatorial J2000 system (EQJ). + * It is expressed in the J2000 mean equator system (EQJ). * * @property {number} ra * The J2000 right ascension of the body's north pole direction, in sidereal hours. @@ -9117,7 +9117,7 @@ exports.RotationAxis = RotationAxis; * 5 = the Lagrange point 60 degrees behind the minor body's orbital position. * * The function returns the state vector for the selected Lagrange point - * in equatorial J2000 coordinates (EQJ), with respect to the center of the + * in J2000 mean equator coordinates (EQJ), with respect to the center of the * major body. * * To calculate Sun/Earth Lagrange points, pass in `Body.Sun` for `major_body` diff --git a/demo/nodejs/calendar/astronomy.ts b/demo/nodejs/calendar/astronomy.ts index fabd7ee0..a37a03cc 100644 --- a/demo/nodejs/calendar/astronomy.ts +++ b/demo/nodejs/calendar/astronomy.ts @@ -3080,7 +3080,7 @@ export function GeoMoon(date: FlexibleDateTime): Vector { * Astronomy on the Personal Computer * by Montenbruck and Pfleger. * - * To calculate an equatorial J2000 vector instead, use {@link GeoMoon}. + * To calculate a J2000 mean equator vector instead, use {@link GeoMoon}. * * @param {FlexibleDateTime} date * The date and time for which to calculate the Moon's position. @@ -4379,7 +4379,7 @@ function ExportState(terse: body_state_t, time: AstroTime): StateVector { * * Given a body and a time, calculates the barycentric position and velocity * vectors for the center of that body at that time. - * The vectors are expressed in equatorial J2000 coordinates (EQJ). + * The vectors are expressed in J2000 mean equator coordinates (EQJ). * * @param {Body} body * The celestial body whose barycentric state vector is to be calculated. @@ -4453,7 +4453,7 @@ export function BaryState(body: Body, date: FlexibleDateTime): StateVector { * * Given a body and a time, calculates the position and velocity * vectors for the center of that body at that time, relative to the center of the Sun. - * The vectors are expressed in equatorial J2000 coordinates (EQJ). + * The vectors are expressed in J2000 mean equator coordinates (EQJ). * If you need the position vector only, it is more efficient to call {@link HelioVector}. * The Sun's center is a non-inertial frame of reference. In other words, the Sun * experiences acceleration due to gravitational forces, mostly from the larger @@ -7167,7 +7167,7 @@ export function RotateState(rotation: RotationMatrix, state: StateVector): State /** - * @brief Calculates a rotation matrix from equatorial J2000 (EQJ) to ecliptic J2000 (ECL). + * @brief Calculates a rotation matrix from J2000 mean equator (EQJ) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -7190,7 +7190,7 @@ export function Rotation_EQJ_ECL(): RotationMatrix { /** - * @brief Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial J2000 (EQJ). + * @brief Calculates a rotation matrix from J2000 mean ecliptic (ECL) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -7213,7 +7213,7 @@ export function Rotation_ECL_EQJ(): RotationMatrix { /** - * @brief Calculates a rotation matrix from equatorial J2000 (EQJ) to equatorial of-date (EQD). + * @brief Calculates a rotation matrix from J2000 mean equator (EQJ) to equatorial of-date (EQD). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -7235,7 +7235,7 @@ export function Rotation_EQJ_EQD(time: FlexibleDateTime): RotationMatrix { /** - * @brief Calculates a rotation matrix from equatorial of-date (EQD) to equatorial J2000 (EQJ). + * @brief Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -7353,7 +7353,7 @@ export function Rotation_HOR_EQJ(time: FlexibleDateTime, observer: Observer): Ro /** - * @brief Calculates a rotation matrix from equatorial J2000 (EQJ) to horizontal (HOR). + * @brief Calculates a rotation matrix from J2000 mean equator (EQJ) to horizontal (HOR). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -7383,7 +7383,7 @@ export function Rotation_EQJ_HOR(time: FlexibleDateTime, observer: Observer): Ro /** - * @brief Calculates a rotation matrix from equatorial of-date (EQD) to ecliptic J2000 (ECL). + * @brief Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -7404,7 +7404,7 @@ export function Rotation_EQD_ECL(time: FlexibleDateTime): RotationMatrix { /** - * @brief Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial of-date (EQD). + * @brief Calculates a rotation matrix from J2000 mean ecliptic (ECL) to equatorial of-date (EQD). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -7424,7 +7424,7 @@ export function Rotation_ECL_EQD(time: FlexibleDateTime): RotationMatrix { /** - * @brief Calculates a rotation matrix from ecliptic J2000 (ECL) to horizontal (HOR). + * @brief Calculates a rotation matrix from J2000 mean ecliptic (ECL) to horizontal (HOR). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -7456,7 +7456,7 @@ export function Rotation_ECL_HOR(time: FlexibleDateTime, observer: Observer): Ro /** - * @brief Calculates a rotation matrix from horizontal (HOR) to ecliptic J2000 (ECL). + * @brief Calculates a rotation matrix from horizontal (HOR) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -7479,7 +7479,7 @@ export function Rotation_HOR_ECL(time: FlexibleDateTime, observer: Observer): Ro /** - * @brief Calculates a rotation matrix from equatorial J2000 (EQJ) to galactic (GAL). + * @brief Calculates a rotation matrix from J2000 mean equator (EQJ) to galactic (GAL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -7502,7 +7502,7 @@ export function Rotation_EQJ_GAL(): RotationMatrix { /** - * @brief Calculates a rotation matrix from galactic (GAL) to equatorial J2000 (EQJ). + * @brief Calculates a rotation matrix from galactic (GAL) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -9350,7 +9350,7 @@ export function NextMoonNode(prevNode: NodeEventInfo): NodeEventInfo { * α0, δ0, and W, respectively, from * [Report of the IAU Working Group on Cartographic Coordinates and Rotational Elements: 2015](https://astropedia.astrogeology.usgs.gov/download/Docs/WGCCRE/WGCCRE2015reprint.pdf). * The field `north` is a unit vector pointing in the direction of the body's north pole. - * It is expressed in the equatorial J2000 system (EQJ). + * It is expressed in the J2000 mean equator system (EQJ). * * @property {number} ra * The J2000 right ascension of the body's north pole direction, in sidereal hours. @@ -9629,7 +9629,7 @@ export function RotationAxis(body: Body, date: FlexibleDateTime): AxisInfo { * 5 = the Lagrange point 60 degrees behind the minor body's orbital position. * * The function returns the state vector for the selected Lagrange point - * in equatorial J2000 coordinates (EQJ), with respect to the center of the + * in J2000 mean equator coordinates (EQJ), with respect to the center of the * major body. * * To calculate Sun/Earth Lagrange points, pass in `Body.Sun` for `major_body` diff --git a/demo/python/astronomy.py b/demo/python/astronomy.py index b7a2c593..cf17b590 100644 --- a/demo/python/astronomy.py +++ b/demo/python/astronomy.py @@ -2295,7 +2295,7 @@ def EclipticGeoMoon(time): [Astronomy on the Personal Computer](https://www.springer.com/us/book/9783540672210) by Montenbruck and Pfleger. - To calculate an equatorial J2000 vector instead, use #GeoMoon. + To calculate a J2000 mean equator vector instead, use #GeoMoon. Parameters ---------- @@ -4336,7 +4336,7 @@ def BaryState(body, time): Given a body and a time, calculates the barycentric position and velocity vectors for the center of that body at that time. - The vectors are expressed in equatorial J2000 coordinates (EQJ). + The vectors are expressed in J2000 mean equator coordinates (EQJ). Parameters ---------- @@ -4414,7 +4414,7 @@ def HelioState(body, time): Given a body and a time, calculates the position and velocity vectors for the center of that body at that time, relative to the center of the Sun. - The vectors are expressed in equatorial J2000 coordinates (EQJ). + The vectors are expressed in J2000 mean equator coordinates (EQJ). If you need the position vector only, it is more efficient to call #HelioVector. The Sun's center is a non-inertial frame of reference. In other words, the Sun experiences acceleration due to gravitational forces, mostly from the larger @@ -7237,7 +7237,7 @@ def RotateState(rotation, state): def Rotation_EQJ_ECL(): - """Calculates a rotation matrix from equatorial J2000 (EQJ) to ecliptic J2000 (ECL). + """Calculates a rotation matrix from J2000 mean equator (EQJ) to J2000 mean ecliptic (ECL). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -7260,7 +7260,7 @@ def Rotation_EQJ_ECL(): def Rotation_ECL_EQJ(): - """Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial J2000 (EQJ). + """Calculates a rotation matrix from J2000 mean ecliptic (ECL) to J2000 mean equator (EQJ). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -7282,7 +7282,7 @@ def Rotation_ECL_EQJ(): ]) def Rotation_EQJ_EQD(time): - """Calculates a rotation matrix from equatorial J2000 (EQJ) to equatorial of-date (EQD). + """Calculates a rotation matrix from J2000 mean equator (EQJ) to equatorial of-date (EQD). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -7305,7 +7305,7 @@ def Rotation_EQJ_EQD(time): def Rotation_EQD_EQJ(time): - """Calculates a rotation matrix from equatorial of-date (EQD) to equatorial J2000 (EQJ). + """Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean equator (EQJ). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -7422,7 +7422,7 @@ def Rotation_HOR_EQJ(time, observer): def Rotation_EQJ_HOR(time, observer): - """Calculates a rotation matrix from equatorial J2000 (EQJ) to horizontal (HOR). + """Calculates a rotation matrix from J2000 mean equator (EQJ) to horizontal (HOR). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -7453,7 +7453,7 @@ def Rotation_EQJ_HOR(time, observer): def Rotation_EQD_ECL(time): - """Calculates a rotation matrix from equatorial of-date (EQD) to ecliptic J2000 (ECL). + """Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean ecliptic (ECL). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -7476,7 +7476,7 @@ def Rotation_EQD_ECL(time): def Rotation_ECL_EQD(time): - """Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial of-date (EQD). + """Calculates a rotation matrix from J2000 mean ecliptic (ECL) to equatorial of-date (EQD). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -7498,7 +7498,7 @@ def Rotation_ECL_EQD(time): def Rotation_ECL_HOR(time, observer): - """Calculates a rotation matrix from ecliptic J2000 (ECL) to horizontal (HOR). + """Calculates a rotation matrix from J2000 mean ecliptic (ECL) to horizontal (HOR). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -7530,7 +7530,7 @@ def Rotation_ECL_HOR(time, observer): def Rotation_HOR_ECL(time, observer): - """Calculates a rotation matrix from horizontal (HOR) to ecliptic J2000 (ECL). + """Calculates a rotation matrix from horizontal (HOR) to J2000 mean ecliptic (ECL). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -7553,7 +7553,7 @@ def Rotation_HOR_ECL(time, observer): return InverseRotation(rot) def Rotation_EQJ_GAL(): - """Calculates a rotation matrix from equatorial J2000 (EQJ) to galactic (GAL). + """Calculates a rotation matrix from J2000 mean equator (EQJ) to galactic (GAL). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -7575,7 +7575,7 @@ def Rotation_EQJ_GAL(): ]) def Rotation_GAL_EQJ(): - """Calculates a rotation matrix from galactic (GAL) to equatorial J2000 (EQJ). + """Calculates a rotation matrix from galactic (GAL) to J2000 mean equator (EQJ). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -9494,7 +9494,7 @@ class AxisInfo: [Report of the IAU Working Group on Cartographic Coordinates and Rotational Elements: 2015](https://astropedia.astrogeology.usgs.gov/download/Docs/WGCCRE/WGCCRE2015reprint.pdf). The field `north` is a unit vector pointing in the direction of the body's north pole. - It is expressed in the equatorial J2000 system (EQJ). + It is expressed in the J2000 mean equator system (EQJ). Attributes ---------- @@ -9759,7 +9759,7 @@ def LagrangePoint(point, time, major_body, minor_body): 5 = the Lagrange point 60 degrees behind the minor body's orbital position. The function returns the state vector for the selected Lagrange point - in equatorial J2000 coordinates (EQJ), with respect to the center of the + in J2000 mean equator coordinates (EQJ), with respect to the center of the major body. To calculate Sun/Earth Lagrange points, pass in `Body.Sun` for `major_body` @@ -10023,7 +10023,7 @@ class GravitySimulator: of the small bodies to be simulated. The caller must know the positions and velocities of the small bodies at an initial moment in time. Their positions and velocities are expressed with respect to `originBody`, - using equatorial J2000 orientation (EQJ). + using J2000 mean equator orientation (EQJ). Positions are expressed in astronomical units (AU). Velocities are expressed in AU/day. All the times embedded within the state vectors must exactly match `time`, diff --git a/generate/template/astronomy.c b/generate/template/astronomy.c index 01a5ccf7..ae1cbcba 100644 --- a/generate/template/astronomy.c +++ b/generate/template/astronomy.c @@ -2164,7 +2164,7 @@ astro_vector_t Astronomy_GeoMoon(astro_time_t time) * [Astronomy on the Personal Computer](https://www.springer.com/us/book/9783540672210) * by Montenbruck and Pfleger. * - * To calculate an equatorial J2000 vector instead, use #Astronomy_GeoMoon. + * To calculate a J2000 mean equator vector instead, use #Astronomy_GeoMoon. * * @param time The date and time for which to calculate the Moon's position. * @return The Moon's position expressed in ecliptic coordinates using the true equinox of date (ECT). @@ -3020,7 +3020,7 @@ static void GravSimDuplicate(astro_grav_sim_t *sim) * @param bodyStateArray * An array of initial state vectors (positions and velocities) of the small bodies to be simulated. * The caller must know the positions and velocities of the small bodies at an initial moment in time. - * Their positions and velocities are expressed with respect to `originBody`, using equatorial J2000 orientation (EQJ). + * Their positions and velocities are expressed with respect to `originBody`, using J2000 mean equator orientation (EQJ). * Positions are expressed in astronomical units (AU). Velocities are expressed in AU/day. * All the times embedded within the state vectors must be exactly equal to `time`, * or this function will fail with the error `ASTRO_INCONSISTENT_TIMES`. @@ -4265,7 +4265,7 @@ astro_vector_t Astronomy_GeoVector(astro_body_t body, astro_time_t time, astro_a * * Given a body and a time, calculates the barycentric position and velocity * vectors for the center of that body at that time. - * The vectors are expressed in equatorial J2000 coordinates (EQJ). + * The vectors are expressed in J2000 mean equator coordinates (EQJ). * * @param body * The celestial body whose barycentric state vector is to be calculated. @@ -4355,7 +4355,7 @@ astro_state_vector_t Astronomy_BaryState(astro_body_t body, astro_time_t time) * * Given a body and a time, calculates the position and velocity * vectors for the center of that body at that time, relative to the center of the Sun. - * The vectors are expressed in equatorial J2000 coordinates (EQJ). + * The vectors are expressed in J2000 mean equator coordinates (EQJ). * If you need the position vector only, it is more efficient to call #Astronomy_HelioVector. * The Sun's center is a non-inertial frame of reference. In other words, the Sun * experiences acceleration due to gravitational forces, mostly from the larger @@ -4504,7 +4504,7 @@ double Astronomy_MassProduct(astro_body_t body) * 5 = the Lagrange point 60 degrees behind the minor body's orbital position. * * The function returns the state vector for the selected Lagrange point - * in equatorial J2000 coordinates (EQJ), with respect to the center of the + * in J2000 mean equator coordinates (EQJ), with respect to the center of the * major body. * * To calculate Sun/Earth Lagrange points, pass in `BODY_SUN` for `major_body` @@ -8653,7 +8653,7 @@ astro_state_vector_t Astronomy_RotateState(astro_rotation_t rotation, astro_stat /** * @brief - * Calculates a rotation matrix from equatorial J2000 (EQJ) to ecliptic J2000 (ECL). + * Calculates a rotation matrix from J2000 mean equator (EQJ) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -8678,7 +8678,7 @@ astro_rotation_t Astronomy_Rotation_EQJ_ECL(void) /** * @brief - * Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial J2000 (EQJ). + * Calculates a rotation matrix from J2000 mean ecliptic (ECL) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -8703,7 +8703,7 @@ astro_rotation_t Astronomy_Rotation_ECL_EQJ(void) /** * @brief - * Calculates a rotation matrix from equatorial J2000 (EQJ) to equatorial of-date (EQD). + * Calculates a rotation matrix from J2000 mean equator (EQJ) to equatorial of-date (EQD). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -8727,7 +8727,7 @@ astro_rotation_t Astronomy_Rotation_EQJ_EQD(astro_time_t *time) /** * @brief - * Calculates a rotation matrix from equatorial of-date (EQD) to equatorial J2000 (EQJ). + * Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -8865,7 +8865,7 @@ astro_rotation_t Astronomy_Rotation_HOR_EQJ(astro_time_t *time, astro_observer_t /** * @brief - * Calculates a rotation matrix from equatorial J2000 (EQJ) to horizontal (HOR). + * Calculates a rotation matrix from J2000 mean equator (EQJ) to horizontal (HOR). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -8894,7 +8894,7 @@ astro_rotation_t Astronomy_Rotation_EQJ_HOR(astro_time_t *time, astro_observer_t /** * @brief - * Calculates a rotation matrix from equatorial of-date (EQD) to ecliptic J2000 (ECL). + * Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -8920,7 +8920,7 @@ astro_rotation_t Astronomy_Rotation_EQD_ECL(astro_time_t *time) /** * @brief - * Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial of-date (EQD). + * Calculates a rotation matrix from J2000 mean ecliptic (ECL) to equatorial of-date (EQD). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -8941,7 +8941,7 @@ astro_rotation_t Astronomy_Rotation_ECL_EQD(astro_time_t *time) /** * @brief - * Calculates a rotation matrix from ecliptic J2000 (ECL) to horizontal (HOR). + * Calculates a rotation matrix from J2000 mean ecliptic (ECL) to horizontal (HOR). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -8970,7 +8970,7 @@ astro_rotation_t Astronomy_Rotation_ECL_HOR(astro_time_t *time, astro_observer_t /** * @brief - * Calculates a rotation matrix from horizontal (HOR) to ecliptic J2000 (ECL). + * Calculates a rotation matrix from horizontal (HOR) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -8994,7 +8994,7 @@ astro_rotation_t Astronomy_Rotation_HOR_ECL(astro_time_t *time, astro_observer_t /** * @brief - * Returns a rotation matrix from ecliptic J2000 (EQJ) to galactic (GAL). + * Returns a rotation matrix from J2000 mean ecliptic (EQJ) to galactic (GAL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. diff --git a/generate/template/astronomy.cs b/generate/template/astronomy.cs index 16bdeadf..78f4f2d2 100644 --- a/generate/template/astronomy.cs +++ b/generate/template/astronomy.cs @@ -1577,7 +1577,7 @@ namespace CosineKitty /// [Report of the IAU Working Group on Cartographic Coordinates and Rotational Elements: 2015](https://astropedia.astrogeology.usgs.gov/download/Docs/WGCCRE/WGCCRE2015reprint.pdf). /// /// The field `north` is a unit vector pointing in the direction of the body's north pole. - /// It is expressed in the equatorial J2000 system (EQJ). + /// It is expressed in the J2000 mean equator system (EQJ). /// public struct AxisInfo { @@ -4174,7 +4174,7 @@ $ASTRO_JUPITER_MOONS(); /// [Astronomy on the Personal Computer](https://www.springer.com/us/book/9783540672210) /// by Montenbruck and Pfleger. /// - /// To calculate an equatorial J2000 vector instead, use #Astronomy.GeoMoon. + /// To calculate a J2000 mean equator vector instead, use #Astronomy.GeoMoon. /// /// /// The date and time for which to calculate the Moon's position. @@ -4794,7 +4794,7 @@ $ASTRO_JUPITER_MOONS(); /// /// Given a body and a time, calculates the barycentric position and velocity /// vectors for the center of that body at that time. - /// The vectors are expressed in equatorial J2000 coordinates (EQJ). + /// The vectors are expressed in J2000 mean equator coordinates (EQJ). /// /// /// The celestial body whose barycentric state vector is to be calculated. @@ -4875,7 +4875,7 @@ $ASTRO_JUPITER_MOONS(); /// /// Given a body and a time, calculates the position and velocity /// vectors for the center of that body at that time, relative to the center of the Sun. - /// The vectors are expressed in equatorial J2000 coordinates (EQJ). + /// The vectors are expressed in J2000 mean equator coordinates (EQJ). /// If you need the position vector only, it is more efficient to call #Astronomy.HelioVector. /// The Sun's center is a non-inertial frame of reference. In other words, the Sun /// experiences acceleration due to gravitational forces, mostly from the larger @@ -8653,7 +8653,7 @@ $ASTRO_JUPITER_MOONS(); /// 5 = the Lagrange point 60 degrees behind the minor body's orbital position. /// /// The function returns the state vector for the selected Lagrange point - /// in equatorial J2000 coordinates (EQJ), with respect to the center of the + /// in J2000 mean equator coordinates (EQJ), with respect to the center of the /// major body. /// /// To calculate Sun/Earth Lagrange points, pass in `Body.Sun` for `major_body` @@ -9589,7 +9589,7 @@ $ASTRO_JUPITER_MOONS(); return axis; } - /// Calculates a rotation matrix from equatorial J2000 (EQJ) to ecliptic J2000 (ECL). + /// Calculates a rotation matrix from J2000 mean equator (EQJ) to J2000 mean ecliptic (ECL). /// /// This is one of the family of functions that returns a rotation matrix /// for converting from one orientation to another. @@ -9612,7 +9612,7 @@ $ASTRO_JUPITER_MOONS(); } - /// Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial J2000 (EQJ). + /// Calculates a rotation matrix from J2000 mean ecliptic (ECL) to J2000 mean equator (EQJ). /// /// This is one of the family of functions that returns a rotation matrix /// for converting from one orientation to another. @@ -9636,7 +9636,7 @@ $ASTRO_JUPITER_MOONS(); /// - /// Calculates a rotation matrix from equatorial J2000 (EQJ) to equatorial of-date (EQD). + /// Calculates a rotation matrix from J2000 mean equator (EQJ) to equatorial of-date (EQD). /// /// /// This is one of the family of functions that returns a rotation matrix @@ -9659,7 +9659,7 @@ $ASTRO_JUPITER_MOONS(); /// - /// Calculates a rotation matrix from equatorial of-date (EQD) to equatorial J2000 (EQJ). + /// Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean equator (EQJ). /// /// /// This is one of the family of functions that returns a rotation matrix @@ -9782,7 +9782,7 @@ $ASTRO_JUPITER_MOONS(); /// - /// Calculates a rotation matrix from equatorial J2000 (EQJ) to horizontal (HOR). + /// Calculates a rotation matrix from J2000 mean equator (EQJ) to horizontal (HOR). /// /// /// This is one of the family of functions that returns a rotation matrix @@ -9811,7 +9811,7 @@ $ASTRO_JUPITER_MOONS(); /// - /// Calculates a rotation matrix from equatorial of-date (EQD) to ecliptic J2000 (ECL). + /// Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean ecliptic (ECL). /// /// /// This is one of the family of functions that returns a rotation matrix @@ -9834,7 +9834,7 @@ $ASTRO_JUPITER_MOONS(); /// - /// Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial of-date (EQD). + /// Calculates a rotation matrix from J2000 mean ecliptic (ECL) to equatorial of-date (EQD). /// /// /// This is one of the family of functions that returns a rotation matrix @@ -9856,7 +9856,7 @@ $ASTRO_JUPITER_MOONS(); /// - /// Calculates a rotation matrix from ecliptic J2000 (ECL) to horizontal (HOR). + /// Calculates a rotation matrix from J2000 mean ecliptic (ECL) to horizontal (HOR). /// /// /// This is one of the family of functions that returns a rotation matrix @@ -9885,7 +9885,7 @@ $ASTRO_JUPITER_MOONS(); } /// - /// Calculates a rotation matrix from horizontal (HOR) to ecliptic J2000 (ECL). + /// Calculates a rotation matrix from horizontal (HOR) to J2000 mean ecliptic (ECL). /// /// /// This is one of the family of functions that returns a rotation matrix @@ -9909,7 +9909,7 @@ $ASTRO_JUPITER_MOONS(); } /// - /// Calculates a rotation matrix from equatorial J2000 (EQJ) to galactic (GAL). + /// Calculates a rotation matrix from J2000 mean equator (EQJ) to galactic (GAL). /// /// /// This is one of the family of functions that returns a rotation matrix @@ -9944,7 +9944,7 @@ $ASTRO_JUPITER_MOONS(); } /// - /// Calculates a rotation matrix from galactic (GAL) to equatorial J2000 (EQJ). + /// Calculates a rotation matrix from galactic (GAL) to J2000 mean equator (EQJ). /// /// /// This is one of the family of functions that returns a rotation matrix diff --git a/generate/template/astronomy.kt b/generate/template/astronomy.kt index e691b7f2..84810d78 100644 --- a/generate/template/astronomy.kt +++ b/generate/template/astronomy.kt @@ -2912,7 +2912,7 @@ class IlluminationInfo( * [Report of the IAU Working Group on Cartographic Coordinates and Rotational Elements: 2015](https://astropedia.astrogeology.usgs.gov/download/Docs/WGCCRE/WGCCRE2015reprint.pdf). * * The field `north` is a unit vector pointing in the direction of the body's north pole. - * It is expressed in the equatorial J2000 system (EQJ). + * It is expressed in the J2000 mean equator system (EQJ). */ class AxisInfo( /** @@ -4708,7 +4708,7 @@ fun rotationAxis(body: Body, time: Time): AxisInfo { * [Astronomy on the Personal Computer](https://www.springer.com/us/book/9783540672210) * by Montenbruck and Pfleger. * -* To calculate an equatorial J2000 vector instead, use [geoMoon]. +* To calculate a J2000 mean equator vector instead, use [geoMoon]. * * @param time * The date and time for which to calculate the Moon's position. @@ -4950,7 +4950,7 @@ fun helioDistance(body: Body, time: Time): Double { * * Given a body and a time, calculates the position and velocity * vectors for the center of that body at that time, relative to the center of the Sun. - * The vectors are expressed in equatorial J2000 coordinates (EQJ). + * The vectors are expressed in J2000 mean equator coordinates (EQJ). * If you need the position vector only, it is more efficient to call [helioVector]. * The Sun's center is a non-inertial frame of reference. In other words, the Sun * experiences acceleration due to gravitational forces, mostly from the larger @@ -4995,7 +4995,7 @@ fun helioState(body: Body, time: Time): StateVector { * * Given a body and a time, calculates the barycentric position and velocity * vectors for the center of that body at that time. - * The vectors are expressed in equatorial J2000 coordinates (EQJ). + * The vectors are expressed in J2000 mean equator coordinates (EQJ). * * @param body * The celestial body whose barycentric state vector is to be calculated. @@ -7396,7 +7396,7 @@ fun observerGravity(latitude: Double, height: Double): Double { * 5 = the Lagrange point 60 degrees behind the minor body's orbital position. * * The function returns the state vector for the selected Lagrange point - * in equatorial J2000 coordinates (EQJ), with respect to the center of the + * in J2000 mean equator coordinates (EQJ), with respect to the center of the * major body. * * To calculate Sun/Earth Lagrange points, pass in [Body.Sun] for `majorBody` @@ -8106,7 +8106,7 @@ internal fun planetExtreme(body: Body, kind: ApsisKind, startTime: Time, initDay /** - * Calculates a rotation matrix from equatorial J2000 (EQJ) to ecliptic J2000 (ECL). + * Calculates a rotation matrix from J2000 mean equator (EQJ) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -8125,7 +8125,7 @@ fun rotationEqjEcl(): RotationMatrix { } /** - * Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial J2000 (EQJ). + * Calculates a rotation matrix from J2000 mean ecliptic (ECL) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -8144,7 +8144,7 @@ fun rotationEclEqj(): RotationMatrix { } /** - * Calculates a rotation matrix from equatorial J2000 (EQJ) to equatorial of-date (EQD). + * Calculates a rotation matrix from J2000 mean equator (EQJ) to equatorial of-date (EQD). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -8159,7 +8159,7 @@ fun rotationEqjEqd(time: Time): RotationMatrix = nutationRot(time, PrecessDirection.From2000) /** - * Calculates a rotation matrix from equatorial of-date (EQD) to equatorial J2000 (EQJ). + * Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -8260,7 +8260,7 @@ fun rotationHorEqj(time: Time, observer: Observer): RotationMatrix = rotationEqdEqj(time) /** - * Calculates a rotation matrix from equatorial J2000 (EQJ) to horizontal (HOR). + * Calculates a rotation matrix from J2000 mean equator (EQJ) to horizontal (HOR). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -8284,7 +8284,7 @@ fun rotationEqjHor(time: Time, observer: Observer): RotationMatrix = rotationHorEqj(time, observer).inverse() /** - * Calculates a rotation matrix from equatorial of-date (EQD) to ecliptic J2000 (ECL). + * Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -8301,7 +8301,7 @@ fun rotationEqdEcl(time: Time): RotationMatrix = rotationEqjEcl() /** - * Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial of-date (EQD). + * Calculates a rotation matrix from J2000 mean ecliptic (ECL) to equatorial of-date (EQD). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -8317,7 +8317,7 @@ fun rotationEclEqd(time: Time): RotationMatrix = rotationEqdEcl(time).inverse() /** - * Calculates a rotation matrix from ecliptic J2000 (ECL) to horizontal (HOR). + * Calculates a rotation matrix from J2000 mean ecliptic (ECL) to horizontal (HOR). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -8342,7 +8342,7 @@ fun rotationEclHor(time: Time, observer: Observer): RotationMatrix = rotationEqdHor(time, observer) /** - * Calculates a rotation matrix from horizontal (HOR) to ecliptic J2000 (ECL). + * Calculates a rotation matrix from horizontal (HOR) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -8362,7 +8362,7 @@ fun rotationHorEcl(time: Time, observer: Observer): RotationMatrix = rotationEclHor(time, observer).inverse() /** - * Calculates a rotation matrix from galactic (GAL) to equatorial J2000 (EQJ). + * Calculates a rotation matrix from galactic (GAL) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -8382,7 +8382,7 @@ fun rotationEqjGal() = ) /** - * Calculates a rotation matrix from galactic (GAL) to equatorial J2000 (EQJ). + * Calculates a rotation matrix from galactic (GAL) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. diff --git a/generate/template/astronomy.py b/generate/template/astronomy.py index b1d1b371..86871c25 100644 --- a/generate/template/astronomy.py +++ b/generate/template/astronomy.py @@ -1608,7 +1608,7 @@ def EclipticGeoMoon(time): [Astronomy on the Personal Computer](https://www.springer.com/us/book/9783540672210) by Montenbruck and Pfleger. - To calculate an equatorial J2000 vector instead, use #GeoMoon. + To calculate a J2000 mean equator vector instead, use #GeoMoon. Parameters ---------- @@ -2830,7 +2830,7 @@ def BaryState(body, time): Given a body and a time, calculates the barycentric position and velocity vectors for the center of that body at that time. - The vectors are expressed in equatorial J2000 coordinates (EQJ). + The vectors are expressed in J2000 mean equator coordinates (EQJ). Parameters ---------- @@ -2908,7 +2908,7 @@ def HelioState(body, time): Given a body and a time, calculates the position and velocity vectors for the center of that body at that time, relative to the center of the Sun. - The vectors are expressed in equatorial J2000 coordinates (EQJ). + The vectors are expressed in J2000 mean equator coordinates (EQJ). If you need the position vector only, it is more efficient to call #HelioVector. The Sun's center is a non-inertial frame of reference. In other words, the Sun experiences acceleration due to gravitational forces, mostly from the larger @@ -5731,7 +5731,7 @@ def RotateState(rotation, state): def Rotation_EQJ_ECL(): - """Calculates a rotation matrix from equatorial J2000 (EQJ) to ecliptic J2000 (ECL). + """Calculates a rotation matrix from J2000 mean equator (EQJ) to J2000 mean ecliptic (ECL). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -5754,7 +5754,7 @@ def Rotation_EQJ_ECL(): def Rotation_ECL_EQJ(): - """Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial J2000 (EQJ). + """Calculates a rotation matrix from J2000 mean ecliptic (ECL) to J2000 mean equator (EQJ). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -5776,7 +5776,7 @@ def Rotation_ECL_EQJ(): ]) def Rotation_EQJ_EQD(time): - """Calculates a rotation matrix from equatorial J2000 (EQJ) to equatorial of-date (EQD). + """Calculates a rotation matrix from J2000 mean equator (EQJ) to equatorial of-date (EQD). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -5799,7 +5799,7 @@ def Rotation_EQJ_EQD(time): def Rotation_EQD_EQJ(time): - """Calculates a rotation matrix from equatorial of-date (EQD) to equatorial J2000 (EQJ). + """Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean equator (EQJ). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -5916,7 +5916,7 @@ def Rotation_HOR_EQJ(time, observer): def Rotation_EQJ_HOR(time, observer): - """Calculates a rotation matrix from equatorial J2000 (EQJ) to horizontal (HOR). + """Calculates a rotation matrix from J2000 mean equator (EQJ) to horizontal (HOR). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -5947,7 +5947,7 @@ def Rotation_EQJ_HOR(time, observer): def Rotation_EQD_ECL(time): - """Calculates a rotation matrix from equatorial of-date (EQD) to ecliptic J2000 (ECL). + """Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean ecliptic (ECL). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -5970,7 +5970,7 @@ def Rotation_EQD_ECL(time): def Rotation_ECL_EQD(time): - """Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial of-date (EQD). + """Calculates a rotation matrix from J2000 mean ecliptic (ECL) to equatorial of-date (EQD). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -5992,7 +5992,7 @@ def Rotation_ECL_EQD(time): def Rotation_ECL_HOR(time, observer): - """Calculates a rotation matrix from ecliptic J2000 (ECL) to horizontal (HOR). + """Calculates a rotation matrix from J2000 mean ecliptic (ECL) to horizontal (HOR). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -6024,7 +6024,7 @@ def Rotation_ECL_HOR(time, observer): def Rotation_HOR_ECL(time, observer): - """Calculates a rotation matrix from horizontal (HOR) to ecliptic J2000 (ECL). + """Calculates a rotation matrix from horizontal (HOR) to J2000 mean ecliptic (ECL). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -6047,7 +6047,7 @@ def Rotation_HOR_ECL(time, observer): return InverseRotation(rot) def Rotation_EQJ_GAL(): - """Calculates a rotation matrix from equatorial J2000 (EQJ) to galactic (GAL). + """Calculates a rotation matrix from J2000 mean equator (EQJ) to galactic (GAL). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -6069,7 +6069,7 @@ def Rotation_EQJ_GAL(): ]) def Rotation_GAL_EQJ(): - """Calculates a rotation matrix from galactic (GAL) to equatorial J2000 (EQJ). + """Calculates a rotation matrix from galactic (GAL) to J2000 mean equator (EQJ). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -7537,7 +7537,7 @@ class AxisInfo: [Report of the IAU Working Group on Cartographic Coordinates and Rotational Elements: 2015](https://astropedia.astrogeology.usgs.gov/download/Docs/WGCCRE/WGCCRE2015reprint.pdf). The field `north` is a unit vector pointing in the direction of the body's north pole. - It is expressed in the equatorial J2000 system (EQJ). + It is expressed in the J2000 mean equator system (EQJ). Attributes ---------- @@ -7802,7 +7802,7 @@ def LagrangePoint(point, time, major_body, minor_body): 5 = the Lagrange point 60 degrees behind the minor body's orbital position. The function returns the state vector for the selected Lagrange point - in equatorial J2000 coordinates (EQJ), with respect to the center of the + in J2000 mean equator coordinates (EQJ), with respect to the center of the major body. To calculate Sun/Earth Lagrange points, pass in `Body.Sun` for `major_body` @@ -8066,7 +8066,7 @@ class GravitySimulator: of the small bodies to be simulated. The caller must know the positions and velocities of the small bodies at an initial moment in time. Their positions and velocities are expressed with respect to `originBody`, - using equatorial J2000 orientation (EQJ). + using J2000 mean equator orientation (EQJ). Positions are expressed in astronomical units (AU). Velocities are expressed in AU/day. All the times embedded within the state vectors must exactly match `time`, diff --git a/generate/template/astronomy.ts b/generate/template/astronomy.ts index 4df4c3f8..1929d5a7 100644 --- a/generate/template/astronomy.ts +++ b/generate/template/astronomy.ts @@ -2347,7 +2347,7 @@ export function GeoMoon(date: FlexibleDateTime): Vector { * Astronomy on the Personal Computer * by Montenbruck and Pfleger. * - * To calculate an equatorial J2000 vector instead, use {@link GeoMoon}. + * To calculate a J2000 mean equator vector instead, use {@link GeoMoon}. * * @param {FlexibleDateTime} date * The date and time for which to calculate the Moon's position. @@ -3451,7 +3451,7 @@ function ExportState(terse: body_state_t, time: AstroTime): StateVector { * * Given a body and a time, calculates the barycentric position and velocity * vectors for the center of that body at that time. - * The vectors are expressed in equatorial J2000 coordinates (EQJ). + * The vectors are expressed in J2000 mean equator coordinates (EQJ). * * @param {Body} body * The celestial body whose barycentric state vector is to be calculated. @@ -3525,7 +3525,7 @@ export function BaryState(body: Body, date: FlexibleDateTime): StateVector { * * Given a body and a time, calculates the position and velocity * vectors for the center of that body at that time, relative to the center of the Sun. - * The vectors are expressed in equatorial J2000 coordinates (EQJ). + * The vectors are expressed in J2000 mean equator coordinates (EQJ). * If you need the position vector only, it is more efficient to call {@link HelioVector}. * The Sun's center is a non-inertial frame of reference. In other words, the Sun * experiences acceleration due to gravitational forces, mostly from the larger @@ -6239,7 +6239,7 @@ export function RotateState(rotation: RotationMatrix, state: StateVector): State /** - * @brief Calculates a rotation matrix from equatorial J2000 (EQJ) to ecliptic J2000 (ECL). + * @brief Calculates a rotation matrix from J2000 mean equator (EQJ) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6262,7 +6262,7 @@ export function Rotation_EQJ_ECL(): RotationMatrix { /** - * @brief Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial J2000 (EQJ). + * @brief Calculates a rotation matrix from J2000 mean ecliptic (ECL) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6285,7 +6285,7 @@ export function Rotation_ECL_EQJ(): RotationMatrix { /** - * @brief Calculates a rotation matrix from equatorial J2000 (EQJ) to equatorial of-date (EQD). + * @brief Calculates a rotation matrix from J2000 mean equator (EQJ) to equatorial of-date (EQD). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6307,7 +6307,7 @@ export function Rotation_EQJ_EQD(time: FlexibleDateTime): RotationMatrix { /** - * @brief Calculates a rotation matrix from equatorial of-date (EQD) to equatorial J2000 (EQJ). + * @brief Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6425,7 +6425,7 @@ export function Rotation_HOR_EQJ(time: FlexibleDateTime, observer: Observer): Ro /** - * @brief Calculates a rotation matrix from equatorial J2000 (EQJ) to horizontal (HOR). + * @brief Calculates a rotation matrix from J2000 mean equator (EQJ) to horizontal (HOR). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6455,7 +6455,7 @@ export function Rotation_EQJ_HOR(time: FlexibleDateTime, observer: Observer): Ro /** - * @brief Calculates a rotation matrix from equatorial of-date (EQD) to ecliptic J2000 (ECL). + * @brief Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6476,7 +6476,7 @@ export function Rotation_EQD_ECL(time: FlexibleDateTime): RotationMatrix { /** - * @brief Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial of-date (EQD). + * @brief Calculates a rotation matrix from J2000 mean ecliptic (ECL) to equatorial of-date (EQD). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6496,7 +6496,7 @@ export function Rotation_ECL_EQD(time: FlexibleDateTime): RotationMatrix { /** - * @brief Calculates a rotation matrix from ecliptic J2000 (ECL) to horizontal (HOR). + * @brief Calculates a rotation matrix from J2000 mean ecliptic (ECL) to horizontal (HOR). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6528,7 +6528,7 @@ export function Rotation_ECL_HOR(time: FlexibleDateTime, observer: Observer): Ro /** - * @brief Calculates a rotation matrix from horizontal (HOR) to ecliptic J2000 (ECL). + * @brief Calculates a rotation matrix from horizontal (HOR) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6551,7 +6551,7 @@ export function Rotation_HOR_ECL(time: FlexibleDateTime, observer: Observer): Ro /** - * @brief Calculates a rotation matrix from equatorial J2000 (EQJ) to galactic (GAL). + * @brief Calculates a rotation matrix from J2000 mean equator (EQJ) to galactic (GAL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6574,7 +6574,7 @@ export function Rotation_EQJ_GAL(): RotationMatrix { /** - * @brief Calculates a rotation matrix from galactic (GAL) to equatorial J2000 (EQJ). + * @brief Calculates a rotation matrix from galactic (GAL) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -7971,7 +7971,7 @@ export function NextMoonNode(prevNode: NodeEventInfo): NodeEventInfo { * α0, δ0, and W, respectively, from * [Report of the IAU Working Group on Cartographic Coordinates and Rotational Elements: 2015](https://astropedia.astrogeology.usgs.gov/download/Docs/WGCCRE/WGCCRE2015reprint.pdf). * The field `north` is a unit vector pointing in the direction of the body's north pole. - * It is expressed in the equatorial J2000 system (EQJ). + * It is expressed in the J2000 mean equator system (EQJ). * * @property {number} ra * The J2000 right ascension of the body's north pole direction, in sidereal hours. @@ -8250,7 +8250,7 @@ export function RotationAxis(body: Body, date: FlexibleDateTime): AxisInfo { * 5 = the Lagrange point 60 degrees behind the minor body's orbital position. * * The function returns the state vector for the selected Lagrange point - * in equatorial J2000 coordinates (EQJ), with respect to the center of the + * in J2000 mean equator coordinates (EQJ), with respect to the center of the * major body. * * To calculate Sun/Earth Lagrange points, pass in `Body.Sun` for `major_body` diff --git a/source/c/README.md b/source/c/README.md index 410c0bf6..290363bf 100644 --- a/source/c/README.md +++ b/source/c/README.md @@ -329,7 +329,7 @@ For a more generalized light travel correction solver, see [`Astronomy_CorrectLi -Given a body and a time, calculates the barycentric position and velocity vectors for the center of that body at that time. The vectors are expressed in equatorial J2000 coordinates (EQJ). +Given a body and a time, calculates the barycentric position and velocity vectors for the center of that body at that time. The vectors are expressed in J2000 mean equator coordinates (EQJ). @@ -598,7 +598,7 @@ The ecliptic angles are measured in "ECT": relative to the true ecliptic plane a This algorithm is based on the Nautical Almanac Office's *Improved Lunar Ephemeris* of 1954, which in turn derives from E. W. Brown's lunar theories from the early twentieth century. It is adapted from Turbo Pascal code from the book [Astronomy on the Personal Computer](https://www.springer.com/us/book/9783540672210) by Montenbruck and Pfleger. -To calculate an equatorial J2000 vector instead, use [`Astronomy_GeoMoon`](#Astronomy_GeoMoon). +To calculate a J2000 mean equator vector instead, use [`Astronomy_GeoMoon`](#Astronomy_GeoMoon). @@ -937,7 +937,7 @@ If this function succeeds (returns `ASTRO_SUCCESS`), `sim` will be set to a dyna | [`astro_body_t`](#astro_body_t) | `originBody` | Specifies the origin of the reference frame. All position vectors and velocity vectors will use `originBody` as the origin of the coordinate system. This origin applies to all the input vectors provided in the `bodyStateArray` parameter of this function, along with all output vectors returned by [`Astronomy_GravSimUpdate`](#Astronomy_GravSimUpdate). Most callers will want to provide one of the following: `BODY_SUN` for heliocentric coordinates, `BODY_SSB` for solar system barycentric coordinates, or `BODY_EARTH` for geocentric coordinates. Note that the gravity simulator does not correct for light travel time; all state vectors are tied to a Newtonian "instantaneous" time. | | [`astro_time_t`](#astro_time_t) | `time` | The initial time at which to start the simulation. | | `int` | `numBodies` | The number of small bodies to be simulated. This may be any non-negative integer. | -| `const astro_state_vector_t *` | `bodyStateArray` | An array of initial state vectors (positions and velocities) of the small bodies to be simulated. The caller must know the positions and velocities of the small bodies at an initial moment in time. Their positions and velocities are expressed with respect to `originBody`, using equatorial J2000 orientation (EQJ). Positions are expressed in astronomical units (AU). Velocities are expressed in AU/day. All the times embedded within the state vectors must be exactly equal to `time`, or this function will fail with the error `ASTRO_INCONSISTENT_TIMES`. | +| `const astro_state_vector_t *` | `bodyStateArray` | An array of initial state vectors (positions and velocities) of the small bodies to be simulated. The caller must know the positions and velocities of the small bodies at an initial moment in time. Their positions and velocities are expressed with respect to `originBody`, using J2000 mean equator orientation (EQJ). Positions are expressed in astronomical units (AU). Velocities are expressed in AU/day. All the times embedded within the state vectors must be exactly equal to `time`, or this function will fail with the error `ASTRO_INCONSISTENT_TIMES`. | @@ -1085,7 +1085,7 @@ Given a date and time, this function calculates the distance between the center -Given a body and a time, calculates the position and velocity vectors for the center of that body at that time, relative to the center of the Sun. The vectors are expressed in equatorial J2000 coordinates (EQJ). If you need the position vector only, it is more efficient to call [`Astronomy_HelioVector`](#Astronomy_HelioVector). The Sun's center is a non-inertial frame of reference. In other words, the Sun experiences acceleration due to gravitational forces, mostly from the larger planets (Jupiter, Saturn, Uranus, and Neptune). If you want to calculate momentum, kinetic energy, or other quantities that require a non-accelerating frame of reference, consider using [`Astronomy_BaryState`](#Astronomy_BaryState) instead. +Given a body and a time, calculates the position and velocity vectors for the center of that body at that time, relative to the center of the Sun. The vectors are expressed in J2000 mean equator coordinates (EQJ). If you need the position vector only, it is more efficient to call [`Astronomy_HelioVector`](#Astronomy_HelioVector). The Sun's center is a non-inertial frame of reference. In other words, the Sun experiences acceleration due to gravitational forces, mostly from the larger planets (Jupiter, Saturn, Uranus, and Neptune). If you want to calculate momentum, kinetic energy, or other quantities that require a non-accelerating frame of reference, consider using [`Astronomy_BaryState`](#Astronomy_BaryState) instead. @@ -1335,7 +1335,7 @@ Given a more massive "major" body and a much less massive "minor" body, calculat 1 = the Lagrange point between the major body and minor body. 2 = the Lagrange point on the far side of the minor body. 3 = the Lagrange point on the far side of the major body. 4 = the Lagrange point 60 degrees ahead of the minor body's orbital position. 5 = the Lagrange point 60 degrees behind the minor body's orbital position. -The function returns the state vector for the selected Lagrange point in equatorial J2000 coordinates (EQJ), with respect to the center of the major body. +The function returns the state vector for the selected Lagrange point in J2000 mean equator coordinates (EQJ), with respect to the center of the major body. To calculate Sun/Earth Lagrange points, pass in `BODY_SUN` for `major_body` and `BODY_EMB` (Earth/Moon barycenter) for `minor_body`. For Lagrange points of the Sun and any other planet, pass in that planet (e.g. `BODY_JUPITER`) for `minor_body`. To calculate Earth/Moon Lagrange points, pass in `BODY_EARTH` and `BODY_MOON` for the major and minor bodies respectively. @@ -2028,7 +2028,7 @@ See [`astro_axis_t`](#astro_axis_t) for more detailed information. ### Astronomy_Rotation_ECL_EQD(time) ⇒ [`astro_rotation_t`](#astro_rotation_t) -**Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial of-date (EQD).** +**Calculates a rotation matrix from J2000 mean ecliptic (ECL) to equatorial of-date (EQD).** @@ -2052,7 +2052,7 @@ This is one of the family of functions that returns a rotation matrix for conver ### Astronomy_Rotation_ECL_EQJ() ⇒ [`astro_rotation_t`](#astro_rotation_t) -**Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial J2000 (EQJ).** +**Calculates a rotation matrix from J2000 mean ecliptic (ECL) to J2000 mean equator (EQJ).** @@ -2069,7 +2069,7 @@ This is one of the family of functions that returns a rotation matrix for conver ### Astronomy_Rotation_ECL_HOR(time, observer) ⇒ [`astro_rotation_t`](#astro_rotation_t) -**Calculates a rotation matrix from ecliptic J2000 (ECL) to horizontal (HOR).** +**Calculates a rotation matrix from J2000 mean ecliptic (ECL) to horizontal (HOR).** @@ -2118,7 +2118,7 @@ This is one of the family of functions that returns a rotation matrix for conver ### Astronomy_Rotation_EQD_ECL(time) ⇒ [`astro_rotation_t`](#astro_rotation_t) -**Calculates a rotation matrix from equatorial of-date (EQD) to ecliptic J2000 (ECL).** +**Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean ecliptic (ECL).** @@ -2166,7 +2166,7 @@ This is one of the family of functions that returns a rotation matrix for conver ### Astronomy_Rotation_EQD_EQJ(time) ⇒ [`astro_rotation_t`](#astro_rotation_t) -**Calculates a rotation matrix from equatorial of-date (EQD) to equatorial J2000 (EQJ).** +**Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean equator (EQJ).** @@ -2215,7 +2215,7 @@ This is one of the family of functions that returns a rotation matrix for conver ### Astronomy_Rotation_EQJ_ECL() ⇒ [`astro_rotation_t`](#astro_rotation_t) -**Calculates a rotation matrix from equatorial J2000 (EQJ) to ecliptic J2000 (ECL).** +**Calculates a rotation matrix from J2000 mean equator (EQJ) to J2000 mean ecliptic (ECL).** @@ -2232,7 +2232,7 @@ This is one of the family of functions that returns a rotation matrix for conver ### Astronomy_Rotation_EQJ_EQD(time) ⇒ [`astro_rotation_t`](#astro_rotation_t) -**Calculates a rotation matrix from equatorial J2000 (EQJ) to equatorial of-date (EQD).** +**Calculates a rotation matrix from J2000 mean equator (EQJ) to equatorial of-date (EQD).** @@ -2256,7 +2256,7 @@ This is one of the family of functions that returns a rotation matrix for conver ### Astronomy_Rotation_EQJ_GAL() ⇒ [`astro_rotation_t`](#astro_rotation_t) -**Returns a rotation matrix from ecliptic J2000 (EQJ) to galactic (GAL).** +**Returns a rotation matrix from J2000 mean ecliptic (EQJ) to galactic (GAL).** @@ -2273,7 +2273,7 @@ This is one of the family of functions that returns a rotation matrix for conver ### Astronomy_Rotation_EQJ_HOR(time, observer) ⇒ [`astro_rotation_t`](#astro_rotation_t) -**Calculates a rotation matrix from equatorial J2000 (EQJ) to horizontal (HOR).** +**Calculates a rotation matrix from J2000 mean equator (EQJ) to horizontal (HOR).** @@ -2315,7 +2315,7 @@ This is one of the family of functions that returns a rotation matrix for conver ### Astronomy_Rotation_HOR_ECL(time, observer) ⇒ [`astro_rotation_t`](#astro_rotation_t) -**Calculates a rotation matrix from horizontal (HOR) to ecliptic J2000 (ECL).** +**Calculates a rotation matrix from horizontal (HOR) to J2000 mean ecliptic (ECL).** diff --git a/source/c/astronomy.c b/source/c/astronomy.c index d15b16a3..6007a153 100644 --- a/source/c/astronomy.c +++ b/source/c/astronomy.c @@ -2275,7 +2275,7 @@ astro_vector_t Astronomy_GeoMoon(astro_time_t time) * [Astronomy on the Personal Computer](https://www.springer.com/us/book/9783540672210) * by Montenbruck and Pfleger. * - * To calculate an equatorial J2000 vector instead, use #Astronomy_GeoMoon. + * To calculate a J2000 mean equator vector instead, use #Astronomy_GeoMoon. * * @param time The date and time for which to calculate the Moon's position. * @return The Moon's position expressed in ecliptic coordinates using the true equinox of date (ECT). @@ -3954,7 +3954,7 @@ static void GravSimDuplicate(astro_grav_sim_t *sim) * @param bodyStateArray * An array of initial state vectors (positions and velocities) of the small bodies to be simulated. * The caller must know the positions and velocities of the small bodies at an initial moment in time. - * Their positions and velocities are expressed with respect to `originBody`, using equatorial J2000 orientation (EQJ). + * Their positions and velocities are expressed with respect to `originBody`, using J2000 mean equator orientation (EQJ). * Positions are expressed in astronomical units (AU). Velocities are expressed in AU/day. * All the times embedded within the state vectors must be exactly equal to `time`, * or this function will fail with the error `ASTRO_INCONSISTENT_TIMES`. @@ -5426,7 +5426,7 @@ astro_vector_t Astronomy_GeoVector(astro_body_t body, astro_time_t time, astro_a * * Given a body and a time, calculates the barycentric position and velocity * vectors for the center of that body at that time. - * The vectors are expressed in equatorial J2000 coordinates (EQJ). + * The vectors are expressed in J2000 mean equator coordinates (EQJ). * * @param body * The celestial body whose barycentric state vector is to be calculated. @@ -5516,7 +5516,7 @@ astro_state_vector_t Astronomy_BaryState(astro_body_t body, astro_time_t time) * * Given a body and a time, calculates the position and velocity * vectors for the center of that body at that time, relative to the center of the Sun. - * The vectors are expressed in equatorial J2000 coordinates (EQJ). + * The vectors are expressed in J2000 mean equator coordinates (EQJ). * If you need the position vector only, it is more efficient to call #Astronomy_HelioVector. * The Sun's center is a non-inertial frame of reference. In other words, the Sun * experiences acceleration due to gravitational forces, mostly from the larger @@ -5665,7 +5665,7 @@ double Astronomy_MassProduct(astro_body_t body) * 5 = the Lagrange point 60 degrees behind the minor body's orbital position. * * The function returns the state vector for the selected Lagrange point - * in equatorial J2000 coordinates (EQJ), with respect to the center of the + * in J2000 mean equator coordinates (EQJ), with respect to the center of the * major body. * * To calculate Sun/Earth Lagrange points, pass in `BODY_SUN` for `major_body` @@ -9814,7 +9814,7 @@ astro_state_vector_t Astronomy_RotateState(astro_rotation_t rotation, astro_stat /** * @brief - * Calculates a rotation matrix from equatorial J2000 (EQJ) to ecliptic J2000 (ECL). + * Calculates a rotation matrix from J2000 mean equator (EQJ) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -9839,7 +9839,7 @@ astro_rotation_t Astronomy_Rotation_EQJ_ECL(void) /** * @brief - * Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial J2000 (EQJ). + * Calculates a rotation matrix from J2000 mean ecliptic (ECL) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -9864,7 +9864,7 @@ astro_rotation_t Astronomy_Rotation_ECL_EQJ(void) /** * @brief - * Calculates a rotation matrix from equatorial J2000 (EQJ) to equatorial of-date (EQD). + * Calculates a rotation matrix from J2000 mean equator (EQJ) to equatorial of-date (EQD). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -9888,7 +9888,7 @@ astro_rotation_t Astronomy_Rotation_EQJ_EQD(astro_time_t *time) /** * @brief - * Calculates a rotation matrix from equatorial of-date (EQD) to equatorial J2000 (EQJ). + * Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -10026,7 +10026,7 @@ astro_rotation_t Astronomy_Rotation_HOR_EQJ(astro_time_t *time, astro_observer_t /** * @brief - * Calculates a rotation matrix from equatorial J2000 (EQJ) to horizontal (HOR). + * Calculates a rotation matrix from J2000 mean equator (EQJ) to horizontal (HOR). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -10055,7 +10055,7 @@ astro_rotation_t Astronomy_Rotation_EQJ_HOR(astro_time_t *time, astro_observer_t /** * @brief - * Calculates a rotation matrix from equatorial of-date (EQD) to ecliptic J2000 (ECL). + * Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -10081,7 +10081,7 @@ astro_rotation_t Astronomy_Rotation_EQD_ECL(astro_time_t *time) /** * @brief - * Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial of-date (EQD). + * Calculates a rotation matrix from J2000 mean ecliptic (ECL) to equatorial of-date (EQD). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -10102,7 +10102,7 @@ astro_rotation_t Astronomy_Rotation_ECL_EQD(astro_time_t *time) /** * @brief - * Calculates a rotation matrix from ecliptic J2000 (ECL) to horizontal (HOR). + * Calculates a rotation matrix from J2000 mean ecliptic (ECL) to horizontal (HOR). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -10131,7 +10131,7 @@ astro_rotation_t Astronomy_Rotation_ECL_HOR(astro_time_t *time, astro_observer_t /** * @brief - * Calculates a rotation matrix from horizontal (HOR) to ecliptic J2000 (ECL). + * Calculates a rotation matrix from horizontal (HOR) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -10155,7 +10155,7 @@ astro_rotation_t Astronomy_Rotation_HOR_ECL(astro_time_t *time, astro_observer_t /** * @brief - * Returns a rotation matrix from ecliptic J2000 (EQJ) to galactic (GAL). + * Returns a rotation matrix from J2000 mean ecliptic (EQJ) to galactic (GAL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. diff --git a/source/csharp/README.md b/source/csharp/README.md index 8fd75b7e..f417f35b 100644 --- a/source/csharp/README.md +++ b/source/csharp/README.md @@ -366,7 +366,7 @@ For a more generalized light travel correction solver, see [`Astronomy.CorrectLi Given a body and a time, calculates the barycentric position and velocity vectors for the center of that body at that time. -The vectors are expressed in equatorial J2000 coordinates (EQJ). +The vectors are expressed in J2000 mean equator coordinates (EQJ). | Type | Parameter | Description | | --- | --- | --- | @@ -494,7 +494,7 @@ It is adapted from Turbo Pascal code from the book [Astronomy on the Personal Computer](https://www.springer.com/us/book/9783540672210) by Montenbruck and Pfleger. -To calculate an equatorial J2000 vector instead, use [`Astronomy.GeoMoon`](#Astronomy.GeoMoon). +To calculate a J2000 mean equator vector instead, use [`Astronomy.GeoMoon`](#Astronomy.GeoMoon). | Type | Parameter | Description | | --- | --- | --- | @@ -719,7 +719,7 @@ of the resulting vector. Given a body and a time, calculates the position and velocity vectors for the center of that body at that time, relative to the center of the Sun. -The vectors are expressed in equatorial J2000 coordinates (EQJ). +The vectors are expressed in J2000 mean equator coordinates (EQJ). If you need the position vector only, it is more efficient to call [`Astronomy.HelioVector`](#Astronomy.HelioVector). The Sun's center is a non-inertial frame of reference. In other words, the Sun experiences acceleration due to gravitational forces, mostly from the larger @@ -942,7 +942,7 @@ selects the Lagrange point as follows: 5 = the Lagrange point 60 degrees behind the minor body's orbital position. The function returns the state vector for the selected Lagrange point -in equatorial J2000 coordinates (EQJ), with respect to the center of the +in J2000 mean equator coordinates (EQJ), with respect to the center of the major body. To calculate Sun/Earth Lagrange points, pass in `Body.Sun` for `major_body` @@ -1471,7 +1471,7 @@ in another orientation. ### Astronomy.Rotation_ECL_EQD(time) ⇒ [`RotationMatrix`](#RotationMatrix) -**Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial of-date (EQD).** +**Calculates a rotation matrix from J2000 mean ecliptic (ECL) to equatorial of-date (EQD).** This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -1487,7 +1487,7 @@ Target: EQD = equatorial system, using equator of date. ### Astronomy.Rotation_ECL_EQJ() ⇒ [`RotationMatrix`](#RotationMatrix) -**Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial J2000 (EQJ).** +**Calculates a rotation matrix from J2000 mean ecliptic (ECL) to J2000 mean equator (EQJ).** This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -1499,7 +1499,7 @@ Target: EQJ = equatorial system, using equator at J2000 epoch. ### Astronomy.Rotation_ECL_HOR(time, observer) ⇒ [`RotationMatrix`](#RotationMatrix) -**Calculates a rotation matrix from ecliptic J2000 (ECL) to horizontal (HOR).** +**Calculates a rotation matrix from J2000 mean ecliptic (ECL) to horizontal (HOR).** This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -1532,7 +1532,7 @@ Target: EQD = equator of date. ### Astronomy.Rotation_EQD_ECL(time) ⇒ [`RotationMatrix`](#RotationMatrix) -**Calculates a rotation matrix from equatorial of-date (EQD) to ecliptic J2000 (ECL).** +**Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean ecliptic (ECL).** This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -1564,7 +1564,7 @@ Target: ECT = true ecliptic of date. ### Astronomy.Rotation_EQD_EQJ(time) ⇒ [`RotationMatrix`](#RotationMatrix) -**Calculates a rotation matrix from equatorial of-date (EQD) to equatorial J2000 (EQJ).** +**Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean equator (EQJ).** This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -1597,7 +1597,7 @@ Target: HOR = horizontal system. ### Astronomy.Rotation_EQJ_ECL() ⇒ [`RotationMatrix`](#RotationMatrix) -**Calculates a rotation matrix from equatorial J2000 (EQJ) to ecliptic J2000 (ECL).** +**Calculates a rotation matrix from J2000 mean equator (EQJ) to J2000 mean ecliptic (ECL).** This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -1609,7 +1609,7 @@ Target: ECL = ecliptic system, using equator at J2000 epoch. ### Astronomy.Rotation_EQJ_EQD(time) ⇒ [`RotationMatrix`](#RotationMatrix) -**Calculates a rotation matrix from equatorial J2000 (EQJ) to equatorial of-date (EQD).** +**Calculates a rotation matrix from J2000 mean equator (EQJ) to equatorial of-date (EQD).** This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -1625,7 +1625,7 @@ Target: EQD = equatorial system, using equator of the specified date/time. ### Astronomy.Rotation_EQJ_GAL() ⇒ [`RotationMatrix`](#RotationMatrix) -**Calculates a rotation matrix from equatorial J2000 (EQJ) to galactic (GAL).** +**Calculates a rotation matrix from J2000 mean equator (EQJ) to galactic (GAL).** This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -1637,7 +1637,7 @@ Target: GAL = galactic system (IAU 1958 definition). ### Astronomy.Rotation_EQJ_HOR(time, observer) ⇒ [`RotationMatrix`](#RotationMatrix) -**Calculates a rotation matrix from equatorial J2000 (EQJ) to horizontal (HOR).** +**Calculates a rotation matrix from J2000 mean equator (EQJ) to horizontal (HOR).** This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -1654,7 +1654,7 @@ Target: HOR = horizontal system. ### Astronomy.Rotation_GAL_EQJ() ⇒ [`RotationMatrix`](#RotationMatrix) -**Calculates a rotation matrix from galactic (GAL) to equatorial J2000 (EQJ).** +**Calculates a rotation matrix from galactic (GAL) to J2000 mean equator (EQJ).** This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -1666,7 +1666,7 @@ Target: EQJ = equatorial system, using the equator at the J2000 epoch. ### Astronomy.Rotation_HOR_ECL(time, observer) ⇒ [`RotationMatrix`](#RotationMatrix) -**Calculates a rotation matrix from horizontal (HOR) to ecliptic J2000 (ECL).** +**Calculates a rotation matrix from horizontal (HOR) to J2000 mean ecliptic (ECL).** This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -2614,7 +2614,7 @@ The fields `ra`, `dec`, and `spin` correspond to the variables [Report of the IAU Working Group on Cartographic Coordinates and Rotational Elements: 2015](https://astropedia.astrogeology.usgs.gov/download/Docs/WGCCRE/WGCCRE2015reprint.pdf). The field `north` is a unit vector pointing in the direction of the body's north pole. -It is expressed in the equatorial J2000 system (EQJ). +It is expressed in the J2000 mean equator system (EQJ). ### member variables diff --git a/source/csharp/astronomy.cs b/source/csharp/astronomy.cs index de775e6d..9482bf6f 100644 --- a/source/csharp/astronomy.cs +++ b/source/csharp/astronomy.cs @@ -1577,7 +1577,7 @@ namespace CosineKitty /// [Report of the IAU Working Group on Cartographic Coordinates and Rotational Elements: 2015](https://astropedia.astrogeology.usgs.gov/download/Docs/WGCCRE/WGCCRE2015reprint.pdf). /// /// The field `north` is a unit vector pointing in the direction of the body's north pole. - /// It is expressed in the equatorial J2000 system (EQJ). + /// It is expressed in the J2000 mean equator system (EQJ). /// public struct AxisInfo { @@ -5308,7 +5308,7 @@ namespace CosineKitty /// [Astronomy on the Personal Computer](https://www.springer.com/us/book/9783540672210) /// by Montenbruck and Pfleger. /// - /// To calculate an equatorial J2000 vector instead, use #Astronomy.GeoMoon. + /// To calculate a J2000 mean equator vector instead, use #Astronomy.GeoMoon. /// /// /// The date and time for which to calculate the Moon's position. @@ -5928,7 +5928,7 @@ namespace CosineKitty /// /// Given a body and a time, calculates the barycentric position and velocity /// vectors for the center of that body at that time. - /// The vectors are expressed in equatorial J2000 coordinates (EQJ). + /// The vectors are expressed in J2000 mean equator coordinates (EQJ). /// /// /// The celestial body whose barycentric state vector is to be calculated. @@ -6009,7 +6009,7 @@ namespace CosineKitty /// /// Given a body and a time, calculates the position and velocity /// vectors for the center of that body at that time, relative to the center of the Sun. - /// The vectors are expressed in equatorial J2000 coordinates (EQJ). + /// The vectors are expressed in J2000 mean equator coordinates (EQJ). /// If you need the position vector only, it is more efficient to call #Astronomy.HelioVector. /// The Sun's center is a non-inertial frame of reference. In other words, the Sun /// experiences acceleration due to gravitational forces, mostly from the larger @@ -9787,7 +9787,7 @@ namespace CosineKitty /// 5 = the Lagrange point 60 degrees behind the minor body's orbital position. /// /// The function returns the state vector for the selected Lagrange point - /// in equatorial J2000 coordinates (EQJ), with respect to the center of the + /// in J2000 mean equator coordinates (EQJ), with respect to the center of the /// major body. /// /// To calculate Sun/Earth Lagrange points, pass in `Body.Sun` for `major_body` @@ -10723,7 +10723,7 @@ namespace CosineKitty return axis; } - /// Calculates a rotation matrix from equatorial J2000 (EQJ) to ecliptic J2000 (ECL). + /// Calculates a rotation matrix from J2000 mean equator (EQJ) to J2000 mean ecliptic (ECL). /// /// This is one of the family of functions that returns a rotation matrix /// for converting from one orientation to another. @@ -10746,7 +10746,7 @@ namespace CosineKitty } - /// Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial J2000 (EQJ). + /// Calculates a rotation matrix from J2000 mean ecliptic (ECL) to J2000 mean equator (EQJ). /// /// This is one of the family of functions that returns a rotation matrix /// for converting from one orientation to another. @@ -10770,7 +10770,7 @@ namespace CosineKitty /// - /// Calculates a rotation matrix from equatorial J2000 (EQJ) to equatorial of-date (EQD). + /// Calculates a rotation matrix from J2000 mean equator (EQJ) to equatorial of-date (EQD). /// /// /// This is one of the family of functions that returns a rotation matrix @@ -10793,7 +10793,7 @@ namespace CosineKitty /// - /// Calculates a rotation matrix from equatorial of-date (EQD) to equatorial J2000 (EQJ). + /// Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean equator (EQJ). /// /// /// This is one of the family of functions that returns a rotation matrix @@ -10916,7 +10916,7 @@ namespace CosineKitty /// - /// Calculates a rotation matrix from equatorial J2000 (EQJ) to horizontal (HOR). + /// Calculates a rotation matrix from J2000 mean equator (EQJ) to horizontal (HOR). /// /// /// This is one of the family of functions that returns a rotation matrix @@ -10945,7 +10945,7 @@ namespace CosineKitty /// - /// Calculates a rotation matrix from equatorial of-date (EQD) to ecliptic J2000 (ECL). + /// Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean ecliptic (ECL). /// /// /// This is one of the family of functions that returns a rotation matrix @@ -10968,7 +10968,7 @@ namespace CosineKitty /// - /// Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial of-date (EQD). + /// Calculates a rotation matrix from J2000 mean ecliptic (ECL) to equatorial of-date (EQD). /// /// /// This is one of the family of functions that returns a rotation matrix @@ -10990,7 +10990,7 @@ namespace CosineKitty /// - /// Calculates a rotation matrix from ecliptic J2000 (ECL) to horizontal (HOR). + /// Calculates a rotation matrix from J2000 mean ecliptic (ECL) to horizontal (HOR). /// /// /// This is one of the family of functions that returns a rotation matrix @@ -11019,7 +11019,7 @@ namespace CosineKitty } /// - /// Calculates a rotation matrix from horizontal (HOR) to ecliptic J2000 (ECL). + /// Calculates a rotation matrix from horizontal (HOR) to J2000 mean ecliptic (ECL). /// /// /// This is one of the family of functions that returns a rotation matrix @@ -11043,7 +11043,7 @@ namespace CosineKitty } /// - /// Calculates a rotation matrix from equatorial J2000 (EQJ) to galactic (GAL). + /// Calculates a rotation matrix from J2000 mean equator (EQJ) to galactic (GAL). /// /// /// This is one of the family of functions that returns a rotation matrix @@ -11078,7 +11078,7 @@ namespace CosineKitty } /// - /// Calculates a rotation matrix from galactic (GAL) to equatorial J2000 (EQJ). + /// Calculates a rotation matrix from galactic (GAL) to J2000 mean equator (EQJ). /// /// /// This is one of the family of functions that returns a rotation matrix diff --git a/source/js/README.md b/source/js/README.md index 233c5af9..67eaf3e7 100644 --- a/source/js/README.md +++ b/source/js/README.md @@ -854,7 +854,7 @@ The fields `ra`, `dec`, and `spin` correspond to the variables α0, δ0, and W, respectively, from [Report of the IAU Working Group on Cartographic Coordinates and Rotational Elements: 2015](https://astropedia.astrogeology.usgs.gov/download/Docs/WGCCRE/WGCCRE2015reprint.pdf). The field `north` is a unit vector pointing in the direction of the body's north pole. -It is expressed in the equatorial J2000 system (EQJ). +It is expressed in the J2000 mean equator system (EQJ). **Properties** | Name | Type | Description | @@ -1245,7 +1245,7 @@ For a more generalized light travel correction solver, see [CorrectLightTravel]( Given a body and a time, calculates the barycentric position and velocity vectors for the center of that body at that time. -The vectors are expressed in equatorial J2000 coordinates (EQJ). +The vectors are expressed in J2000 mean equator coordinates (EQJ). | Param | Type | Description | | --- | --- | --- | @@ -1394,7 +1394,7 @@ It is adapted from Turbo Pascal code from the book Astronomy on the Personal Computer by Montenbruck and Pfleger. -To calculate an equatorial J2000 vector instead, use [GeoMoon](#GeoMoon). +To calculate a J2000 mean equator vector instead, use [GeoMoon](#GeoMoon). | Param | Type | Description | | --- | --- | --- | @@ -1610,7 +1610,7 @@ of the resulting vector. Given a body and a time, calculates the position and velocity vectors for the center of that body at that time, relative to the center of the Sun. -The vectors are expressed in equatorial J2000 coordinates (EQJ). +The vectors are expressed in J2000 mean equator coordinates (EQJ). If you need the position vector only, it is more efficient to call [HelioVector](#HelioVector). The Sun's center is a non-inertial frame of reference. In other words, the Sun experiences acceleration due to gravitational forces, mostly from the larger @@ -1815,7 +1815,7 @@ selects the Lagrange point as follows: 5 = the Lagrange point 60 degrees behind the minor body's orbital position. The function returns the state vector for the selected Lagrange point -in equatorial J2000 coordinates (EQJ), with respect to the center of the +in J2000 mean equator coordinates (EQJ), with respect to the center of the major body. To calculate Sun/Earth Lagrange points, pass in `Body.Sun` for `major_body` @@ -2385,7 +2385,7 @@ See [AxisInfo](#AxisInfo) for more detailed information. ## Rotation\_ECL\_EQD(time) ⇒ [RotationMatrix](#RotationMatrix) **Kind**: global function **Returns**: [RotationMatrix](#RotationMatrix) - A rotation matrix that converts ECL to EQD. -**Brief**: Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial of-date (EQD). +**Brief**: Calculates a rotation matrix from J2000 mean ecliptic (ECL) to equatorial of-date (EQD). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -2404,7 +2404,7 @@ Target: EQD = equatorial system, using equator of date. ## Rotation\_ECL\_EQJ() ⇒ [RotationMatrix](#RotationMatrix) **Kind**: global function **Returns**: [RotationMatrix](#RotationMatrix) - A rotation matrix that converts ECL to EQJ. -**Brief**: Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial J2000 (EQJ). +**Brief**: Calculates a rotation matrix from J2000 mean ecliptic (ECL) to J2000 mean equator (EQJ). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -2422,7 +2422,7 @@ Target: EQJ = equatorial system, using equator at J2000 epoch. x = north, y = west, z = zenith (straight up from the observer). These components are chosen so that the "right-hand rule" works for the vector and so that north represents the direction where azimuth = 0. -**Brief**: Calculates a rotation matrix from ecliptic J2000 (ECL) to horizontal (HOR). +**Brief**: Calculates a rotation matrix from J2000 mean ecliptic (ECL) to horizontal (HOR). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -2459,7 +2459,7 @@ Target: EQD = equator of date ## Rotation\_EQD\_ECL(time) ⇒ [RotationMatrix](#RotationMatrix) **Kind**: global function **Returns**: [RotationMatrix](#RotationMatrix) - A rotation matrix that converts EQD to ECL. -**Brief**: Calculates a rotation matrix from equatorial of-date (EQD) to ecliptic J2000 (ECL). +**Brief**: Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean ecliptic (ECL). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -2492,7 +2492,7 @@ Target: ECT = true ecliptic of date ## Rotation\_EQD\_EQJ(time) ⇒ [RotationMatrix](#RotationMatrix) **Kind**: global function **Returns**: [RotationMatrix](#RotationMatrix) - A rotation matrix that converts EQD at `time` to EQJ. -**Brief**: Calculates a rotation matrix from equatorial of-date (EQD) to equatorial J2000 (EQJ). +**Brief**: Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean equator (EQJ). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -2538,7 +2538,7 @@ to a traditional altitude/azimuth pair. ## Rotation\_EQJ\_ECL() ⇒ [RotationMatrix](#RotationMatrix) **Kind**: global function **Returns**: [RotationMatrix](#RotationMatrix) - A rotation matrix that converts EQJ to ECL. -**Brief**: Calculates a rotation matrix from equatorial J2000 (EQJ) to ecliptic J2000 (ECL). +**Brief**: Calculates a rotation matrix from J2000 mean equator (EQJ) to J2000 mean ecliptic (ECL). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -2552,7 +2552,7 @@ Target: ECL = ecliptic system, using equator at J2000 epoch. ## Rotation\_EQJ\_EQD(time) ⇒ [RotationMatrix](#RotationMatrix) **Kind**: global function **Returns**: [RotationMatrix](#RotationMatrix) - A rotation matrix that converts EQJ to EQD at `time`. -**Brief**: Calculates a rotation matrix from equatorial J2000 (EQJ) to equatorial of-date (EQD). +**Brief**: Calculates a rotation matrix from J2000 mean equator (EQJ) to equatorial of-date (EQD). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -2571,7 +2571,7 @@ Target: EQD = equatorial system, using equator of the specified date/time. ## Rotation\_EQJ\_GAL() ⇒ [RotationMatrix](#RotationMatrix) **Kind**: global function **Returns**: [RotationMatrix](#RotationMatrix) - A rotation matrix that converts EQJ to GAL. -**Brief**: Calculates a rotation matrix from equatorial J2000 (EQJ) to galactic (GAL). +**Brief**: Calculates a rotation matrix from J2000 mean equator (EQJ) to galactic (GAL). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -2589,7 +2589,7 @@ Target: GAL = galactic system (IAU 1958 definition). x = north, y = west, z = zenith (straight up from the observer). These components are chosen so that the "right-hand rule" works for the vector and so that north represents the direction where azimuth = 0. -**Brief**: Calculates a rotation matrix from equatorial J2000 (EQJ) to horizontal (HOR). +**Brief**: Calculates a rotation matrix from J2000 mean equator (EQJ) to horizontal (HOR). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -2612,7 +2612,7 @@ to a traditional altitude/azimuth pair. ## Rotation\_GAL\_EQJ() ⇒ [RotationMatrix](#RotationMatrix) **Kind**: global function **Returns**: [RotationMatrix](#RotationMatrix) - A rotation matrix that converts GAL to EQJ. -**Brief**: Calculates a rotation matrix from galactic (GAL) to equatorial J2000 (EQJ). +**Brief**: Calculates a rotation matrix from galactic (GAL) to J2000 mean equator (EQJ). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -2626,7 +2626,7 @@ Target: EQJ = equatorial system, using the equator at the J2000 epoch. ## Rotation\_HOR\_ECL(time, observer) ⇒ [RotationMatrix](#RotationMatrix) **Kind**: global function **Returns**: [RotationMatrix](#RotationMatrix) - A rotation matrix that converts HOR to ECL. -**Brief**: Calculates a rotation matrix from horizontal (HOR) to ecliptic J2000 (ECL). +**Brief**: Calculates a rotation matrix from horizontal (HOR) to J2000 mean ecliptic (ECL). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. diff --git a/source/js/astronomy.browser.js b/source/js/astronomy.browser.js index 44b47490..66d2209e 100644 --- a/source/js/astronomy.browser.js +++ b/source/js/astronomy.browser.js @@ -2830,7 +2830,7 @@ exports.GeoMoon = GeoMoon; * Astronomy on the Personal Computer * by Montenbruck and Pfleger. * - * To calculate an equatorial J2000 vector instead, use {@link GeoMoon}. + * To calculate a J2000 mean equator vector instead, use {@link GeoMoon}. * * @param {FlexibleDateTime} date * The date and time for which to calculate the Moon's position. @@ -3919,7 +3919,7 @@ function ExportState(terse, time) { * * Given a body and a time, calculates the barycentric position and velocity * vectors for the center of that body at that time. - * The vectors are expressed in equatorial J2000 coordinates (EQJ). + * The vectors are expressed in J2000 mean equator coordinates (EQJ). * * @param {Body} body * The celestial body whose barycentric state vector is to be calculated. @@ -3970,7 +3970,7 @@ exports.BaryState = BaryState; * * Given a body and a time, calculates the position and velocity * vectors for the center of that body at that time, relative to the center of the Sun. - * The vectors are expressed in equatorial J2000 coordinates (EQJ). + * The vectors are expressed in J2000 mean equator coordinates (EQJ). * If you need the position vector only, it is more efficient to call {@link HelioVector}. * The Sun's center is a non-inertial frame of reference. In other words, the Sun * experiences acceleration due to gravitational forces, mostly from the larger @@ -6426,7 +6426,7 @@ function RotateState(rotation, state) { } exports.RotateState = RotateState; /** - * @brief Calculates a rotation matrix from equatorial J2000 (EQJ) to ecliptic J2000 (ECL). + * @brief Calculates a rotation matrix from J2000 mean equator (EQJ) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6448,7 +6448,7 @@ function Rotation_EQJ_ECL() { } exports.Rotation_EQJ_ECL = Rotation_EQJ_ECL; /** - * @brief Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial J2000 (EQJ). + * @brief Calculates a rotation matrix from J2000 mean ecliptic (ECL) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6470,7 +6470,7 @@ function Rotation_ECL_EQJ() { } exports.Rotation_ECL_EQJ = Rotation_ECL_EQJ; /** - * @brief Calculates a rotation matrix from equatorial J2000 (EQJ) to equatorial of-date (EQD). + * @brief Calculates a rotation matrix from J2000 mean equator (EQJ) to equatorial of-date (EQD). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6491,7 +6491,7 @@ function Rotation_EQJ_EQD(time) { } exports.Rotation_EQJ_EQD = Rotation_EQJ_EQD; /** - * @brief Calculates a rotation matrix from equatorial of-date (EQD) to equatorial J2000 (EQJ). + * @brief Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6602,7 +6602,7 @@ function Rotation_HOR_EQJ(time, observer) { } exports.Rotation_HOR_EQJ = Rotation_HOR_EQJ; /** - * @brief Calculates a rotation matrix from equatorial J2000 (EQJ) to horizontal (HOR). + * @brief Calculates a rotation matrix from J2000 mean equator (EQJ) to horizontal (HOR). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6631,7 +6631,7 @@ function Rotation_EQJ_HOR(time, observer) { } exports.Rotation_EQJ_HOR = Rotation_EQJ_HOR; /** - * @brief Calculates a rotation matrix from equatorial of-date (EQD) to ecliptic J2000 (ECL). + * @brief Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6651,7 +6651,7 @@ function Rotation_EQD_ECL(time) { } exports.Rotation_EQD_ECL = Rotation_EQD_ECL; /** - * @brief Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial of-date (EQD). + * @brief Calculates a rotation matrix from J2000 mean ecliptic (ECL) to equatorial of-date (EQD). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6670,7 +6670,7 @@ function Rotation_ECL_EQD(time) { } exports.Rotation_ECL_EQD = Rotation_ECL_EQD; /** - * @brief Calculates a rotation matrix from ecliptic J2000 (ECL) to horizontal (HOR). + * @brief Calculates a rotation matrix from J2000 mean ecliptic (ECL) to horizontal (HOR). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6701,7 +6701,7 @@ function Rotation_ECL_HOR(time, observer) { } exports.Rotation_ECL_HOR = Rotation_ECL_HOR; /** - * @brief Calculates a rotation matrix from horizontal (HOR) to ecliptic J2000 (ECL). + * @brief Calculates a rotation matrix from horizontal (HOR) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6723,7 +6723,7 @@ function Rotation_HOR_ECL(time, observer) { } exports.Rotation_HOR_ECL = Rotation_HOR_ECL; /** - * @brief Calculates a rotation matrix from equatorial J2000 (EQJ) to galactic (GAL). + * @brief Calculates a rotation matrix from J2000 mean equator (EQJ) to galactic (GAL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6745,7 +6745,7 @@ function Rotation_EQJ_GAL() { } exports.Rotation_EQJ_GAL = Rotation_EQJ_GAL; /** - * @brief Calculates a rotation matrix from galactic (GAL) to equatorial J2000 (EQJ). + * @brief Calculates a rotation matrix from galactic (GAL) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -8891,7 +8891,7 @@ exports.NextMoonNode = NextMoonNode; * α0, δ0, and W, respectively, from * [Report of the IAU Working Group on Cartographic Coordinates and Rotational Elements: 2015](https://astropedia.astrogeology.usgs.gov/download/Docs/WGCCRE/WGCCRE2015reprint.pdf). * The field `north` is a unit vector pointing in the direction of the body's north pole. - * It is expressed in the equatorial J2000 system (EQJ). + * It is expressed in the J2000 mean equator system (EQJ). * * @property {number} ra * The J2000 right ascension of the body's north pole direction, in sidereal hours. @@ -9118,7 +9118,7 @@ exports.RotationAxis = RotationAxis; * 5 = the Lagrange point 60 degrees behind the minor body's orbital position. * * The function returns the state vector for the selected Lagrange point - * in equatorial J2000 coordinates (EQJ), with respect to the center of the + * in J2000 mean equator coordinates (EQJ), with respect to the center of the * major body. * * To calculate Sun/Earth Lagrange points, pass in `Body.Sun` for `major_body` diff --git a/source/js/astronomy.d.ts b/source/js/astronomy.d.ts index 9610683e..81735bf0 100644 --- a/source/js/astronomy.d.ts +++ b/source/js/astronomy.d.ts @@ -888,7 +888,7 @@ export declare function GeoMoon(date: FlexibleDateTime): Vector; * Astronomy on the Personal Computer * by Montenbruck and Pfleger. * - * To calculate an equatorial J2000 vector instead, use {@link GeoMoon}. + * To calculate a J2000 mean equator vector instead, use {@link GeoMoon}. * * @param {FlexibleDateTime} date * The date and time for which to calculate the Moon's position. @@ -1147,7 +1147,7 @@ export declare function GeoVector(body: Body, date: FlexibleDateTime, aberration * * Given a body and a time, calculates the barycentric position and velocity * vectors for the center of that body at that time. - * The vectors are expressed in equatorial J2000 coordinates (EQJ). + * The vectors are expressed in J2000 mean equator coordinates (EQJ). * * @param {Body} body * The celestial body whose barycentric state vector is to be calculated. @@ -1167,7 +1167,7 @@ export declare function BaryState(body: Body, date: FlexibleDateTime): StateVect * * Given a body and a time, calculates the position and velocity * vectors for the center of that body at that time, relative to the center of the Sun. - * The vectors are expressed in equatorial J2000 coordinates (EQJ). + * The vectors are expressed in J2000 mean equator coordinates (EQJ). * If you need the position vector only, it is more efficient to call {@link HelioVector}. * The Sun's center is a non-inertial frame of reference. In other words, the Sun * experiences acceleration due to gravitational forces, mostly from the larger @@ -2296,7 +2296,7 @@ export declare function RotateVector(rotation: RotationMatrix, vector: Vector): */ export declare function RotateState(rotation: RotationMatrix, state: StateVector): StateVector; /** - * @brief Calculates a rotation matrix from equatorial J2000 (EQJ) to ecliptic J2000 (ECL). + * @brief Calculates a rotation matrix from J2000 mean equator (EQJ) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -2308,7 +2308,7 @@ export declare function RotateState(rotation: RotationMatrix, state: StateVector */ export declare function Rotation_EQJ_ECL(): RotationMatrix; /** - * @brief Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial J2000 (EQJ). + * @brief Calculates a rotation matrix from J2000 mean ecliptic (ECL) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -2320,7 +2320,7 @@ export declare function Rotation_EQJ_ECL(): RotationMatrix; */ export declare function Rotation_ECL_EQJ(): RotationMatrix; /** - * @brief Calculates a rotation matrix from equatorial J2000 (EQJ) to equatorial of-date (EQD). + * @brief Calculates a rotation matrix from J2000 mean equator (EQJ) to equatorial of-date (EQD). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -2335,7 +2335,7 @@ export declare function Rotation_ECL_EQJ(): RotationMatrix; */ export declare function Rotation_EQJ_EQD(time: FlexibleDateTime): RotationMatrix; /** - * @brief Calculates a rotation matrix from equatorial of-date (EQD) to equatorial J2000 (EQJ). + * @brief Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -2411,7 +2411,7 @@ export declare function Rotation_HOR_EQD(time: FlexibleDateTime, observer: Obser */ export declare function Rotation_HOR_EQJ(time: FlexibleDateTime, observer: Observer): RotationMatrix; /** - * @brief Calculates a rotation matrix from equatorial J2000 (EQJ) to horizontal (HOR). + * @brief Calculates a rotation matrix from J2000 mean equator (EQJ) to horizontal (HOR). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -2436,7 +2436,7 @@ export declare function Rotation_HOR_EQJ(time: FlexibleDateTime, observer: Obser */ export declare function Rotation_EQJ_HOR(time: FlexibleDateTime, observer: Observer): RotationMatrix; /** - * @brief Calculates a rotation matrix from equatorial of-date (EQD) to ecliptic J2000 (ECL). + * @brief Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -2451,7 +2451,7 @@ export declare function Rotation_EQJ_HOR(time: FlexibleDateTime, observer: Obser */ export declare function Rotation_EQD_ECL(time: FlexibleDateTime): RotationMatrix; /** - * @brief Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial of-date (EQD). + * @brief Calculates a rotation matrix from J2000 mean ecliptic (ECL) to equatorial of-date (EQD). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -2466,7 +2466,7 @@ export declare function Rotation_EQD_ECL(time: FlexibleDateTime): RotationMatrix */ export declare function Rotation_ECL_EQD(time: FlexibleDateTime): RotationMatrix; /** - * @brief Calculates a rotation matrix from ecliptic J2000 (ECL) to horizontal (HOR). + * @brief Calculates a rotation matrix from J2000 mean ecliptic (ECL) to horizontal (HOR). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -2491,7 +2491,7 @@ export declare function Rotation_ECL_EQD(time: FlexibleDateTime): RotationMatrix */ export declare function Rotation_ECL_HOR(time: FlexibleDateTime, observer: Observer): RotationMatrix; /** - * @brief Calculates a rotation matrix from horizontal (HOR) to ecliptic J2000 (ECL). + * @brief Calculates a rotation matrix from horizontal (HOR) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -2509,7 +2509,7 @@ export declare function Rotation_ECL_HOR(time: FlexibleDateTime, observer: Obser */ export declare function Rotation_HOR_ECL(time: FlexibleDateTime, observer: Observer): RotationMatrix; /** - * @brief Calculates a rotation matrix from equatorial J2000 (EQJ) to galactic (GAL). + * @brief Calculates a rotation matrix from J2000 mean equator (EQJ) to galactic (GAL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -2521,7 +2521,7 @@ export declare function Rotation_HOR_ECL(time: FlexibleDateTime, observer: Obser */ export declare function Rotation_EQJ_GAL(): RotationMatrix; /** - * @brief Calculates a rotation matrix from galactic (GAL) to equatorial J2000 (EQJ). + * @brief Calculates a rotation matrix from galactic (GAL) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -3077,7 +3077,7 @@ export declare function NextMoonNode(prevNode: NodeEventInfo): NodeEventInfo; * α0, δ0, and W, respectively, from * [Report of the IAU Working Group on Cartographic Coordinates and Rotational Elements: 2015](https://astropedia.astrogeology.usgs.gov/download/Docs/WGCCRE/WGCCRE2015reprint.pdf). * The field `north` is a unit vector pointing in the direction of the body's north pole. - * It is expressed in the equatorial J2000 system (EQJ). + * It is expressed in the J2000 mean equator system (EQJ). * * @property {number} ra * The J2000 right ascension of the body's north pole direction, in sidereal hours. @@ -3137,7 +3137,7 @@ export declare function RotationAxis(body: Body, date: FlexibleDateTime): AxisIn * 5 = the Lagrange point 60 degrees behind the minor body's orbital position. * * The function returns the state vector for the selected Lagrange point - * in equatorial J2000 coordinates (EQJ), with respect to the center of the + * in J2000 mean equator coordinates (EQJ), with respect to the center of the * major body. * * To calculate Sun/Earth Lagrange points, pass in `Body.Sun` for `major_body` diff --git a/source/js/astronomy.js b/source/js/astronomy.js index 2d30c590..6643c77c 100644 --- a/source/js/astronomy.js +++ b/source/js/astronomy.js @@ -2829,7 +2829,7 @@ exports.GeoMoon = GeoMoon; * Astronomy on the Personal Computer * by Montenbruck and Pfleger. * - * To calculate an equatorial J2000 vector instead, use {@link GeoMoon}. + * To calculate a J2000 mean equator vector instead, use {@link GeoMoon}. * * @param {FlexibleDateTime} date * The date and time for which to calculate the Moon's position. @@ -3918,7 +3918,7 @@ function ExportState(terse, time) { * * Given a body and a time, calculates the barycentric position and velocity * vectors for the center of that body at that time. - * The vectors are expressed in equatorial J2000 coordinates (EQJ). + * The vectors are expressed in J2000 mean equator coordinates (EQJ). * * @param {Body} body * The celestial body whose barycentric state vector is to be calculated. @@ -3969,7 +3969,7 @@ exports.BaryState = BaryState; * * Given a body and a time, calculates the position and velocity * vectors for the center of that body at that time, relative to the center of the Sun. - * The vectors are expressed in equatorial J2000 coordinates (EQJ). + * The vectors are expressed in J2000 mean equator coordinates (EQJ). * If you need the position vector only, it is more efficient to call {@link HelioVector}. * The Sun's center is a non-inertial frame of reference. In other words, the Sun * experiences acceleration due to gravitational forces, mostly from the larger @@ -6425,7 +6425,7 @@ function RotateState(rotation, state) { } exports.RotateState = RotateState; /** - * @brief Calculates a rotation matrix from equatorial J2000 (EQJ) to ecliptic J2000 (ECL). + * @brief Calculates a rotation matrix from J2000 mean equator (EQJ) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6447,7 +6447,7 @@ function Rotation_EQJ_ECL() { } exports.Rotation_EQJ_ECL = Rotation_EQJ_ECL; /** - * @brief Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial J2000 (EQJ). + * @brief Calculates a rotation matrix from J2000 mean ecliptic (ECL) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6469,7 +6469,7 @@ function Rotation_ECL_EQJ() { } exports.Rotation_ECL_EQJ = Rotation_ECL_EQJ; /** - * @brief Calculates a rotation matrix from equatorial J2000 (EQJ) to equatorial of-date (EQD). + * @brief Calculates a rotation matrix from J2000 mean equator (EQJ) to equatorial of-date (EQD). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6490,7 +6490,7 @@ function Rotation_EQJ_EQD(time) { } exports.Rotation_EQJ_EQD = Rotation_EQJ_EQD; /** - * @brief Calculates a rotation matrix from equatorial of-date (EQD) to equatorial J2000 (EQJ). + * @brief Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6601,7 +6601,7 @@ function Rotation_HOR_EQJ(time, observer) { } exports.Rotation_HOR_EQJ = Rotation_HOR_EQJ; /** - * @brief Calculates a rotation matrix from equatorial J2000 (EQJ) to horizontal (HOR). + * @brief Calculates a rotation matrix from J2000 mean equator (EQJ) to horizontal (HOR). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6630,7 +6630,7 @@ function Rotation_EQJ_HOR(time, observer) { } exports.Rotation_EQJ_HOR = Rotation_EQJ_HOR; /** - * @brief Calculates a rotation matrix from equatorial of-date (EQD) to ecliptic J2000 (ECL). + * @brief Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6650,7 +6650,7 @@ function Rotation_EQD_ECL(time) { } exports.Rotation_EQD_ECL = Rotation_EQD_ECL; /** - * @brief Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial of-date (EQD). + * @brief Calculates a rotation matrix from J2000 mean ecliptic (ECL) to equatorial of-date (EQD). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6669,7 +6669,7 @@ function Rotation_ECL_EQD(time) { } exports.Rotation_ECL_EQD = Rotation_ECL_EQD; /** - * @brief Calculates a rotation matrix from ecliptic J2000 (ECL) to horizontal (HOR). + * @brief Calculates a rotation matrix from J2000 mean ecliptic (ECL) to horizontal (HOR). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6700,7 +6700,7 @@ function Rotation_ECL_HOR(time, observer) { } exports.Rotation_ECL_HOR = Rotation_ECL_HOR; /** - * @brief Calculates a rotation matrix from horizontal (HOR) to ecliptic J2000 (ECL). + * @brief Calculates a rotation matrix from horizontal (HOR) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6722,7 +6722,7 @@ function Rotation_HOR_ECL(time, observer) { } exports.Rotation_HOR_ECL = Rotation_HOR_ECL; /** - * @brief Calculates a rotation matrix from equatorial J2000 (EQJ) to galactic (GAL). + * @brief Calculates a rotation matrix from J2000 mean equator (EQJ) to galactic (GAL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6744,7 +6744,7 @@ function Rotation_EQJ_GAL() { } exports.Rotation_EQJ_GAL = Rotation_EQJ_GAL; /** - * @brief Calculates a rotation matrix from galactic (GAL) to equatorial J2000 (EQJ). + * @brief Calculates a rotation matrix from galactic (GAL) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -8890,7 +8890,7 @@ exports.NextMoonNode = NextMoonNode; * α0, δ0, and W, respectively, from * [Report of the IAU Working Group on Cartographic Coordinates and Rotational Elements: 2015](https://astropedia.astrogeology.usgs.gov/download/Docs/WGCCRE/WGCCRE2015reprint.pdf). * The field `north` is a unit vector pointing in the direction of the body's north pole. - * It is expressed in the equatorial J2000 system (EQJ). + * It is expressed in the J2000 mean equator system (EQJ). * * @property {number} ra * The J2000 right ascension of the body's north pole direction, in sidereal hours. @@ -9117,7 +9117,7 @@ exports.RotationAxis = RotationAxis; * 5 = the Lagrange point 60 degrees behind the minor body's orbital position. * * The function returns the state vector for the selected Lagrange point - * in equatorial J2000 coordinates (EQJ), with respect to the center of the + * in J2000 mean equator coordinates (EQJ), with respect to the center of the * major body. * * To calculate Sun/Earth Lagrange points, pass in `Body.Sun` for `major_body` diff --git a/source/js/astronomy.ts b/source/js/astronomy.ts index fabd7ee0..a37a03cc 100644 --- a/source/js/astronomy.ts +++ b/source/js/astronomy.ts @@ -3080,7 +3080,7 @@ export function GeoMoon(date: FlexibleDateTime): Vector { * Astronomy on the Personal Computer * by Montenbruck and Pfleger. * - * To calculate an equatorial J2000 vector instead, use {@link GeoMoon}. + * To calculate a J2000 mean equator vector instead, use {@link GeoMoon}. * * @param {FlexibleDateTime} date * The date and time for which to calculate the Moon's position. @@ -4379,7 +4379,7 @@ function ExportState(terse: body_state_t, time: AstroTime): StateVector { * * Given a body and a time, calculates the barycentric position and velocity * vectors for the center of that body at that time. - * The vectors are expressed in equatorial J2000 coordinates (EQJ). + * The vectors are expressed in J2000 mean equator coordinates (EQJ). * * @param {Body} body * The celestial body whose barycentric state vector is to be calculated. @@ -4453,7 +4453,7 @@ export function BaryState(body: Body, date: FlexibleDateTime): StateVector { * * Given a body and a time, calculates the position and velocity * vectors for the center of that body at that time, relative to the center of the Sun. - * The vectors are expressed in equatorial J2000 coordinates (EQJ). + * The vectors are expressed in J2000 mean equator coordinates (EQJ). * If you need the position vector only, it is more efficient to call {@link HelioVector}. * The Sun's center is a non-inertial frame of reference. In other words, the Sun * experiences acceleration due to gravitational forces, mostly from the larger @@ -7167,7 +7167,7 @@ export function RotateState(rotation: RotationMatrix, state: StateVector): State /** - * @brief Calculates a rotation matrix from equatorial J2000 (EQJ) to ecliptic J2000 (ECL). + * @brief Calculates a rotation matrix from J2000 mean equator (EQJ) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -7190,7 +7190,7 @@ export function Rotation_EQJ_ECL(): RotationMatrix { /** - * @brief Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial J2000 (EQJ). + * @brief Calculates a rotation matrix from J2000 mean ecliptic (ECL) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -7213,7 +7213,7 @@ export function Rotation_ECL_EQJ(): RotationMatrix { /** - * @brief Calculates a rotation matrix from equatorial J2000 (EQJ) to equatorial of-date (EQD). + * @brief Calculates a rotation matrix from J2000 mean equator (EQJ) to equatorial of-date (EQD). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -7235,7 +7235,7 @@ export function Rotation_EQJ_EQD(time: FlexibleDateTime): RotationMatrix { /** - * @brief Calculates a rotation matrix from equatorial of-date (EQD) to equatorial J2000 (EQJ). + * @brief Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -7353,7 +7353,7 @@ export function Rotation_HOR_EQJ(time: FlexibleDateTime, observer: Observer): Ro /** - * @brief Calculates a rotation matrix from equatorial J2000 (EQJ) to horizontal (HOR). + * @brief Calculates a rotation matrix from J2000 mean equator (EQJ) to horizontal (HOR). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -7383,7 +7383,7 @@ export function Rotation_EQJ_HOR(time: FlexibleDateTime, observer: Observer): Ro /** - * @brief Calculates a rotation matrix from equatorial of-date (EQD) to ecliptic J2000 (ECL). + * @brief Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -7404,7 +7404,7 @@ export function Rotation_EQD_ECL(time: FlexibleDateTime): RotationMatrix { /** - * @brief Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial of-date (EQD). + * @brief Calculates a rotation matrix from J2000 mean ecliptic (ECL) to equatorial of-date (EQD). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -7424,7 +7424,7 @@ export function Rotation_ECL_EQD(time: FlexibleDateTime): RotationMatrix { /** - * @brief Calculates a rotation matrix from ecliptic J2000 (ECL) to horizontal (HOR). + * @brief Calculates a rotation matrix from J2000 mean ecliptic (ECL) to horizontal (HOR). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -7456,7 +7456,7 @@ export function Rotation_ECL_HOR(time: FlexibleDateTime, observer: Observer): Ro /** - * @brief Calculates a rotation matrix from horizontal (HOR) to ecliptic J2000 (ECL). + * @brief Calculates a rotation matrix from horizontal (HOR) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -7479,7 +7479,7 @@ export function Rotation_HOR_ECL(time: FlexibleDateTime, observer: Observer): Ro /** - * @brief Calculates a rotation matrix from equatorial J2000 (EQJ) to galactic (GAL). + * @brief Calculates a rotation matrix from J2000 mean equator (EQJ) to galactic (GAL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -7502,7 +7502,7 @@ export function Rotation_EQJ_GAL(): RotationMatrix { /** - * @brief Calculates a rotation matrix from galactic (GAL) to equatorial J2000 (EQJ). + * @brief Calculates a rotation matrix from galactic (GAL) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -9350,7 +9350,7 @@ export function NextMoonNode(prevNode: NodeEventInfo): NodeEventInfo { * α0, δ0, and W, respectively, from * [Report of the IAU Working Group on Cartographic Coordinates and Rotational Elements: 2015](https://astropedia.astrogeology.usgs.gov/download/Docs/WGCCRE/WGCCRE2015reprint.pdf). * The field `north` is a unit vector pointing in the direction of the body's north pole. - * It is expressed in the equatorial J2000 system (EQJ). + * It is expressed in the J2000 mean equator system (EQJ). * * @property {number} ra * The J2000 right ascension of the body's north pole direction, in sidereal hours. @@ -9629,7 +9629,7 @@ export function RotationAxis(body: Body, date: FlexibleDateTime): AxisInfo { * 5 = the Lagrange point 60 degrees behind the minor body's orbital position. * * The function returns the state vector for the selected Lagrange point - * in equatorial J2000 coordinates (EQJ), with respect to the center of the + * in J2000 mean equator coordinates (EQJ), with respect to the center of the * major body. * * To calculate Sun/Earth Lagrange points, pass in `Body.Sun` for `major_body` diff --git a/source/js/esm/astronomy.js b/source/js/esm/astronomy.js index 83730bf7..497980c3 100644 --- a/source/js/esm/astronomy.js +++ b/source/js/esm/astronomy.js @@ -2794,7 +2794,7 @@ export function GeoMoon(date) { * Astronomy on the Personal Computer * by Montenbruck and Pfleger. * - * To calculate an equatorial J2000 vector instead, use {@link GeoMoon}. + * To calculate a J2000 mean equator vector instead, use {@link GeoMoon}. * * @param {FlexibleDateTime} date * The date and time for which to calculate the Moon's position. @@ -3872,7 +3872,7 @@ function ExportState(terse, time) { * * Given a body and a time, calculates the barycentric position and velocity * vectors for the center of that body at that time. - * The vectors are expressed in equatorial J2000 coordinates (EQJ). + * The vectors are expressed in J2000 mean equator coordinates (EQJ). * * @param {Body} body * The celestial body whose barycentric state vector is to be calculated. @@ -3922,7 +3922,7 @@ export function BaryState(body, date) { * * Given a body and a time, calculates the position and velocity * vectors for the center of that body at that time, relative to the center of the Sun. - * The vectors are expressed in equatorial J2000 coordinates (EQJ). + * The vectors are expressed in J2000 mean equator coordinates (EQJ). * If you need the position vector only, it is more efficient to call {@link HelioVector}. * The Sun's center is a non-inertial frame of reference. In other words, the Sun * experiences acceleration due to gravitational forces, mostly from the larger @@ -6336,7 +6336,7 @@ export function RotateState(rotation, state) { return new StateVector(rotation.rot[0][0] * state.x + rotation.rot[1][0] * state.y + rotation.rot[2][0] * state.z, rotation.rot[0][1] * state.x + rotation.rot[1][1] * state.y + rotation.rot[2][1] * state.z, rotation.rot[0][2] * state.x + rotation.rot[1][2] * state.y + rotation.rot[2][2] * state.z, rotation.rot[0][0] * state.vx + rotation.rot[1][0] * state.vy + rotation.rot[2][0] * state.vz, rotation.rot[0][1] * state.vx + rotation.rot[1][1] * state.vy + rotation.rot[2][1] * state.vz, rotation.rot[0][2] * state.vx + rotation.rot[1][2] * state.vy + rotation.rot[2][2] * state.vz, state.t); } /** - * @brief Calculates a rotation matrix from equatorial J2000 (EQJ) to ecliptic J2000 (ECL). + * @brief Calculates a rotation matrix from J2000 mean equator (EQJ) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6357,7 +6357,7 @@ export function Rotation_EQJ_ECL() { ]); } /** - * @brief Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial J2000 (EQJ). + * @brief Calculates a rotation matrix from J2000 mean ecliptic (ECL) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6378,7 +6378,7 @@ export function Rotation_ECL_EQJ() { ]); } /** - * @brief Calculates a rotation matrix from equatorial J2000 (EQJ) to equatorial of-date (EQD). + * @brief Calculates a rotation matrix from J2000 mean equator (EQJ) to equatorial of-date (EQD). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6398,7 +6398,7 @@ export function Rotation_EQJ_EQD(time) { return CombineRotation(prec, nut); } /** - * @brief Calculates a rotation matrix from equatorial of-date (EQD) to equatorial J2000 (EQJ). + * @brief Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6505,7 +6505,7 @@ export function Rotation_HOR_EQJ(time, observer) { return CombineRotation(hor_eqd, eqd_eqj); } /** - * @brief Calculates a rotation matrix from equatorial J2000 (EQJ) to horizontal (HOR). + * @brief Calculates a rotation matrix from J2000 mean equator (EQJ) to horizontal (HOR). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6533,7 +6533,7 @@ export function Rotation_EQJ_HOR(time, observer) { return InverseRotation(rot); } /** - * @brief Calculates a rotation matrix from equatorial of-date (EQD) to ecliptic J2000 (ECL). + * @brief Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6552,7 +6552,7 @@ export function Rotation_EQD_ECL(time) { return CombineRotation(eqd_eqj, eqj_ecl); } /** - * @brief Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial of-date (EQD). + * @brief Calculates a rotation matrix from J2000 mean ecliptic (ECL) to equatorial of-date (EQD). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6570,7 +6570,7 @@ export function Rotation_ECL_EQD(time) { return InverseRotation(rot); } /** - * @brief Calculates a rotation matrix from ecliptic J2000 (ECL) to horizontal (HOR). + * @brief Calculates a rotation matrix from J2000 mean ecliptic (ECL) to horizontal (HOR). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6600,7 +6600,7 @@ export function Rotation_ECL_HOR(time, observer) { return CombineRotation(ecl_eqd, eqd_hor); } /** - * @brief Calculates a rotation matrix from horizontal (HOR) to ecliptic J2000 (ECL). + * @brief Calculates a rotation matrix from horizontal (HOR) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6621,7 +6621,7 @@ export function Rotation_HOR_ECL(time, observer) { return InverseRotation(rot); } /** - * @brief Calculates a rotation matrix from equatorial J2000 (EQJ) to galactic (GAL). + * @brief Calculates a rotation matrix from J2000 mean equator (EQJ) to galactic (GAL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -6642,7 +6642,7 @@ export function Rotation_EQJ_GAL() { ]); } /** - * @brief Calculates a rotation matrix from galactic (GAL) to equatorial J2000 (EQJ). + * @brief Calculates a rotation matrix from galactic (GAL) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -8767,7 +8767,7 @@ export function NextMoonNode(prevNode) { * α0, δ0, and W, respectively, from * [Report of the IAU Working Group on Cartographic Coordinates and Rotational Elements: 2015](https://astropedia.astrogeology.usgs.gov/download/Docs/WGCCRE/WGCCRE2015reprint.pdf). * The field `north` is a unit vector pointing in the direction of the body's north pole. - * It is expressed in the equatorial J2000 system (EQJ). + * It is expressed in the J2000 mean equator system (EQJ). * * @property {number} ra * The J2000 right ascension of the body's north pole direction, in sidereal hours. @@ -8992,7 +8992,7 @@ export function RotationAxis(body, date) { * 5 = the Lagrange point 60 degrees behind the minor body's orbital position. * * The function returns the state vector for the selected Lagrange point - * in equatorial J2000 coordinates (EQJ), with respect to the center of the + * in J2000 mean equator coordinates (EQJ), with respect to the center of the * major body. * * To calculate Sun/Earth Lagrange points, pass in `Body.Sun` for `major_body` diff --git a/source/kotlin/README.md b/source/kotlin/README.md index cf096b09..977e4a87 100644 --- a/source/kotlin/README.md +++ b/source/kotlin/README.md @@ -170,20 +170,20 @@ movement through the Solar System. | [radiansToDegrees](doc/radians-to-degrees.md)
fun [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html).[radiansToDegrees](doc/radians-to-degrees.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Convert an angle expressed in radians to an angle expressed in degrees. | | [refractionAngle](doc/refraction-angle.md)
fun [refractionAngle](doc/refraction-angle.md)(refraction: [Refraction](doc/-refraction/index.md), altitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Calculates the amount of "lift" to an altitude angle caused by atmospheric refraction. | | [rotationAxis](doc/rotation-axis.md)
fun [rotationAxis](doc/rotation-axis.md)(body: [Body](doc/-body/index.md), time: [Time](doc/-time/index.md)): [AxisInfo](doc/-axis-info/index.md)
Calculates information about a body's rotation axis at a given time. | -| [rotationEclEqd](doc/rotation-ecl-eqd.md)
fun [rotationEclEqd](doc/rotation-ecl-eqd.md)(time: [Time](doc/-time/index.md)): [RotationMatrix](doc/-rotation-matrix/index.md)
Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial of-date (EQD). | -| [rotationEclEqj](doc/rotation-ecl-eqj.md)
fun [rotationEclEqj](doc/rotation-ecl-eqj.md)(): [RotationMatrix](doc/-rotation-matrix/index.md)
Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial J2000 (EQJ). | -| [rotationEclHor](doc/rotation-ecl-hor.md)
fun [rotationEclHor](doc/rotation-ecl-hor.md)(time: [Time](doc/-time/index.md), observer: [Observer](doc/-observer/index.md)): [RotationMatrix](doc/-rotation-matrix/index.md)
Calculates a rotation matrix from ecliptic J2000 (ECL) to horizontal (HOR). | +| [rotationEclEqd](doc/rotation-ecl-eqd.md)
fun [rotationEclEqd](doc/rotation-ecl-eqd.md)(time: [Time](doc/-time/index.md)): [RotationMatrix](doc/-rotation-matrix/index.md)
Calculates a rotation matrix from J2000 mean ecliptic (ECL) to equatorial of-date (EQD). | +| [rotationEclEqj](doc/rotation-ecl-eqj.md)
fun [rotationEclEqj](doc/rotation-ecl-eqj.md)(): [RotationMatrix](doc/-rotation-matrix/index.md)
Calculates a rotation matrix from J2000 mean ecliptic (ECL) to J2000 mean equator (EQJ). | +| [rotationEclHor](doc/rotation-ecl-hor.md)
fun [rotationEclHor](doc/rotation-ecl-hor.md)(time: [Time](doc/-time/index.md), observer: [Observer](doc/-observer/index.md)): [RotationMatrix](doc/-rotation-matrix/index.md)
Calculates a rotation matrix from J2000 mean ecliptic (ECL) to horizontal (HOR). | | [rotationEctEqd](doc/rotation-ect-eqd.md)
fun [rotationEctEqd](doc/rotation-ect-eqd.md)(time: [Time](doc/-time/index.md)): [RotationMatrix](doc/-rotation-matrix/index.md)
Calculates a rotation matrix from true ecliptic of date (ECT) to equator of date (EQD). | -| [rotationEqdEcl](doc/rotation-eqd-ecl.md)
fun [rotationEqdEcl](doc/rotation-eqd-ecl.md)(time: [Time](doc/-time/index.md)): [RotationMatrix](doc/-rotation-matrix/index.md)
Calculates a rotation matrix from equatorial of-date (EQD) to ecliptic J2000 (ECL). | +| [rotationEqdEcl](doc/rotation-eqd-ecl.md)
fun [rotationEqdEcl](doc/rotation-eqd-ecl.md)(time: [Time](doc/-time/index.md)): [RotationMatrix](doc/-rotation-matrix/index.md)
Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean ecliptic (ECL). | | [rotationEqdEct](doc/rotation-eqd-ect.md)
fun [rotationEqdEct](doc/rotation-eqd-ect.md)(time: [Time](doc/-time/index.md)): [RotationMatrix](doc/-rotation-matrix/index.md)
Calculates a rotation matrix from equator of date (EQD) to true ecliptic of date (ECT). | -| [rotationEqdEqj](doc/rotation-eqd-eqj.md)
fun [rotationEqdEqj](doc/rotation-eqd-eqj.md)(time: [Time](doc/-time/index.md)): [RotationMatrix](doc/-rotation-matrix/index.md)
Calculates a rotation matrix from equatorial of-date (EQD) to equatorial J2000 (EQJ). | +| [rotationEqdEqj](doc/rotation-eqd-eqj.md)
fun [rotationEqdEqj](doc/rotation-eqd-eqj.md)(time: [Time](doc/-time/index.md)): [RotationMatrix](doc/-rotation-matrix/index.md)
Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean equator (EQJ). | | [rotationEqdHor](doc/rotation-eqd-hor.md)
fun [rotationEqdHor](doc/rotation-eqd-hor.md)(time: [Time](doc/-time/index.md), observer: [Observer](doc/-observer/index.md)): [RotationMatrix](doc/-rotation-matrix/index.md)
Calculates a rotation matrix from equatorial of-date (EQD) to horizontal (HOR). | -| [rotationEqjEcl](doc/rotation-eqj-ecl.md)
fun [rotationEqjEcl](doc/rotation-eqj-ecl.md)(): [RotationMatrix](doc/-rotation-matrix/index.md)
Calculates a rotation matrix from equatorial J2000 (EQJ) to ecliptic J2000 (ECL). | -| [rotationEqjEqd](doc/rotation-eqj-eqd.md)
fun [rotationEqjEqd](doc/rotation-eqj-eqd.md)(time: [Time](doc/-time/index.md)): [RotationMatrix](doc/-rotation-matrix/index.md)
Calculates a rotation matrix from equatorial J2000 (EQJ) to equatorial of-date (EQD). | -| [rotationEqjGal](doc/rotation-eqj-gal.md)
fun [rotationEqjGal](doc/rotation-eqj-gal.md)(): [RotationMatrix](doc/-rotation-matrix/index.md)
Calculates a rotation matrix from galactic (GAL) to equatorial J2000 (EQJ). | -| [rotationEqjHor](doc/rotation-eqj-hor.md)
fun [rotationEqjHor](doc/rotation-eqj-hor.md)(time: [Time](doc/-time/index.md), observer: [Observer](doc/-observer/index.md)): [RotationMatrix](doc/-rotation-matrix/index.md)
Calculates a rotation matrix from equatorial J2000 (EQJ) to horizontal (HOR). | -| [rotationGalEqj](doc/rotation-gal-eqj.md)
fun [rotationGalEqj](doc/rotation-gal-eqj.md)(): [RotationMatrix](doc/-rotation-matrix/index.md)
Calculates a rotation matrix from galactic (GAL) to equatorial J2000 (EQJ). | -| [rotationHorEcl](doc/rotation-hor-ecl.md)
fun [rotationHorEcl](doc/rotation-hor-ecl.md)(time: [Time](doc/-time/index.md), observer: [Observer](doc/-observer/index.md)): [RotationMatrix](doc/-rotation-matrix/index.md)
Calculates a rotation matrix from horizontal (HOR) to ecliptic J2000 (ECL). | +| [rotationEqjEcl](doc/rotation-eqj-ecl.md)
fun [rotationEqjEcl](doc/rotation-eqj-ecl.md)(): [RotationMatrix](doc/-rotation-matrix/index.md)
Calculates a rotation matrix from J2000 mean equator (EQJ) to J2000 mean ecliptic (ECL). | +| [rotationEqjEqd](doc/rotation-eqj-eqd.md)
fun [rotationEqjEqd](doc/rotation-eqj-eqd.md)(time: [Time](doc/-time/index.md)): [RotationMatrix](doc/-rotation-matrix/index.md)
Calculates a rotation matrix from J2000 mean equator (EQJ) to equatorial of-date (EQD). | +| [rotationEqjGal](doc/rotation-eqj-gal.md)
fun [rotationEqjGal](doc/rotation-eqj-gal.md)(): [RotationMatrix](doc/-rotation-matrix/index.md)
Calculates a rotation matrix from galactic (GAL) to J2000 mean equator (EQJ). | +| [rotationEqjHor](doc/rotation-eqj-hor.md)
fun [rotationEqjHor](doc/rotation-eqj-hor.md)(time: [Time](doc/-time/index.md), observer: [Observer](doc/-observer/index.md)): [RotationMatrix](doc/-rotation-matrix/index.md)
Calculates a rotation matrix from J2000 mean equator (EQJ) to horizontal (HOR). | +| [rotationGalEqj](doc/rotation-gal-eqj.md)
fun [rotationGalEqj](doc/rotation-gal-eqj.md)(): [RotationMatrix](doc/-rotation-matrix/index.md)
Calculates a rotation matrix from galactic (GAL) to J2000 mean equator (EQJ). | +| [rotationHorEcl](doc/rotation-hor-ecl.md)
fun [rotationHorEcl](doc/rotation-hor-ecl.md)(time: [Time](doc/-time/index.md), observer: [Observer](doc/-observer/index.md)): [RotationMatrix](doc/-rotation-matrix/index.md)
Calculates a rotation matrix from horizontal (HOR) to J2000 mean ecliptic (ECL). | | [rotationHorEqd](doc/rotation-hor-eqd.md)
fun [rotationHorEqd](doc/rotation-hor-eqd.md)(time: [Time](doc/-time/index.md), observer: [Observer](doc/-observer/index.md)): [RotationMatrix](doc/-rotation-matrix/index.md)
Calculates a rotation matrix from horizontal (HOR) to equatorial of-date (EQD). | | [rotationHorEqj](doc/rotation-hor-eqj.md)
fun [rotationHorEqj](doc/rotation-hor-eqj.md)(time: [Time](doc/-time/index.md), observer: [Observer](doc/-observer/index.md)): [RotationMatrix](doc/-rotation-matrix/index.md)
Calculates a rotation matrix from horizontal (HOR) to J2000 equatorial (EQJ). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. Source: HOR = horizontal system (x=North, y=West, z=Zenith). Target: EQJ = equatorial system, using equator at the J2000 epoch. | | [search](doc/search.md)
fun [search](doc/search.md)(time1: [Time](doc/-time/index.md), time2: [Time](doc/-time/index.md), toleranceSeconds: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), func: [SearchContext](doc/-search-context/index.md)): [Time](doc/-time/index.md)?
Searches for a time at which a function's value increases through zero. | diff --git a/source/kotlin/doc/-axis-info/index.md b/source/kotlin/doc/-axis-info/index.md index c3361c1f..dd062e47 100644 --- a/source/kotlin/doc/-axis-info/index.md +++ b/source/kotlin/doc/-axis-info/index.md @@ -14,7 +14,7 @@ The spin field indicates the angular position of a prime meridian arbitrarily re The fields ra, dec, and spin correspond to the variables α0, δ0, and W, respectively, from [Report of the IAU Working Group on Cartographic Coordinates and Rotational Elements: 2015](https://astropedia.astrogeology.usgs.gov/download/Docs/WGCCRE/WGCCRE2015reprint.pdf). -The field north is a unit vector pointing in the direction of the body's north pole. It is expressed in the equatorial J2000 system (EQJ). +The field north is a unit vector pointing in the direction of the body's north pole. It is expressed in the J2000 mean equator system (EQJ). ## Constructors diff --git a/source/kotlin/doc/bary-state.md b/source/kotlin/doc/bary-state.md index a0da50b4..61292296 100644 --- a/source/kotlin/doc/bary-state.md +++ b/source/kotlin/doc/bary-state.md @@ -6,7 +6,7 @@ fun [baryState](bary-state.md)(body: [Body](-body/index.md), time: [Time](-time/ Calculates barycentric position and velocity vectors for the given body. -Given a body and a time, calculates the barycentric position and velocity vectors for the center of that body at that time. The vectors are expressed in equatorial J2000 coordinates (EQJ). +Given a body and a time, calculates the barycentric position and velocity vectors for the center of that body at that time. The vectors are expressed in J2000 mean equator coordinates (EQJ). #### Return diff --git a/source/kotlin/doc/ecliptic-geo-moon.md b/source/kotlin/doc/ecliptic-geo-moon.md index dee80037..434db1cc 100644 --- a/source/kotlin/doc/ecliptic-geo-moon.md +++ b/source/kotlin/doc/ecliptic-geo-moon.md @@ -12,7 +12,7 @@ The ecliptic angles are measured in "ECT": relative to the true ecliptic plane a This algorithm is based on the Nautical Almanac Office's *Improved Lunar Ephemeris* of 1954, which in turn derives from E. W. Brown's lunar theories from the early twentieth century. It is adapted from Turbo Pascal code from the book [Astronomy on the Personal Computer](https://www.springer.com/us/book/9783540672210) by Montenbruck and Pfleger. -To calculate an equatorial J2000 vector instead, use [geoMoon](geo-moon.md). +To calculate a J2000 mean equator vector instead, use [geoMoon](geo-moon.md). #### Return diff --git a/source/kotlin/doc/helio-state.md b/source/kotlin/doc/helio-state.md index fd1e8fd5..81b16ff5 100644 --- a/source/kotlin/doc/helio-state.md +++ b/source/kotlin/doc/helio-state.md @@ -6,7 +6,7 @@ fun [helioState](helio-state.md)(body: [Body](-body/index.md), time: [Time](-tim Calculates heliocentric position and velocity vectors for the given body. -Given a body and a time, calculates the position and velocity vectors for the center of that body at that time, relative to the center of the Sun. The vectors are expressed in equatorial J2000 coordinates (EQJ). If you need the position vector only, it is more efficient to call [helioVector](helio-vector.md). The Sun's center is a non-inertial frame of reference. In other words, the Sun experiences acceleration due to gravitational forces, mostly from the larger planets (Jupiter, Saturn, Uranus, and Neptune). If you want to calculate momentum, kinetic energy, or other quantities that require a non-accelerating frame of reference, consider using [baryState](bary-state.md) instead. +Given a body and a time, calculates the position and velocity vectors for the center of that body at that time, relative to the center of the Sun. The vectors are expressed in J2000 mean equator coordinates (EQJ). If you need the position vector only, it is more efficient to call [helioVector](helio-vector.md). The Sun's center is a non-inertial frame of reference. In other words, the Sun experiences acceleration due to gravitational forces, mostly from the larger planets (Jupiter, Saturn, Uranus, and Neptune). If you want to calculate momentum, kinetic energy, or other quantities that require a non-accelerating frame of reference, consider using [baryState](bary-state.md) instead. #### Return diff --git a/source/kotlin/doc/index.md b/source/kotlin/doc/index.md index 9673527e..8c6c70a4 100644 --- a/source/kotlin/doc/index.md +++ b/source/kotlin/doc/index.md @@ -101,20 +101,20 @@ | [radiansToDegrees](radians-to-degrees.md)
fun [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html).[radiansToDegrees](radians-to-degrees.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Convert an angle expressed in radians to an angle expressed in degrees. | | [refractionAngle](refraction-angle.md)
fun [refractionAngle](refraction-angle.md)(refraction: [Refraction](-refraction/index.md), altitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Calculates the amount of "lift" to an altitude angle caused by atmospheric refraction. | | [rotationAxis](rotation-axis.md)
fun [rotationAxis](rotation-axis.md)(body: [Body](-body/index.md), time: [Time](-time/index.md)): [AxisInfo](-axis-info/index.md)
Calculates information about a body's rotation axis at a given time. | -| [rotationEclEqd](rotation-ecl-eqd.md)
fun [rotationEclEqd](rotation-ecl-eqd.md)(time: [Time](-time/index.md)): [RotationMatrix](-rotation-matrix/index.md)
Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial of-date (EQD). | -| [rotationEclEqj](rotation-ecl-eqj.md)
fun [rotationEclEqj](rotation-ecl-eqj.md)(): [RotationMatrix](-rotation-matrix/index.md)
Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial J2000 (EQJ). | -| [rotationEclHor](rotation-ecl-hor.md)
fun [rotationEclHor](rotation-ecl-hor.md)(time: [Time](-time/index.md), observer: [Observer](-observer/index.md)): [RotationMatrix](-rotation-matrix/index.md)
Calculates a rotation matrix from ecliptic J2000 (ECL) to horizontal (HOR). | +| [rotationEclEqd](rotation-ecl-eqd.md)
fun [rotationEclEqd](rotation-ecl-eqd.md)(time: [Time](-time/index.md)): [RotationMatrix](-rotation-matrix/index.md)
Calculates a rotation matrix from J2000 mean ecliptic (ECL) to equatorial of-date (EQD). | +| [rotationEclEqj](rotation-ecl-eqj.md)
fun [rotationEclEqj](rotation-ecl-eqj.md)(): [RotationMatrix](-rotation-matrix/index.md)
Calculates a rotation matrix from J2000 mean ecliptic (ECL) to J2000 mean equator (EQJ). | +| [rotationEclHor](rotation-ecl-hor.md)
fun [rotationEclHor](rotation-ecl-hor.md)(time: [Time](-time/index.md), observer: [Observer](-observer/index.md)): [RotationMatrix](-rotation-matrix/index.md)
Calculates a rotation matrix from J2000 mean ecliptic (ECL) to horizontal (HOR). | | [rotationEctEqd](rotation-ect-eqd.md)
fun [rotationEctEqd](rotation-ect-eqd.md)(time: [Time](-time/index.md)): [RotationMatrix](-rotation-matrix/index.md)
Calculates a rotation matrix from true ecliptic of date (ECT) to equator of date (EQD). | -| [rotationEqdEcl](rotation-eqd-ecl.md)
fun [rotationEqdEcl](rotation-eqd-ecl.md)(time: [Time](-time/index.md)): [RotationMatrix](-rotation-matrix/index.md)
Calculates a rotation matrix from equatorial of-date (EQD) to ecliptic J2000 (ECL). | +| [rotationEqdEcl](rotation-eqd-ecl.md)
fun [rotationEqdEcl](rotation-eqd-ecl.md)(time: [Time](-time/index.md)): [RotationMatrix](-rotation-matrix/index.md)
Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean ecliptic (ECL). | | [rotationEqdEct](rotation-eqd-ect.md)
fun [rotationEqdEct](rotation-eqd-ect.md)(time: [Time](-time/index.md)): [RotationMatrix](-rotation-matrix/index.md)
Calculates a rotation matrix from equator of date (EQD) to true ecliptic of date (ECT). | -| [rotationEqdEqj](rotation-eqd-eqj.md)
fun [rotationEqdEqj](rotation-eqd-eqj.md)(time: [Time](-time/index.md)): [RotationMatrix](-rotation-matrix/index.md)
Calculates a rotation matrix from equatorial of-date (EQD) to equatorial J2000 (EQJ). | +| [rotationEqdEqj](rotation-eqd-eqj.md)
fun [rotationEqdEqj](rotation-eqd-eqj.md)(time: [Time](-time/index.md)): [RotationMatrix](-rotation-matrix/index.md)
Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean equator (EQJ). | | [rotationEqdHor](rotation-eqd-hor.md)
fun [rotationEqdHor](rotation-eqd-hor.md)(time: [Time](-time/index.md), observer: [Observer](-observer/index.md)): [RotationMatrix](-rotation-matrix/index.md)
Calculates a rotation matrix from equatorial of-date (EQD) to horizontal (HOR). | -| [rotationEqjEcl](rotation-eqj-ecl.md)
fun [rotationEqjEcl](rotation-eqj-ecl.md)(): [RotationMatrix](-rotation-matrix/index.md)
Calculates a rotation matrix from equatorial J2000 (EQJ) to ecliptic J2000 (ECL). | -| [rotationEqjEqd](rotation-eqj-eqd.md)
fun [rotationEqjEqd](rotation-eqj-eqd.md)(time: [Time](-time/index.md)): [RotationMatrix](-rotation-matrix/index.md)
Calculates a rotation matrix from equatorial J2000 (EQJ) to equatorial of-date (EQD). | -| [rotationEqjGal](rotation-eqj-gal.md)
fun [rotationEqjGal](rotation-eqj-gal.md)(): [RotationMatrix](-rotation-matrix/index.md)
Calculates a rotation matrix from galactic (GAL) to equatorial J2000 (EQJ). | -| [rotationEqjHor](rotation-eqj-hor.md)
fun [rotationEqjHor](rotation-eqj-hor.md)(time: [Time](-time/index.md), observer: [Observer](-observer/index.md)): [RotationMatrix](-rotation-matrix/index.md)
Calculates a rotation matrix from equatorial J2000 (EQJ) to horizontal (HOR). | -| [rotationGalEqj](rotation-gal-eqj.md)
fun [rotationGalEqj](rotation-gal-eqj.md)(): [RotationMatrix](-rotation-matrix/index.md)
Calculates a rotation matrix from galactic (GAL) to equatorial J2000 (EQJ). | -| [rotationHorEcl](rotation-hor-ecl.md)
fun [rotationHorEcl](rotation-hor-ecl.md)(time: [Time](-time/index.md), observer: [Observer](-observer/index.md)): [RotationMatrix](-rotation-matrix/index.md)
Calculates a rotation matrix from horizontal (HOR) to ecliptic J2000 (ECL). | +| [rotationEqjEcl](rotation-eqj-ecl.md)
fun [rotationEqjEcl](rotation-eqj-ecl.md)(): [RotationMatrix](-rotation-matrix/index.md)
Calculates a rotation matrix from J2000 mean equator (EQJ) to J2000 mean ecliptic (ECL). | +| [rotationEqjEqd](rotation-eqj-eqd.md)
fun [rotationEqjEqd](rotation-eqj-eqd.md)(time: [Time](-time/index.md)): [RotationMatrix](-rotation-matrix/index.md)
Calculates a rotation matrix from J2000 mean equator (EQJ) to equatorial of-date (EQD). | +| [rotationEqjGal](rotation-eqj-gal.md)
fun [rotationEqjGal](rotation-eqj-gal.md)(): [RotationMatrix](-rotation-matrix/index.md)
Calculates a rotation matrix from galactic (GAL) to J2000 mean equator (EQJ). | +| [rotationEqjHor](rotation-eqj-hor.md)
fun [rotationEqjHor](rotation-eqj-hor.md)(time: [Time](-time/index.md), observer: [Observer](-observer/index.md)): [RotationMatrix](-rotation-matrix/index.md)
Calculates a rotation matrix from J2000 mean equator (EQJ) to horizontal (HOR). | +| [rotationGalEqj](rotation-gal-eqj.md)
fun [rotationGalEqj](rotation-gal-eqj.md)(): [RotationMatrix](-rotation-matrix/index.md)
Calculates a rotation matrix from galactic (GAL) to J2000 mean equator (EQJ). | +| [rotationHorEcl](rotation-hor-ecl.md)
fun [rotationHorEcl](rotation-hor-ecl.md)(time: [Time](-time/index.md), observer: [Observer](-observer/index.md)): [RotationMatrix](-rotation-matrix/index.md)
Calculates a rotation matrix from horizontal (HOR) to J2000 mean ecliptic (ECL). | | [rotationHorEqd](rotation-hor-eqd.md)
fun [rotationHorEqd](rotation-hor-eqd.md)(time: [Time](-time/index.md), observer: [Observer](-observer/index.md)): [RotationMatrix](-rotation-matrix/index.md)
Calculates a rotation matrix from horizontal (HOR) to equatorial of-date (EQD). | | [rotationHorEqj](rotation-hor-eqj.md)
fun [rotationHorEqj](rotation-hor-eqj.md)(time: [Time](-time/index.md), observer: [Observer](-observer/index.md)): [RotationMatrix](-rotation-matrix/index.md)
Calculates a rotation matrix from horizontal (HOR) to J2000 equatorial (EQJ). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. Source: HOR = horizontal system (x=North, y=West, z=Zenith). Target: EQJ = equatorial system, using equator at the J2000 epoch. | | [search](search.md)
fun [search](search.md)(time1: [Time](-time/index.md), time2: [Time](-time/index.md), toleranceSeconds: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), func: [SearchContext](-search-context/index.md)): [Time](-time/index.md)?
Searches for a time at which a function's value increases through zero. | diff --git a/source/kotlin/doc/lagrange-point.md b/source/kotlin/doc/lagrange-point.md index 64230139..ae442ec6 100644 --- a/source/kotlin/doc/lagrange-point.md +++ b/source/kotlin/doc/lagrange-point.md @@ -10,7 +10,7 @@ Given a more massive "major" body and a much less massive "minor" body, calculat 1 = the Lagrange point between the major body and minor body. 2 = the Lagrange point on the far side of the minor body. 3 = the Lagrange point on the far side of the major body. 4 = the Lagrange point 60 degrees ahead of the minor body's orbital position. 5 = the Lagrange point 60 degrees behind the minor body's orbital position. -The function returns the state vector for the selected Lagrange point in equatorial J2000 coordinates (EQJ), with respect to the center of the major body. +The function returns the state vector for the selected Lagrange point in J2000 mean equator coordinates (EQJ), with respect to the center of the major body. To calculate Sun/Earth Lagrange points, pass in [Body.Sun](-body/-sun/index.md) for majorBody and [Body.EMB](-body/-e-m-b/index.md) (Earth/Moon barycenter) for minorBody. For Lagrange points of the Sun and any other planet, pass in just that planet (e.g. [Body.Jupiter](-body/-jupiter/index.md)) for minorBody. To calculate Earth/Moon Lagrange points, pass in [Body.Earth](-body/-earth/index.md) and [Body.Moon](-body/-moon/index.md) for the major and minor bodies respectively. diff --git a/source/kotlin/doc/rotation-ecl-eqd.md b/source/kotlin/doc/rotation-ecl-eqd.md index 22d4dc1d..58459962 100644 --- a/source/kotlin/doc/rotation-ecl-eqd.md +++ b/source/kotlin/doc/rotation-ecl-eqd.md @@ -4,7 +4,7 @@ fun [rotationEclEqd](rotation-ecl-eqd.md)(time: [Time](-time/index.md)): [RotationMatrix](-rotation-matrix/index.md) -Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial of-date (EQD). +Calculates a rotation matrix from J2000 mean ecliptic (ECL) to equatorial of-date (EQD). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. Source: ECL = ecliptic system, using equator at J2000 epoch. Target: EQD = equatorial system, using equator of date. diff --git a/source/kotlin/doc/rotation-ecl-eqj.md b/source/kotlin/doc/rotation-ecl-eqj.md index fb2e0fac..e7d52938 100644 --- a/source/kotlin/doc/rotation-ecl-eqj.md +++ b/source/kotlin/doc/rotation-ecl-eqj.md @@ -4,6 +4,6 @@ fun [rotationEclEqj](rotation-ecl-eqj.md)(): [RotationMatrix](-rotation-matrix/index.md) -Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial J2000 (EQJ). +Calculates a rotation matrix from J2000 mean ecliptic (ECL) to J2000 mean equator (EQJ). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. Source: ECL = ecliptic system, using equator at J2000 epoch. Target: EQJ = equatorial system, using equator at J2000 epoch. diff --git a/source/kotlin/doc/rotation-ecl-hor.md b/source/kotlin/doc/rotation-ecl-hor.md index d0adcea5..2beb5d35 100644 --- a/source/kotlin/doc/rotation-ecl-hor.md +++ b/source/kotlin/doc/rotation-ecl-hor.md @@ -4,7 +4,7 @@ fun [rotationEclHor](rotation-ecl-hor.md)(time: [Time](-time/index.md), observer: [Observer](-observer/index.md)): [RotationMatrix](-rotation-matrix/index.md) -Calculates a rotation matrix from ecliptic J2000 (ECL) to horizontal (HOR). +Calculates a rotation matrix from J2000 mean ecliptic (ECL) to horizontal (HOR). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. Source: ECL = ecliptic system, using equator at J2000 epoch. Target: HOR = horizontal system. diff --git a/source/kotlin/doc/rotation-eqd-ecl.md b/source/kotlin/doc/rotation-eqd-ecl.md index dc140514..a2447a17 100644 --- a/source/kotlin/doc/rotation-eqd-ecl.md +++ b/source/kotlin/doc/rotation-eqd-ecl.md @@ -4,7 +4,7 @@ fun [rotationEqdEcl](rotation-eqd-ecl.md)(time: [Time](-time/index.md)): [RotationMatrix](-rotation-matrix/index.md) -Calculates a rotation matrix from equatorial of-date (EQD) to ecliptic J2000 (ECL). +Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean ecliptic (ECL). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. Source: EQD = equatorial system, using equator of date. Target: ECL = ecliptic system, using equator at J2000 epoch. diff --git a/source/kotlin/doc/rotation-eqd-eqj.md b/source/kotlin/doc/rotation-eqd-eqj.md index 4910031b..5a2373d9 100644 --- a/source/kotlin/doc/rotation-eqd-eqj.md +++ b/source/kotlin/doc/rotation-eqd-eqj.md @@ -4,7 +4,7 @@ fun [rotationEqdEqj](rotation-eqd-eqj.md)(time: [Time](-time/index.md)): [RotationMatrix](-rotation-matrix/index.md) -Calculates a rotation matrix from equatorial of-date (EQD) to equatorial J2000 (EQJ). +Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean equator (EQJ). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. Source: EQD = equatorial system, using equator of the specified date/time. Target: EQJ = equatorial system, using equator at J2000 epoch. diff --git a/source/kotlin/doc/rotation-eqj-ecl.md b/source/kotlin/doc/rotation-eqj-ecl.md index 17bb2789..32a04218 100644 --- a/source/kotlin/doc/rotation-eqj-ecl.md +++ b/source/kotlin/doc/rotation-eqj-ecl.md @@ -4,6 +4,6 @@ fun [rotationEqjEcl](rotation-eqj-ecl.md)(): [RotationMatrix](-rotation-matrix/index.md) -Calculates a rotation matrix from equatorial J2000 (EQJ) to ecliptic J2000 (ECL). +Calculates a rotation matrix from J2000 mean equator (EQJ) to J2000 mean ecliptic (ECL). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. Source: EQJ = equatorial system, using equator at J2000 epoch. Target: ECL = ecliptic system, using equator at J2000 epoch. diff --git a/source/kotlin/doc/rotation-eqj-eqd.md b/source/kotlin/doc/rotation-eqj-eqd.md index 7afc6051..50932013 100644 --- a/source/kotlin/doc/rotation-eqj-eqd.md +++ b/source/kotlin/doc/rotation-eqj-eqd.md @@ -4,7 +4,7 @@ fun [rotationEqjEqd](rotation-eqj-eqd.md)(time: [Time](-time/index.md)): [RotationMatrix](-rotation-matrix/index.md) -Calculates a rotation matrix from equatorial J2000 (EQJ) to equatorial of-date (EQD). +Calculates a rotation matrix from J2000 mean equator (EQJ) to equatorial of-date (EQD). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. Source: EQJ = equatorial system, using equator at J2000 epoch. Target: EQD = equatorial system, using equator of the specified date/time. diff --git a/source/kotlin/doc/rotation-eqj-gal.md b/source/kotlin/doc/rotation-eqj-gal.md index fa0349c9..2ff209b6 100644 --- a/source/kotlin/doc/rotation-eqj-gal.md +++ b/source/kotlin/doc/rotation-eqj-gal.md @@ -4,7 +4,7 @@ fun [rotationEqjGal](rotation-eqj-gal.md)(): [RotationMatrix](-rotation-matrix/index.md) -Calculates a rotation matrix from galactic (GAL) to equatorial J2000 (EQJ). +Calculates a rotation matrix from galactic (GAL) to J2000 mean equator (EQJ). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. Source: GAL = galactic system (IAU 1958 definition). Target: EQJ = equatorial system, using the equator at the J2000 epoch. diff --git a/source/kotlin/doc/rotation-eqj-hor.md b/source/kotlin/doc/rotation-eqj-hor.md index 670d2a0b..f89e3da2 100644 --- a/source/kotlin/doc/rotation-eqj-hor.md +++ b/source/kotlin/doc/rotation-eqj-hor.md @@ -4,7 +4,7 @@ fun [rotationEqjHor](rotation-eqj-hor.md)(time: [Time](-time/index.md), observer: [Observer](-observer/index.md)): [RotationMatrix](-rotation-matrix/index.md) -Calculates a rotation matrix from equatorial J2000 (EQJ) to horizontal (HOR). +Calculates a rotation matrix from J2000 mean equator (EQJ) to horizontal (HOR). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. Source: EQJ = equatorial system, using the equator at the J2000 epoch. Target: HOR = horizontal system. diff --git a/source/kotlin/doc/rotation-gal-eqj.md b/source/kotlin/doc/rotation-gal-eqj.md index da37d31a..d8496d5b 100644 --- a/source/kotlin/doc/rotation-gal-eqj.md +++ b/source/kotlin/doc/rotation-gal-eqj.md @@ -4,7 +4,7 @@ fun [rotationGalEqj](rotation-gal-eqj.md)(): [RotationMatrix](-rotation-matrix/index.md) -Calculates a rotation matrix from galactic (GAL) to equatorial J2000 (EQJ). +Calculates a rotation matrix from galactic (GAL) to J2000 mean equator (EQJ). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. Source: GAL = galactic system (IAU 1958 definition). Target: EQJ = equatorial system, using the equator at the J2000 epoch. diff --git a/source/kotlin/doc/rotation-hor-ecl.md b/source/kotlin/doc/rotation-hor-ecl.md index 3db11b03..962e5389 100644 --- a/source/kotlin/doc/rotation-hor-ecl.md +++ b/source/kotlin/doc/rotation-hor-ecl.md @@ -4,7 +4,7 @@ fun [rotationHorEcl](rotation-hor-ecl.md)(time: [Time](-time/index.md), observer: [Observer](-observer/index.md)): [RotationMatrix](-rotation-matrix/index.md) -Calculates a rotation matrix from horizontal (HOR) to ecliptic J2000 (ECL). +Calculates a rotation matrix from horizontal (HOR) to J2000 mean ecliptic (ECL). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. Source: HOR = horizontal system. Target: ECL = ecliptic system, using equator at J2000 epoch. diff --git a/source/kotlin/src/main/kotlin/io/github/cosinekitty/astronomy/astronomy.kt b/source/kotlin/src/main/kotlin/io/github/cosinekitty/astronomy/astronomy.kt index d7426297..de8c5229 100644 --- a/source/kotlin/src/main/kotlin/io/github/cosinekitty/astronomy/astronomy.kt +++ b/source/kotlin/src/main/kotlin/io/github/cosinekitty/astronomy/astronomy.kt @@ -2912,7 +2912,7 @@ class IlluminationInfo( * [Report of the IAU Working Group on Cartographic Coordinates and Rotational Elements: 2015](https://astropedia.astrogeology.usgs.gov/download/Docs/WGCCRE/WGCCRE2015reprint.pdf). * * The field `north` is a unit vector pointing in the direction of the body's north pole. - * It is expressed in the equatorial J2000 system (EQJ). + * It is expressed in the J2000 mean equator system (EQJ). */ class AxisInfo( /** @@ -4708,7 +4708,7 @@ fun rotationAxis(body: Body, time: Time): AxisInfo { * [Astronomy on the Personal Computer](https://www.springer.com/us/book/9783540672210) * by Montenbruck and Pfleger. * -* To calculate an equatorial J2000 vector instead, use [geoMoon]. +* To calculate a J2000 mean equator vector instead, use [geoMoon]. * * @param time * The date and time for which to calculate the Moon's position. @@ -4950,7 +4950,7 @@ fun helioDistance(body: Body, time: Time): Double { * * Given a body and a time, calculates the position and velocity * vectors for the center of that body at that time, relative to the center of the Sun. - * The vectors are expressed in equatorial J2000 coordinates (EQJ). + * The vectors are expressed in J2000 mean equator coordinates (EQJ). * If you need the position vector only, it is more efficient to call [helioVector]. * The Sun's center is a non-inertial frame of reference. In other words, the Sun * experiences acceleration due to gravitational forces, mostly from the larger @@ -4995,7 +4995,7 @@ fun helioState(body: Body, time: Time): StateVector { * * Given a body and a time, calculates the barycentric position and velocity * vectors for the center of that body at that time. - * The vectors are expressed in equatorial J2000 coordinates (EQJ). + * The vectors are expressed in J2000 mean equator coordinates (EQJ). * * @param body * The celestial body whose barycentric state vector is to be calculated. @@ -7396,7 +7396,7 @@ fun observerGravity(latitude: Double, height: Double): Double { * 5 = the Lagrange point 60 degrees behind the minor body's orbital position. * * The function returns the state vector for the selected Lagrange point - * in equatorial J2000 coordinates (EQJ), with respect to the center of the + * in J2000 mean equator coordinates (EQJ), with respect to the center of the * major body. * * To calculate Sun/Earth Lagrange points, pass in [Body.Sun] for `majorBody` @@ -8106,7 +8106,7 @@ internal fun planetExtreme(body: Body, kind: ApsisKind, startTime: Time, initDay /** - * Calculates a rotation matrix from equatorial J2000 (EQJ) to ecliptic J2000 (ECL). + * Calculates a rotation matrix from J2000 mean equator (EQJ) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -8125,7 +8125,7 @@ fun rotationEqjEcl(): RotationMatrix { } /** - * Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial J2000 (EQJ). + * Calculates a rotation matrix from J2000 mean ecliptic (ECL) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -8144,7 +8144,7 @@ fun rotationEclEqj(): RotationMatrix { } /** - * Calculates a rotation matrix from equatorial J2000 (EQJ) to equatorial of-date (EQD). + * Calculates a rotation matrix from J2000 mean equator (EQJ) to equatorial of-date (EQD). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -8159,7 +8159,7 @@ fun rotationEqjEqd(time: Time): RotationMatrix = nutationRot(time, PrecessDirection.From2000) /** - * Calculates a rotation matrix from equatorial of-date (EQD) to equatorial J2000 (EQJ). + * Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -8260,7 +8260,7 @@ fun rotationHorEqj(time: Time, observer: Observer): RotationMatrix = rotationEqdEqj(time) /** - * Calculates a rotation matrix from equatorial J2000 (EQJ) to horizontal (HOR). + * Calculates a rotation matrix from J2000 mean equator (EQJ) to horizontal (HOR). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -8284,7 +8284,7 @@ fun rotationEqjHor(time: Time, observer: Observer): RotationMatrix = rotationHorEqj(time, observer).inverse() /** - * Calculates a rotation matrix from equatorial of-date (EQD) to ecliptic J2000 (ECL). + * Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -8301,7 +8301,7 @@ fun rotationEqdEcl(time: Time): RotationMatrix = rotationEqjEcl() /** - * Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial of-date (EQD). + * Calculates a rotation matrix from J2000 mean ecliptic (ECL) to equatorial of-date (EQD). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -8317,7 +8317,7 @@ fun rotationEclEqd(time: Time): RotationMatrix = rotationEqdEcl(time).inverse() /** - * Calculates a rotation matrix from ecliptic J2000 (ECL) to horizontal (HOR). + * Calculates a rotation matrix from J2000 mean ecliptic (ECL) to horizontal (HOR). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -8342,7 +8342,7 @@ fun rotationEclHor(time: Time, observer: Observer): RotationMatrix = rotationEqdHor(time, observer) /** - * Calculates a rotation matrix from horizontal (HOR) to ecliptic J2000 (ECL). + * Calculates a rotation matrix from horizontal (HOR) to J2000 mean ecliptic (ECL). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -8362,7 +8362,7 @@ fun rotationHorEcl(time: Time, observer: Observer): RotationMatrix = rotationEclHor(time, observer).inverse() /** - * Calculates a rotation matrix from galactic (GAL) to equatorial J2000 (EQJ). + * Calculates a rotation matrix from galactic (GAL) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. @@ -8382,7 +8382,7 @@ fun rotationEqjGal() = ) /** - * Calculates a rotation matrix from galactic (GAL) to equatorial J2000 (EQJ). + * Calculates a rotation matrix from galactic (GAL) to J2000 mean equator (EQJ). * * This is one of the family of functions that returns a rotation matrix * for converting from one orientation to another. diff --git a/source/python/README.md b/source/python/README.md index f4bfbe73..d227b5de 100644 --- a/source/python/README.md +++ b/source/python/README.md @@ -321,7 +321,7 @@ The fields `ra`, `dec`, and `spin` correspond to the variables α0, δ0, and W, respectively, from [Report of the IAU Working Group on Cartographic Coordinates and Rotational Elements: 2015](https://astropedia.astrogeology.usgs.gov/download/Docs/WGCCRE/WGCCRE2015reprint.pdf). The field `north` is a unit vector pointing in the direction of the body's north pole. -It is expressed in the equatorial J2000 system (EQJ). +It is expressed in the J2000 mean equator system (EQJ). | Type | Attribute | Description | | --- | --- | --- | @@ -493,7 +493,7 @@ time steps. | --- | --- | --- | | [`Body`](#Body) | `originBody` | Specifies the origin of the reference frame. All position vectors and velocity vectors will use `originBody` as the origin of the coordinate system. This origin applies to all the input vectors provided in the `bodyStates` parameter of this function, along with all output vectors returned by [`GravitySimulator.Update`](#GravitySimulator.Update). Most callers will want to provide one of the following: `Body.Sun` for heliocentric coordinates, `Body.SSB` for solar system barycentric coordinates, or `Body.Earth` for geocentric coordinates. Note that the gravity simulator does not correct for light travel time; all state vectors are tied to a Newtonian "instantaneous" time. | | [`Time`](#Time) | `time` | The initial time at which to start the simulation. | -| [`StateVector`](#StateVector)`[]` | `bodyStates` | An array of zero or more initial state vectors (positions and velocities) of the small bodies to be simulated. The caller must know the positions and velocities of the small bodies at an initial moment in time. Their positions and velocities are expressed with respect to `originBody`, using equatorial J2000 orientation (EQJ). Positions are expressed in astronomical units (AU). Velocities are expressed in AU/day. All the times embedded within the state vectors must exactly match `time`, or this constructor will throw an exception. | +| [`StateVector`](#StateVector)`[]` | `bodyStates` | An array of zero or more initial state vectors (positions and velocities) of the small bodies to be simulated. The caller must know the positions and velocities of the small bodies at an initial moment in time. Their positions and velocities are expressed with respect to `originBody`, using J2000 mean equator orientation (EQJ). Positions are expressed in astronomical units (AU). Velocities are expressed in AU/day. All the times embedded within the state vectors must exactly match `time`, or this constructor will throw an exception. | ### GravitySimulator.OriginBody(self) @@ -1344,7 +1344,7 @@ body to arrive at the observer at the observation time. Given a body and a time, calculates the barycentric position and velocity vectors for the center of that body at that time. -The vectors are expressed in equatorial J2000 coordinates (EQJ). +The vectors are expressed in J2000 mean equator coordinates (EQJ). | Type | Parameter | Description | | --- | --- | --- | @@ -1526,7 +1526,7 @@ which in turn derives from E. W. Brown's lunar theories from the early twentieth It is adapted from Turbo Pascal code from the book [Astronomy on the Personal Computer](https://www.springer.com/us/book/9783540672210) by Montenbruck and Pfleger. -To calculate an equatorial J2000 vector instead, use [`GeoMoon`](#GeoMoon). +To calculate a J2000 mean equator vector instead, use [`GeoMoon`](#GeoMoon). | Type | Parameter | Description | | --- | --- | --- | @@ -1752,7 +1752,7 @@ The heliocentric distance in AU. Given a body and a time, calculates the position and velocity vectors for the center of that body at that time, relative to the center of the Sun. -The vectors are expressed in equatorial J2000 coordinates (EQJ). +The vectors are expressed in J2000 mean equator coordinates (EQJ). If you need the position vector only, it is more efficient to call [`HelioVector`](#HelioVector). The Sun's center is a non-inertial frame of reference. In other words, the Sun experiences acceleration due to gravitational forces, mostly from the larger @@ -1987,7 +1987,7 @@ selects the Lagrange point as follows: 4 = the Lagrange point 60 degrees ahead of the minor body's orbital position. 5 = the Lagrange point 60 degrees behind the minor body's orbital position. The function returns the state vector for the selected Lagrange point -in equatorial J2000 coordinates (EQJ), with respect to the center of the +in J2000 mean equator coordinates (EQJ), with respect to the center of the major body. To calculate Sun/Earth Lagrange points, pass in `Body.Sun` for `major_body` and `Body.EMB` (Earth/Moon barycenter) for `minor_body`. @@ -2498,7 +2498,7 @@ The body's north pole direction and angle of its prime meridian. ### Rotation_ECL_EQD(time) -**Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial of-date (EQD).** +**Calculates a rotation matrix from J2000 mean ecliptic (ECL) to equatorial of-date (EQD).** This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -2517,7 +2517,7 @@ A rotation matrix that converts ECL to EQD. ### Rotation_ECL_EQJ() -**Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial J2000 (EQJ).** +**Calculates a rotation matrix from J2000 mean ecliptic (ECL) to J2000 mean equator (EQJ).** This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -2532,7 +2532,7 @@ A rotation matrix that converts ECL to EQJ. ### Rotation_ECL_HOR(time, observer) -**Calculates a rotation matrix from ecliptic J2000 (ECL) to horizontal (HOR).** +**Calculates a rotation matrix from J2000 mean ecliptic (ECL) to horizontal (HOR).** This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -2577,7 +2577,7 @@ A rotation matrix that converts ECT to EQD. ### Rotation_EQD_ECL(time) -**Calculates a rotation matrix from equatorial of-date (EQD) to ecliptic J2000 (ECL).** +**Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean ecliptic (ECL).** This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -2615,7 +2615,7 @@ A rotation matrix that converts EQD to ECT. ### Rotation_EQD_EQJ(time) -**Calculates a rotation matrix from equatorial of-date (EQD) to equatorial J2000 (EQJ).** +**Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean equator (EQJ).** This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -2660,7 +2660,7 @@ and so that north represents the direction where azimuth = 0. ### Rotation_EQJ_ECL() -**Calculates a rotation matrix from equatorial J2000 (EQJ) to ecliptic J2000 (ECL).** +**Calculates a rotation matrix from J2000 mean equator (EQJ) to J2000 mean ecliptic (ECL).** This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -2675,7 +2675,7 @@ A rotation matrix that converts EQJ to ECL. ### Rotation_EQJ_EQD(time) -**Calculates a rotation matrix from equatorial J2000 (EQJ) to equatorial of-date (EQD).** +**Calculates a rotation matrix from J2000 mean equator (EQJ) to equatorial of-date (EQD).** This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -2694,7 +2694,7 @@ A rotation matrix that converts EQJ to EQD at `time`. ### Rotation_EQJ_GAL() -**Calculates a rotation matrix from equatorial J2000 (EQJ) to galactic (GAL).** +**Calculates a rotation matrix from J2000 mean equator (EQJ) to galactic (GAL).** This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -2709,7 +2709,7 @@ A rotation matrix that converts EQJ to GAL. ### Rotation_EQJ_HOR(time, observer) -**Calculates a rotation matrix from equatorial J2000 (EQJ) to horizontal (HOR).** +**Calculates a rotation matrix from J2000 mean equator (EQJ) to horizontal (HOR).** This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -2735,7 +2735,7 @@ and so that north represents the direction where azimuth = 0. ### Rotation_GAL_EQJ() -**Calculates a rotation matrix from galactic (GAL) to equatorial J2000 (EQJ).** +**Calculates a rotation matrix from galactic (GAL) to J2000 mean equator (EQJ).** This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -2750,7 +2750,7 @@ A rotation matrix that converts GAL to EQJ. ### Rotation_HOR_ECL(time, observer) -**Calculates a rotation matrix from horizontal (HOR) to ecliptic J2000 (ECL).** +**Calculates a rotation matrix from horizontal (HOR) to J2000 mean ecliptic (ECL).** This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. diff --git a/source/python/astronomy/astronomy.py b/source/python/astronomy/astronomy.py index b7a2c593..cf17b590 100644 --- a/source/python/astronomy/astronomy.py +++ b/source/python/astronomy/astronomy.py @@ -2295,7 +2295,7 @@ def EclipticGeoMoon(time): [Astronomy on the Personal Computer](https://www.springer.com/us/book/9783540672210) by Montenbruck and Pfleger. - To calculate an equatorial J2000 vector instead, use #GeoMoon. + To calculate a J2000 mean equator vector instead, use #GeoMoon. Parameters ---------- @@ -4336,7 +4336,7 @@ def BaryState(body, time): Given a body and a time, calculates the barycentric position and velocity vectors for the center of that body at that time. - The vectors are expressed in equatorial J2000 coordinates (EQJ). + The vectors are expressed in J2000 mean equator coordinates (EQJ). Parameters ---------- @@ -4414,7 +4414,7 @@ def HelioState(body, time): Given a body and a time, calculates the position and velocity vectors for the center of that body at that time, relative to the center of the Sun. - The vectors are expressed in equatorial J2000 coordinates (EQJ). + The vectors are expressed in J2000 mean equator coordinates (EQJ). If you need the position vector only, it is more efficient to call #HelioVector. The Sun's center is a non-inertial frame of reference. In other words, the Sun experiences acceleration due to gravitational forces, mostly from the larger @@ -7237,7 +7237,7 @@ def RotateState(rotation, state): def Rotation_EQJ_ECL(): - """Calculates a rotation matrix from equatorial J2000 (EQJ) to ecliptic J2000 (ECL). + """Calculates a rotation matrix from J2000 mean equator (EQJ) to J2000 mean ecliptic (ECL). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -7260,7 +7260,7 @@ def Rotation_EQJ_ECL(): def Rotation_ECL_EQJ(): - """Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial J2000 (EQJ). + """Calculates a rotation matrix from J2000 mean ecliptic (ECL) to J2000 mean equator (EQJ). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -7282,7 +7282,7 @@ def Rotation_ECL_EQJ(): ]) def Rotation_EQJ_EQD(time): - """Calculates a rotation matrix from equatorial J2000 (EQJ) to equatorial of-date (EQD). + """Calculates a rotation matrix from J2000 mean equator (EQJ) to equatorial of-date (EQD). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -7305,7 +7305,7 @@ def Rotation_EQJ_EQD(time): def Rotation_EQD_EQJ(time): - """Calculates a rotation matrix from equatorial of-date (EQD) to equatorial J2000 (EQJ). + """Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean equator (EQJ). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -7422,7 +7422,7 @@ def Rotation_HOR_EQJ(time, observer): def Rotation_EQJ_HOR(time, observer): - """Calculates a rotation matrix from equatorial J2000 (EQJ) to horizontal (HOR). + """Calculates a rotation matrix from J2000 mean equator (EQJ) to horizontal (HOR). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -7453,7 +7453,7 @@ def Rotation_EQJ_HOR(time, observer): def Rotation_EQD_ECL(time): - """Calculates a rotation matrix from equatorial of-date (EQD) to ecliptic J2000 (ECL). + """Calculates a rotation matrix from equatorial of-date (EQD) to J2000 mean ecliptic (ECL). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -7476,7 +7476,7 @@ def Rotation_EQD_ECL(time): def Rotation_ECL_EQD(time): - """Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial of-date (EQD). + """Calculates a rotation matrix from J2000 mean ecliptic (ECL) to equatorial of-date (EQD). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -7498,7 +7498,7 @@ def Rotation_ECL_EQD(time): def Rotation_ECL_HOR(time, observer): - """Calculates a rotation matrix from ecliptic J2000 (ECL) to horizontal (HOR). + """Calculates a rotation matrix from J2000 mean ecliptic (ECL) to horizontal (HOR). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -7530,7 +7530,7 @@ def Rotation_ECL_HOR(time, observer): def Rotation_HOR_ECL(time, observer): - """Calculates a rotation matrix from horizontal (HOR) to ecliptic J2000 (ECL). + """Calculates a rotation matrix from horizontal (HOR) to J2000 mean ecliptic (ECL). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -7553,7 +7553,7 @@ def Rotation_HOR_ECL(time, observer): return InverseRotation(rot) def Rotation_EQJ_GAL(): - """Calculates a rotation matrix from equatorial J2000 (EQJ) to galactic (GAL). + """Calculates a rotation matrix from J2000 mean equator (EQJ) to galactic (GAL). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -7575,7 +7575,7 @@ def Rotation_EQJ_GAL(): ]) def Rotation_GAL_EQJ(): - """Calculates a rotation matrix from galactic (GAL) to equatorial J2000 (EQJ). + """Calculates a rotation matrix from galactic (GAL) to J2000 mean equator (EQJ). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. @@ -9494,7 +9494,7 @@ class AxisInfo: [Report of the IAU Working Group on Cartographic Coordinates and Rotational Elements: 2015](https://astropedia.astrogeology.usgs.gov/download/Docs/WGCCRE/WGCCRE2015reprint.pdf). The field `north` is a unit vector pointing in the direction of the body's north pole. - It is expressed in the equatorial J2000 system (EQJ). + It is expressed in the J2000 mean equator system (EQJ). Attributes ---------- @@ -9759,7 +9759,7 @@ def LagrangePoint(point, time, major_body, minor_body): 5 = the Lagrange point 60 degrees behind the minor body's orbital position. The function returns the state vector for the selected Lagrange point - in equatorial J2000 coordinates (EQJ), with respect to the center of the + in J2000 mean equator coordinates (EQJ), with respect to the center of the major body. To calculate Sun/Earth Lagrange points, pass in `Body.Sun` for `major_body` @@ -10023,7 +10023,7 @@ class GravitySimulator: of the small bodies to be simulated. The caller must know the positions and velocities of the small bodies at an initial moment in time. Their positions and velocities are expressed with respect to `originBody`, - using equatorial J2000 orientation (EQJ). + using J2000 mean equator orientation (EQJ). Positions are expressed in astronomical units (AU). Velocities are expressed in AU/day. All the times embedded within the state vectors must exactly match `time`,