`parameters_setup`¶

This module contains a set of factory functions for setting up the observation models, for use in the tudat estimation framework

This module and its constituents are in many cases documented under the assumption that its functionalities are used in the context of an estimation problem. However, since estimatable parameter settings are firstly used to set up variational equations of the dynamical / observation model w.r.t. the estimatable parameters, the functionality of this module can be relevant in any context in which variational equations are required.

Functions¶

`create_parameter_set`(parameter_settings, ...)	Function for creating a consolidated parameter from the given estimatable parameter settings.
`initial_states`(propagator_settings, bodies)	Function for creating parameter settings for initial state parameters.
`constant_drag_coefficient`(body)	Function for creating parameter settings for constant drag coefficients.
`arcwise_constant_drag_coefficient`(body, ...)	Function for creating parameter settings for arc-wise constant drag coefficients.
`drag_component_scaling`(body)	Function for creating parameter settings for aerodynamic drag scaling factor
`side_component_scaling`(body)	Function for creating parameter settings for aerodynamic side force scaling factor
`lift_component_scaling`(body)	Function for creating parameter settings for aerodynamic lift force scaling factor
`radiation_pressure_coefficient`(body)	Function for creating parameter settings for radiation pressure coefficients.
`arcwise_radiation_pressure_coefficient`(body, ...)	Function for creating parameter settings for arc-wise radiation pressure coefficients.
`radiation_pressure_target_direction_scaling`(...)	Function for creating parameter settings for a radiation pressure acceleration scaling factor in target direction.
`radiation_pressure_target_perpendicular_direction_scaling`(...)	Function for creating parameter settings for a radiation pressure acceleration scaling factor perpendicular to target direction.
`empirical_accelerations`(body, centralBody, ...)	Function for creating parameter settings for empirical acceleration magnitudes.
`arcwise_empirical_accelerations`(body, ...)	Function for creating parameter settings for arc-wise empirical acceleration magnitudes.
`constant_empirical_acceleration_terms`(body, ...)	Function for creating parameter settings for constant empirical acceleration terms.
`full_empirical_acceleration_terms`(body, ...)	Function for creating parameter settings for empirical acceleration magnitudes for all components.
`arcwise_constant_empirical_acceleration_terms`(...)	Function for creating parameter settings for arc-wise constant empirical acceleration terms.
`quasi_impulsive_shots`(body)	Function for creating parameter settings for quasi-impulsive shots.
`gravitational_parameter`(body)	Function for creating parameter settings for a massive body's gravitational parameter.
`spherical_harmonics_c_coefficients`(body, ...)	Function for creating parameter settings for the cosine coefficients of body's spherical harmonics gravitational model.
`spherical_harmonics_s_coefficients`(body, ...)	Function for creating parameter settings for the sine coefficients of body's spherical harmonics gravitational model.
`spherical_harmonics_c_coefficients_block`(...)	Function for creating parameter settings for the cosine coefficients of body's spherical harmonics gravitational model.
`spherical_harmonics_s_coefficients_block`(...)	Function for creating parameter settings for the sine coefficients of body's spherical harmonics gravitational model.
`yarkovsky_parameter`(body_name[, ...])	Function for creating parameter settings for Yarkovsky parameter.
`constant_rotation_rate`(body)	Function for creating parameter settings for a body's constant rotation rate.
`rotation_pole_position`(body)	Function for creating parameter settings for a body's rotation pole position.
`order_invariant_k_love_number`(deformed_body, ...)	Function for creating parameter settings for a body's \(k_{l}\) Love number.
`order_varying_k_love_number`(deformed_body, ...)	Function for creating parameter settings for a body's \(k_{lm}\) Love numbers.
`mode_coupled_k_love_numbers`(deformed_body, ...)	Function for creating parameter settings for a body's mode-coupled \(k_{lm}^{l'm'}\) Love numbers.
`polynomial_gravity_field_variation_amplitudes`(...)	Function for creating parameter settings for a body's polynomial gravity field amplitudes.
`periodic_gravity_field_variation_amplitudes`(...)	Function for creating parameter settings for a body's polynomial gravity field variation amplitudes
`monomial_gravity_field_variation_amplitudes`(...)	Function for creating parameter settings for a body's polynomial gravity field amplitudes at a single power.
`monomial_full_block_gravity_field_variation_amplitudes`(...)	Function for creating parameter settings for a body's polynomial gravity field amplitudes at a single power.
`direct_tidal_dissipation_time_lag`(*args, ...)	Overloaded function.
`inverse_tidal_quality_factor`(args, *kwargs)	Overloaded function.
`mean_moment_of_inertia`(body)	Function for creating parameter settings for a body's mean moment of inertia.
`periodic_spin_variations`(body)	Function for creating parameter settings for a body's periodic spin variations.
`polar_motion_amplitudes`(body)	Function for creating parameter settings for a body's polar motion amplitudes.
`scaled_longitude_libration_amplitude`(body_name)	No documentation found.
`core_factor`(body)	Function for creating parameter settings for a body's core factor.
`free_core_nutation_rate`(body)	Function for creating parameter settings for a body's free core nutation rate.
`absolute_observation_bias`(link_ends, ...)	Function for creating parameter settings for an absolute observation bias.
`relative_observation_bias`(link_ends, ...)	Function for creating parameter settings for an relative observation bias.
`arcwise_absolute_observation_bias`(link_ends, ...)	Function for creating parameter settings for arc-wise absolute observation bias.
`arcwise_relative_observation_bias`(link_ends, ...)	Function for creating parameter settings for arc-wise absolute observation bias.
`ground_station_position`(body, ...)	Function for creating parameter settings for ground station position bias.
`reference_point_position`(body, ...)	No documentation found.
`ppn_parameter_gamma`()	Function for creating parameter settings for post-newtonian gamma parameter.
`ppn_parameter_beta`()	Function for creating parameter settings for post-newtonian beta parameter.
`global_polynomial_clock_corrections`(...)
`arc_wise_polynomial_clock_corrections`(...)
`time_drift_observation_bias`(link_ends, ...)
`arcwise_time_drift_observation_bias`(...)
`constant_time_bias`(link_ends, tudat, ...)
`arcwise_time_bias`(link_ends, tudat, ...)
`custom_parameter`(custom_id, parameter_size, ...)	No documentation found.
`custom_analytical_partial`(...)	No documentation found.
`custom_numerical_partial`(...)	No documentation found.
`arcwise_drag_component_scaling`(body, ...)	Function for creating parameter settings for arc-wise aerodynamic drag scaling factor
`arcwise_exponential_atmosphere_base_density`(...)	Environment model parameter associated with the exponential atmosphere model of given body.
`arcwise_exponential_atmosphere_scale_height`(...)	Environment model parameter associated with the exponential atmosphere model of given body.
`arcwise_lift_component_scaling`(body, ...)	Function for creating parameter settings for arc-wise aerodynamic lift force scaling factor
`arcwise_side_component_scaling`(body, ...)	Function for creating parameter settings for arc-wise aerodynamic side force scaling factor
`area_to_mass_ratio_scaling_parameter`(body_name)	Function for creating parameter settings for a scaling factor for a body's area to mass ratio(s)
`exponential_atmosphere_base_density`(body_name)	Environment model parameter associated with the exponential atmosphere model of given body.
`exponential_atmosphere_scale_height`(body_name)	Environment model parameter associated with the exponential atmosphere model of given body.
`full_acceleration_scaling_parameter`(...)	Function for creating parameter settings for a scaling factor for a single acceleration acting on a body
`iau_rotation_model_longitudinal_librations`(...)	Function for creating parameter settings for a body's longitudinal libration amplitudes in an IAU rotation model
`iau_rotation_model_pole`(body)	Function for creating parameter settings for a body's nominal pole position in an IAU rotation model
`iau_rotation_model_pole_librations`(body, ...)	Function for creating parameter settings for a body's pole libration amplitudes in an IAU rotation model
`iau_rotation_model_pole_rate`(body)	Function for creating parameter settings for a body's pole precession rate in an IAU rotation model
`rtg_force_vector`(body_name)	Force model parameter associated with the RTG radiation acceleration.
`rtg_force_vector_magnitude`(body_name)	Force model parameter associated with the RTG radiation acceleration.

create_parameter_set(parameter_settings: list[tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings], bodies: tudatpy.kernel.dynamics.environment.SystemOfBodies, propagator_settings: tudatpy.kernel.dynamics.propagation_setup.propagator.PropagatorSettings = None, consider_parameters_names: list[tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings] = [], print_parameter_order_warning: bool = True) → tudat::estimatable_parameters::EstimatableParameterSet<double>¶

Function for creating a consolidated parameter from the given estimatable parameter settings.

Function for creating a consolidated parameter from the given estimatable parameter settings. The function checks for consistency between the parameter settings and the models contained in the simulation setup (given by the bodies & and propagator_settings parameters).

Parameters:

parameter_settings (list( EstimatableParameterSettings )) – List of objects that define the settings for the parameters that are to be created. Each entry in this list is typically created by a call to a function in the parameters_setup module.
bodies (SystemOfBodies) – Object consolidating all bodies and environment models, including ground station models, that constitute the physical environment.
propagator_settings (PropagatorSettings) – Object containing the consolidated propagation settings of the simulation.
consider_parameters_names (list( EstimatableParameterSettings ) = []) – List of objects that define the settings for the considered parameters that are to be created. Each entry in this list is typically created by a call to a function in the parameters_setup module.
print_parameter_order_warning (bool = True) – Flag to determine whether a warning is printed to the console if there are both scalar and vector parameters found.

Returns:

Instance of EstimatableParameterSet class, consolidating all estimatable parameters and simulation models.

Return type:

EstimatableParameterSet

Examples

# Create bodies
bodies = ...
# Define parameters settings
parameter_settings = ...
# Create the parameters that will be estimated
parameters_to_estimate = dynamics.parameters_setup.create_parameter_set(parameter_settings, bodies)

This code snippet closely follows what is done in: Full Estimation Example.

initial_states(propagator_settings: tudatpy.kernel.dynamics.propagation_setup.propagator.PropagatorSettings, bodies: tudatpy.kernel.dynamics.environment.SystemOfBodies, arc_initial_times: list[float | SupportsIndex] = []) → list[tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings]¶

Function for creating parameter settings for initial state parameters.

Function for creating a parameter settings object for initial state parameters. The function uses the propagator settings to determine which type of initial state parameter (single/multi/hybrid-arc; translational/rotational/… dynamics) is to be estimated, e.g. if a single-arc translational state propagator is defined, the function will automatically create the parameters for the associated initial state parameter

Note

This function return lists of parameter settings objects. This means that the return of this function cannot simply be added to the parameter settings objects of single parameters in a list creation statement. Instead, list concatenation is recommended. Please see the following example:

# define single estimatable parameters
single_parameter_1 = ...
single_parameter_2 = ...
...

# bad: list creation statement --> will result in nested list, undesired!
list_of_all_parameters = [dynamics.parameters_setup.initial_states(...), single_parameter_1, single_parameter_2, ...]

# better: list concatenation --> will result in simple list, desired!
list_of_all_parameters = dynamics.parameters_setup.initial_states(...) + [single_parameter_1, single_parameter_2, ...]

Parameters:

propagator_settings (PropagatorSettings) – Object containing the consolidated propagation settings of the simulation in the context of which the given model parameters are to be estimated.
bodies (SystemOfBodies) – Object consolidating all bodies and environment models that constitute the physical environment.
arc_initial_times (List[ float ] = []) – Initial times of arcs, only required if arc-wise propagation settings are passed via the propagator_settings object.

Returns:

List of EstimatableParameterSettings objects, one per component of each initial state in the simulation.

Return type:

List[ EstimatableParameterSettings ]

constant_drag_coefficient(body: str) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for constant drag coefficients.

Function for creating parameter settings object for a constant drag coefficient parameter \(C_{D}\) (see aerodynamic() ). Using the constant drag coefficient as an estimatable parameter requires:

A constant() aerodynamic interface (with negative_aerodynamic_frame_coefficients() as input to force_coefficients_frame ) to be defined for the body specified by the body parameter
The body specified by the body parameter to undergo aerodynamic() acceleration

The estimated parameter modifies the aerodynamic()

Parameters:: body (str) – Name of the body, with whose drag acceleration model the estimatable parameter is associated.
Returns:: EstimatableParameterSettings object for the specified body’s constant drag coefficient.
Return type:: EstimatableParameterSettings

arcwise_constant_drag_coefficient(body: str, arc_initial_times: list[float | SupportsIndex]) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for arc-wise constant drag coefficients.

Function for creating parameter settings object for arc-wise constant drag coefficients \(C_{D}\) (arc-wise version of constant_drag_coefficient()). Using the arc-wise constant drag coefficient as an estimatable parameter requires:

A constant() aerodynamic interface to be defined for the body specified by the body parameter
The body specified by the body parameter to undergo aerodynamic() acceleration

When using this parameter, whenever \(C_{D}\) is required at a time \(t\), the index \(i\) in the arc_initial_times ordered list is found for which \(t_{i}\le t<t_{i+1}\) (or, if \(t\) is larger than the largest value in the list, \(i\) is set to be last index of the list), and the parameter entry representing \(C_{D,i}\) will be used.

Note

This parameter may be estimated for a single-arc propagation, or a multi-arc propagation. In the latter case, the arcs selected for the estimation of the drag coefficient may, but need not, correspond to the arcs used for a multi-arc propagation.

Parameters:

body (str) – Name of the body, with whose drag acceleration model the estimatable parameter is associated.
arc_initial_times (List[ float ]) – Ordered list of times at which the arcs over which the drag coefficient is to be estimated will start.

Returns:

Instance of EstimatableParameterSettings derived ArcWiseDragCoefficientEstimatableParameterSettings class for arc-wise treatment of the specified body’s constant drag coefficient.

Return type:

EstimatableParameterSettings

drag_component_scaling(body: str) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for aerodynamic drag scaling factor

Function for creating parameter settings object for a scaling factor \(K\) (initialized to 1.0) for the aerodynamic force along the drag direction (effectively scaling the drag coefficient \(C_{D}\) (see aerodynamic() )

Using the arc-wise constant drag coefficient as an estimatable parameter requires:

The body specified by the body parameter to undergo aerodynamic() acceleration

Note that, unlike the constant_drag_coefficient() parameter, this parameter does not modify the drag coefficient itself, but works regardless of the type of aerodynamic coefficients (in any frame, and with any dependencies). Using this parameter, the aerodynamic force along the drag direction is scaled (multiplied) by the factor \(K\) during each function evaluation.

Parameters:: body (str) – Name of the body, with whose aerodynamic acceleration model the estimatable parameter is associated.
Returns:: Instance of EstimatableParameterSettings class that define the settings.
Return type:: EstimatableParameterSettings

side_component_scaling(body: str) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for aerodynamic side force scaling factor

As drag_component_scaling(), but scales the force along the \(C_{S}\) direction rather than the \(C_{D}\) direction

Parameters:: body (str) – Name of the body, with whose aerodynamic acceleration model the estimatable parameter is associated.
Returns:: Instance of EstimatableParameterSettings class that define the settings.
Return type:: EstimatableParameterSettings

lift_component_scaling(body: str) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for aerodynamic lift force scaling factor

As drag_component_scaling(), but scales the force along the \(C_{L}\) direction rather than the \(C_{D}\) direction

Parameters:: body (str) – Name of the body, with whose aerodynamic acceleration model the estimatable parameter is associated.
Returns:: Instance of EstimatableParameterSettings class that define the settings.
Return type:: EstimatableParameterSettings

radiation_pressure_coefficient(body: str) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for radiation pressure coefficients.

Function for creating parameter settings object for a radiation pressure coefficient \(C_{r}\). Using the radiation pressure coefficient as an estimatable parameter requires:

A cannonball_radiation_target() radiation pressure target model to be defined for the body specified by the body parameter
The body specified by the body parameter to undergo radiation_pressure() acceleration (which, if the body has multiple target model defined, has the target_type input set to cannonball_target)

Parameters:: body (str) – Name of the body, with whose radiation pressure acceleration model the estimatable parameter is associated.
Returns:: EstimatableParameterSettings object for the specified body’s radiation pressure coefficient.
Return type:: EstimatableParameterSettings

arcwise_radiation_pressure_coefficient(body: str, arc_initial_times: list[float | SupportsIndex]) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for arc-wise radiation pressure coefficients.

Function for creating parameter settings object for arc-wise radiation pressure coefficients \(C_{r}\) (arc-wise version of radiation_pressure_coefficient()). Using the radiation pressure coefficient as an estimatable parameter requires:

A cannonball_radiation_target() radiation pressure target model to be defined for the body specified by the body parameter
The body specified by the body parameter to undergo radiation_pressure() acceleration (which, if the body has multiple target model defined, has the target_type input set to cannonball_target())

When using this parameter, whenever \(C_{r}\) is required at a time \(t\), the index math:i in the arc_initial_times ordered list is found for which \(t_{i}\le t<t_{i+1}\) (or, if \(t\) is larger than the largest value in the list, \(i\) is set to be last index of the list), and the parameter entry representing \(C_{r,i}\) will be used.

Note

This parameter may be estimated for a single-arc propagation, or a multi-arc propagation. In the latter case, the arcs selected for the estimation of the radiation pressure coefficient may, but need not, correspond to the arcs used for a multi-arc propagation.

Parameters:

body (str) – Name of the body, with whose radiation pressure acceleration model the estimatable parameter is associated.
arc_initial_times (List[ float ]) – List of times at which the arcs over which the radiation pressure coefficient is to be estimated will start.

Returns:

Instance of EstimatableParameterSettings derived ArcWiseRadiationPressureCoefficientEstimatableParameterSettings class for arc-wise treatment of the specified body’s radiation pressure coefficient.

Return type:

EstimatableParameterSettings

radiation_pressure_target_direction_scaling(target_body: str, source_body: str) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for a radiation pressure acceleration scaling factor in target direction.

Function for creating parameter settings for scaling the radiation pressure acceleration component in the direction from the body undergoing the acceleration to the source model. When using this parameter, the radiation pressure \(\mathbf{a}\) is decomposed into a component \(\mathbf{a}_{\parallel}\) and \(\mathbf{a}_{\perp}, such that :math:\)mathbf{a}=mathbf{a}_{parallel}+mathbf{a}_{perp}`, where the parallel direction is computed as the component parallel with the vector from the center of mass of the source direction to the center of mass of the target direction. The radiation pressure model has parameters \(c_{\parallel}\) and \(c_{\perp}\) (nominally set to unity) that modify the acceleration as:

\[\mathbf{a}=c_{\parallel}\mathbf{a}_{\parallel}+c_{\perp}\mathbf{a}_{\perp}\]

The present function creates settings for a parameter defining \(c_{\parallel}\)

Using this parameter requires:

The body specified by the target_body parameter to undergo radiation_pressure() acceleration exerted by source_body

Parameters:

target_body (str) – Name of the body on which radiation pressure is exerted
source_body (str) – Name of the body exerting the radiation pressure

Returns:

Instance of EstimatableParameterSettings class defining parallel radiation pressure scaling

Return type:

EstimatableParameterSettings

radiation_pressure_target_perpendicular_direction_scaling(target_body: str, source_body: str) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for a radiation pressure acceleration scaling factor perpendicular to target direction.

Function for creating parameter settings for scaling the radiation pressure acceleration component perpendicular to the direction from the body undergoing the acceleration to the source model. The present function creates settings for a parameter defining \(c_{\perp}\), see radiation_pressure_target_direction_scaling()

Using this parameter requires:

The body specified by the target_body parameter to undergo radiation_pressure() acceleration exerted by source_body

Parameters:

target_body (str) – Name of the body on which radiation pressure is exerted
source_body (str) – Name of the body exerting the radiation pressure

Returns:

Instance of EstimatableParameterSettings class defining parallel radiation pressure scaling

Return type:

EstimatableParameterSettings

empirical_accelerations(body: str, centralBody: str, acceleration_components: dict[tudatpy.kernel.dynamics.parameters_setup.EmpiricalAccelerationComponents, list[tudatpy.kernel.dynamics.parameters_setup.EmpiricalAccelerationFunctionalShapes]]) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for empirical acceleration magnitudes.

Function for creating parameter settings object for empirical acceleration magnitudes. Using the empirical acceleration terms as estimatable parameters requires:

The body specified by the body parameter to undergo empirical() acceleration, which include constant (in RSW frame) terms

Any subset of the directions and functional shapes can be estimated. The values in the parameter vector are ordered first by functional shape (constant, sine, cosine) and then by component (radial, normal, cross-track) For instance, if all nine coefficients are estimated, they will be ordered as \(\mathbf{a}_{R,\text{const.}},\mathbf{a}_{R,\text{sine}},\mathbf{a}_{R,\text{cosine}},\mathbf{a}_{S,\text{const.}},\mathbf{a}_{S,\text{sine}},\mathbf{a}_{S,\text{cosine}},\mathbf{a}_{W,\text{const.}},\mathbf{a}_{W,\text{sine}},\mathbf{a}_{W,\text{cosine}}\) Any non-estimated components will be left to the values at which they were initialized.

Parameters:

body (str) – Name of the body, with whose empirical acceleration model the estimatable parameter is associated.
centralBody (str) – Name of the central body of the empirical acceleration model (of which the gravitational parameter is extracted to compute the true anomaly, and w.r.t. which the RSW directions are determined). This body is the same as the body considered to be ‘exerting’ the empirical acceleration
acceleration_components (dict[ EmpiricalAccelerationComponents, list[ EmpiricalAccelerationFunctionalShapes] ]) – Dictionary of components of the empirical acceleration which are to be estimated. There are two ‘degrees of freedom’ in these components: the direction of the acceleration (e.g. R, S or W direction) and the temporal signature (constant, sine of true anomaly or cosine of true anomaly). With this input, any subset may be selected. This parameter is a dictionary, with the key denoting the direction of the acceleration, and the value a list of the temporal signatures to estimate for this empirical acceleration direction.

Returns:

Instance of EstimatableParameterSettings derived EmpiricalAccelerationEstimatableParameterSettings class for the specified body’s empirical acceleration terms.

Return type:

EstimatableParameterSettings

arcwise_empirical_accelerations(body: str, centralBody: str, acceleration_components: dict[tudatpy.kernel.dynamics.parameters_setup.EmpiricalAccelerationComponents, list[tudatpy.kernel.dynamics.parameters_setup.EmpiricalAccelerationFunctionalShapes]], arc_start_times: list[float | SupportsIndex]) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for arc-wise empirical acceleration magnitudes.

Function for creating parameter settings object for arc-wise empirical acceleration magnitudes (arc-wise version of empirical_accelerations()). Using the empirical acceleration terms as estimatable parameters requires:

The body specified by the body parameter to undergo empirical() acceleration, which include constant (in RSW frame) terms

When using this parameter, whenever an empirical acceleration is required at a time \(t\), the index math:i in the arc_initial_times ordered list is found for which \(t_{i}\le t<t_{i+1}\) (or, if \(t\) is larger than the largest value in the list, \(i\) is set to be last index of the list), and the parameter values representing empirical acceleration components in arc \(i\) will be used.

Note

Parameters:

body (str) – Name of the body, with whose empirical acceleration model the estimatable parameter is associated.
centralBody (str) – Name of the central body of the empirical acceleration model (of which the gravitational parameter is extracted to compute the true anomaly, and w.r.t. which the RSW directions are determined). This body is the same as the body considered to be ‘exerting’ the empirical acceleration
acceleration_components (Dict[ EmpiricalAccelerationComponents, List[ EmpiricalAccelerationFunctionalShapes] ]) – Dictionary of components of the empirical acceleration which are to be estimated. There are two ‘degrees of freedom’ in these components: the direction of the acceleration (e.g. R, S or W direction) and the temporal signature (constant, sine of true anomaly or cosine of true anomaly). With this input, any subset may be selected. This parameter is a dictionary, with the key denoting the direction of the acceleration, and the value a list of the temporal signatures to estimate for this empirical acceleration direction.
arc_initial_times (List[ float ]) – List of times at which the arcs over which the empirical accelerations are to be estimated will start.

Returns:

Instance of EstimatableParameterSettings derived EmpiricalAccelerationEstimatableParameterSettings class for the specified body’s arc-wise empirical acceleration terms.

Return type:

EstimatableParameterSettings

constant_empirical_acceleration_terms(body: str, centralBody: str) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for constant empirical acceleration terms.

As empirical_accelerations(), but only using the constant R, S and W components (no sine or cosine term estimation). This function is added as a function of convenience

Parameters:

body (str) – Name of the body, with whose empirical acceleration model the estimatable parameter is associated.
centralBody (str) – Name of the central body of the empirical acceleration model (of which the gravitational parameter is extracted to compute the true anomaly, and w.r.t. which the RSW directions are determined). This body is the same as the body considered to be ‘exerting’ the empirical acceleration

Returns:

Instance of EstimatableParameterSettings derived EmpiricalAccelerationEstimatableParameterSettings class for the specified body’s empirical acceleration terms.

Return type:

EstimatableParameterSettings

full_empirical_acceleration_terms(body: str, centralBody: str) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for empirical acceleration magnitudes for all components.

As empirical_accelerations(), but using selecting all nine components. This function is added as a function of convenience

Parameters:

body (str) – Name of the body, with whose empirical acceleration model the estimatable parameter is associated.
centralBody (str) – Name of the central body of the empirical acceleration model (of which the gravitational parameter is extracted to compute the true anomaly, and w.r.t. which the RSW directions are determined). This body is the same as the body considered to be ‘exerting’ the empirical acceleration

Returns:

Instance of EstimatableParameterSettings derived EmpiricalAccelerationEstimatableParameterSettings class for the specified body’s empirical acceleration terms.

Return type:

EstimatableParameterSettings

arcwise_constant_empirical_acceleration_terms(body: str, centralBody: str, arc_start_times: list[float | SupportsIndex]) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for arc-wise constant empirical acceleration terms.

As arcwise_empirical_accelerations(), but only using the constant R, S and W components (no sine or cosine term estimation). This function is added as a function of convenience

Parameters:

body (str) – Name of the body, with whose empirical acceleration model the estimatable parameter is associated.
centralBody (str) – Name of the central body of the empirical acceleration model (of which the gravitational parameter is extracted to compute the true anomaly, and w.r.t. which the RSW directions are determined). This body is the same as the body considered to be ‘exerting’ the empirical acceleration
arc_initial_times (List[ float ]) – List of times at which the arcs over which the empirical accelerations are to be estimated will start.

Returns:

Instance of EstimatableParameterSettings derived EmpiricalAccelerationEstimatableParameterSettings class for the specified body’s arc-wise constant empirical acceleration terms.

Return type:

EstimatableParameterSettings

quasi_impulsive_shots(body: str) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for quasi-impulsive shots.

Function for creating parameter settings object for so-called ‘quasi-impulsive shots’, such as desaturation maneuvers. With this parameter, the total \(\Delta \mathbf{V}\) vector of a set of such maneuvers can be estimated (see quasi_impulsive_shots_acceleration() for mathematical details). Using the quasi-impulsive shots as an estimatable parameter requires:

The body specified by the body parameter to undergo quasi_impulsive_shots_acceleration() acceleration

Note

this parameter considers all shots/maneuvers used in the above acceleration model, and estimates the value of the ‘delta_v_values’ input of this acceleration.

Parameters:: body (str) – Name of the body, with which the quasi-impulsive shot estimatable parameter is associated.
Returns:: EstimatableParameterSettings object for the specified body’s quasi-impulsive shots
Return type:: EstimatableParameterSettings

gravitational_parameter(body: str) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for a massive body’s gravitational parameter.

Function for creating parameter settings object for the gravitational parameter of massive bodies. Using the gravitational parameter as estimatable parameter requires:

The body specified by the body parameter to be endowed with a gravity field (see gravity_field module for options)
Any dynamical or observational model to depend on the gravitational parameter of the body specified by the body parameter

Parameters:: body (str) – Name of the body, with whose gravitational model the estimatable parameter is associated.
Returns:: EstimatableParameterSettings object for the specified body’s gravitational parameter.
Return type:: EstimatableParameterSettings

spherical_harmonics_c_coefficients(body: str, minimum_degree: int | SupportsIndex, minimum_order: int | SupportsIndex, maximum_degree: int | SupportsIndex, maximum_order: int | SupportsIndex) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for the cosine coefficients of body’s spherical harmonics gravitational model.

Function for creating parameter settings object for the spherical harmonics cosine-coefficients (\(\bar{C}_{lm}\)) of a body with a spherical harmonic gravity field. Using this function, a ‘full’ set of spherical harmonic coefficients between an minimum/maximum degree/order are estimated. For instance, for minimum degree/order of 2/0, and maximum degree/order 4/4, all spherical harmonic cosine coefficients of degrees 2, 3 and 4 are estimated. If the maximum degree/order is set to 4/2, only coefficients with an order of 0, 1 and 2 are included. The entries in the parameter are sorted first by degree, and then by order (both in ascending order) Using the spherical harmonics cosine coefficients as estimatable parameter requires:

A spherical_harmonic() (or derived) gravity model to be defined for the body specified by the body parameter
Any dynamical or observational model to depend on the estimated cosine coefficients of the body specified by the body parameter. Typically, this dependency will be a spherical_harmonic() acceleration

Parameters:

body (str) – Name of the body, with whose gravitational model the estimatable parameters are associated.
minimum_degree (int) – Minimum degree of c-coefficients to be included.
minimum_order (int) – Minimum order of c-coefficients to be included.
maximum_degree (int) – Maximum degree of c-coefficients to be included.
maximum_order (int) – Maximum order of c-coefficients to be included.

Returns:

Instance of EstimatableParameterSettings derived SphericalHarmonicEstimatableParameterSettings class for the applicable spherical harmonics c-coefficients of the specified body’s gravitational model.

Return type:

EstimatableParameterSettings

spherical_harmonics_s_coefficients(body: str, minimum_degree: int | SupportsIndex, minimum_order: int | SupportsIndex, maximum_degree: int | SupportsIndex, maximum_order: int | SupportsIndex) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for the sine coefficients of body’s spherical harmonics gravitational model.

Function for creating parameter settings object for the spherical harmonics sine-coefficients (\(\bar{S}_{lm}\)) of a body with a spherical harmonic gravity field. Using this function, a ‘full’ set of spherical harmonic coefficients between an minimum/maximum degree/order are estimated. For instance, for minimum degree/order of 2/1 (there is no order 0 sine coefficient), and maximum degree/order 4/4, all spherical harmonic sine coefficients of degrees 2, 3 and 4 are estimated. If the maximum degree/order is set to 4/2, only coefficients with an order of 1 and 2 are included. The entries in the parameter are sorted first by degree, and then by order (both in ascending order) Using the spherical harmonics cosine coefficients as estimatable parameter requires:

A spherical_harmonic() (or derived) gravity model to be defined for the body specified by the body parameter
Any dynamical or observational model to depend on the estimated cosine coefficients of the body specified by the body parameter. Typically, this dependency will be a spherical_harmonic() acceleration

Parameters:

body (str) – Name of the body, with whose gravitational model the estimatable parameters are associated.
minimum_degree (int) – Minimum degree of s-coefficients to be included.
minimum_order (int) – Minimum order of s-coefficients to be included.
maximum_degree (int) – Maximum degree of s-coefficients to be included.
maximum_order (int) – Maximum order of s-coefficients to be included.

Returns:

Instance of EstimatableParameterSettings derived SphericalHarmonicEstimatableParameterSettings class for the applicable spherical harmonics s-coefficients of the specified body’s gravitational model.

Return type:

EstimatableParameterSettings

spherical_harmonics_c_coefficients_block(body: str, block_indices: list[tuple[int | SupportsIndex, int | SupportsIndex]]) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for the cosine coefficients of body’s spherical harmonics gravitational model.

As spherical_harmonics_c_coefficients, but with a manually defined set of coefficients.

Parameters:

body (str) – Name of the body, with whose gravitational model the estimatable parameters are associated.
block_indices (List[ tuple[int, int] ]) – List of block indices. The length of this list can be arbitrary, as long as the pairs are unique. For each pair, the first value is the degree and the second the order of the coefficient to be included.

Returns:

Return type:

EstimatableParameterSettings

spherical_harmonics_s_coefficients_block(body: str, block_indices: list[tuple[int | SupportsIndex, int | SupportsIndex]]) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for the sine coefficients of body’s spherical harmonics gravitational model.

As spherical_harmonics_s_coefficients, but with a manually defined set of coefficients.

Parameters:

body (str) – Name of the body, with whose gravitational model the estimatable parameters are associated.
block_indices (List[ tuple[int, int] ]) – List of block indices. The length of this list can be arbitrary, as long as the pairs are unique. For each pair, the first value is the degree and the second the order of the coefficient to be included.

Returns:

Return type:

EstimatableParameterSettings

yarkovsky_parameter(body_name: str, central_body_name: str = 'Sun') → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for Yarkovsky parameter.

Function for creating parameter settings for Yarkovsky acceleration parameter \(A_{2}\) (see yarkovsky()).

The body specified by the body parameter to undergo yarkovsky() acceleration with central_body_name as body exerting the acceleration

Parameters:: body (str) – Name of the body, with whose radiation pressure acceleration model the estimatable parameter is associated.
Returns:: EstimatableParameterSettings object for the specified body’s radiation pressure coefficient.
Return type:: EstimatableParameterSettings

constant_rotation_rate(body: str) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for a body’s constant rotation rate.

Function for creating parameter settings object for a body’s constant rotation rate parameter. Using the constant rotation rate as estimatable parameter requires:

A simple() or simple_from_spice() rotation model specified by the body parameter
Any dynamical or observational model to depend on the rotation model of the body specified by the body parameter

Parameters:: body (str) – Name of the body, with whose rotation model the estimatable parameter is associated.
Returns:: EstimatableParameterSettings object for the specified body’s constant spin rate.
Return type:: EstimatableParameterSettings

rotation_pole_position(body: str) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for a body’s rotation pole position.

Function for creating parameter settings object for a body’s rotation pole position, parameterized by the constant pole rotation angles (\(\alpha\) and \(\delta\)). Using the rotation pole position as estimatable parameter requires:

A simple() or simple_from_spice() rotation model specified by the body parameter
Any dynamical or observational model to depend on the rotation model of the body specified by the body parameter

Parameters:: body (str) – Name of the body, with whose rotation model the estimatable parameter is associated.
Returns:: EstimatableParameterSettings object for the specified body’s rotation pole position.
Return type:: EstimatableParameterSettings

order_invariant_k_love_number(deformed_body: str, degree: int | SupportsIndex, deforming_bodies: list[str], use_complex_love_number: bool = 0) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for a body’s \(k_{l}\) Love number.

Function for creating parameter settings for a body’s \(k_{l}\) Love number. When using this function, we assume (for the case of degree 2 Love number) that \(k_{20}=k_{21}=k_{22}\). The estimation of the Love number can be limited to a subset of the bodies that raise a tide on the body undergoing tidal deformation.

Using the \(k_{l}\) Love number as estimatable parameter requires:

A solid_body_tide() gravity field variation model in the deformed_body (or one the more complex ones such as solid_body_tide_degree_order_variable_k()). The parameter settings have to match the specifics of the variation model. For instance, if use_complex_love_number is set to true, the gravity field variation has to have been created using a complex Love number
Any dynamical model to depend on the gravity field of the body specified by the deformed_body parameter

Parameters:

deformed_body (str) – Name of the body that is undergoing tidal deformation
degree (int) – Degree \(l\) of the Love number \(k_{l}\) that is to be estimated
deforming_bodies (list[str]) – List of bodies that raise a tide on deformed_body for which the single Love number defined by this setting is to be used. If the list is left empty, all tide-raising bodies will be used. By using this parameter, the value of \(k_{l}\) will be identical for the tides raised by each body in this list once parameter values are reset, even if they were different upon environment initialization
use_complex_love_number (bool) – Boolean defining whether the estimated Love number is real or imaginary

Returns:

Object for the specified body’s Love number \(k_{l}\) for the tides raised by the specified bodies

Return type:

EstimatableParameterSettings

order_varying_k_love_number(deformed_body: str, degree: int | SupportsIndex, orders: list[int | SupportsIndex], deforming_bodies: list[str], use_complex_love_number: bool) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for a body’s \(k_{lm}\) Love numbers.

Function for creating parameter settings for a body’s \(k_{lm}\) Love numbers. When using this function, we assume (for the case of degree 2 Love number) that \(k_{20}\neq k_{21}\neq k_{22}\). The estimation of the Love numbers can be limited to a subset of the bodies that raise a tide on the body undergoing tidal deformation.

Using the \(k_{lm}\) Love number as estimatable parameter requires:

A solid_body_tide_degree_order_variable_k() gravity field variation model in the deformed_body (or solid_body_tide_degree_order_variable_complex_k() if use_complex_love_number is set to true)
Any dynamical model to depend on the gravity field of the body specified by the deformed_body parameter

Parameters:

deformed_body (str) – Name of the body that is undergoing tidal deformation
degree (list[int]) – Degree \(l\) of the Love numbers \(k_{lm}\) that are to be estimated
degree – Orders \(m\) of the Love numbers \(k_{lm}\) that are to be estimated
deforming_bodies (list[str]) – List of bodies that raise a tide on deformed_body for which the Love numbers defined by this setting is to be used. If the list is left empty, all tide-raising bodies will be used. By using this parameter, the values of \(k_{lm}\) will be identical for the tides raised by each body in this list once parameter values are reset, even if they were different upon environment initialization
use_complex_love_number (bool) – Boolean defining whether the estimated Love number is real or imaginary

Returns:

Object for the specified body’s Love numbers \(k_{lm}\) for the tides raised by the specified bodies

Return type:

EstimatableParameterSettings

mode_coupled_k_love_numbers(deformed_body: str, love_number_indices: dict[tuple[int | SupportsIndex, int | SupportsIndex], list[tuple[int | SupportsIndex, int | SupportsIndex]]], deforming_bodies: list[str]) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for a body’s mode-coupled \(k_{lm}^{l'm'}\) Love numbers.

Function for creating parameter settings for a body’s \(k_{lm}^{l'm'}\) Love numbers (see mode_coupled_solid_body_tide model() details). The estimation of the Love numbers can be limited to a subset of the bodies that raise a (mode-coupled) tide on the body undergoing tidal deformation.

Using the \(k_{lm}\) Love number as estimatable parameter requires:

A mode_coupled_solid_body_tide() gravity field variation model in the deformed_body.
Any dynamical model to depend on the gravity field of the body specified by the deformed_body parameter

Parameters:

deformed_body (str) – Name of the body that is undergoing tidal deformation
love_number_per_degree (dict[tuple[int, int], list[int,int]]]) – Dictionary of Love number indices for each combination for forcing and response degree and order. The first tuple (key) is the forcing degree and order \(l,m\), the list of tuples (key) is the list of associated response degrees and orders \(l',m'\) for which the Love numbers are to be estimated (see mode_coupled_solid_body_tide() for mathematical definition))
deforming_bodies (list[str]) – List of bodies that raise a tide on deformed_body for which the Love numbers defined by this setting is to be used. If the list is left empty, all tide-raising bodies will be used. By using this parameter, the values of \(k_{lm}\) will be identical for the tides raised by each body in this list once parameter values are reset, even if they were different upon environment initialization

Returns:

Object for the specified body’s mode-coupled Love numbers \(k_{lm}^{l'm'}\) for the tides raised by the specified bodies

Return type:

EstimatableParameterSettings

polynomial_gravity_field_variation_amplitudes(body_name: str, cosine_indices_per_power: dict[int | SupportsIndex, list[tuple[int | SupportsIndex, int | SupportsIndex]]], sine_indices_per_power: dict[int | SupportsIndex, list[tuple[int | SupportsIndex, int | SupportsIndex]]]) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for a body’s polynomial gravity field amplitudes.

Function for creating parameter settings for a body’s polynomial gravity field amplitudes \(K_{i,\bar{C}_{lm}}\) and \(K_{i,\bar{S}_{lm}}\), as defined in polynomial().

Using this settings as estimatable parameter requires:

A polynomial() (or single_power_polynomial()) gravity field variation model in the body_name.
Any dynamical model to depend on the gravity field of the body specified by the deformed_body parameter

When using this parameter, a subset of all the variation amplitudes defined in the gravity field variation model can be estimated. These are defined in the cosine_indices_per_power and sine_indices_per_power inputs

Parameters:

body_name (str) – Name of the body that is undergoing gravity field variation
cosine_indices_per_power (dict[int, list[int,int]]) – Dictionary of powers \(i\) (as keys) with list of combinations of degrees \(l\) and orders \(m\) for which to estimate \(K_{i,\bar{C}_{lm}}\) as values (see polynomial() for mathematical definition)
sine_indices_per_power (dict[int, list[int,int]]) – Dictionary of powers \(i\) (as keys) with list of combinations of degrees \(l\) and orders \(m\) for which to estimate \(K_{i,\bar{S}_{lm}}\) as values (see polynomial() for mathematical definition)

Returns:

Object for the specified body’s polynomial gravity field variations

Return type:

EstimatableParameterSettings

periodic_gravity_field_variation_amplitudes(body_name: str, cosine_indices_per_period: dict[int | SupportsIndex, list[tuple[int | SupportsIndex, int | SupportsIndex]]], sine_indices_per_period: dict[int | SupportsIndex, list[tuple[int | SupportsIndex, int | SupportsIndex]]]) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for a body’s polynomial gravity field variation amplitudes

Function for creating parameter settings for a body’s polynomial gravity field variation amplitudes \(A_{i,\bar{C}_{lm}}\), \(B_{i,\bar{C}_{lm}}\), \(A_{i,\bar{S}_{lm}}\) and \(B_{i,\bar{S}_{lm}}\) as defined in single_period_periodic().

Using this settings as estimatable parameter requires:

A periodic() (or single_period_periodic()) gravity field variation model in the body_name.
Any dynamical model to depend on the gravity field of the body specified by the deformed_body parameter

Parameters:

body_name (str) – Name of the body that is undergoing gravity field variation
cosine_indices_per_period (dict[int, list[int,int]]) – Dictionary of frequency index \(i\) (as keys; corresponding to frequency \(f_{i}\)) with list of combinations of degrees \(l\) and orders \(m\) for which to estimate \(A_{i,\bar{C}_{lm}}\) and \(B_{i,\bar{C}_{lm}}\) as values (see periodic() for mathematical definition)
sine_indices_per_period (dict[int, list[int,int]]) – Dictionary of frequency index \(i\) (as keys; corresponding to frequency \(f_{i}\)) with list of combinations of degrees \(l\) and orders \(m\) for which to estimate \(A_{i,\bar{S}_{lm}}\) and \(B_{i,\bar{S}_{lm}}\) as values (see periodic() for mathematical definition)

Returns:

Object for the specified body’s periodic gravity field variations

Return type:

EstimatableParameterSettings

monomial_gravity_field_variation_amplitudes(body_name: str, power: int | SupportsIndex, cosine_indices: list[tuple[int | SupportsIndex, int | SupportsIndex]], sine_indices: list[tuple[int | SupportsIndex, int | SupportsIndex]]) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for a body’s polynomial gravity field amplitudes at a single power.

Identical to polynomial(), but for only a single power.

Parameters:

body_name (str) – Name of the body that is undergoing gravity field variation
power (int) – Power \(i\) for which to estimate polynomial gravity field variations
cosine_indices (list[int,int]) – List of combinations of degrees \(l\) and orders \(m\) for which to estimate \(K_{i,\bar{C}_{lm}}\) (see polynomial() for mathematical definition)
sine_indices (list[int,int]) – List of combinations of degrees \(l\) and orders \(m\) for which to estimate \(K_{i,\bar{S}_{lm}}\) (see polynomial() for mathematical definition)

Returns:

Object for the specified body’s polynomial gravity field variations

Return type:

EstimatableParameterSettings

monomial_full_block_gravity_field_variation_amplitudes(body_name: str, power: int | SupportsIndex, minimum_degree: int | SupportsIndex, minimum_order: int | SupportsIndex, maximum_degree: int | SupportsIndex, maximum_order: int | SupportsIndex) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for a body’s polynomial gravity field amplitudes at a single power.

Identical to polynomial(), but for only a single power, and a full block of spherical harmonic coefficient degrees \(l\) and orders :math`m` For each degree \(l_{\text{min}}\le l \le l_{\text{max}}\), variations are estimated for all orders \(m_{\text{min}}\le m \le \left( \text{min}(m_{\text{max}},l) \right)\)

Parameters:

body_name (str) – Name of the body that is undergoing gravity field variation
power (int) – Power \(i\) for which to estimate polynomial gravity field variations
minimum_degree (int) – Minimum degree \(l_{\text{min}}\) for which \(K_{i,\bar{C}_{lm}}\) and \(K_{i,\bar{S}_{lm}}\) are to be estimated (see polynomial() for mathematical definition)
minimum_order (int) – Minimum order \(m_{\text{min}}\) for which \(K_{i,\bar{C}_{lm}}\) and \(K_{i,\bar{S}_{lm}}\) are to be estimated (see polynomial() for mathematical definition)
maximum_degree (int) – Maximum degree \(l_{\text{max}}\) for which \(K_{i,\bar{C}_{lm}}\) and \(K_{i,\bar{S}_{lm}}\) are to be estimated (see polynomial() for mathematical definition)
maximum_order (int) – Maximum degree \(m_{\text{max}}\) for which \(K_{i,\bar{C}_{lm}}\) and \(K_{i,\bar{S}_{lm}}\) are to be estimated (see polynomial() for mathematical definition)

Returns:

Object for the specified body’s polynomial gravity field variations

Return type:

EstimatableParameterSettings

direct_tidal_dissipation_time_lag(*args, **kwargs)¶

Overloaded function.

Overload 1: direct_tidal_dissipation_time_lag(body: str, deforming_body: str) -> tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings

No documentation found.

Overload 2: direct_tidal_dissipation_time_lag(body: str, deforming_body: collections.abc.Sequence[str]) -> tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings

No documentation found.

inverse_tidal_quality_factor(*args, **kwargs)¶

Overloaded function.

Overload 1: inverse_tidal_quality_factor(body: str, deforming_body: str) -> tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings

No documentation found.

Overload 2: inverse_tidal_quality_factor(body: str, deforming_body: collections.abc.Sequence[str]) -> tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings

No documentation found.

mean_moment_of_inertia(body: str) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for a body’s mean moment of inertia.

Function for creating parameter settings object for a body’s mean moment of inertia. In most cases, the mean moment of inertia will not influence the dynamics/observation directly and sensitivity to this parameter will not be included. The dynamics/observation will be sensitive to this parameter if the rotational dynamics of a relevant body is estimated. Using the mean moment of inertia as estimatable parameter requires:

The estimation of an initial rotational state of the body specified by the body parameter

Parameters:: body (str) – Name of the body, with whose body model the estimatable parameter is associated.
Returns:: EstimatableParameterSettings object for the specified body’s mean moment of inertia.
Return type:: EstimatableParameterSettings

periodic_spin_variations(body: str) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for a body’s periodic spin variations.

Function for creating parameter settings object for a body’s periodic spin variation parameters. Using the mean moment of inertia as estimatable parameter requires:

A mars_high_accuracy() rotation model specified by the body parameter
Any dynamical or observational model to depend on the rotation model of the body specified by the body parameter

Parameters:: body (str) – Name of the body, with whose rotation model the estimatable parameter is associated.
Returns:: EstimatableParameterSettings object for the specified body’s periodic spin variations.
Return type:: EstimatableParameterSettings

polar_motion_amplitudes(body: str) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for a body’s polar motion amplitudes.

Function for creating parameter settings object for a body’s polar motion amplitudes. Using the polar motion amplitudes as estimatable parameter requires

A mars_high_accuracy() rotation model specified by the body parameter
Any dynamical or observational model to depend on the rotation model of the body specified by the body parameter

Parameters:: body (str) – Name of the body, with whose rotation model the estimatable parameter is associated.
Returns:: EstimatableParameterSettings object for the specified body’s polar motion amplitudes.
Return type:: EstimatableParameterSettings

scaled_longitude_libration_amplitude(body_name: str) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶: No documentation found.

core_factor(body: str) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for a body’s core factor.

Function for creating parameter settings object for a body’s core factor. Using the core factor as estimatable parameter requires

A mars_high_accuracy() rotation model specified by the body parameter
Any dynamical or observational model to depend on the rotation model of the body specified by the body parameter

Parameters:: body (str) – Name of the body, with whose rotation model the estimatable parameter is associated.
Returns:: EstimatableParameterSettings object for the specified body’s core factor.
Return type:: EstimatableParameterSettings

free_core_nutation_rate(body: str) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for a body’s free core nutation rate.

Function for creating parameter settings object for a body’s free core nutation rate. Using the free core nutation rate as estimatable parameter requires

A mars_high_accuracy() rotation model specified by the body parameter
Any dynamical or observational model to depend on the rotation model of the body specified by the body parameter

Parameters:: body (str) – Name of the body, with whose rotation model the estimatable parameter is associated.
Returns:: EstimatableParameterSettings object for the specified body’s free core nutation rate.
Return type:: EstimatableParameterSettings

absolute_observation_bias(link_ends: tudat::observation_models::LinkDefinition, observable_type: tudat::observation_models::ObservableType) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for an absolute observation bias.

Function for creating parameter settings object for an observation’s absolute bias parameter. Using the absolute observation bias as estimatable parameter requires:

The observation model (corresponding to the link_ends and observable_type) to include an absolute bias (absolute_bias())

Parameters:

link_ends (Dict[LinkEndType, tuple[str, str]) – Set of link ends that define the geometry of the biased observations.
observable_type (ObservableType) – Observable type of the biased observations.

Returns:

Instance of the EstimatableParameterSettings derived ConstantObservationBiasEstimatableParameterSettings for the specified observation’s arc-wise absolute bias.

Return type:

EstimatableParameterSettings

relative_observation_bias(link_ends: tudat::observation_models::LinkDefinition, observable_type: tudat::observation_models::ObservableType) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for an relative observation bias.

Function for creating parameter settings object for an observation’s relative bias parameter. Using the relative observation bias as estimatable parameter requires

The observation model (corresponding to the link_ends and observable_type) to include a relative bias (relative_bias())

Parameters:

link_ends (Dict[LinkEndType, tuple[str, str]) – Set of link ends that define the geometry of the biased observations.
observable_type (ObservableType) – Observable type of the biased observations.

Returns:

Instance of the EstimatableParameterSettings derived ConstantObservationBiasEstimatableParameterSettings for the specified observation’s arc-wise relative bias.

Return type:

EstimatableParameterSettings

arcwise_absolute_observation_bias(link_ends: tudat::observation_models::LinkDefinition, observable_type: tudat::observation_models::ObservableType, arc_start_times: list[float | typing.SupportsIndex], time_link_end: tudat::observation_models::LinkEndType) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for arc-wise absolute observation bias.

Function for creating parameter settings object for the arc-wise treatment of an observation’s absolute bias parameter. Using the arc-wise absolute observation bias as estimatable parameter requires

The observation model (corresponding to the link_ends and observable_type) to include an arc-wise absolute bias (arcwise_absolute_bias())

Parameters:

link_ends (Dict[LinkEndType, tuple[str, str]) – Set of link ends that define the geometry of the biased observations.
observable_type (ObservableType) – Observable type of the biased observations.
arc_start_times (List[ float ]) – List of times at which the arcs over which the bias is to be estimated will start.
time_link_end (LinkEndType) – The link end type (transmitter, receiver, etc.) at which the arc_start_times is evaluated.

Returns:

Instance of the EstimatableParameterSettings derived ArcWiseConstantObservationBiasEstimatableParameterSettings for the specified observation’s arc-wise absolute bias.

Return type:

EstimatableParameterSettings

arcwise_relative_observation_bias(link_ends: tudat::observation_models::LinkDefinition, observable_type: tudat::observation_models::ObservableType, arc_start_times: list[float | typing.SupportsIndex], time_link_end: tudat::observation_models::LinkEndType) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for arc-wise absolute observation bias.

Function for creating parameter settings object for the arc-wise treatment of an observation’s relative bias parameter. Using the arc-wise relative observation bias as estimatable parameter requires

The observation model (corresponding to the link_ends and observable_type) to include an arc-wise relative bias (arcwise_relative_bias())

Note

This parameter may be estimated for a single-arc propagation, or a multi-arc propagation. In the latter case, the arcs selected for the estimation of the bias may, but need not, correspond to the arcs used for a multi-arc propagation.

Parameters:

link_ends (Dict[LinkEndType, tuple[str, str]) – Set of link ends that define the geometry of the biased observations.
observable_type (ObservableType) – Observable type of the biased observations.
arc_start_times (List[ float ]) – List of times at which the arcs over which the bias is to be estimated will start.
time_link_end (LinkEndType) – The link end type (transmitter, receiver, etc.) at which the arc_start_times is evaluated.

Returns:

Instance of the EstimatableParameterSettings derived ArcWiseConstantObservationBiasEstimatableParameterSettings for the specified observation’s arc-wise relative bias.

Return type:

EstimatableParameterSettings

ground_station_position(body: str, ground_station_name: str) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for ground station position bias.

Function for creating parameter settings object for a ground station’s body-fixed Cartesian position. Using the ground station position bias as estimatable parameter requires:

At least one observation model to rely on the specified ground station

Parameters:

body (str) – Body name identifying the body, with which the ground station is associated.
ground_station_name (str) – Name which identifies the position-biased ground station.

Returns:

EstimatableParameterSettings object for the specified ground station’s position bias.

Return type:

EstimatableParameterSettings

reference_point_position(body: str, reference_point_name: str) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶: No documentation found.

ppn_parameter_gamma() → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for post-newtonian gamma parameter.

Function for creating parameter settings object for a global PPN \(\gamma\) parameter. Using the post-newtonian gamma parameter as estimatable parameter requires at least one of the following:

An acceleration model depending on this parameter, such as relativistic_correction()
An observation model with a light-time correction depending on this parameter, such as first_order_relativistic_light_time_correction()

Returns:: EstimatableParameterSettings object for a global post-newtonian \(\gamma\) parameter.
Return type:: EstimatableParameterSettings

ppn_parameter_beta() → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for post-newtonian beta parameter.

Function for creating parameter settings object for a global PPN \(\beta\) parameter. Using the post-newtonian gamma parameter as estimatable parameter requires at least one of the following:

An acceleration model depending on this parameter, such as relativistic_correction()
An observation model with a light-time correction depending on this parameter (none yet implemented)

Returns:: EstimatableParameterSettings object for a global post-newtonian \(\beta\) parameter.
Return type:: EstimatableParameterSettings

global_polynomial_clock_corrections(associated_body: str, associated_station: str, correction_powers: list[int | SupportsIndex]) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

arc_wise_polynomial_clock_corrections(associated_body: str, associated_station: str, correction_powers: list[int | SupportsIndex], arc_indices: list[int | SupportsIndex]) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

time_drift_observation_bias(link_ends: dict[tudat::observation_models::LinkEndType, tudat::observation_models::LinkEndId], observable_type: tudat::observation_models::ObservableType, ref_epoch: float | typing.SupportsIndex, time_link_end: tudat::observation_models::LinkEndType) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

arcwise_time_drift_observation_bias(link_ends: dict[tudat::observation_models::LinkEndType, tudat::observation_models::LinkEndId], observable_type: tudat::observation_models::ObservableType, arc_start_times: list[float | typing.SupportsIndex], ref_epochs: list[float | typing.SupportsIndex], time_link_end: tudat::observation_models::LinkEndType) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

constant_time_bias(link_ends: dict[tudat::observation_models::LinkEndType, tudat::observation_models::LinkEndId], observable_type: tudat::observation_models::ObservableType, reference_link_end: tudat::observation_models::LinkEndType) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

arcwise_time_bias(link_ends: dict[tudat::observation_models::LinkEndType, tudat::observation_models::LinkEndId], observable_type: tudat::observation_models::ObservableType, arc_start_times: list[float | typing.SupportsIndex], reference_link_end: tudat::observation_models::LinkEndType) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

custom_parameter(custom_id: str, parameter_size: int | SupportsIndex, get_parameter_function: Callable[[], numpy.ndarray[numpy.float64[m, 1]]], set_parameter_function: Callable[[numpy.ndarray[numpy.float64[m, 1]]], None]) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶: No documentation found.

custom_analytical_partial(analytical_partial_function: Callable[[float | SupportsIndex, numpy.ndarray[numpy.float64[3, 1]]], numpy.ndarray[numpy.float64[m, n]]], body_undergoing_acceleration: str, body_exerting_acceleration: str, acceleration_type: tudatpy.kernel.dynamics.propagation_setup.acceleration.AvailableAcceleration) → tudatpy.kernel.dynamics.parameters_setup.CustomAccelerationPartialSettings¶: No documentation found.

custom_numerical_partial(parameter_perturbation: numpy.ndarray[numpy.float64[m, 1]], body_undergoing_acceleration: str, body_exerting_acceleration: str, acceleration_type: tudatpy.kernel.dynamics.propagation_setup.acceleration.AvailableAcceleration, environment_updates: dict[tudat::propagators::EnvironmentModelsToUpdate, list[str]] = {}) → tudatpy.kernel.dynamics.parameters_setup.CustomAccelerationPartialSettings¶: No documentation found.

arcwise_drag_component_scaling(body: str, arc_initial_times: list[float | SupportsIndex]) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for arc-wise aerodynamic drag scaling factor

Function for creating parameter settings object for an arcwise scaling factor \(K\) (initialized to 1.0) for the aerodynamic force along the drag direction (effectively scaling the drag coefficient \(C_{D}\) (see aerodynamic() )

Using the arc-wise drag component scaling as an estimatable parameter requires:

The body specified by the body parameter to undergo aerodynamic() acceleration

Parameters:

body (str) – Name of the body, with whose aerodynamic acceleration model the estimatable parameter is associated.
arc_initial_times (List[ float ]) – Ordered list of starting times over which the component scaling parameters are to be applied.

Returns:

Instance of ArcWiseEstimatableParameterSettings class that define the settings.

Return type:

ArcWiseEstimatableParameterSettings

arcwise_exponential_atmosphere_base_density(body_name: str, arc_start_times: list[float | SupportsIndex]) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶: Environment model parameter associated with the exponential atmosphere model of given body. This parameter allows for arc-wise estimation of the base density in an exponential atmosphere model of the given body.

arcwise_exponential_atmosphere_scale_height(body_name: str, arc_start_times: list[float | SupportsIndex]) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶: Environment model parameter associated with the exponential atmosphere model of given body. This parameter allows for arc-wise estimation of the scale height in an exponential atmosphere model of the given body.

arcwise_lift_component_scaling(body: str, arc_initial_times: list[float | SupportsIndex]) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for arc-wise aerodynamic lift force scaling factor

As arcwise_drag_component_scaling(), but scales the force along the \(C_{L}\) direction rather than the \(C_{D}\) direction

Parameters:

body (str) – Name of the body, with whose aerodynamic acceleration model the estimatable parameter is associated.
arc_initial_times (List[ float ]) – Ordered list of starting times over which the component scaling parameters are to be applied.

Returns:

Instance of ArcWiseEstimatableParameterSettings class that define the settings.

Return type:

ArcWiseEstimatableParameterSettings

arcwise_side_component_scaling(body: str, arc_initial_times: list[float | SupportsIndex]) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for arc-wise aerodynamic side force scaling factor

As arcwise_drag_component_scaling(), but scales the force along the \(C_{S}\) direction rather than the \(C_{D}\) direction

Parameters:

body (str) – Name of the body, with whose aerodynamic acceleration model the estimatable parameter is associated.
arc_initial_times (List[ float ]) – Ordered list of starting times over which the component scaling parameters are to be applied.

Returns:

Instance of ArcWiseEstimatableParameterSettings class that define the settings.

Return type:

ArcWiseEstimatableParameterSettings

area_to_mass_ratio_scaling_parameter(body_name: str) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for a scaling factor for a body’s area to mass ratio(s)

Using these parameter settings, a scaling factor for the all acceleration models that contain an area-to-mass scaling factor \(A/m\), specifically radiation pressure or aerodynamics. Upon initialization, the value of this parameter \(p\) is equal to 1. When using it, it effectively scales the acceleration formulation such that \(A/m\rightarrow p(A/m)\). Estimating an area-to-mass ratio is typical in, for instance, orbit estimation of near-Earth space debris.

However, since the mass of a body is not (necessarily) a constant, and the reference area of a body is not (necessarily) related to a physical surface area, so we have opted to implement an \(A/m\) scaling factor as parameter instead. This scaling factor applies to both aerodynamics and radiation pressure, regardless of whether their reference areas are identical. It is also by definition comaptible with an object of varying mass.

Using this settings as estimatable parameter requires:

The acceleration models of body body_name to include one or more accelerations that contains an area to mass ratio \(A/m\) in its formulation, either aerodynamic() or radiation_pressure(). Each such acceleration will be scaled (multiplied) by the value of the parameter during the propagation

Parameters:: body_undergoing_acceleration (str) – Name of the body for which the area-to-mass scaling factor is applied
Returns:: Instance of the EstimatableParameterSettings class for the specified scaling factor
Return type:: EstimatableParameterSettings

exponential_atmosphere_base_density(body_name: str) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶: Environment model parameter associated with the exponential atmosphere model of given body. This parameter allows for estimation of the base density in an exponential atmosphere model of the given body.

exponential_atmosphere_scale_height(body_name: str) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶: Environment model parameter associated with the exponential atmosphere model of given body. This parameter allows for estimation of the scale height in an exponential atmosphere model of the given body.

full_acceleration_scaling_parameter(body_name_undergoing_acceleration: str, body_name_exerting_acceleration: str, acceleration_type: tudatpy.kernel.dynamics.propagation_setup.acceleration.AvailableAcceleration) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for a scaling factor for a single acceleration acting on a body

Using these parameter settings, a scaling factor \(p\) is applied to a single acceleration \(\mathbf{a}\), increasing or decreasing it according to the value of the parameter \(p\) as \(\mathbf{a}\rightarrow p\mathbf{a}\). This parameter is typically used in an estimation to absorb a (constant scaling) mismodelling in a single acceleration. The value of \(p\) is initialized to 1 upon parameter creation

Using this settings as estimatable parameter requires:

The body body_undergoing_acceleration undergoing an acceleration of exerted by body_exerting_acceleration of type acceleration_type

Parameters:

body_undergoing_acceleration (str) – Name of the body undergoing the acceleration
body_exerting_acceleration (str) – Name of the body exerting the acceleration
acceleration_type (AvailableAcceleration) – Type of exerted acceleration

Returns:

Instance of the EstimatableParameterSettings class for the specified scaling factor

Return type:

EstimatableParameterSettings

iau_rotation_model_longitudinal_librations(body: str, libration_angular_frequencies: list[float | SupportsIndex]) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for a body’s longitudinal libration amplitudes in an IAU rotation model

Function for creating parameter settings for a body’s longitudinal libration amplitudes in an IAU rotation model Using this requires:

A iau_rotation_model() rotation model specified by the body parameter
Any dynamical or observational model to depend on the rotation model of the body specified by the body parameter

This parameter estimates a list of \(W_{i}\) variables of the iau_rotation_model() rotation model. The values of \(i\) for which \(W_{i}\) is estimated is defined by the libration_angular_frequencies input, which defines the corresponding \(\omega_{W_i}\) values for which the librations are to be estimated. Note that the parameters are ordered as in the libration_angular_frequencies vector.

Parameters:

body (str) – Name of the body, with whose rotation model the estimatable parameter is associated.
libration_angular_frequencies (List[ float ]) – List of angular frequencies (\(\omega_{W_i}\)) at which longitudinal libration amplitudes (\(W_{i}\)) are to be included in estimatable parameter.

Returns:

EstimatableParameterSettings object for the specified body’s property

Return type:

EstimatableParameterSettings

iau_rotation_model_pole(body: str) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for a body’s nominal pole position in an IAU rotation model

Function for creating parameter settings for a body’s nominal pole position in an IAU rotation model Using this requires:

A iau_rotation_model() rotation model specified by the body parameter
Any dynamical or observational model to depend on the rotation model of the body specified by the body parameter

This parameter estimates the \([\alpha_{0},\delta_{0}]\) variables of the iau_rotation_model() rotation model

Parameters:: body (str) – Name of the body, with whose rotation model the estimatable parameter is associated.
Returns:: EstimatableParameterSettings object for the specified body’s property
Return type:: EstimatableParameterSettings

iau_rotation_model_pole_librations(body: str, libration_angular_frequencies: list[float | SupportsIndex]) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for a body’s pole libration amplitudes in an IAU rotation model

Function for creating parameter settings for a body’s pole libration amplitudes in an IAU rotation model Using this requires:

A iau_rotation_model() rotation model specified by the body parameter
Any dynamical or observational model to depend on the rotation model of the body specified by the body parameter

This parameter estimates the libration amplitude \(\alpha_{i}\) and \(\delta_{i}\) variables of the iau_rotation_model() rotation model. The values of \(i\) for which the amplitudes is estimated is defined by the libration_angular_frequencies input, which defines the corresponding \(\omega_{alpha_i}\) (\(=\omega_{\delta_i}\)) values for which the amplitudes are to be estimated. Note that the parameters are ordered [\(\alpha_{i}\), \(\delta_{i}\), \(\alpha_{i+1}\), \(\alpha_{i+1}\), …], where the index \(i\) follows the order of the frequency terms provided in the libration_angular_frequencies input argument.

Parameters:

body (str) – Name of the body, with whose rotation model the estimatable parameter is associated.
libration_angular_frequencies (List[ float ]) – List of angular frequencies (\(\omega_{alpha_i}\) (\(=\omega_{\delta_i}\))) at which pole libration amplitudes (\(\alpha_{i}\), \(\delta_{i}\)) are to be included in estimatable parameter.

Returns:

EstimatableParameterSettings object for the specified body’s property

Return type:

EstimatableParameterSettings

iau_rotation_model_pole_rate(body: str) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶

Function for creating parameter settings for a body’s pole precession rate in an IAU rotation model

Function for creating parameter settings for a body’s pole precession rate in an IAU rotation model Using this requires:

A iau_rotation_model() rotation model specified by the body parameter
Any dynamical or observational model to depend on the rotation model of the body specified by the body parameter

This parameter estimates the \([\dot{\alpha},\dot{\delta}]\) variables of the iau_rotation_model() rotation model

Parameters:: body (str) – Name of the body, with whose rotation model the estimatable parameter is associated.
Returns:: EstimatableParameterSettings object for the specified body’s property
Return type:: EstimatableParameterSettings

rtg_force_vector(body_name: str) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶: Force model parameter associated with the RTG radiation acceleration. This parameter allows for estimation of RTG force direction (in body-fixed frame) and magnitude at the acceleration model reference epoch.

rtg_force_vector_magnitude(body_name: str) → tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings¶: Force model parameter associated with the RTG radiation acceleration. This parameter allows for estimation of RTG force magnitude at the acceleration model reference epoch.

Enumerations¶

`EstimatableParameterTypes`	Enumeration of model parameters that are available for estimation.
`EmpiricalAccelerationComponents`	Enumeration of the available empirical acceleration components that are available to estimate.
`EmpiricalAccelerationFunctionalShapes`	Enumeration of the available empirical acceleration shapes that are available per component

class EstimatableParameterTypes¶

Bases: pybind11_object

Enumeration of model parameters that are available for estimation. In order to establish a parameter estimation settings for a parameter of a certain type, use the function dedicated to this parameter type. Note that not all of the listed types might be accessible via functions in the python interface yet.

Members:

arc_wise_initial_body_state_type

initial_body_state_type

initial_rotational_body_state_type

gravitational_parameter_type

constant_drag_coefficient_type

radiation_pressure_coefficient_type

arc_wise_radiation_pressure_coefficient_type

spherical_harmonics_cosine_coefficient_block_type

spherical_harmonics_sine_coefficient_block_type

constant_rotation_rate_type

rotation_pole_position_type

constant_additive_observation_bias_type

arcwise_constant_additive_observation_bias_type

constant_relative_observation_bias_type

arcwise_constant_relative_observation_bias_type

ppn_parameter_gamma_type

ppn_parameter_beta_type

ground_station_position_type

equivalence_principle_lpi_violation_parameter_type

empirical_acceleration_coefficients_type

arc_wise_empirical_acceleration_coefficients_type

full_degree_tidal_love_number_type

single_degree_variable_tidal_love_number_type

direct_dissipation_tidal_time_lag_type

mean_moment_of_inertia_type

arc_wise_constant_drag_coefficient_type

periodic_spin_variation_type

polar_motion_amplitude_type

core_factor_type

free_core_nutation_rate_type

desaturation_delta_v_values_type

constant_time_drift_observation_bias_type

arc_wise_time_drift_observation_bias_type

global_polynomial_clock_corrections_type

arc_wise_polynomial_clock_corrections_type

inverse_tidal_quality_factor_type

radiation_pressure_target_perpendicular_direction_scaling_factor_type

radiation_pressure_target_direction_scaling_factor_type

drag_component_scaling_factor_type

side_component_scaling_factor_type

lift_component_scaling_factor_type

arc_wise_drag_component_scaling_factor_type

arc_wise_side_component_scaling_factor_type

arc_wise_lift_component_scaling_factor_type

rtg_force_vector_type

rtg_force_vector_magnitude_type

exponential_atmosphere_base_density_type

exponential_atmosphere_scale_height_type

arc_wise_exponential_atmosphere_base_density_type

arc_wise_exponential_atmosphere_scale_height_type

EstimatableParameterTypes.name -> str

class EmpiricalAccelerationComponents¶

Bases: pybind11_object

Enumeration of the available empirical acceleration components that are available to estimate.

These are used in the empirical_accelerations() function to specify which components of the empirical acceleration are to be estimated.

Members:

radial_empirical_acceleration_component

along_track_empirical_acceleration_component

across_track_empirical_acceleration_component

EmpiricalAccelerationComponents.name -> str

class EmpiricalAccelerationFunctionalShapes¶

Bases: pybind11_object

Enumeration of the available empirical acceleration shapes that are available per component

These are used in the empirical_accelerations() function to specify the signature of the estimated empirical acceleration component. .

Members:

constant_empirical

sine_empirical

cosine_empirical

EmpiricalAccelerationFunctionalShapes.name -> str

Classes¶

`EstimatableParameterSettings`	Base class to defining settings of parameter to be estimated.
`CustomAccelerationPartialSettings`	No documentation found.

class EstimatableParameterSettings¶

Bases: pybind11_object

Base class to defining settings of parameter to be estimated.

Functional (base) class for settings of model parameter to be estimated. Settings of simple parameters types are managed via this class, more complex parameter types are handled by specialised derivatives of this class. Instances of either base or derived class can be created via dedicated functions.

property parameter_identifier¶

Type and associated body of the parameter.

The identifier contains the type of the parameter, defined by the EstimatableParameterTypes enumeration, the body and (if applicable) the reference point to which the parameter is associated. The identifier is represented by a tuple of the form (parameter_type, (body_name, reference_point_name)).

Type:: tuple[ EstimatableParameterTypes, tuple[str, str] ]

class CustomAccelerationPartialSettings¶

Bases: pybind11_object

No documentation found.

parameters_setup¶

Functions¶

Enumerations¶

Classes¶

`parameters_setup`¶