ootk-core/dist/coordinate/Geodetic.d.ts

Orbital Object Toolkit. A modern typed replacement for satellite.js including SGP4 propagation, TLE parsing, Sun and Moon calculations, and more.

/**
 * @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 { 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;
}