ootk 4.0.9 → 5.1.0

package/dist/coordinate/ClassicalElements.d.ts

@@ -0,0 +1,132 @@
+/**
+ * @author @thkruz Theodore Kruczek
+ * @description Orbital Object ToolKit (ootk) is a collection of tools for working
+ * with satellites and other orbital objects.
+ * @license AGPL-3.0-or-later
+ * @copyright (c) 2025 Kruczek Labs LLC
+ *
+ * Many of the classes are based off of the work of @david-rc-dayton and his
+ * Pious Squid library (https://github.com/david-rc-dayton/pious_squid) which
+ * is licensed under the MIT license.
+ *
+ * Orbital Object ToolKit is free software: you can redistribute it and/or modify it under the
+ * terms of the GNU Affero General Public License as published by the Free Software
+ * Foundation, either version 3 of the License, or (at your option) any later version.
+ *
+ * Orbital Object ToolKit is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
+ * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License along with
+ * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
+ */
+import { Minutes, PositionVelocity, Degrees, Kilometers, Radians } from '../main.js';
+import { EpochUTC } from '../time/EpochUTC.js';
+import { EquinoctialElements } from './EquinoctialElements.js';
+import { OrbitRegime } from '../enums/OrbitRegime.js';
+import { StateVector } from './StateVector.js';
+import { ClassicalElementsParams } from '../interfaces/ClassicalElementsParams.js';
+/**
+ * The ClassicalElements class represents the classical orbital elements of an object.
+ * @example
+ * ```ts
+ * const epoch = EpochUTC.fromDateTime(new Date('2024-01-14T14:39:39.914Z'));
+ * const elements = new ClassicalElements({
+ *  epoch,
+ *  semimajorAxis: 6943.547853722985 as Kilometers,
+ *  eccentricity: 0.0011235968124658146,
+ *  inclination: 0.7509087232045765 as Radians,
+ *  rightAscension: 0.028239555738616327 as Radians,
+ *  argPerigee: 2.5386411901807353 as Radians,
+ *  trueAnomaly: 0.5931399364974058 as Radians,
+ * });
+ * ```
+ */
+export declare class ClassicalElements {
+    epoch: EpochUTC;
+    semimajorAxis: Kilometers;
+    eccentricity: number;
+    inclination: Radians;
+    rightAscension: Radians;
+    argPerigee: Radians;
+    trueAnomaly: Radians;
+    /** Gravitational parameter in km³/s².  */
+    mu: number;
+    constructor({ epoch, semimajorAxis, eccentricity, inclination, rightAscension, argPerigee, trueAnomaly, mu, }: ClassicalElementsParams);
+    /**
+     * Creates a new instance of ClassicalElements from a StateVector.
+     * @param state The StateVector to convert.
+     * @param mu The gravitational parameter of the central body. Default value is Earth's gravitational parameter.
+     * @returns A new instance of ClassicalElements.
+     * @throws Error if the StateVector is not in an inertial frame.
+     */
+    static fromStateVector(state: StateVector, mu?: number): ClassicalElements;
+    /**
+     * Gets the inclination in degrees.
+     * @returns The inclination in degrees.
+     */
+    get inclinationDegrees(): Degrees;
+    /**
+     * Gets the right ascension in degrees.
+     * @returns The right ascension in degrees.
+     */
+    get rightAscensionDegrees(): Degrees;
+    /**
+     * Gets the argument of perigee in degrees.
+     * @returns The argument of perigee in degrees.
+     */
+    get argPerigeeDegrees(): Degrees;
+    /**
+     * Gets the true anomaly in degrees.
+     * @returns The true anomaly in degrees.
+     */
+    get trueAnomalyDegrees(): Degrees;
+    /**
+     * Gets the apogee of the classical elements. It is measured from the surface of the earth.
+     * @returns The apogee in kilometers.
+     */
+    get apogee(): Kilometers;
+    /**
+     * Gets the perigee of the classical elements. The perigee is the point in an
+     * orbit that is closest to the surface of the earth.
+     * @returns The perigee distance in kilometers.
+     */
+    get perigee(): number;
+    toString(): string;
+    /**
+     * Calculates the mean motion of the celestial object.
+     * @returns The mean motion in radians.
+     */
+    get meanMotion(): Radians;
+    /**
+     * Calculates the period of the orbit.
+     * @returns The period in seconds.
+     */
+    get period(): Minutes;
+    /**
+     * Compute the number of revolutions completed per day for this orbit.
+     * @returns The number of revolutions per day.
+     */
+    get revsPerDay(): number;
+    /**
+     * Returns the orbit regime based on the classical elements.
+     * @returns The orbit regime.
+     */
+    getOrbitRegime(): OrbitRegime;
+    /**
+     * Converts the classical orbital elements to position and velocity vectors.
+     * @returns An object containing the position and velocity vectors.
+     */
+    toPositionVelocity(): PositionVelocity;
+    /**
+     * Converts the classical elements to equinoctial elements.
+     * @returns The equinoctial elements.
+     */
+    toEquinoctialElements(): EquinoctialElements;
+    /**
+     * Propagates the classical elements to a given epoch.
+     * @param propEpoch - The epoch to propagate the classical elements to.
+     * @returns The classical elements at the propagated epoch.
+     */
+    propagate(propEpoch: EpochUTC): ClassicalElements;
+}

package/dist/coordinate/ClassicalElements.js

@@ -0,0 +1,279 @@
+/**
+ * @author @thkruz Theodore Kruczek
+ * @description Orbital Object ToolKit (ootk) is a collection of tools for working
+ * with satellites and other orbital objects.
+ * @license AGPL-3.0-or-later
+ * @copyright (c) 2025 Kruczek Labs LLC
+ *
+ * Many of the classes are based off of the work of @david-rc-dayton and his
+ * Pious Squid library (https://github.com/david-rc-dayton/pious_squid) which
+ * is licensed under the MIT license.
+ *
+ * Orbital Object ToolKit is free software: you can redistribute it and/or modify it under the
+ * terms of the GNU Affero General Public License as published by the Free Software
+ * Foundation, either version 3 of the License, or (at your option) any later version.
+ *
+ * Orbital Object ToolKit is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
+ * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License along with
+ * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
+ */
+import { Earth, } from '../main.js';
+import { Vector3D } from '../operations/Vector3D.js';
+import { earthGravityParam, MINUTES_PER_DAY, RAD2DEG, sec2min, TAU } from '../utils/constants.js';
+import { clamp, matchHalfPlane, newtonNu } from '../utils/functions.js';
+import { EquinoctialElements } from './EquinoctialElements.js';
+import { OrbitRegime } from '../enums/OrbitRegime.js';
+/**
+ * The ClassicalElements class represents the classical orbital elements of an object.
+ * @example
+ * ```ts
+ * const epoch = EpochUTC.fromDateTime(new Date('2024-01-14T14:39:39.914Z'));
+ * const elements = new ClassicalElements({
+ *  epoch,
+ *  semimajorAxis: 6943.547853722985 as Kilometers,
+ *  eccentricity: 0.0011235968124658146,
+ *  inclination: 0.7509087232045765 as Radians,
+ *  rightAscension: 0.028239555738616327 as Radians,
+ *  argPerigee: 2.5386411901807353 as Radians,
+ *  trueAnomaly: 0.5931399364974058 as Radians,
+ * });
+ * ```
+ */
+export class ClassicalElements {
+    epoch;
+    semimajorAxis;
+    eccentricity;
+    inclination;
+    rightAscension;
+    argPerigee;
+    trueAnomaly;
+    /** Gravitational parameter in km³/s².  */
+    mu;
+    constructor({ epoch, semimajorAxis, eccentricity, inclination, rightAscension, argPerigee, trueAnomaly, mu = earthGravityParam, }) {
+        this.epoch = epoch;
+        this.semimajorAxis = semimajorAxis;
+        this.eccentricity = eccentricity;
+        this.inclination = inclination;
+        this.rightAscension = rightAscension;
+        this.argPerigee = argPerigee;
+        this.trueAnomaly = trueAnomaly;
+        this.mu = mu;
+    }
+    /**
+     * Creates a new instance of ClassicalElements from a StateVector.
+     * @param state The StateVector to convert.
+     * @param mu The gravitational parameter of the central body. Default value is Earth's gravitational parameter.
+     * @returns A new instance of ClassicalElements.
+     * @throws Error if the StateVector is not in an inertial frame.
+     */
+    static fromStateVector(state, mu = earthGravityParam) {
+        if (!state.inertial) {
+            throw new Error('State vector must be in inertial frame (like J2000).');
+        }
+        const pos = state.position;
+        const vel = state.velocity;
+        const a = state.semimajorAxis;
+        const eVecA = pos.scale(vel.magnitude() ** 2 - mu / pos.magnitude());
+        const eVecB = vel.scale(pos.dot(vel));
+        const eVec = eVecA.subtract(eVecB).scale(1 / mu);
+        const e = eVec.magnitude();
+        const h = pos.cross(vel);
+        const i = Math.acos(clamp(h.z / h.magnitude(), -1.0, 1.0));
+        const n = Vector3D.zAxis.cross(h);
+        let o = Math.acos(clamp(n.x / n.magnitude(), -1.0, 1.0));
+        if (n.y < 0) {
+            o = TAU - o;
+        }
+        let w = n.angle(eVec);
+        if (eVec.z < 0) {
+            w = TAU - w;
+        }
+        let v = eVec.angle(pos);
+        if (pos.dot(vel) < 0) {
+            v = TAU - v;
+        }
+        return new ClassicalElements({
+            epoch: state.epoch,
+            semimajorAxis: a,
+            eccentricity: e,
+            inclination: i,
+            rightAscension: o,
+            argPerigee: w,
+            trueAnomaly: v,
+            mu,
+        });
+    }
+    /**
+     * Gets the inclination in degrees.
+     * @returns The inclination in degrees.
+     */
+    get inclinationDegrees() {
+        return (this.inclination * RAD2DEG);
+    }
+    /**
+     * Gets the right ascension in degrees.
+     * @returns The right ascension in degrees.
+     */
+    get rightAscensionDegrees() {
+        return (this.rightAscension * RAD2DEG);
+    }
+    /**
+     * Gets the argument of perigee in degrees.
+     * @returns The argument of perigee in degrees.
+     */
+    get argPerigeeDegrees() {
+        return (this.argPerigee * RAD2DEG);
+    }
+    /**
+     * Gets the true anomaly in degrees.
+     * @returns The true anomaly in degrees.
+     */
+    get trueAnomalyDegrees() {
+        return (this.trueAnomaly * RAD2DEG);
+    }
+    /**
+     * Gets the apogee of the classical elements. It is measured from the surface of the earth.
+     * @returns The apogee in kilometers.
+     */
+    get apogee() {
+        return (this.semimajorAxis * (1.0 + this.eccentricity) - Earth.radiusMean);
+    }
+    /**
+     * Gets the perigee of the classical elements. The perigee is the point in an
+     * orbit that is closest to the surface of the earth.
+     * @returns The perigee distance in kilometers.
+     */
+    get perigee() {
+        return (this.semimajorAxis * (1.0 - this.eccentricity) - Earth.radiusMean);
+    }
+    toString() {
+        return [
+            '[ClassicalElements]',
+            `  Epoch: ${this.epoch}`,
+            `  Semimajor Axis (a):       ${this.semimajorAxis.toFixed(4)} km`,
+            `  Eccentricity (e):         ${this.eccentricity.toFixed(7)}`,
+            `  Inclination (i):          ${this.inclinationDegrees.toFixed(4)}°`,
+            `  Right Ascension (Ω):      ${this.rightAscensionDegrees.toFixed(4)}°`,
+            `  Argument of Perigee (ω):  ${this.argPerigeeDegrees.toFixed(4)}°`,
+            `  True Anomaly (ν):         ${this.trueAnomalyDegrees.toFixed(4)}°`,
+        ].join('\n');
+    }
+    /**
+     * Calculates the mean motion of the celestial object.
+     * @returns The mean motion in radians.
+     */
+    get meanMotion() {
+        return Math.sqrt(this.mu / this.semimajorAxis ** 3);
+    }
+    /**
+     * Calculates the period of the orbit.
+     * @returns The period in seconds.
+     */
+    get period() {
+        const periodSec = (TAU * Math.sqrt(this.semimajorAxis ** 3 / this.mu));
+        return (periodSec / 60);
+    }
+    /**
+     * Compute the number of revolutions completed per day for this orbit.
+     * @returns The number of revolutions per day.
+     */
+    get revsPerDay() {
+        return MINUTES_PER_DAY / this.period;
+    }
+    /**
+     * Returns the orbit regime based on the classical elements.
+     * @returns The orbit regime.
+     */
+    getOrbitRegime() {
+        const n = this.revsPerDay;
+        const p = this.period * sec2min;
+        if (n >= 0.99 && n <= 1.01 && this.eccentricity < 0.01) {
+            return OrbitRegime.GEO;
+        }
+        if (p >= 600 && p <= 800 && this.eccentricity <= 0.25) {
+            return OrbitRegime.MEO;
+        }
+        if (n >= 11.25 && this.eccentricity <= 0.25) {
+            return OrbitRegime.LEO;
+        }
+        if (this.eccentricity > 0.25) {
+            return OrbitRegime.HEO;
+        }
+        return OrbitRegime.OTHER;
+    }
+    /**
+     * Converts the classical orbital elements to position and velocity vectors.
+     * @returns An object containing the position and velocity vectors.
+     */
+    toPositionVelocity() {
+        const rVec = new Vector3D(Math.cos(this.trueAnomaly), Math.sin(this.trueAnomaly), 0.0);
+        const rPQW = rVec.scale((this.semimajorAxis * (1.0 - this.eccentricity ** 2)) / (1.0 + this.eccentricity * Math.cos(this.trueAnomaly)));
+        const vVec = new Vector3D(-Math.sin(this.trueAnomaly), this.eccentricity + Math.cos(this.trueAnomaly), 0.0);
+        const vPQW = vVec.scale(Math.sqrt(this.mu / (this.semimajorAxis * (1 - this.eccentricity ** 2))));
+        const position = rPQW
+            .rotZ(-this.argPerigee)
+            .rotX(-this.inclination)
+            .rotZ(-this.rightAscension);
+        const velocity = vPQW
+            .rotZ(-this.argPerigee)
+            .rotX(-this.inclination)
+            .rotZ(-this.rightAscension);
+        return { position, velocity };
+    }
+    /**
+     * Converts the classical elements to equinoctial elements.
+     * @returns The equinoctial elements.
+     */
+    toEquinoctialElements() {
+        const I = this.inclination > Math.PI / 2 ? -1 : 1;
+        const h = this.eccentricity * Math.sin(this.argPerigee + I * this.rightAscension);
+        const k = this.eccentricity * Math.cos(this.argPerigee + I * this.rightAscension);
+        const meanAnomaly = newtonNu(this.eccentricity, this.trueAnomaly).m;
+        const lambda = (meanAnomaly + this.argPerigee + I * this.rightAscension);
+        const a = this.semimajorAxis;
+        const p = Math.tan(0.5 * this.inclination) ** I * Math.sin(this.rightAscension);
+        const q = Math.tan(0.5 * this.inclination) ** I * Math.cos(this.rightAscension);
+        return new EquinoctialElements({ epoch: this.epoch, k, h, lambda, a, p, q, mu: this.mu, I });
+    }
+    /**
+     * Propagates the classical elements to a given epoch.
+     * @param propEpoch - The epoch to propagate the classical elements to.
+     * @returns The classical elements at the propagated epoch.
+     */
+    propagate(propEpoch) {
+        const t = this.epoch;
+        const n = this.meanMotion;
+        const delta = propEpoch.difference(t);
+        const cosV = Math.cos(this.trueAnomaly);
+        let eaInit = Math.acos(clamp((this.eccentricity + cosV) / (1 + this.eccentricity * cosV), -1, 1));
+        eaInit = matchHalfPlane(eaInit, this.trueAnomaly);
+        let maInit = eaInit - this.eccentricity * Math.sin(eaInit);
+        maInit = matchHalfPlane(maInit, eaInit);
+        const maFinal = (maInit + n * delta) % TAU;
+        let eaFinal = maFinal;
+        for (let iter = 0; iter < 32; iter++) {
+            const eaTemp = maFinal + this.eccentricity * Math.sin(eaFinal);
+            if (Math.abs(eaTemp - eaFinal) < 1e-12) {
+                break;
+            }
+            eaFinal = eaTemp;
+        }
+        const cosEaFinal = Math.cos(eaFinal);
+        let vFinal = clamp(Math.acos((cosEaFinal - this.eccentricity) / (1 - this.eccentricity * cosEaFinal)), -1, 1);
+        vFinal = matchHalfPlane(vFinal, eaFinal);
+        return new ClassicalElements({
+            epoch: propEpoch,
+            semimajorAxis: this.semimajorAxis,
+            eccentricity: this.eccentricity,
+            inclination: this.inclination,
+            rightAscension: this.rightAscension,
+            argPerigee: this.argPerigee,
+            trueAnomaly: vFinal,
+            mu: this.mu,
+        });
+    }
+}
+//# sourceMappingURL=ClassicalElements.js.map

package/dist/coordinate/ClassicalElements.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ClassicalElements.js","sourceRoot":"","sources":["../../src/coordinate/ClassicalElements.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,EACkF,KAAK,GAC7F,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAErD,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,uBAAuB,CAAC;AAClG,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACxE,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAItD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,OAAO,iBAAiB;IAC5B,KAAK,CAAW;IAChB,aAAa,CAAa;IAC1B,YAAY,CAAS;IACrB,WAAW,CAAU;IACrB,cAAc,CAAU;IACxB,UAAU,CAAU;IACpB,WAAW,CAAU;IACrB,0CAA0C;IAC1C,EAAE,CAAS;IAEX,YAAY,EACV,KAAK,EACL,aAAa,EACb,YAAY,EACZ,WAAW,EACX,cAAc,EACd,UAAU,EACV,WAAW,EACX,EAAE,GAAG,iBAAiB,GACE;QACxB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;IACf,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,eAAe,CAAC,KAAkB,EAAE,EAAE,GAAG,iBAAiB;QAC/D,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;QAC1E,CAAC;QACD,MAAM,GAAG,GAAG,KAAK,CAAC,QAAQ,CAAC;QAC3B,MAAM,GAAG,GAAG,KAAK,CAAC,QAAQ,CAAC;QAC3B,MAAM,CAAC,GAAG,KAAK,CAAC,aAAa,CAAC;QAC9B,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,CAAC,SAAS,EAAyB,CAAC,CAAC;QAC5F,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;QACtC,MAAM,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;QACjD,MAAM,CAAC,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;QAC3B,MAAM,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACzB,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,CAAY,CAAC;QACtE,MAAM,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAClC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,CAAY,CAAC;QAEpE,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;YACZ,CAAC,GAAG,GAAG,GAAG,CAAY,CAAC;QACzB,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAEtB,IAAI,IAAI,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;YACf,CAAC,GAAG,GAAG,GAAG,CAAY,CAAC;QACzB,CAAC;QACD,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAExB,IAAI,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YACrB,CAAC,GAAG,GAAG,GAAG,CAAY,CAAC;QACzB,CAAC;QAED,OAAO,IAAI,iBAAiB,CAAC;YAC3B,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,aAAa,EAAE,CAAC;YAChB,YAAY,EAAE,CAAC;YACf,WAAW,EAAE,CAAC;YACd,cAAc,EAAE,CAAC;YACjB,UAAU,EAAE,CAAC;YACb,WAAW,EAAE,CAAC;YACd,EAAE;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,IAAI,kBAAkB;QACpB,OAAO,CAAC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAY,CAAC;IACjD,CAAC;IAED;;;OAGG;IACH,IAAI,qBAAqB;QACvB,OAAO,CAAC,IAAI,CAAC,cAAc,GAAG,OAAO,CAAY,CAAC;IACpD,CAAC;IAED;;;OAGG;IACH,IAAI,iBAAiB;QACnB,OAAO,CAAC,IAAI,CAAC,UAAU,GAAG,OAAO,CAAY,CAAC;IAChD,CAAC;IAED;;;OAGG;IACH,IAAI,kBAAkB;QACpB,OAAO,CAAC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAY,CAAC;IACjD,CAAC;IAED;;;OAGG;IACH,IAAI,MAAM;QACR,OAAO,CAAC,IAAI,CAAC,aAAa,GAAG,CAAC,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,UAAU,CAAe,CAAC;IAC3F,CAAC;IAED;;;;OAIG;IACH,IAAI,OAAO;QACT,OAAO,CAAC,IAAI,CAAC,aAAa,GAAG,CAAC,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,UAAU,CAAe,CAAC;IAC3F,CAAC;IAED,QAAQ;QACN,OAAO;YACL,qBAAqB;YACrB,YAAY,IAAI,CAAC,KAAK,EAAE;YACxB,+BAA+B,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK;YACjE,+BAA+B,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;YAC7D,+BAA+B,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG;YACpE,+BAA+B,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG;YACvE,+BAA+B,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG;YACnE,+BAA+B,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG;SACrE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACf,CAAC;IAED;;;OAGG;IACH,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,aAAa,IAAI,CAAC,CAAY,CAAC;IACjE,CAAC;IAED;;;OAGG;IACH,IAAI,MAAM;QACR,MAAM,SAAS,GAAG,CAAC,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC,CAAY,CAAC;QAElF,OAAO,CAAC,SAAS,GAAG,EAAE,CAAY,CAAC;IACrC,CAAC;IAED;;;OAGG;IACH,IAAI,UAAU;QACZ,OAAO,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC;IACvC,CAAC;IAED;;;OAGG;IACH,cAAc;QACZ,MAAM,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC;QAC1B,MAAM,CAAC,GAAG,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC;QAEhC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,IAAI,CAAC,YAAY,GAAG,IAAI,EAAE,CAAC;YACvD,OAAO,WAAW,CAAC,GAAG,CAAC;QACzB,CAAC;QACD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,EAAE,CAAC;YACtD,OAAO,WAAW,CAAC,GAAG,CAAC;QACzB,CAAC;QACD,IAAI,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,EAAE,CAAC;YAC5C,OAAO,WAAW,CAAC,GAAG,CAAC;QACzB,CAAC;QACD,IAAI,IAAI,CAAC,YAAY,GAAG,IAAI,EAAE,CAAC;YAC7B,OAAO,WAAW,CAAC,GAAG,CAAC;QACzB,CAAC;QAED,OAAO,WAAW,CAAC,KAAK,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACH,kBAAkB;QAChB,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,GAAG,CAAC,CAAC;QACvF,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CACrB,CAAC,IAAI,CAAC,aAAa,GAAG,CAAC,GAAG,GAAG,IAAI,CAAC,YAAY,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,GAAG,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAC/G,CAAC;QACF,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,GAAG,CAAC,CAAC;QAC5G,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,YAAY,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAClG,MAAM,QAAQ,GAAG,IAAI;aAClB,IAAI,CAAC,CAAC,IAAI,CAAC,UAAqB,CAAC;aACjC,IAAI,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC;aACvB,IAAI,CAAC,CAAC,IAAI,CAAC,cAAyB,CAAyB,CAAC;QACjE,MAAM,QAAQ,GAAG,IAAI;aAClB,IAAI,CAAC,CAAC,IAAI,CAAC,UAAqB,CAAC;aACjC,IAAI,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC;aACvB,IAAI,CAAC,CAAC,IAAI,CAAC,cAAyB,CAAkC,CAAC;QAE1E,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC;IAChC,CAAC;IAED;;;OAGG;IACH,qBAAqB;QACnB,MAAM,CAAC,GAAG,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAClD,MAAM,CAAC,GAAG,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,GAAG,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC;QAClF,MAAM,CAAC,GAAG,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,GAAG,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC;QAClF,MAAM,WAAW,GAAG,QAAQ,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;QACpE,MAAM,MAAM,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,UAAU,GAAG,CAAC,GAAG,IAAI,CAAC,cAAc,CAAY,CAAC;QACpF,MAAM,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC;QAC7B,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAChF,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAEhF,OAAO,IAAI,mBAAmB,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,SAAmB;QAC3B,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC;QACrB,MAAM,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC;QAC1B,MAAM,KAAK,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QACtC,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACxC,IAAI,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAElG,MAAM,GAAG,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAClD,IAAI,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAE3D,MAAM,GAAG,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACxC,MAAM,OAAO,GAAG,CAAC,MAAM,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,GAAG,CAAC;QAC3C,IAAI,OAAO,GAAG,OAAO,CAAC;QAEtB,KAAK,IAAI,IAAI,GAAG,CAAC,EAAE,IAAI,GAAG,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC;YACrC,MAAM,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YAE/D,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,GAAG,OAAO,CAAC,GAAG,KAAK,EAAE,CAAC;gBACvC,MAAM;YACR,CAAC;YACD,OAAO,GAAG,MAAM,CAAC;QACnB,CAAC;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACrC,IAAI,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,YAAY,GAAG,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAE9G,MAAM,GAAG,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEzC,OAAO,IAAI,iBAAiB,CAAC;YAC3B,KAAK,EAAE,SAAS;YAChB,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,WAAW,EAAE,MAAiB;YAC9B,EAAE,EAAE,IAAI,CAAC,EAAE;SACZ,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/coordinate/EquinoctialElements.d.ts

@@ -0,0 +1,114 @@
+/**
+ * @author @thkruz Theodore Kruczek
+ * @description Orbital Object ToolKit (ootk) is a collection of tools for working
+ * with satellites and other orbital objects.
+ * @license AGPL-3.0-or-later
+ * @copyright (c) 2025 Kruczek Labs LLC
+ *
+ * Many of the classes are based off of the work of @david-rc-dayton and his
+ * Pious Squid library (https://github.com/david-rc-dayton/pious_squid) which
+ * is licensed under the MIT license.
+ *
+ * Orbital Object ToolKit is free software: you can redistribute it and/or modify it under the
+ * terms of the GNU Affero General Public License as published by the Free Software
+ * Foundation, either version 3 of the License, or (at your option) any later version.
+ *
+ * Orbital Object ToolKit is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
+ * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License along with
+ * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
+ */
+import { Minutes, PositionVelocity, Kilometers, Radians } from '../main.js';
+import { EpochUTC } from '../time/EpochUTC.js';
+import { ClassicalElements } from './ClassicalElements.js';
+import { EquinoctialElementsParams } from '../interfaces/EquinoctialElementsParams.js';
+/**
+ * Equinoctial elements are a set of orbital elements used to describe the
+ * orbits of celestial bodies, such as satellites around a planet. They provide
+ * an alternative to the traditional Keplerian elements and are especially
+ * useful for avoiding singularities and numerical issues in certain types of
+ * orbits.
+ *
+ * Unlike Keplerian elements, equinoctial elements don't suffer from
+ * singularities at zero eccentricity (circular orbits) or zero inclination
+ * (equatorial orbits). This makes them more reliable for numerical simulations
+ * and analytical studies, especially in these edge cases.
+ * @see https://faculty.nps.edu/dad/orbital/th0.pdf
+ */
+export declare class EquinoctialElements {
+    epoch: EpochUTC;
+    /** The semi-major axis of the orbit in kilometers. */
+    a: Kilometers;
+    /** The h component of the eccentricity vector. */
+    h: number;
+    /** The k component of the eccentricity vector. */
+    k: number;
+    /** The p component of the ascending node vector. */
+    p: number;
+    /** The q component of the ascending node vector. */
+    q: number;
+    /** The mean longitude of the orbit in radians. */
+    lambda: Radians;
+    /** The gravitational parameter of the central body in km³/s². */
+    mu: number;
+    /** The retrograde factor. 1 for prograde orbits, -1 for retrograde orbits. */
+    I: 1 | -1;
+    constructor({ epoch, h, k, lambda, a, p, q, mu, I }: EquinoctialElementsParams);
+    /**
+     * Returns a string representation of the EquinoctialElements object.
+     * @returns A string representation of the EquinoctialElements object.
+     */
+    toString(): string;
+    /**
+     * Gets the semimajor axis.
+     * @returns The semimajor axis in kilometers.
+     */
+    get semimajorAxis(): Kilometers;
+    /**
+     * Gets the mean longitude.
+     * @returns The mean longitude in radians.
+     */
+    get meanLongitude(): Radians;
+    /**
+     * Calculates the mean motion of the celestial object.
+     * @returns The mean motion in units of radians per second.
+     */
+    get meanMotion(): number;
+    /**
+     * Gets the retrograde factor.
+     * @returns The retrograde factor.
+     */
+    get retrogradeFactor(): number;
+    /**
+     * Checks if the orbit is prograde.
+     * @returns True if the orbit is prograde, false otherwise.
+     */
+    isPrograde(): boolean;
+    /**
+     * Checks if the orbit is retrograde.
+     * @returns True if the orbit is retrograde, false otherwise.
+     */
+    isRetrograde(): boolean;
+    /**
+     * Gets the period of the orbit.
+     * @returns The period in minutes.
+     */
+    get period(): Minutes;
+    /**
+     * Gets the number of revolutions per day.
+     * @returns The number of revolutions per day.
+     */
+    get revsPerDay(): number;
+    /**
+     * Converts the equinoctial elements to classical elements.
+     * @returns The classical elements.
+     */
+    toClassicalElements(): ClassicalElements;
+    /**
+     * Converts the equinoctial elements to position and velocity.
+     * @returns The position and velocity in classical elements.
+     */
+    toPositionVelocity(): PositionVelocity;
+}