ootk-core
Version:
Orbital Object Toolkit. A modern typed replacement for satellite.js including SGP4 propagation, TLE parsing, Sun and Moon calculations, and more.
112 lines (111 loc) • 4.92 kB
TypeScript
/**
* @author Theodore Kruczek.
* @license MIT
* @copyright (c) 2022-2025 Theodore Kruczek Permission is
* hereby granted, free of charge, to any person obtaining a copy of this
* software and associated documentation files (the "Software"), to deal in the
* Software without restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
* the Software, and to permit persons to whom the Software is furnished to do
* so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
import { J2000 } from '../coordinate/J2000.js';
import { AngularDistanceMethod } from '../enums/AngularDistanceMethod.js';
import { Degrees, Kilometers, Radians } from '../main.js';
import { Vector3D } from '../operations/Vector3D.js';
import { EpochUTC } from '../time/EpochUTC.js';
export declare class RAE {
epoch: EpochUTC;
rng: Kilometers;
azRad: Radians;
elRad: Radians;
/** The range rate of the satellite relative to the observer in kilometers per second. */
rngRate?: number;
/** The azimuth rate of the satellite relative to the observer in radians per second. */
azRateRad?: number;
/** The elevation rate of the satellite relative to the observer in radians per second. */
elRateRad?: number;
constructor(epoch: EpochUTC, rng: Kilometers, azRad: Radians, elRad: Radians,
/** The range rate of the satellite relative to the observer in kilometers per second. */
rngRate?: number,
/** The azimuth rate of the satellite relative to the observer in radians per second. */
azRateRad?: number,
/** The elevation rate of the satellite relative to the observer in radians per second. */
elRateRad?: number);
static fromDegrees(epoch: EpochUTC, range: Kilometers, azimuth: Degrees, elevation: Degrees, rangeRate?: number, azimuthRate?: number, elevationRate?: number): RAE;
/**
* Create a [Razel] object from an inertial [state] and [site] vector.
* @param state The inertial [state] vector.
* @param site The observer [site] vector.
* @returns A new [Razel] object.
*/
static fromStateVector(state: J2000, site: J2000): RAE;
/**
* Gets the azimuth in degrees.
* @returns The azimuth in degrees.
*/
get az(): Degrees;
/**
* Gets the elevation angle in degrees.
* @returns The elevation angle in degrees.
*/
get el(): Degrees;
/**
* Gets the azimuth rate in degrees per second.
* @returns The azimuth rate in degrees per second, or undefined if it is not available.
*/
get azRate(): number | undefined;
/**
* Gets the elevation rate in degrees per second.
* @returns The elevation rate in degrees per second, or undefined if the elevation rate is not set.
*/
get elRate(): number | undefined;
toString(): string;
/**
* Return the position relative to the observer [site].
*
* An optional azimuth [az] _(rad)_ and elevation [el] _(rad)_ value can be
* passed to override the values contained in this observation.
* @param site The observer [site].
* @param azRad Azimuth _(rad)_.
* @param elRad Elevation _(rad)_.
* @returns A [Vector3D] object.
*/
position(site: J2000, azRad?: Radians, elRad?: Radians): Vector3D<Kilometers>;
/**
* Convert this observation into a [J2000] state vector.
*
* This will throw an error if the [rangeRate], [elevationRate], or
* [azimuthRate] are not defined.
* @param site The observer [site].
* @returns A [J2000] state vector.
*/
toStateVector(site: J2000): J2000;
/**
* Calculate the angular distance _(rad)_ between this and another [Razel]
* object.
* @param razel The other [Razel] object.
* @param method The angular distance method to use.
* @returns The angular distance _(rad)_.
*/
angle(razel: RAE, method?: AngularDistanceMethod): number;
/**
* Calculate the angular distance _(°)_ between this and another [Razel]
* object.
* @param razel The other [Razel] object.
* @param method The angular distance method to use.
* @returns The angular distance _(°)_.
*/
angleDegrees(razel: RAE, method?: AngularDistanceMethod): number;
}