ootk 4.0.0-7 → 4.0.0-9

package/dist/propagator/Sgp4Propagator.d.ts

@@ -18,17 +18,59 @@ import { EpochUTC, J2000, Tle } from 'ootk-core';
 import { Thrust } from '../force/Thrust';
 import { VerletBlendInterpolator } from '../interpolator/VerletBlendInterpolator';
 import { Propagator } from './Propagator';
+/**
+ * Sgp4Propagator is a propagator that uses the SGP4 model to propagate the state of an object.
+ * This class is useful for propagating multiple states with the same TLE, since it caches the
+ * state of the TLE at different epochs.
+ */
 export declare class Sgp4Propagator extends Propagator {
     private tle;
     constructor(tle: Tle);
     private _cacheState;
     private _checkpoints;
+    /**
+     * Gets the state of the propagator in the J2000 coordinate system.
+     * @returns The J2000 state of the propagator.
+     */
     get state(): J2000;
+    /**
+     * Calculates the ephemeris maneuver using the SGP4 propagator.
+     * @param start The start epoch in UTC.
+     * @param finish The finish epoch in UTC.
+     * @param maneuvers The array of thrust maneuvers.
+     * @param interval The time interval in seconds.
+     */
     ephemerisManeuver(start: EpochUTC, finish: EpochUTC, maneuvers: Thrust[], interval?: number): VerletBlendInterpolator;
+    /**
+     * Performs a maneuver with the given thrust.
+     * @param maneuver - The thrust maneuver to perform.
+     * @param interval - The time interval for the maneuver (default: 60.0 seconds).
+     * @throws Error if maneuvers cannot be modeled with SGP4.
+     */
     maneuver(maneuver: Thrust, interval?: number): J2000[];
+    /**
+     * Propagates the state of the Sgp4Propagator to a specified epoch in J2000 coordinates.
+     * @param epoch - The epoch in UTC format.
+     * @returns The propagated state in J2000 coordinates.
+     */
     propagate(epoch: EpochUTC): J2000;
+    /**
+     * Resets the state of the Sgp4Propagator by updating the cache state
+     * to the current J2000 state of the TLE.
+     */
     reset(): void;
+    /**
+     * Saves the current state of the propagator and returns the index of the checkpoint.
+     * @returns The index of the checkpoint.
+     */
     checkpoint(): number;
+    /**
+     * Clears all the checkpoints in the propagator.
+     */
     clearCheckpoints(): void;
+    /**
+     * Restores the state of the propagator to a previously saved checkpoint.
+     * @param index - The index of the checkpoint to restore.
+     */
     restore(index: number): void;
 }

package/dist/propagator/Sgp4Propagator.js

@@ -15,10 +15,13 @@
  * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
  */
 import { Propagator } from './Propagator';
-// / SGP4 propagator.
+/**
+ * Sgp4Propagator is a propagator that uses the SGP4 model to propagate the state of an object.
+ * This class is useful for propagating multiple states with the same TLE, since it caches the
+ * state of the TLE at different epochs.
+ */
 export class Sgp4Propagator extends Propagator {
     tle;
-    // / Create a new [Sgp4Propagator] object from a [TLE].
     constructor(tle) {
         super();
         this.tle = tle;
@@ -26,29 +29,66 @@ export class Sgp4Propagator extends Propagator {
     }
     _cacheState;
     _checkpoints = [];
+    /**
+     * Gets the state of the propagator in the J2000 coordinate system.
+     * @returns The J2000 state of the propagator.
+     */
     get state() {
         return this._cacheState;
     }
+    /**
+     * Calculates the ephemeris maneuver using the SGP4 propagator.
+     * @param start The start epoch in UTC.
+     * @param finish The finish epoch in UTC.
+     * @param maneuvers The array of thrust maneuvers.
+     * @param interval The time interval in seconds.
+     */
     ephemerisManeuver(start, finish, maneuvers, interval = 60.0) {
         throw new Error('Maneuvers cannot be modelled with SGP4.');
     }
+    /**
+     * Performs a maneuver with the given thrust.
+     * @param maneuver - The thrust maneuver to perform.
+     * @param interval - The time interval for the maneuver (default: 60.0 seconds).
+     * @throws Error if maneuvers cannot be modeled with SGP4.
+     */
     maneuver(maneuver, interval = 60.0) {
         throw new Error('Maneuvers cannot be modelled with SGP4.');
     }
+    /**
+     * Propagates the state of the Sgp4Propagator to a specified epoch in J2000 coordinates.
+     * @param epoch - The epoch in UTC format.
+     * @returns The propagated state in J2000 coordinates.
+     */
     propagate(epoch) {
         this._cacheState = this.tle.propagate(epoch).toJ2000();
         return this._cacheState;
     }
+    /**
+     * Resets the state of the Sgp4Propagator by updating the cache state
+     * to the current J2000 state of the TLE.
+     */
     reset() {
         this._cacheState = this.tle.state.toJ2000();
     }
+    /**
+     * Saves the current state of the propagator and returns the index of the checkpoint.
+     * @returns The index of the checkpoint.
+     */
     checkpoint() {
         this._checkpoints.push(this._cacheState);
         return this._checkpoints.length - 1;
     }
+    /**
+     * Clears all the checkpoints in the propagator.
+     */
     clearCheckpoints() {
         this._checkpoints = [];
     }
+    /**
+     * Restores the state of the propagator to a previously saved checkpoint.
+     * @param index - The index of the checkpoint to restore.
+     */
     restore(index) {
         this._cacheState = this._checkpoints[index];
     }

package/dist/propagator/Sgp4Propagator.js.map

@@ -1 +1 @@
-{"version":3,"file":"Sgp4Propagator.js","sourceRoot":"","sources":["../../src/propagator/Sgp4Propagator.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAOH,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,qBAAqB;AACrB,MAAM,OAAO,cAAe,SAAQ,UAAU;IAExB;IADpB,uDAAuD;IACvD,YAAoB,GAAQ;QAC1B,KAAK,EAAE,CAAC;QADU,QAAG,GAAH,GAAG,CAAK;QAE1B,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;IACzC,CAAC;IAEO,WAAW,CAAQ;IACnB,YAAY,GAAY,EAAE,CAAC;IAEnC,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,iBAAiB,CAAC,KAAe,EAAE,MAAgB,EAAE,SAAmB,EAAE,QAAQ,GAAG,IAAI;QACvF,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;IAC7D,CAAC;IAED,QAAQ,CAAC,QAAgB,EAAE,QAAQ,GAAG,IAAI;QACxC,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;IAC7D,CAAC;IAED,SAAS,CAAC,KAAe;QACvB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC;QAEvD,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,KAAK;QACH,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;IAC9C,CAAC;IAED,UAAU;QACR,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAEzC,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC;IACtC,CAAC;IAED,gBAAgB;QACd,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC;IACzB,CAAC;IAED,OAAO,CAAC,KAAa;QACnB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;IAC9C,CAAC;CACF"}
+{"version":3,"file":"Sgp4Propagator.js","sourceRoot":"","sources":["../../src/propagator/Sgp4Propagator.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAOH,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;;;GAIG;AACH,MAAM,OAAO,cAAe,SAAQ,UAAU;IACxB;IAApB,YAAoB,GAAQ;QAC1B,KAAK,EAAE,CAAC;QADU,QAAG,GAAH,GAAG,CAAK;QAE1B,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;IACzC,CAAC;IAEO,WAAW,CAAQ;IACnB,YAAY,GAAY,EAAE,CAAC;IAEnC;;;OAGG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;;;;;;OAMG;IACH,iBAAiB,CAAC,KAAe,EAAE,MAAgB,EAAE,SAAmB,EAAE,QAAQ,GAAG,IAAI;QACvF,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAC,QAAgB,EAAE,QAAQ,GAAG,IAAI;QACxC,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,KAAe;QACvB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC;QAEvD,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACH,KAAK;QACH,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;IAC9C,CAAC;IAED;;;OAGG;IACH,UAAU;QACR,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAEzC,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC;IACtC,CAAC;IAED;;OAEG;IACH,gBAAgB;QACd,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC;IACzB,CAAC;IAED;;;OAGG;IACH,OAAO,CAAC,KAAa;QACnB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;IAC9C,CAAC;CACF"}

package/dist/propagator/index.d.ts

@@ -0,0 +1,3 @@
+export { RungeKutta4Propagator } from './RungeKutta4Propagator';
+export { RungeKutta89Propagator } from './RungeKutta89Propagator';
+export { Sgp4Propagator } from './Sgp4Propagator';

package/dist/propagator/index.js

@@ -0,0 +1,4 @@
+export { RungeKutta4Propagator } from './RungeKutta4Propagator';
+export { RungeKutta89Propagator } from './RungeKutta89Propagator';
+export { Sgp4Propagator } from './Sgp4Propagator';
+//# sourceMappingURL=index.js.map

package/dist/propagator/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/propagator/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC"}

package/dist/transforms/transforms.js

@@ -48,7 +48,7 @@ export function rae2raeOffBoresight(rae, sensor, maxSensorAz) {
  */
 export function rae2ruv(rae, sensor, maxSensorAz) {
     const { az, el } = rae2raeOffBoresight(rae, sensor, maxSensorAz);
-    const { u, v } = azel2uv(az, el, sensor.coneHalfAngleRad);
+    const { u, v } = azel2uv(az, el, sensor.beamwidthRad);
     return { rng: rae.rng, u, v };
 }
 /**

package/dist/transforms/transforms.js.map

@@ -1 +1 @@
-{"version":3,"file":"transforms.js","sourceRoot":"","sources":["../../src/transforms/transforms.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAoB,OAAO,EAAoB,GAAG,EAAE,MAAM,WAAW,CAAC;AAGtF;;;;;;;;;GASG;AACH,MAAM,UAAU,OAAO,CAAC,EAAW,EAAE,EAAW,EAAE,aAAsB;IACtE,IAAI,EAAE,GAAG,aAAa,IAAI,EAAE,GAAG,aAAa,EAAE;QAC5C,MAAM,IAAI,UAAU,CAAC,6BAA6B,EAAE,EAAE,CAAC,CAAC;KACzD;IAED,IAAI,EAAE,GAAG,aAAa,IAAI,EAAE,GAAG,aAAa,EAAE;QAC5C,MAAM,IAAI,UAAU,CAAC,+BAA+B,EAAE,EAAE,CAAC,CAAC;KAC3D;IAED,MAAM,KAAK,GAAG,CAAC,EAAE,GAAG,CAAC,aAAa,GAAG,OAAO,CAAC,CAAC,GAAG,EAAE,CAAC;IACpD,MAAM,IAAI,GAAG,CAAC,EAAE,GAAG,CAAC,aAAa,GAAG,OAAO,CAAC,CAAC,GAAG,EAAE,CAAC;IAEnD,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAY,CAAC;IACrC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAY,CAAC;IAEnC,CAAC,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,CAAa,CAAC,CAAC,CAAC,CAAC,CAAC;IAE1C,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;AAClB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CACjC,GAAY,EACZ,MAAgB,EAChB,WAAoB;IAEpB,IAAI,EAAE,GAAG,CAAC,GAAG,CAAC,EAAE,GAAG,OAAO,CAAY,CAAC;IACvC,IAAI,EAAE,GAAG,CAAC,GAAG,CAAC,EAAE,GAAG,OAAO,CAAY,CAAC;IAEvC,0CAA0C;IAC1C,EAAE,GAAG,EAAE,GAAG,WAAW,GAAG,OAAO,CAAC,CAAC,CAAE,CAAC,EAAE,GAAG,GAAG,CAAa,CAAC,CAAC,CAAC,EAAE,CAAC;IAE/D,EAAE,GAAG,CAAC,EAAE,GAAG,MAAM,CAAC,WAAW,CAAY,CAAC;IAC1C,EAAE,GAAG,CAAC,EAAE,GAAG,MAAM,CAAC,WAAW,CAAY,CAAC;IAE1C,OAAO,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC;AACpB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,OAAO,CAAC,GAAY,EAAE,MAAgB,EAAE,WAAoB;IAC1E,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,GAAG,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IACjE,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,gBAAgB,CAAC,CAAC;IAE1D,OAAO,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;AAChC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,OAAO,CAAC,CAAS,EAAE,CAAS,EAAE,aAAsB;IAClE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE;QACnB,MAAM,IAAI,UAAU,CAAC,uBAAuB,CAAC,EAAE,CAAC,CAAC;KAClD;IAED,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE;QACnB,MAAM,IAAI,UAAU,CAAC,uBAAuB,CAAC,EAAE,CAAC,CAAC;KAClD;IAED,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAY,CAAC;IACtC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAY,CAAC;IACrC,MAAM,EAAE,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC,GAAG,CAAC,aAAa,GAAG,OAAO,CAAC,CAAY,CAAC;IACjE,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,GAAG,EAAE,CAAC,GAAG,CAAC,aAAa,GAAG,OAAO,CAAC,CAAY,CAAC;IAEhE,OAAO,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC;AACpB,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,MAAM,CAA+C,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAc,EAAE,EAAK,EAAE,EAAK;IACxG,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IACjG,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IACjG,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IAEjD,OAAO;QACL,CAAC,EAAE,GAAQ;QACX,CAAC,EAAE,GAAQ;QACX,CAAC,EAAE,GAAQ;KACZ,CAAC;AACJ,CAAC"}
+{"version":3,"file":"transforms.js","sourceRoot":"","sources":["../../src/transforms/transforms.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAoB,OAAO,EAAoB,GAAG,EAAE,MAAM,WAAW,CAAC;AAGtF;;;;;;;;;GASG;AACH,MAAM,UAAU,OAAO,CAAC,EAAW,EAAE,EAAW,EAAE,aAAsB;IACtE,IAAI,EAAE,GAAG,aAAa,IAAI,EAAE,GAAG,aAAa,EAAE;QAC5C,MAAM,IAAI,UAAU,CAAC,6BAA6B,EAAE,EAAE,CAAC,CAAC;KACzD;IAED,IAAI,EAAE,GAAG,aAAa,IAAI,EAAE,GAAG,aAAa,EAAE;QAC5C,MAAM,IAAI,UAAU,CAAC,+BAA+B,EAAE,EAAE,CAAC,CAAC;KAC3D;IAED,MAAM,KAAK,GAAG,CAAC,EAAE,GAAG,CAAC,aAAa,GAAG,OAAO,CAAC,CAAC,GAAG,EAAE,CAAC;IACpD,MAAM,IAAI,GAAG,CAAC,EAAE,GAAG,CAAC,aAAa,GAAG,OAAO,CAAC,CAAC,GAAG,EAAE,CAAC;IAEnD,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAY,CAAC;IACrC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAY,CAAC;IAEnC,CAAC,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,CAAa,CAAC,CAAC,CAAC,CAAC,CAAC;IAE1C,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;AAClB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CACjC,GAAY,EACZ,MAAgB,EAChB,WAAoB;IAEpB,IAAI,EAAE,GAAG,CAAC,GAAG,CAAC,EAAE,GAAG,OAAO,CAAY,CAAC;IACvC,IAAI,EAAE,GAAG,CAAC,GAAG,CAAC,EAAE,GAAG,OAAO,CAAY,CAAC;IAEvC,0CAA0C;IAC1C,EAAE,GAAG,EAAE,GAAG,WAAW,GAAG,OAAO,CAAC,CAAC,CAAE,CAAC,EAAE,GAAG,GAAG,CAAa,CAAC,CAAC,CAAC,EAAE,CAAC;IAE/D,EAAE,GAAG,CAAC,EAAE,GAAG,MAAM,CAAC,WAAW,CAAY,CAAC;IAC1C,EAAE,GAAG,CAAC,EAAE,GAAG,MAAM,CAAC,WAAW,CAAY,CAAC;IAE1C,OAAO,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC;AACpB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,OAAO,CAAC,GAAY,EAAE,MAAgB,EAAE,WAAoB;IAC1E,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,GAAG,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IACjE,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC;IAEtD,OAAO,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;AAChC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,OAAO,CAAC,CAAS,EAAE,CAAS,EAAE,aAAsB;IAClE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE;QACnB,MAAM,IAAI,UAAU,CAAC,uBAAuB,CAAC,EAAE,CAAC,CAAC;KAClD;IAED,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE;QACnB,MAAM,IAAI,UAAU,CAAC,uBAAuB,CAAC,EAAE,CAAC,CAAC;KAClD;IAED,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAY,CAAC;IACtC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAY,CAAC;IACrC,MAAM,EAAE,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC,GAAG,CAAC,aAAa,GAAG,OAAO,CAAC,CAAY,CAAC;IACjE,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,GAAG,EAAE,CAAC,GAAG,CAAC,aAAa,GAAG,OAAO,CAAC,CAAY,CAAC;IAEhE,OAAO,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC;AACpB,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,MAAM,CAA+C,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAc,EAAE,EAAK,EAAE,EAAK;IACxG,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IACjG,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IACjG,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IAEjD,OAAO;QACL,CAAC,EAAE,GAAQ;QACX,CAAC,EAAE,GAAQ;QACX,CAAC,EAAE,GAAQ;KACZ,CAAC;AACJ,CAAC"}

package/dist/types/types.d.ts

@@ -14,7 +14,8 @@
  * 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 { Degrees, Kilometers, Milliseconds, SatelliteParams, Vec3 } from 'ootk-core';
+import { Kilometers, Milliseconds, SatelliteParams, Vec3 } from 'ootk-core';
+import { CommLink } from '../main';
 export declare enum ZoomValue {
     LEO = 0.45,
     GEO = 0.82,
@@ -46,8 +47,8 @@ export interface DetailedSatelliteParams extends SatelliteParams {
     shape?: string;
     span?: string;
     user?: string;
-    vmag?: number;
-    rcs?: number;
+    vmag?: number | null;
+    rcs?: number | null;
     source?: string;
     altId?: string;
     altName?: string;
@@ -57,14 +58,8 @@ export interface DetailedSensorParams {
     country?: string;
     /** 3 Letter Designation */
     shortName?: string;
-    /** For radars, this is the width of the beam */
-    beamwidth?: Degrees;
     changeObjectInterval?: Milliseconds;
-    linkAehf?: boolean;
-    linkGalileo?: boolean;
-    linkIridium?: boolean;
-    linkStarlink?: boolean;
-    linkWgs?: boolean;
+    commLinks?: CommLink[];
     static?: boolean;
     sensorId?: number;
     url?: string;
@@ -72,8 +67,6 @@ export interface DetailedSensorParams {
     volume?: boolean;
     /** How far away should we zoom when selecting this sensor? */
     zoom: ZoomValue;
-    /** For radar sensors, what frequency does this sensor operate in? */
-    band?: string;
     /** This is the name of the object in the array */
     objName?: string;
     /** This is the name of the object in the UI */

package/dist/types/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAIH,MAAM,CAAN,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,0CAAU,CAAA;IACV,0CAAU,CAAA;IACV,uCAAO,CAAA;AACT,CAAC,EAJW,SAAS,KAAT,SAAS,QAIpB"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAKH,MAAM,CAAN,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,0CAAU,CAAA;IACV,0CAAU,CAAA;IACV,uCAAO,CAAA;AACT,CAAC,EAJW,SAAS,KAAT,SAAS,QAIpB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ootk",
-  "version": "4.0.0-7",
+  "version": "4.0.0-9",
   "type": "module",
   "module": "dist/main.js",
   "description": "Orbital Object Toolkit including Multiple Propagators, Initial Orbit Determination, and Maneuver Calculations.",
@@ -42,7 +42,6 @@
     "@typescript-eslint/eslint-plugin": "^6.18.1",
     "@typescript-eslint/parser": "^6.18.1",
     "auto-changelog": "^2.4.0",
-    "auto-changelog-thkruz": "^1.0.0",
     "babel-eslint": "^10.1.0",
     "babel-jest": "^29.7.0",
     "babel-loader": "^9.1.3",
@@ -53,7 +52,7 @@
     "typescript": "^4.9.5"
   },
   "dependencies": {
-    "ootk-core": "^1.1.0"
+    "ootk-core": "^1.1.2"
   },
   "homepage": "https://github.com/thkruz/ootk"
 }

package/src/enums/CommLink.ts

@@ -0,0 +1,7 @@
+export enum CommLink {
+  AEHF = 'AEHF',
+  GALILEO = 'Galileo',
+  IRIDIUM = 'Iridium',
+  STARLINK = 'Starlink',
+  WGS = 'WGS'
+}

package/src/enums/index.ts

@@ -1 +1,2 @@
 export { CatalogSource } from './CatalogSource';
+export { CommLink } from './CommLink';

package/src/force/EarthGravity.ts

@@ -21,12 +21,37 @@ import { DataHandler, Earth, ITRF, J2000, Kilometers, KilometersPerSecond, Vecto
 
 import { Force } from './Force';
 
-// / tesseral geopotential perturbations.
+/**
+ * designed to model the Earth's gravitational field, which is not uniformly distributed due to variations in mass
+ * distribution within the Earth and the Earth's shape (it's not a perfect sphere). To accurately model this complex
+ * field, the gravity model is expanded into a series of spherical harmonics, characterized by their degree and order.
+ *
+ * This `degree` parameter is related to the spatial resolution of the gravity model. A higher degree corresponds to a
+ * finer resolution, capable of representing smaller-scale variations in the gravity field. The degree essentially
+ * denotes how many times the gravitational potential function varies over the surface of the Earth.
+ *
+ * For each degree, there can be multiple orders ranging from 0 up to the degree. The `order` accounts for the
+ * longitudinal variation in the gravity field. Each order within a degree captures different characteristics of the
+ * gravity anomalies.
+ *
+ * `Degree 0` corresponds to the overall, mean gravitational force of the Earth (considered as a point mass).
+ *
+ * `Degree 1` terms are related to the Earth's center of mass but are usually not used because the center of mass is
+ * defined as the origin of the coordinate system.
+ *
+ * `Degree 2` and higher capture the deviations from this spherical symmetry, such as the flattening at the poles and
+ * bulging at the equator (degree 2), and other anomalies at finer scales as the degree increases.
+ */
 export class EarthGravity implements Force {
   degree: number;
   order: number;
   _asphericalFlag: boolean;
 
+  /**
+   * Creates a new instance of the EarthGravity class.
+   * @param degree The degree of the Earth's gravity field. Must be between 0 and 36.
+   * @param order The order of the Earth's gravity field. Must be between 0 and 36.
+   */
   constructor(degree: number, order: number) {
     this.degree = Math.min(Math.max(degree, 0), 36);
     this.order = Math.min(Math.max(order, 0), 36);

package/src/force/ForceModel.ts

@@ -51,6 +51,14 @@ export class ForceModel {
     this._solarRadiationPressure = new SolarRadiationPressure(mass, area, coeff);
   }
 
+  /**
+   * Sets the atmospheric drag for the force model.
+   * @deprecated This is still a work in progress!
+   * @param mass - The mass of the object.
+   * @param area - The cross-sectional area of the object.
+   * @param coeff - The drag coefficient. Default value is 2.2.
+   * @param cosine - The cosine of the angle between the object's velocity vector and the drag force vector.
+   */
   setAtmosphericDrag(mass: number, area: number, coeff = 2.2, cosine = 4): void {
     this._atmosphericDrag = new AtmosphericDrag(mass, area, coeff, cosine);
   }

package/src/force/index.ts

@@ -0,0 +1 @@
+export { ForceModel } from './ForceModel';

package/src/interfaces/RfSensorParams.ts

@@ -24,7 +24,10 @@
 import { Degrees, SensorParams } from 'ootk-core';
 
 export interface RfSensorParams extends SensorParams {
-  coneHalfAngle: Degrees;
   boresightAz: Degrees;
   boresightEl: Degrees;
+  /** For radars, this is the width of the beam */
+  beamwidth: Degrees;
+  /** For radar sensors, what frequency does this sensor operate in? */
+  freqBand?: string;
 }

package/src/main.ts

@@ -27,5 +27,7 @@ export * from './interfaces';
 export * from './coordinate';
 export * from './objects';
 export * from './operations';
+export * from './force';
+export * from './propagator';
 export * from './transforms';
 export * from './utils';

package/src/objects/DetailedSatellite.ts

@@ -56,8 +56,8 @@ export class DetailedSatellite extends Satellite {
   span: string = '';
   user: string = '';
   source: string = '';
-  vmag: number;
-  rcs: number;
+  vmag: number|null;
+  rcs: number|null;
   altId: string = '';
   altName: string = '';
 
@@ -76,8 +76,8 @@ export class DetailedSatellite extends Satellite {
     this.length = info.length ?? '';
     this.diameter = info.diameter ?? '';
     this.source = info.source ?? '';
-    this.vmag = info.vmag ?? 0;
-    this.rcs = info.rcs ?? 0;
+    this.vmag = info.vmag ?? null;
+    this.rcs = info.rcs ?? null;
     this.altId = info.altId ?? '';
     this.altName = info.altName ?? '';
     this.initOperationDetails_(info);
@@ -179,4 +179,8 @@ export class DetailedSatellite extends Satellite {
       dryMass: this.dryMass,
     };
   }
+
+  clone(): DetailedSatellite {
+    return new DetailedSatellite(this);
+  }
 }

package/src/objects/DetailedSensor.ts

@@ -15,54 +15,43 @@
  * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
  */
 
-import { BaseObjectParams, Degrees, Milliseconds, Radians, Sensor, SensorParams } from 'ootk-core';
+import { BaseObjectParams, Milliseconds, Sensor, SensorParams } from 'ootk-core';
 import { DetailedSensorParams, ZoomValue } from '../types/types';
+import { CommLink } from '../enums/CommLink';
 
 export class DetailedSensor extends Sensor {
-  country?: string;
-  latRad: Radians;
-  lonRad: Radians;
-  shortName?: string;
-  beamwidth?: Degrees;
-  changeObjectInterval?: Milliseconds;
-  linkAehf?: boolean;
-  linkGalileo?: boolean;
-  linkIridium?: boolean;
-  linkStarlink?: boolean;
-  linkWgs?: boolean;
-  static?: boolean;
   sensorId?: number;
-  url?: string;
-  volume?: boolean;
-  zoom: ZoomValue;
-  band?: string;
   objName?: string;
+  shortName?: string;
   uiName?: string;
+  country?: string;
+  dwellTime?: Milliseconds;
+  commLinks: CommLink[];
+  /** Is this sensor volumetric? */
+  isVolumetric?: boolean;
+  /** The ideal zoom to see the sensor's full FOV */
+  zoom: ZoomValue | number;
   system?: string;
   operator?: string;
+  url?: string;
 
   constructor(info: DetailedSensorParams & SensorParams & BaseObjectParams) {
     super(info);
+    this.commLinks = info.commLinks ?? [];
     this.country = info.country;
-    this.latRad = (info.lat * (Math.PI / 180)) as Radians;
-    this.lonRad = (info.lon * (Math.PI / 180)) as Radians;
-    this.shortName = info.shortName;
-    this.beamwidth = info.beamwidth;
-    this.changeObjectInterval = info.changeObjectInterval;
-    this.linkAehf = info.linkAehf;
-    this.linkGalileo = info.linkGalileo;
-    this.linkIridium = info.linkIridium;
-    this.linkStarlink = info.linkStarlink;
-    this.linkWgs = info.linkWgs;
-    this.static = info.static;
+    this.dwellTime = info.changeObjectInterval;
+    this.isVolumetric = info.volume;
+    this.objName = info.objName;
+    this.operator = info.operator;
     this.sensorId = info.sensorId;
+    this.shortName = info.shortName;
+    this.system = info.system;
+    this.uiName = info.uiName;
     this.url = info.url;
-    this.volume = info.volume;
     this.zoom = info.zoom;
-    this.band = info.band;
-    this.objName = info.objName;
-    this.uiName = info.uiName;
-    this.system = info.system;
-    this.operator = info.operator;
+  }
+
+  isStatic(): boolean {
+    return true;
   }
 }

package/src/objects/RfSensor.ts

@@ -25,9 +25,10 @@ import { DEG2RAD, Degrees, RAD2DEG, Radians, Sensor, SpaceObjectType } from 'oot
 import { azel2uv, uv2azel, RfSensorParams } from '../main';
 
 export class RfSensor extends Sensor {
-  coneHalfAngle: Degrees;
   boresightAz: Degrees;
   boresightEl: Degrees;
+  freqBand?: string;
+  beamwidth: Degrees;
 
   constructor(info: RfSensorParams) {
     super(info);
@@ -41,9 +42,10 @@ export class RfSensor extends Sensor {
         throw new Error('Invalid sensor type');
     }
 
-    this.coneHalfAngle = info.coneHalfAngle;
     this.boresightAz = info.boresightAz;
     this.boresightEl = info.boresightEl;
+    this.beamwidth = info.beamwidth;
+    this.freqBand = info.freqBand;
   }
 
   uvFromAzEl(az: Degrees, el: Degrees) {
@@ -52,11 +54,11 @@ export class RfSensor extends Sensor {
     const azDiff = (azRad - this.boresightAzRad) as Radians;
     const elDiff = (elRad - this.boresightElRad) as Radians;
 
-    return azel2uv(azDiff, elDiff, this.coneHalfAngleRad);
+    return azel2uv(azDiff, elDiff, this.beamwidthRad);
   }
 
   azElFromUV(u: number, v: number) {
-    const { az, el } = uv2azel(u, v, this.coneHalfAngleRad);
+    const { az, el } = uv2azel(u, v, this.beamwidthRad);
 
     return {
       az: ((az + this.boresightAz) * RAD2DEG) as Degrees,
@@ -72,7 +74,7 @@ export class RfSensor extends Sensor {
     return (this.boresightEl * DEG2RAD) as Radians;
   }
 
-  get coneHalfAngleRad() {
-    return (this.coneHalfAngle * DEG2RAD) as Radians;
+  get beamwidthRad() {
+    return (this.beamwidth * DEG2RAD) as Radians;
   }
 }

package/src/orbit_determination/BatchLeastSquaresOD.ts

@@ -29,13 +29,13 @@ import { BatchLeastSquaresResult } from './BatchLeastSquaresResult';
  * Batch least squares orbit determination.
  */
 export class BatchLeastSquaresOD {
-  // / Propagator pair cache, for generating observation Jacobians.
+  /** Propagator pair cache, for generating observation Jacobians. */
   private propPairs_: PropagatorPairs;
-  // / Nominal state propagator.
+  /**  Nominal state propagator. */
   private propagator_: Propagator;
-  // / State estimate during solve.
+  /**  State estimate during solve. */
   private nominal_: J2000;
-  // / Solve start epoch.
+  /**  Solve start epoch. */
   private start_: EpochUTC;
 
   /**

package/src/propagator/Sgp4Propagator.ts

@@ -22,9 +22,12 @@ import { Thrust } from '../force/Thrust';
 import { VerletBlendInterpolator } from '../interpolator/VerletBlendInterpolator';
 import { Propagator } from './Propagator';
 
-// / SGP4 propagator.
+/**
+ * Sgp4Propagator is a propagator that uses the SGP4 model to propagate the state of an object.
+ * This class is useful for propagating multiple states with the same TLE, since it caches the
+ * state of the TLE at different epochs.
+ */
 export class Sgp4Propagator extends Propagator {
-  // / Create a new [Sgp4Propagator] object from a [TLE].
   constructor(private tle: Tle) {
     super();
     this._cacheState = tle.state.toJ2000();
@@ -33,38 +36,75 @@ export class Sgp4Propagator extends Propagator {
   private _cacheState: J2000;
   private _checkpoints: J2000[] = [];
 
+  /**
+   * Gets the state of the propagator in the J2000 coordinate system.
+   * @returns The J2000 state of the propagator.
+   */
   get state(): J2000 {
     return this._cacheState;
   }
 
+  /**
+   * Calculates the ephemeris maneuver using the SGP4 propagator.
+   * @param start The start epoch in UTC.
+   * @param finish The finish epoch in UTC.
+   * @param maneuvers The array of thrust maneuvers.
+   * @param interval The time interval in seconds.
+   */
   ephemerisManeuver(start: EpochUTC, finish: EpochUTC, maneuvers: Thrust[], interval = 60.0): VerletBlendInterpolator {
     throw new Error('Maneuvers cannot be modelled with SGP4.');
   }
 
+  /**
+   * Performs a maneuver with the given thrust.
+   * @param maneuver - The thrust maneuver to perform.
+   * @param interval - The time interval for the maneuver (default: 60.0 seconds).
+   * @throws Error if maneuvers cannot be modeled with SGP4.
+   */
   maneuver(maneuver: Thrust, interval = 60.0): J2000[] {
     throw new Error('Maneuvers cannot be modelled with SGP4.');
   }
 
+  /**
+   * Propagates the state of the Sgp4Propagator to a specified epoch in J2000 coordinates.
+   * @param epoch - The epoch in UTC format.
+   * @returns The propagated state in J2000 coordinates.
+   */
   propagate(epoch: EpochUTC): J2000 {
     this._cacheState = this.tle.propagate(epoch).toJ2000();
 
     return this._cacheState;
   }
 
+  /**
+   * Resets the state of the Sgp4Propagator by updating the cache state
+   * to the current J2000 state of the TLE.
+   */
   reset(): void {
     this._cacheState = this.tle.state.toJ2000();
   }
 
+  /**
+   * Saves the current state of the propagator and returns the index of the checkpoint.
+   * @returns The index of the checkpoint.
+   */
   checkpoint(): number {
     this._checkpoints.push(this._cacheState);
 
     return this._checkpoints.length - 1;
   }
 
+  /**
+   * Clears all the checkpoints in the propagator.
+   */
   clearCheckpoints(): void {
     this._checkpoints = [];
   }
 
+  /**
+   * Restores the state of the propagator to a previously saved checkpoint.
+   * @param index - The index of the checkpoint to restore.
+   */
   restore(index: number): void {
     this._cacheState = this._checkpoints[index];
   }

package/src/propagator/index.ts

@@ -0,0 +1,3 @@
+export { RungeKutta4Propagator } from './RungeKutta4Propagator';
+export { RungeKutta89Propagator } from './RungeKutta89Propagator';
+export { Sgp4Propagator } from './Sgp4Propagator';

package/src/transforms/transforms.ts

@@ -64,7 +64,7 @@ export function rae2raeOffBoresight(
  */
 export function rae2ruv(rae: RaeVec3, sensor: RfSensor, maxSensorAz: Degrees): RuvVec3 {
   const { az, el } = rae2raeOffBoresight(rae, sensor, maxSensorAz);
-  const { u, v } = azel2uv(az, el, sensor.coneHalfAngleRad);
+  const { u, v } = azel2uv(az, el, sensor.beamwidthRad);
 
   return { rng: rae.rng, u, v };
 }