ootk 4.0.9 → 5.1.0

package/dist/coordinate/J2000.js

@@ -0,0 +1,120 @@
+/**
+ * @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 '../body/Earth.js';
+import { ITRF } from './ITRF.js';
+import { StateVector } from './StateVector.js';
+import { TEME } from './TEME.js';
+/**
+ * Represents a position and velocity in the J2000 coordinate system. This is an Earth-centered inertial (ECI)
+ * coordinate system.
+ *
+ * Commonly used ECI frame is defined with the Earth's Mean Equator and Mean Equinox (MEME) at 12:00 Terrestrial Time on
+ * 1 January 2000. It can be referred to as J2K, J2000 or EME2000. The x-axis is aligned with the mean vernal equinox.
+ * The z-axis is aligned with the Earth's rotation axis (or equivalently, the celestial North Pole) as it was at that
+ * time. The y-axis is rotated by 90° East about the celestial equator.
+ * @see https://en.wikipedia.org/wiki/Earth-centered_inertial
+ */
+export class J2000 extends StateVector {
+    /**
+     * Creates a J2000 coordinate from classical elements.
+     * @param elements The classical elements.
+     * @returns The J2000 coordinate.
+     */
+    static fromClassicalElements(elements) {
+        const rv = elements.toPositionVelocity();
+        return new J2000(elements.epoch, rv.position, rv.velocity);
+    }
+    /**
+     * Gets the name of the coordinate system.
+     * @returns The name of the coordinate system.
+     */
+    get name() {
+        return 'J2000';
+    }
+    /**
+     * Gets a value indicating whether the coordinate system is inertial.
+     * @returns A boolean value indicating whether the coordinate system is inertial.
+     */
+    get inertial() {
+        return true;
+    }
+    /**
+     * Converts the coordinates from J2000 to the International Terrestrial Reference Frame (ITRF).
+     * This is an ECI to ECF transformation.
+     * @returns The ITRF coordinates.
+     */
+    toITRF() {
+        const p = Earth.precession(this.epoch);
+        const n = Earth.nutation(this.epoch);
+        const ast = (this.epoch.gmstAngle() + n.eqEq);
+        const rMOD = this.position
+            .rotZ(-p.zeta)
+            .rotY(p.theta)
+            .rotZ(-p.zed);
+        const vMOD = this.velocity
+            .rotZ(-p.zeta)
+            .rotY(p.theta)
+            .rotZ(-p.zed);
+        const rTOD = rMOD
+            .rotX(n.mEps)
+            .rotZ(-n.dPsi)
+            .rotX(-n.eps);
+        const vTOD = vMOD
+            .rotX(n.mEps)
+            .rotZ(-n.dPsi)
+            .rotX(-n.eps);
+        const rPEF = rTOD.rotZ(ast);
+        const vPEF = vTOD.rotZ(ast).add(Earth.rotation.negate().cross(rPEF));
+        return new ITRF(this.epoch, rPEF, vPEF);
+    }
+    /**
+     * Converts the J2000 coordinate to the TEME coordinate.
+     * @returns The TEME coordinate.
+     */
+    toTEME() {
+        const p = Earth.precession(this.epoch);
+        const n = Earth.nutation(this.epoch);
+        const eps = n.mEps + n.dEps;
+        const dPsiCosEps = (n.dPsi * Math.cos(eps));
+        const rMOD = this.position
+            .rotZ(-p.zeta)
+            .rotY(p.theta)
+            .rotZ(-p.zed);
+        const vMOD = this.velocity
+            .rotZ(-p.zeta)
+            .rotY(p.theta)
+            .rotZ(-p.zed);
+        const rTEME = rMOD
+            .rotX(n.mEps)
+            .rotZ(-n.dPsi)
+            .rotX(-eps)
+            .rotZ(dPsiCosEps);
+        const vTEME = vMOD
+            .rotX(n.mEps)
+            .rotZ(-n.dPsi)
+            .rotX(-eps)
+            .rotZ(dPsiCosEps);
+        return new TEME(this.epoch, rTEME, vTEME);
+    }
+}
+//# sourceMappingURL=J2000.js.map

package/dist/coordinate/J2000.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"J2000.js","sourceRoot":"","sources":["../../src/coordinate/J2000.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAGH,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC;;;;;;;;;GASG;AACH,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;OAIG;IACH,MAAM,CAAC,qBAAqB,CAAC,QAA2B;QACtD,MAAM,EAAE,GAAG,QAAQ,CAAC,kBAAkB,EAAE,CAAC;QAEzC,OAAO,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC;IAC7D,CAAC;IAED;;;OAGG;IACH,IAAI,IAAI;QACN,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;OAGG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,MAAM,CAAC,GAAG,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACvC,MAAM,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACrC,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,IAAI,CAAY,CAAC;QACzD,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ;aACvB,IAAI,CAAC,CAAC,CAAC,CAAC,IAAe,CAAC;aACxB,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;aACb,IAAI,CAAC,CAAC,CAAC,CAAC,GAAc,CAAC,CAAC;QAC3B,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ;aACvB,IAAI,CAAC,CAAC,CAAC,CAAC,IAAe,CAAC;aACxB,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;aACb,IAAI,CAAC,CAAC,CAAC,CAAC,GAAc,CAAC,CAAC;QAC3B,MAAM,IAAI,GAAG,IAAI;aACd,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;aACZ,IAAI,CAAC,CAAC,CAAC,CAAC,IAAe,CAAC;aACxB,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QAChB,MAAM,IAAI,GAAG,IAAI;aACd,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;aACZ,IAAI,CAAC,CAAC,CAAC,CAAC,IAAe,CAAC;aACxB,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QAChB,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAyB,CAAC;QACpD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAkC,CAAC;QAEtG,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC1C,CAAC;IAED;;;OAGG;IACH,MAAM;QACJ,MAAM,CAAC,GAAG,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACvC,MAAM,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACrC,MAAM,GAAG,GAAG,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC;QAC5B,MAAM,UAAU,GAAG,CAAC,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAY,CAAC;QACvD,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ;aACvB,IAAI,CAAC,CAAC,CAAC,CAAC,IAAe,CAAC;aACxB,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;aACb,IAAI,CAAC,CAAC,CAAC,CAAC,GAAc,CAAC,CAAC;QAC3B,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ;aACvB,IAAI,CAAC,CAAC,CAAC,CAAC,IAAe,CAAC;aACxB,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;aACb,IAAI,CAAC,CAAC,CAAC,CAAC,GAAc,CAAC,CAAC;QAC3B,MAAM,KAAK,GAAG,IAAI;aACf,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;aACZ,IAAI,CAAC,CAAC,CAAC,CAAC,IAAe,CAAC;aACxB,IAAI,CAAC,CAAC,GAAG,CAAC;aACV,IAAI,CAAC,UAAU,CAAyB,CAAC;QAC5C,MAAM,KAAK,GAAG,IAAI;aACf,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;aACZ,IAAI,CAAC,CAAC,CAAC,CAAC,IAAe,CAAC;aACxB,IAAI,CAAC,CAAC,GAAG,CAAC;aACV,IAAI,CAAC,UAAU,CAAkC,CAAC;QAErD,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IAC5C,CAAC;CACF"}

package/dist/coordinate/RIC.d.ts

@@ -0,0 +1,64 @@
+/**
+ * @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 { Matrix } from '../operations/Matrix.js';
+import { J2000 } from './J2000.js';
+import { RelativeState } from './RelativeState.js';
+/**
+ * Represents a Radial-Intrack-Crosstrack (RIC) coordinates.
+ */
+export declare class RIC extends RelativeState {
+    /**
+     * Gets the name of the RIC coordinate system.
+     * @returns The name of the RIC coordinate system.
+     */
+    get name(): string;
+    /**
+     * Creates a new RIC (Radial-Intrack-Crosstrack) coordinate from the J2000 state vectors.
+     * @param state - The J2000 state vector.
+     * @param origin - The J2000 state vector of the origin.
+     * @param transform - The transformation matrix.
+     * @returns The RIC coordinate.
+     */
+    static fromJ2000Matrix(state: J2000, origin: J2000, transform: Matrix): RIC;
+    /**
+     * Creates a RIC (Radial-Intrack-Crosstrack) coordinate system from a J2000 state and origin.
+     * @param state The J2000 state.
+     * @param origin The J2000 origin.
+     * @returns The RIC coordinate system.
+     */
+    static fromJ2000(state: J2000, origin: J2000): RIC;
+    /**
+     * Transforms the current RIC coordinate to the J2000 coordinate system using the provided origin and transform
+     * matrix.
+     * @param origin The origin J2000 coordinate.
+     * @param transform The transformation matrix.
+     * @returns The transformed J2000 coordinate.
+     */
+    toJ2000Matrix(origin: J2000, transform: Matrix): J2000;
+    /**
+     * Transforms the current RIC coordinate to the J2000 coordinate system using the provided origin.
+     * @param origin The origin J2000 coordinate.
+     * @returns The transformed J2000 coordinate.
+     */
+    toJ2000(origin: J2000): J2000;
+}

package/dist/coordinate/RIC.js

@@ -0,0 +1,79 @@
+/**
+ * @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 { J2000 } from './J2000.js';
+import { RelativeState } from './RelativeState.js';
+/**
+ * Represents a Radial-Intrack-Crosstrack (RIC) coordinates.
+ */
+export class RIC extends RelativeState {
+    /**
+     * Gets the name of the RIC coordinate system.
+     * @returns The name of the RIC coordinate system.
+     */
+    get name() {
+        return 'RIC';
+    }
+    /**
+     * Creates a new RIC (Radial-Intrack-Crosstrack) coordinate from the J2000 state vectors.
+     * @param state - The J2000 state vector.
+     * @param origin - The J2000 state vector of the origin.
+     * @param transform - The transformation matrix.
+     * @returns The RIC coordinate.
+     */
+    static fromJ2000Matrix(state, origin, transform) {
+        const dr = state.position.subtract(origin.position);
+        const dv = state.velocity.subtract(origin.velocity);
+        return new RIC(transform.multiplyVector3D(dr), transform.multiplyVector3D(dv));
+    }
+    /**
+     * Creates a RIC (Radial-Intrack-Crosstrack) coordinate system from a J2000 state and origin.
+     * @param state The J2000 state.
+     * @param origin The J2000 origin.
+     * @returns The RIC coordinate system.
+     */
+    static fromJ2000(state, origin) {
+        return RIC.fromJ2000Matrix(state, origin, RelativeState.createMatrix(origin.position, origin.velocity));
+    }
+    /**
+     * Transforms the current RIC coordinate to the J2000 coordinate system using the provided origin and transform
+     * matrix.
+     * @param origin The origin J2000 coordinate.
+     * @param transform The transformation matrix.
+     * @returns The transformed J2000 coordinate.
+     */
+    toJ2000Matrix(origin, transform) {
+        const tt = transform.transpose();
+        const tr = tt.multiplyVector3D(this.position);
+        const tv = tt.multiplyVector3D(this.velocity);
+        return new J2000(origin.epoch, origin.position.add(tr), origin.velocity.add(tv));
+    }
+    /**
+     * Transforms the current RIC coordinate to the J2000 coordinate system using the provided origin.
+     * @param origin The origin J2000 coordinate.
+     * @returns The transformed J2000 coordinate.
+     */
+    toJ2000(origin) {
+        return this.toJ2000Matrix(origin, RelativeState.createMatrix(origin.position, origin.velocity));
+    }
+}
+//# sourceMappingURL=RIC.js.map

package/dist/coordinate/RIC.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RIC.js","sourceRoot":"","sources":["../../src/coordinate/RIC.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAGH,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;GAEG;AACH,MAAM,OAAO,GAAI,SAAQ,aAAa;IACpC;;;OAGG;IACH,IAAI,IAAI;QACN,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,eAAe,CAAC,KAAY,EAAE,MAAa,EAAE,SAAiB;QACnE,MAAM,EAAE,GAAG,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACpD,MAAM,EAAE,GAAG,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAEpD,OAAO,IAAI,GAAG,CAAC,SAAS,CAAC,gBAAgB,CAAC,EAAE,CAAC,EAAE,SAAS,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC,CAAC;IACjF,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,SAAS,CAAC,KAAY,EAAE,MAAa;QAC1C,OAAO,GAAG,CAAC,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,aAAa,CAAC,YAAY,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC1G,CAAC;IAED;;;;;;OAMG;IACH,aAAa,CAAC,MAAa,EAAE,SAAiB;QAC5C,MAAM,EAAE,GAAG,SAAS,CAAC,SAAS,EAAE,CAAC;QACjC,MAAM,EAAE,GAAG,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC9C,MAAM,EAAE,GAAG,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAE9C,OAAO,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;IACnF,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,MAAa;QACnB,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,aAAa,CAAC,YAAY,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;IAClG,CAAC;CACF"}

package/dist/coordinate/RelativeState.d.ts

@@ -0,0 +1,70 @@
+/**
+ * @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 { Kilometers, KilometersPerSecond } from '../main.js';
+import { Matrix } from '../operations/Matrix.js';
+import { Vector3D } from '../operations/Vector3D.js';
+import { J2000 } from './J2000.js';
+/**
+ * Represents the relative state of an object in 3D space.
+ */
+export declare abstract class RelativeState {
+    position: Vector3D<Kilometers>;
+    velocity: Vector3D<KilometersPerSecond>;
+    constructor(position: Vector3D<Kilometers>, velocity: Vector3D<KilometersPerSecond>);
+    /**
+     * Gets the name of the coordinate system.
+     * @returns The name of the coordinate system.
+     */
+    abstract get name(): string;
+    /**
+     * Returns a string representation of the RelativeState object. The string includes the name, position, and velocity
+     * of the object.
+     * @returns A string representation of the RelativeState object.
+     */
+    toString(): string;
+    /**
+     * Transforms the current RelativeState coordinate to the J2000 coordinate
+     * @param origin The origin J2000 coordinate.
+     * @returns The transformed J2000 coordinate.
+     */
+    abstract toJ2000(origin: J2000): J2000;
+    /**
+     * Creates a matrix based on the given position and velocity vectors. The matrix represents the relative state of an
+     * object in 3D space.
+     * @param position - The position vector.
+     * @param velocity - The velocity vector.
+     * @returns The matrix representing the relative state.
+     */
+    static createMatrix(position: Vector3D, velocity: Vector3D): Matrix;
+    /**
+     * Calculates the range of the relative state.
+     * @returns The range in kilometers.
+     */
+    get range(): Kilometers;
+    /**
+     * Calculates the range rate of the relative state. Range rate is the dot product of the position and velocity divided
+     * by the range.
+     * @returns The range rate in Kilometers per second.
+     */
+    get rangeRate(): number;
+}

package/dist/coordinate/RelativeState.js

@@ -0,0 +1,79 @@
+/**
+ * @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 { Matrix } from '../operations/Matrix.js';
+/**
+ * Represents the relative state of an object in 3D space.
+ */
+export class RelativeState {
+    position;
+    velocity;
+    constructor(position, velocity) {
+        this.position = position;
+        this.velocity = velocity;
+    }
+    /**
+     * Returns a string representation of the RelativeState object. The string includes the name, position, and velocity
+     * of the object.
+     * @returns A string representation of the RelativeState object.
+     */
+    toString() {
+        return [
+            `[${this.name}]`,
+            `  Position: ${this.position.toString(6)} km`,
+            `  Velocity: ${this.velocity.toString(9)} km/s`,
+        ].join('\n');
+    }
+    /**
+     * Creates a matrix based on the given position and velocity vectors. The matrix represents the relative state of an
+     * object in 3D space.
+     * @param position - The position vector.
+     * @param velocity - The velocity vector.
+     * @returns The matrix representing the relative state.
+     */
+    static createMatrix(position, velocity) {
+        const ru = position.normalize();
+        const cu = position.cross(velocity).normalize();
+        const iu = cu.cross(ru).normalize();
+        return new Matrix([
+            [ru.x, ru.y, ru.z],
+            [iu.x, iu.y, iu.z],
+            [cu.x, cu.y, cu.z],
+        ]);
+    }
+    /**
+     * Calculates the range of the relative state.
+     * @returns The range in kilometers.
+     */
+    get range() {
+        return this.position.magnitude();
+    }
+    /**
+     * Calculates the range rate of the relative state. Range rate is the dot product of the position and velocity divided
+     * by the range.
+     * @returns The range rate in Kilometers per second.
+     */
+    get rangeRate() {
+        return this.position.dot(this.velocity) / this.range;
+    }
+}
+//# sourceMappingURL=RelativeState.js.map

package/dist/coordinate/RelativeState.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RelativeState.js","sourceRoot":"","sources":["../../src/coordinate/RelativeState.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAGH,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AAIjD;;GAEG;AACH,MAAM,OAAgB,aAAa;IACjC,QAAQ,CAAuB;IAC/B,QAAQ,CAAgC;IACxC,YAAY,QAA8B,EAAE,QAAuC;QACjF,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAQD;;;;OAIG;IACH,QAAQ;QACN,OAAO;YACL,IAAI,IAAI,CAAC,IAAI,GAAG;YAChB,eAAe,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK;YAC7C,eAAe,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO;SAChD,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACf,CAAC;IASD;;;;;;OAMG;IACH,MAAM,CAAC,YAAY,CAAC,QAAkB,EAAE,QAAkB;QACxD,MAAM,EAAE,GAAG,QAAQ,CAAC,SAAS,EAAE,CAAC;QAChC,MAAM,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,SAAS,EAAE,CAAC;QAChD,MAAM,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,SAAS,EAAE,CAAC;QAEpC,OAAO,IAAI,MAAM,CAAC;YAChB,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;YAClB,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;YAClB,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;SACnB,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACH,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC;IACvD,CAAC;CACF"}

package/dist/coordinate/StateVector.d.ts

@@ -0,0 +1,76 @@
+/**
+ * @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 { ClassicalElements, Kilometers, KilometersPerSecond, Minutes, EpochUTC, Vector3D } from '../main.js';
+/**
+ * A state vector is a set of coordinates used to specify the position and
+ * velocity of an object in a particular reference frame.
+ */
+export declare abstract class StateVector {
+    epoch: EpochUTC;
+    position: Vector3D<Kilometers>;
+    velocity: Vector3D<KilometersPerSecond>;
+    constructor(epoch: EpochUTC, position: Vector3D<Kilometers>, velocity: Vector3D<KilometersPerSecond>);
+    /**
+     * The name of the reference frame in which the state vector is defined.
+     * @returns The name of the reference frame.
+     */
+    abstract get name(): string;
+    /**
+     * Whether the state vector is defined in an inertial reference frame.
+     * @returns True if the state vector is defined in an inertial reference
+     */
+    abstract get inertial(): boolean;
+    /**
+     * Returns a string representation of the StateVector object. The string includes the name, epoch, position, and
+     * velocity.
+     * @returns A string representation of the StateVector object.
+     */
+    toString(): string;
+    /**
+     * Calculates the mechanical energy of the state vector.
+     * @returns The mechanical energy value.
+     */
+    get mechanicalEnergy(): number;
+    /**
+     * Calculates the semimajor axis of the state vector.
+     * @returns The semimajor axis in kilometers.
+     */
+    get semimajorAxis(): Kilometers;
+    /**
+     * Gets the period of the state vector in minutes.
+     * @returns The period in minutes.
+     */
+    get period(): Minutes;
+    /**
+     * Gets the angular rate of the state vector.
+     * @returns The angular rate.
+     */
+    get angularRate(): number;
+    /**
+     * Converts the state vector to classical elements.
+     * @param mu The gravitational parameter of the celestial body. Defaults to Earth's gravitational parameter.
+     * @returns The classical elements corresponding to the state vector.
+     * @throws Error if classical elements are undefined for fixed frames.
+     */
+    toClassicalElements(mu?: number): ClassicalElements;
+}

package/dist/coordinate/StateVector.js

@@ -0,0 +1,97 @@
+/**
+ * @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 { ClassicalElements, TAU, Earth, } from '../main.js';
+/**
+ * A state vector is a set of coordinates used to specify the position and
+ * velocity of an object in a particular reference frame.
+ */
+export class StateVector {
+    epoch;
+    position;
+    velocity;
+    constructor(epoch, position, velocity) {
+        this.epoch = epoch;
+        this.position = position;
+        this.velocity = velocity;
+    }
+    /**
+     * Returns a string representation of the StateVector object. The string includes the name, epoch, position, and
+     * velocity.
+     * @returns A string representation of the StateVector object.
+     */
+    toString() {
+        return [
+            `[${this.name}]`,
+            `  Epoch: ${this.epoch}`,
+            `  Position: ${this.position.toString(6)} km`,
+            `  Velocity: ${this.velocity.toString(9)} km/s`,
+        ].join('\n');
+    }
+    /**
+     * Calculates the mechanical energy of the state vector.
+     * @returns The mechanical energy value.
+     */
+    get mechanicalEnergy() {
+        const r = this.position.magnitude();
+        const v = this.velocity.magnitude();
+        return v * v * 0.5 - Earth.mu / r;
+    }
+    /**
+     * Calculates the semimajor axis of the state vector.
+     * @returns The semimajor axis in kilometers.
+     */
+    get semimajorAxis() {
+        const energy = this.mechanicalEnergy;
+        return (-Earth.mu / (2.0 * energy));
+    }
+    /**
+     * Gets the period of the state vector in minutes.
+     * @returns The period in minutes.
+     */
+    get period() {
+        const a = this.semimajorAxis;
+        const periodSeconds = TAU * Math.sqrt((a * a * a) / Earth.mu);
+        return (periodSeconds / 60.0);
+    }
+    /**
+     * Gets the angular rate of the state vector.
+     * @returns The angular rate.
+     */
+    get angularRate() {
+        const a = this.semimajorAxis;
+        return Math.sqrt(Earth.mu / (a * a * a));
+    }
+    /**
+     * Converts the state vector to classical elements.
+     * @param mu The gravitational parameter of the celestial body. Defaults to Earth's gravitational parameter.
+     * @returns The classical elements corresponding to the state vector.
+     * @throws Error if classical elements are undefined for fixed frames.
+     */
+    toClassicalElements(mu = Earth.mu) {
+        if (!this.inertial) {
+            throw new Error('Classical elements are undefined for fixed frames.');
+        }
+        return ClassicalElements.fromStateVector(this, mu);
+    }
+}
+//# sourceMappingURL=StateVector.js.map

package/dist/coordinate/StateVector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StateVector.js","sourceRoot":"","sources":["../../src/coordinate/StateVector.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,EACL,iBAAiB,EAAE,GAAG,EAAE,KAAK,GAC9B,MAAM,YAAY,CAAC;AAEpB;;;GAGG;AACH,MAAM,OAAgB,WAAW;IAC/B,KAAK,CAAW;IAChB,QAAQ,CAAuB;IAC/B,QAAQ,CAAgC;IACxC,YAAY,KAAe,EAAE,QAA8B,EAAE,QAAuC;QAClG,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAcD;;;;OAIG;IACH,QAAQ;QACN,OAAO;YACL,IAAI,IAAI,CAAC,IAAI,GAAG;YAChB,YAAY,IAAI,CAAC,KAAK,EAAE;YACxB,eAAe,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK;YAC7C,eAAe,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO;SAChD,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACf,CAAC;IAED;;;OAGG;IACH,IAAI,gBAAgB;QAClB,MAAM,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC;QACpC,MAAM,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC;QAEpC,OAAO,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC;IACpC,CAAC;IAED;;;OAGG;IACH,IAAI,aAAa;QACf,MAAM,MAAM,GAAG,IAAI,CAAC,gBAAgB,CAAC;QAErC,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,GAAG,GAAG,MAAM,CAAC,CAAe,CAAC;IACpD,CAAC;IAED;;;OAGG;IACH,IAAI,MAAM;QACR,MAAM,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC;QAC7B,MAAM,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC;QAE9D,OAAO,CAAC,aAAa,GAAG,IAAI,CAAY,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACH,IAAI,WAAW;QACb,MAAM,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC;QAE7B,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,GAAG,KAAK,CAAC,EAAE;QAC/B,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;QACxE,CAAC;QAED,OAAO,iBAAiB,CAAC,eAAe,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACrD,CAAC;CACF"}

package/dist/coordinate/TEME.d.ts

@@ -0,0 +1,57 @@
+/**
+ * @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 type { ClassicalElements } from './ClassicalElements.js';
+import { J2000 } from './J2000.js';
+import { StateVector } from './StateVector.js';
+/**
+ * True Equator Mean Equinox (TEME) is a coordinate system commonly used in satellite tracking and orbit prediction. It
+ * is a reference frame that defines the position and orientation of an object relative to the Earth's equator and
+ * equinox.
+ *
+ * By using the True Equator Mean Equinox (TEME) coordinate system, we can accurately describe the position and motion
+ * of satellites relative to the Earth's equator and equinox. This is particularly useful for tracking and predicting
+ * satellite orbits in various applications, such as satellite communication, navigation, and remote sensing.
+ */
+export declare class TEME extends StateVector {
+    /**
+     * Gets the name of the coordinate system.
+     * @returns The name of the coordinate system.
+     */
+    get name(): string;
+    /**
+     * Gets a value indicating whether the coordinate is inertial.
+     * @returns A boolean value indicating whether the coordinate is inertial.
+     */
+    get inertial(): boolean;
+    /**
+     * Creates a TEME (True Equator Mean Equinox) object from classical orbital elements.
+     * @param elements - The classical orbital elements.
+     * @returns A new TEME object.
+     */
+    static fromClassicalElements(elements: ClassicalElements): TEME;
+    /**
+     * Converts the TEME (True Equator Mean Equinox) coordinates to J2000 coordinates.
+     * @returns The J2000 coordinates.
+     */
+    toJ2000(): J2000;
+}