IODGauss

py_outfit.iod_gauss.GaussResult

Result of a Gauss Initial Orbit Determination (IOD) for a single object.

Variants

• PrelimOrbit(OrbitalElements) — result directly from the Gauss solution.
• CorrectedOrbit(OrbitalElements) — result after the post-Gauss correction step.

See also

• from_keplerian, from_equinoctial, from_cometary — Build a result from a given element family.
• is_preliminary, is_corrected — Stage predicates.
• elements_type — "keplerian" | "equinoctial" | "cometary".
• keplerian, equinoctial, cometary — Typed extraction helpers (return None if mismatched).
• to_dict — Structured dict view for serialization or logging.

from_keplerian classmethod

from_keplerian(
    keplerian: KeplerianElements, corrected: Optional[bool] = ...
) -> GaussResult

Build a GaussResult from Keplerian elements.

RETURNS	DESCRIPTION
GaussResult	A GaussResult embedding the provided elements.

from_equinoctial classmethod

from_equinoctial(
    equinoctial: EquinoctialElements, corrected: Optional[bool] = ...
) -> GaussResult

Build a GaussResult from Equinoctial elements.

RETURNS	DESCRIPTION
GaussResult	A GaussResult embedding the provided elements.

from_cometary classmethod

from_cometary(
    cometary: CometaryElements, corrected: Optional[bool] = ...
) -> GaussResult

Build a GaussResult from Cometary elements.

RETURNS	DESCRIPTION
GaussResult	A GaussResult embedding the provided elements.

is_corrected

is_corrected() -> bool

Whether this result is the corrected stage.

RETURNS	DESCRIPTION
bool	True for CorrectedOrbit, False for PrelimOrbit.

is_preliminary

is_preliminary() -> bool

Whether this result is the preliminary Gauss solution.

RETURNS	DESCRIPTION
bool	True for PrelimOrbit, False for CorrectedOrbit.

elements_type

elements_type() -> Literal['keplerian', 'equinoctial', 'cometary']

Return the family of orbital elements stored inside.

RETURNS	DESCRIPTION
Literal['keplerian', 'equinoctial', 'cometary']	The family of orbital elements stored inside.

keplerian

keplerian() -> Optional[KeplerianElements]

Extract Keplerian elements if present.

RETURNS	DESCRIPTION
KeplerianElements | None	KeplerianElements if the underlying family is keplerian, else None.

equinoctial

equinoctial() -> Optional[EquinoctialElements]

Extract Equinoctial elements if present.

RETURNS	DESCRIPTION
EquinoctialElements | None	EquinoctialElements if the underlying family is equinoctial, else None.

cometary

cometary() -> Optional[CometaryElements]

Extract Cometary elements if present.

RETURNS	DESCRIPTION
CometaryElements | None	CometaryElements if the underlying family is cometary, else None.

to_dict

to_dict() -> Dict[str, Any]

Convert the result to a structured Python dict.

Schema

• "stage": "preliminary" | "corrected"
• "type": "keplerian" | "equinoctial" | "cometary"
• "elements": dict of concrete fields for the stored family:
• Keplerian: reference_epoch, semi_major_axis, eccentricity, inclination, ascending_node_longitude, periapsis_argument, mean_anomaly
• Equinoctial: reference_epoch, semi_major_axis, eccentricity_sin_lon, eccentricity_cos_lon, tan_half_incl_sin_node, tan_half_incl_cos_node, mean_longitude
• Cometary: reference_epoch, perihelion_distance, eccentricity, inclination, ascending_node_longitude, periapsis_argument, true_anomaly

RETURNS	DESCRIPTION
dict[str, Any]	A structured dict representation of the result.