ostk.physics.environment.atmospheric.Earth

class Earth(*args, **kwargs)

Bases: pybind11_object

Earth atmospheric model.

Overloaded function.

1. __init__(self: ostk.physics.environment.atmospheric.Earth, type: ostk.physics.environment.atmospheric.Earth.Type, input_data_type: ostk.physics.environment.atmospheric.Earth.InputDataType = <InputDataType.Undefined: 0>, f107_constant_value: ostk.core.type.Real = 150.0, f107_average_constant_value: ostk.core.type.Real = 150.0, kp_constant_value: ostk.core.type.Real = 3.0, earth_frame: ostk.physics.coordinate.Frame = Frame.ITRF(), earth_radius: ostk.physics.unit.Length = WGS84.equatorialRadius_, earth_flattening: ostk.core.type.Real = WGS84.flattening_, sun_celestial: ostk.physics.environment.object.Celestial = None) -> None

   Constructor.

   Args:

   type (Earth.Type): Earth atmospheric model type. input_data_type (Earth.InputDataType, optional): Earth atmospheric model input data type. Defaults to Earth.InputDataType.Undefined. f107_constant_value (Real, optional): F10.7 constant value. Defaults to 150.0. f107_average_constant_value (Real, optional): F10.7a constant value. Defaults to 150.0. kp_constant_value (Real, optional): Kp constant value. Defaults to 3.0. earth_frame (Frame, optional): Earth frame. Defaults to Frame.ITRF(). earth_radius (Length, optional): Earth radius [m]. Defaults to the WGS84 equatorial radius. earth_flattening (Real, optional): Earth flattening. Defaults to the WGS84 flattening. sun_celestial (Celestial, optional): Sun celestial object. Defaults to None.

   Returns:

   Earth: Earth atmospheric model.

2. __init__(self: ostk.physics.environment.atmospheric.Earth, type: ostk.physics.environment.atmospheric.Earth.Type, earth_frame: ostk.physics.coordinate.Frame, input_data_type: ostk.physics.environment.atmospheric.Earth.InputDataType = <InputDataType.CSSISpaceWeatherFile: 2>, f107_constant_value: ostk.core.type.Real = 150.0, f107_average_constant_value: ostk.core.type.Real = 150.0, kp_constant_value: ostk.core.type.Real = 3.0, earth_radius: ostk.physics.unit.Length = WGS84.equatorialRadius_, earth_flattening: ostk.core.type.Real = WGS84.flattening_, sun_celestial: ostk.physics.environment.object.Celestial = None) -> None

   Constructor, with the Earth frame as second argument.

   Args:

   type (Earth.Type): Earth atmospheric model type. earth_frame (Frame): Earth frame. input_data_type (Earth.InputDataType, optional): Earth atmospheric model input data type. Defaults to Earth.InputDataType.CSSISpaceWeatherFile. f107_constant_value (Real, optional): F10.7 constant value. Defaults to 150.0. f107_average_constant_value (Real, optional): F10.7a constant value. Defaults to 150.0. kp_constant_value (Real, optional): Kp constant value. Defaults to 3.0. earth_radius (Length, optional): Earth radius [m]. Defaults to the WGS84 equatorial radius. earth_flattening (Real, optional): Earth flattening. Defaults to the WGS84 flattening. sun_celestial (Celestial, optional): Sun celestial object. Defaults to None.

   Returns:

   Earth: Earth atmospheric model.

Methods

get_density_at	Overloaded function.
get_input_data_type	Get the Earth atmospheric model input data type.
get_type	Get the Earth atmospheric model type.
is_defined	Check if the Earth atmospheric model is defined.

class InputDataType(

self: ostk.physics.environment.atmospheric.Earth.InputDataType,

value: int,

)

Bases: pybind11_object

Members:

Undefined :

Undefined.

ConstantFluxAndGeoMag :

Use constant values for F10.7, F10.7a and Kp NRLMSISE00 input parameters.

CSSISpaceWeatherFile :

Use historical and predicted values for F10.7, F10.7a and Kp NRLMSISE00 input parameters from CSSI.

property name

class Type(self: ostk.physics.environment.atmospheric.Earth.Type, value: int)

Bases: pybind11_object

Members:

Undefined :

Undefined.

Exponential :

Exponential atmospheric density model, valid up to 1000 km.

NRLMSISE00 :

Navy Research Lab Mass Spectrometer and Incoherent Scatter Radar Exosphere 2000.

property name

get_density_at(*args, **kwargs)

Overloaded function.

1. get_density_at(self: ostk.physics.environment.atmospheric.Earth, position: ostk.physics.coordinate.Position, instant: ostk.physics.time.Instant) -> ostk.core.type.Real

   Get the atmospheric density value at a given position and instant.

   Args:

   position (Position): A position. instant (Instant): An instant.

   Returns:

   float: Atmospheric density value [kg.m^-3].

2. get_density_at(self: ostk.physics.environment.atmospheric.Earth, lla: ostk.physics.coordinate.spherical.LLA, instant: ostk.physics.time.Instant) -> ostk.core.type.Real

   Get the atmospheric density value at a given position and instant.

   Args:

   lla (LLA): A position, expressed as latitude, longitude, altitude [deg, deg, m]. instant (Instant): An instant.

   Returns:

   float: Atmospheric density value [kg.m^-3].

get_input_data_type(

self: ostk.physics.environment.atmospheric.Earth,

) → ostk.physics.environment.atmospheric.Earth.InputDataType

Get the Earth atmospheric model input data type.

Returns:

Earth atmospheric model input data type.

Return type:

Earth.InputDataType

get_type(

self: ostk.physics.environment.atmospheric.Earth,

) → ostk.physics.environment.atmospheric.Earth.Type

Get the Earth atmospheric model type.

Returns:

Earth atmospheric model type.

Return type:

Earth.Type

is_defined(self: ostk.physics.environment.atmospheric.Earth) → bool

Check if the Earth atmospheric model is defined.

Returns:

True if defined.

Return type:

bool