ootk 4.0.0-8 → 4.0.0

package/src/operations/index.ts

@@ -1,4 +1,4 @@
-export { BoxMuller } from './BoxMuller';
-export { EulerAngles } from './EulerAngles';
-export { Quaternion } from './Quaternion';
-export { RandomGaussianSource } from './RandomGaussianSource';
+export { BoxMuller } from './BoxMuller.js';
+export { EulerAngles } from './EulerAngles.js';
+export { Quaternion } from './Quaternion.js';
+export { RandomGaussianSource } from './RandomGaussianSource.js';

package/src/optimize/ChebyshevCompressor.ts

@@ -16,9 +16,9 @@
  */
 
 import { EpochUTC, Seconds, Vector3D } from 'ootk-core';
-import { StateInterpolator } from '../interpolator/StateInterpolator';
-import { ChebyshevCoefficients } from './../interpolator/ChebyshevCoefficients';
-import { ChebyshevInterpolator } from './../interpolator/ChebyshevInterpolator';
+import { StateInterpolator } from '../interpolator/StateInterpolator.js';
+import { ChebyshevCoefficients } from './../interpolator/ChebyshevCoefficients.js';
+import { ChebyshevInterpolator } from './../interpolator/ChebyshevInterpolator.js';
 
 // / Ephemeris compressor.
 export class ChebyshevCompressor {

package/src/optimize/DownhillSimplex.ts

@@ -15,7 +15,7 @@
  * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
  */
 
-import { CostFunction, SimplexEntry } from './SimplexEntry';
+import { CostFunction, SimplexEntry } from './SimplexEntry.js';
 
 // / Derivative-free Nelder-Mead simplex optimizer.
 export class DownhillSimplex {

package/src/optimize/GoldenSection.ts

@@ -15,7 +15,7 @@
  * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
  */
 
-import { DifferentiableFunction } from '../main';
+import { DifferentiableFunction } from '../main.js';
 
 // / Golden Section bounded single value optimizer.
 export class GoldenSection {

package/src/optimize/PolynomialRegression.ts

@@ -18,8 +18,8 @@
 /* eslint-disable require-jsdoc */
 /* eslint-disable func-style */
 import { evalPoly } from 'ootk-core';
-import { DownhillSimplex } from './DownhillSimplex';
-import { PolynomicalRegressionResult } from './PolynomicalRegressionResult';
+import { DownhillSimplex } from './DownhillSimplex.js';
+import { PolynomicalRegressionResult } from './PolynomicalRegressionResult.js';
 // / Polynomial regression optimizer.
 export class PolynomialRegression {
   private constructor() {

package/src/orbit_determination/BatchLeastSquaresOD.ts

@@ -16,26 +16,26 @@
  */
 
 import { concat, EpochUTC, J2000, Kilometers, KilometersPerSecond, Matrix, Vector, Vector3D } from 'ootk-core';
-import { Observation } from '../observation/Observation';
-import { PropagatorPairs } from '../observation/PropagatorPairs';
-import { Propagator } from '../propagator/Propagator';
-import { CovarianceFrame, StateCovariance } from './../covariance/StateCovariance';
-import { ForceModel } from './../force/ForceModel';
-import { KeplerPropagator } from './../propagator/KeplerPropagator';
-import { RungeKutta89Propagator } from './../propagator/RungeKutta89Propagator';
-import { BatchLeastSquaresResult } from './BatchLeastSquaresResult';
+import { Observation } from '../observation/Observation.js';
+import { PropagatorPairs } from '../observation/PropagatorPairs.js';
+import { Propagator } from '../propagator/Propagator.js';
+import { CovarianceFrame, StateCovariance } from './../covariance/StateCovariance.js';
+import { ForceModel } from './../force/ForceModel.js';
+import { KeplerPropagator } from './../propagator/KeplerPropagator.js';
+import { RungeKutta89Propagator } from './../propagator/RungeKutta89Propagator.js';
+import { BatchLeastSquaresResult } from './BatchLeastSquaresResult.js';
 
 /**
  * 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/orbit_determination/BatchLeastSquaresResult.ts

@@ -16,7 +16,7 @@
  */
 
 import { J2000 } from 'ootk-core';
-import { StateCovariance } from './../covariance/StateCovariance';
+import { StateCovariance } from './../covariance/StateCovariance.js';
 
 // / Batch least squares orbit determination result.
 export class BatchLeastSquaresResult {

package/src/orbit_determination/GibbsIOD.ts

@@ -16,8 +16,8 @@
  */
 
 import { DEG2RAD, Earth, EpochUTC, halfPi, J2000, Kilometers, KilometersPerSecond, Radians, Vector3D } from 'ootk-core';
-import { ForceModel } from './../force/ForceModel';
-import { RungeKutta89Propagator } from './../propagator/RungeKutta89Propagator';
+import { ForceModel } from './../force/ForceModel.js';
+import { RungeKutta89Propagator } from './../propagator/RungeKutta89Propagator.js';
 
 /**
  * Gibbs 3-position inital orbit determination.

package/src/orbit_determination/GoodingIOD.ts

@@ -16,11 +16,11 @@
  */
 
 import { Earth, J2000, Kilometers, KilometersPerSecond, Seconds, TAU, Vector3D } from 'ootk-core';
-import { ForceModel } from '../force/ForceModel';
-import { RungeKutta89Propagator } from '../propagator/RungeKutta89Propagator';
-import { ObservationOptical } from './../observation/ObservationOptical';
-import { GibbsIOD } from './GibbsIOD';
-import { LambertIOD } from './LambertIOD';
+import { ForceModel } from '../force/ForceModel.js';
+import { RungeKutta89Propagator } from '../propagator/RungeKutta89Propagator.js';
+import { ObservationOptical } from './../observation/ObservationOptical.js';
+import { GibbsIOD } from './GibbsIOD.js';
+import { LambertIOD } from './LambertIOD.js';
 
 type SolveRangeProblemParams = {
   rho1init: Kilometers;

package/src/orbit_determination/ModifiedGoodingIOD.ts

@@ -16,12 +16,12 @@
  */
 
 import { Earth, EpochUTC, J2000, Kilometers, KilometersPerSecond, RadecTopocentric, Vector3D } from 'ootk-core';
-import { ForceModel } from '../force/ForceModel';
-import { RungeKutta89Propagator } from '../propagator/RungeKutta89Propagator';
-import { ObservationOptical } from './../observation/ObservationOptical';
-import { DownhillSimplex } from './../optimize/DownhillSimplex';
-import { CostFunction } from './../optimize/SimplexEntry';
-import { GoodingIOD } from './GoodingIOD';
+import { ForceModel } from '../force/ForceModel.js';
+import { RungeKutta89Propagator } from '../propagator/RungeKutta89Propagator.js';
+import { ObservationOptical } from './../observation/ObservationOptical.js';
+import { DownhillSimplex } from './../optimize/DownhillSimplex.js';
+import { CostFunction } from './../optimize/SimplexEntry.js';
+import { GoodingIOD } from './GoodingIOD.js';
 
 type SolveOptions = {
   nRev?: number;

package/src/propagator/DormandPrince54Propagator.ts

@@ -16,7 +16,7 @@
  */
 
 /* eslint-disable class-methods-use-this */
-import { RungeKuttaAdaptive } from './RungeKuttaAdaptive';
+import { RungeKuttaAdaptive } from './RungeKuttaAdaptive.js';
 
 export class DormandPrince54Propagator extends RungeKuttaAdaptive {
   private _a: Float64Array = Float64Array.from([0.0, 1.0 / 5.0, 3.0 / 10.0, 4.0 / 5.0, 8.0 / 9.0, 1.0, 1.0]);

package/src/propagator/KeplerPropagator.ts

@@ -16,9 +16,9 @@
  */
 
 import { ClassicalElements, EpochUTC, J2000, Seconds } from 'ootk-core';
-import { Thrust } from '../force/Thrust';
-import { VerletBlendInterpolator } from '../interpolator/VerletBlendInterpolator';
-import { Propagator } from './Propagator';
+import { Thrust } from '../force/Thrust.js';
+import { VerletBlendInterpolator } from '../interpolator/VerletBlendInterpolator.js';
+import { Propagator } from './Propagator.js';
 
 // / Kepler analytical two-body propagator.
 export class KeplerPropagator extends Propagator {

package/src/propagator/Propagator.ts

@@ -16,9 +16,9 @@
  */
 
 import { EpochUTC, J2000, Seconds } from 'ootk-core';
-import { Thrust } from '../force/Thrust';
-import { VerletBlendInterpolator } from '../interpolator/VerletBlendInterpolator';
-import { GoldenSection } from './../optimize/GoldenSection';
+import { Thrust } from '../force/Thrust.js';
+import { VerletBlendInterpolator } from '../interpolator/VerletBlendInterpolator.js';
+import { GoldenSection } from './../optimize/GoldenSection.js';
 
 // Propagator base class.
 export abstract class Propagator {

package/src/propagator/RungeKutta4Propagator.ts

@@ -16,10 +16,10 @@
  */
 
 import { EpochUTC, J2000, Kilometers, KilometersPerSecond, Seconds, Vector, Vector3D } from 'ootk-core';
-import { ForceModel } from '../force/ForceModel';
-import { Thrust } from '../force/Thrust';
-import { VerletBlendInterpolator } from '../interpolator/VerletBlendInterpolator';
-import { Propagator } from './Propagator';
+import { ForceModel } from '../force/ForceModel.js';
+import { Thrust } from '../force/Thrust.js';
+import { VerletBlendInterpolator } from '../interpolator/VerletBlendInterpolator.js';
+import { Propagator } from './Propagator.js';
 
 // / Runge-Kutta 4 fixed numerical propagator.
 export class RungeKutta4Propagator extends Propagator {

package/src/propagator/RungeKutta89Propagator.ts

@@ -17,7 +17,7 @@
 
 /* eslint-disable @typescript-eslint/no-loss-of-precision */
 /* eslint-disable class-methods-use-this */
-import { RungeKuttaAdaptive } from './RungeKuttaAdaptive';
+import { RungeKuttaAdaptive } from './RungeKuttaAdaptive.js';
 
 // / Runge-Kutta 8(9) adaptive numerical propagator.
 export class RungeKutta89Propagator extends RungeKuttaAdaptive {

package/src/propagator/RungeKuttaAdaptive.ts

@@ -16,12 +16,12 @@
  */
 
 import { EpochUTC, J2000, Kilometers, KilometersPerSecond, Seconds, Vector, Vector3D } from 'ootk-core';
-import { ForceModel } from '../force/ForceModel';
-import { Thrust } from '../force/Thrust';
-import { VerletBlendInterpolator } from './../interpolator/VerletBlendInterpolator';
-import { Propagator } from './Propagator';
-import { RkCheckpoint } from './RkCheckpoint';
-import { RkResult } from './RkResult';
+import { ForceModel } from '../force/ForceModel.js';
+import { Thrust } from '../force/Thrust.js';
+import { VerletBlendInterpolator } from './../interpolator/VerletBlendInterpolator.js';
+import { Propagator } from './Propagator.js';
+import { RkCheckpoint } from './RkCheckpoint.js';
+import { RkResult } from './RkResult.js';
 
 // / Adaptive Runge-Kutta propagator base class.
 export abstract class RungeKuttaAdaptive extends Propagator {

package/src/propagator/Sgp4Propagator.ts

@@ -18,13 +18,16 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 /* eslint-disable class-methods-use-this */
 import { EpochUTC, J2000, Tle } from 'ootk-core';
-import { Thrust } from '../force/Thrust';
-import { VerletBlendInterpolator } from '../interpolator/VerletBlendInterpolator';
-import { Propagator } from './Propagator';
+import { Thrust } from '../force/Thrust.js';
+import { VerletBlendInterpolator } from '../interpolator/VerletBlendInterpolator.js';
+import { Propagator } from './Propagator.js';
 
-// / 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.js';
+export { RungeKutta89Propagator } from './RungeKutta89Propagator.js';
+export { Sgp4Propagator } from './Sgp4Propagator.js';

package/src/transforms/index.ts

@@ -1 +1 @@
-export * from './transforms';
+export * from './transforms.js';

package/src/transforms/transforms.ts

@@ -1,5 +1,5 @@
 import { DEG2RAD, Degrees, EnuVec3, RAD2DEG, Radians, RaeVec3, TAU } from 'ootk-core';
-import { RfVec3, RuvVec3, RfSensor } from '../main';
+import { RfVec3, RuvVec3, RfSensor } from '../main.js';
 
 /**
  * Converts Azimuth and Elevation to U and V.
@@ -35,12 +35,14 @@ export function azel2uv(az: Radians, el: Radians, coneHalfAngle: Radians): { u:
  * Determine azimuth and elevation off of boresight based on sensor orientation and RAE.
  * @param rae Range, Azimuth, Elevation
  * @param sensor Radar sensor object
+ * @param face Face number of the sensor
  * @param maxSensorAz Maximum sensor azimuth
  * @returns Azimuth and Elevation off of boresight
  */
 export function rae2raeOffBoresight(
   rae: RaeVec3,
   sensor: RfSensor,
+  face: number,
   maxSensorAz: Degrees,
 ): { az: Radians; el: Radians } {
   let az = (rae.az * DEG2RAD) as Radians;
@@ -49,8 +51,8 @@ export function rae2raeOffBoresight(
   // Correct azimuth for sensor orientation.
   az = az > maxSensorAz * DEG2RAD ? ((az - TAU) as Radians) : az;
 
-  az = (az - sensor.boresightAz) as Radians;
-  el = (el - sensor.boresightEl) as Radians;
+  az = (az - sensor.boresightAz[face]) as Radians;
+  el = (el - sensor.boresightEl[face]) as Radians;
 
   return { az, el };
 }
@@ -59,12 +61,13 @@ export function rae2raeOffBoresight(
  * Converts Range Az El to Range U V.
  * @param rae Range, Azimuth, Elevation
  * @param sensor Radar sensor object
+ * @param face Face number of the sensor
  * @param maxSensorAz Maximum sensor azimuth
  * @returns Range, U, V
  */
-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);
+export function rae2ruv(rae: RaeVec3, sensor: RfSensor, face: number, maxSensorAz: Degrees): RuvVec3 {
+  const { az, el } = rae2raeOffBoresight(rae, sensor, face, maxSensorAz);
+  const { u, v } = azel2uv(az, el, sensor.beamwidthRad);
 
   return { rng: rae.rng, u, v };
 }

package/src/types/types.ts

@@ -15,7 +15,8 @@
  * Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
  */
 
-import { Degrees, Kilometers, Milliseconds, SatelliteParams, Vec3 } from 'ootk-core';
+import { Kilometers, Milliseconds, SatelliteParams, SensorParams, Vec3 } from 'ootk-core';
+import { CommLink } from '../main.js';
 
 export enum ZoomValue {
   LEO = 0.45,
@@ -49,35 +50,28 @@ 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;
 }
 
-export interface DetailedSensorParams {
+export interface DetailedSensorParams extends SensorParams {
   /** The country that owns the sensor */
   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[];
+  freqBand?: string;
   static?: boolean;
   sensorId?: number;
   url?: string;
   /** Does this sensor use a volumetric search pattern? */
   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;
+  zoom?: ZoomValue;
   /** This is the name of the object in the array */
   objName?: string;
   /** This is the name of the object in the UI */

package/src/utils/functions.ts

@@ -1,4 +1,4 @@
-import { DifferentiableFunction } from '../main';
+import { DifferentiableFunction } from '../main.js';
 
 /**
  * Calculates the derivative of a differentiable function.

package/src/utils/index.ts

@@ -1,2 +1,2 @@
-export * from './jacobian';
-export * from './functions';
+export * from './jacobian.js';
+export * from './functions.js';

package/src/utils/jacobian.ts

@@ -1,5 +1,5 @@
 import { array2d, Matrix, Vector } from 'ootk-core';
-import { JacobianFunction } from '../types/types';
+import { JacobianFunction } from '../types/types.js';
 
 // TODO: #11 Expand documentation of Jacobian function.