ootk/dist/coordinate/Geodetic.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 { AngularDistanceMethod, Degrees, GroundObject, Kilometers, Radians } from '../main.js';
import { EpochUTC } from '../time/EpochUTC.js';
import { ITRF } from './ITRF.js';
/**
 * This Geodetic class represents a geodetic coordinate in three-dimensional
 * space, consisting of latitude, longitude, and altitude. It provides various
 * methods to perform calculations and operations related to geodetic
 * coordinates.
 *
 * This is a class for geodetic coordinates. This is related to the GroundObject
 * class, which is used to represent an object on the surface of the Earth.
 */
export declare class Geodetic {
    lat: Radians;
    lon: Radians;
    alt: Kilometers;
    constructor(latitude: Radians, longitude: Radians, altitude: Kilometers);
    /**
     * Creates a Geodetic object from latitude, longitude, and altitude values in
     * degrees.
     * @param latitude The latitude value in degrees.
     * @param longitude The longitude value in degrees.
     * @param altitude The altitude value in kilometers.
     * @returns A Geodetic object representing the specified latitude, longitude,
     * and altitude.
     */
    static fromDegrees(latitude: Degrees, longitude: Degrees, altitude: Kilometers): Geodetic;
    /**
     * Returns a string representation of the Geodetic object.
     * @returns A string containing the latitude, longitude, and altitude of the Geodetic object.
     */
    toString(): string;
    /**
     * Gets the latitude in degrees.
     * @returns The latitude in degrees.
     */
    get latDeg(): number;
    /**
     * Gets the longitude in degrees.
     * @returns The longitude in degrees.
     */
    get lonDeg(): number;
    /**
     * Converts the geodetic coordinates to a ground position.
     * @returns The ground position object.
     */
    toGroundObject(): GroundObject;
    /**
     * Converts the geodetic coordinates to the International Terrestrial
     * Reference Frame (ITRF) coordinates.
     * @param epoch The epoch in UTC.
     * @returns The ITRF coordinates.
     */
    toITRF(epoch: EpochUTC): ITRF;
    /**
     * Calculates the angle between two geodetic coordinates.
     * @param g The geodetic coordinate to calculate the angle to.
     * @param method The method to use for calculating the angular distance (optional, default is Haversine).
     * @returns The angle between the two geodetic coordinates in radians.
     */
    angle(g: Geodetic, method?: AngularDistanceMethod): Radians;
    /**
     * Calculates the angle in degrees between two Geodetic coordinates.
     * @param g The Geodetic coordinate to calculate the angle with.
     * @param method The method to use for calculating the angular distance (optional, default is Haversine).
     * @returns The angle in degrees.
     */
    angleDeg(g: Geodetic, method?: AngularDistanceMethod): Degrees;
    /**
     * Calculates the distance between two geodetic coordinates.
     * @param g The geodetic coordinates to calculate the distance to.
     * @param method The method to use for calculating the angular distance. Default is Haversine.
     * @returns The distance between the two geodetic coordinates in kilometers.
     */
    distance(g: Geodetic, method?: AngularDistanceMethod): Kilometers;
    /**
     * Calculates the field of view based on the altitude of the Geodetic object.
     * @returns The field of view in radians.
     */
    fieldOfView(): Radians;
    /**
     * Determines if the current geodetic coordinate can see another geodetic coordinate.
     * @param g The geodetic coordinate to check for visibility.
     * @param method The method to use for calculating the angular distance (optional, default is Haversine).
     * @returns A boolean indicating if the current coordinate can see the other coordinate.
     */
    isInView(g: Geodetic, method?: AngularDistanceMethod): boolean;
}