ootk/dist/observation/RAE.d.ts

Orbital Object Toolkit including Multiple Propagators, Initial Orbit Determination, and Maneuver Calculations.

/**
 * @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 '../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 | undefined;
    /** The azimuth rate of the satellite relative to the observer in radians per second. */
    azRateRad?: number | undefined;
    /** The elevation rate of the satellite relative to the observer in radians per second. */
    elRateRad?: number | undefined;
    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 | undefined, 
    /** The azimuth rate of the satellite relative to the observer in radians per second. */
    azRateRad?: number | undefined, 
    /** The elevation rate of the satellite relative to the observer in radians per second. */
    elRateRad?: number | undefined);
    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;
}