:py:mod:`pycasx.scenario.calculate_cpa`
=======================================

.. py:module:: pycasx.scenario.calculate_cpa

.. autoapi-nested-parse::

   Calculate the closest point of approach (CPA) given the time to CPA.



Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   pycasx.scenario.calculate_cpa.calculate_cpa



.. py:function:: calculate_cpa(cfg: pycasx.conf.ScenarioConfig) -> pycasx.scenario.GeographicCoordinates
                 calculate_cpa(cfg: pycasx.conf.ScenarioConfig, return_tuple: Literal[False]) -> pycasx.scenario.GeographicCoordinates
                 calculate_cpa(cfg: pycasx.conf.ScenarioConfig, return_tuple: Literal[True]) -> tuple[float, float]
                 calculate_cpa(cfg: pycasx.conf.ScenarioConfig, return_tuple: Literal[False], order: Literal[lat,lon, lon,lat]) -> pycasx.scenario.GeographicCoordinates
                 calculate_cpa(cfg: pycasx.conf.ScenarioConfig, return_tuple: Literal[True], order: Literal[lat,lon, lon,lat]) -> tuple[float, float]

   Calculate the closest point of approach given the initial condition.

   :param cfg: The scenario configuration
   :type cfg: ScenarioConfig
   :param return_tuple: If true, return the result as a tuple.
                        Otherwise, return a GeographicCoordinates object.
   :type return_tuple: bool
   :param order: The order of the returned
                 tuple if `return_tuple` is true.
   :type order: Literal["lat,lon", "lon,lat"]

   :returns:

             The closest point of
                 approach as a GeographicCoordinates object if `return_tuple` is
                 false, otherwise as a tuple of latitude and longitude in the
                 specified order.
   :rtype: GeographicCoordinates | tuple[float, float]