Orbit Shapes – ephemerista.coords.shapes

The shapes.py module.

This module provides several classes which provide different ways to define the shape of an orbit.

Notes

The classes in this module are part of the ephemerista.coords.twobody.Keplerian data model for Keplerian orbits and should not be used directly.

class ephemerista.coords.shapes.AltitudesShape(*, type='altitudes', apoapsisAltitude, periapsisAltitude)

Orbit shape based on apoapsis and periapsis altitude.

apoapsis_radius(mean_radius)

Return the apoapsis radius of the orbit in kilometers.

Return type:

float

eccentricity(mean_radius)

Return the eccentricity of the orbit.

Return type:

float

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

periapsis_radius(mean_radius)

Return the periapsis radius of the orbit in kilometers.

Return type:

float

semi_major_axis(mean_radius)

Return the semi-major axis of the orbit in kilometers.

Return type:

float

class ephemerista.coords.shapes.OrbitShape

Abstract base class for orbital shapes.

abstractmethod apoapsis_radius(mean_radius)

Return the apoapsis radius of the orbit in kilometers.

Parameters:

mean_radius (float) – Mean radius of the central body [km]

Return type:

float

Notes

The mean_radius parameter is not being used by the SemiMajorAxisShape and RadiiShape subclasses.

abstractmethod eccentricity(mean_radius)

Return the eccentricity of the orbit.

Parameters:

mean_radius (float) – Mean radius of the central body [km]

Return type:

float

Notes

The mean_radius parameter is not being used by the SemiMajorAxisShape and RadiiShape subclasses.

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

abstractmethod periapsis_radius(mean_radius)

Return the periapsis radius of the orbit in kilometers.

Parameters:

mean_radius (float) – Mean radius of the central body [km]

Return type:

float

Notes

The mean_radius parameter is not being used by the SemiMajorAxisShape and RadiiShape subclasses.

abstractmethod semi_major_axis(mean_radius)

Return the semi-major axis of the orbit in kilometers.

Parameters:

mean_radius (float) – Mean radius of the central body [km]

Return type:

float

Notes

The mean_radius parameter is not being used by the SemiMajorAxisShape and RadiiShape subclasses and can be set to zero.

class ephemerista.coords.shapes.RadiiShape(*, type='radii', apoapsisRadius, periapsisRadius)

Orbit shape based on apoapsis and periapsis radius.

apoapsis_radius(mean_radius)

Return the apoapsis radius of the orbit in kilometers.

Return type:

float

eccentricity(mean_radius)

Return the eccentricity of the orbit.

Return type:

float

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

periapsis_radius(mean_radius)

Return the periapsis radius of the orbit in kilometers.

Return type:

float

semi_major_axis(mean_radius)

Return the semi-major axis of the orbit in kilometers.

Return type:

float

class ephemerista.coords.shapes.SemiMajorAxisShape(*, type='semi_major', semiMajorAxis, eccentricity)

Orbit shape based on semi-major axis and eccentricity.

apoapsis_radius(mean_radius)

Return the apoapsis radius of the orbit in kilometers.

Return type:

float

eccentricity(mean_radius)

Return the eccentricity of the orbit.

Return type:

float

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

periapsis_radius(mean_radius)

Return the periapsis radius of the orbit in kilometers.

Return type:

float

semi_major_axis(mean_radius)

Return the semi-major axis of the orbit in kilometers.

Return type:

float