ancillary_settings¶

Functions¶

doppler_ancilliary_settings([integration_time])

Function for creating ancilliary settings for averaged Doppler observable.

two_way_range_ancilliary_settings([...])

Function for creating ancilliary settings for two-way range observable.

two_way_doppler_ancilliary_settings([...])

Function for creating ancilliary settings for two-way averaged Doppler observable.

n_way_range_ancilliary_settings(...)

Function for creating ancilliary settings for n-way range observable.

n_way_doppler_ancilliary_settings(...)

Function for creating ancilliary settings for n-way averaged Doppler observable.

dsn_n_way_range_ancilliary_settings(...)

No documentation found.

dsn_n_way_doppler_ancilliary_settings(...)

No documentation found.

doppler_measured_frequency_ancillary_settings(...)

No documentation found.

add_ancilliary_settings_to_observable(...)

No documentation found.

add_ancilliary_settings_to_observable_for_link_ends(...)

No documentation found.

dsn_default_turnaround_ratios(uplink_band, ...)

No documentation found.

cassini_turnaround_ratios(uplink_band, ...)

No documentation found.
doppler_ancilliary_settings(integration_time: SupportsFloat = 60.0) → tudatpy.kernel.estimation.observations_setup.ancillary_settings.ObservationAncilliarySimulationSettings¶

Function for creating ancilliary settings for averaged Doppler observable.

Function for creating ancilliary settings for an averaged Doppler observable. Specifically, this function can be used to create settings for the integration time of the observable. Note: in case no retransmission delays (or other additional ancilliary settings) are to be defined, this setting may be used for one-, two-, or N-way averaged Doppler.

Parameters:

integration_time (float, default = 60.0) – Integration time that is to be used for the averaged Doppler observable

Returns:

Instance of the ObservationAncilliarySimulationSettings with the required settings.

Return type:

ObservationAncilliarySimulationSettings

two_way_range_ancilliary_settings(retransmission_delay: SupportsFloat = 0.0) → tudatpy.kernel.estimation.observations_setup.ancillary_settings.ObservationAncilliarySimulationSettings¶

Function for creating ancilliary settings for two-way range observable.

Function for creating ancilliary settings for a two-way range observable. Specifically, this function can be used to create settings for the retransmission delay of the observable. NOTE: this function is provided for convenience, and is equivalent to calling n_way_range_ancilliary_settings() with a single retransmission delay.

Parameters:

retransmission_delay (float, default = 0.0) – Retransmission delay that is to be applied to the simulation of the two-way observable

Returns:

Instance of the ObservationAncilliarySimulationSettings with the required settings.

Return type:

ObservationAncilliarySimulationSettings

two_way_doppler_ancilliary_settings(integration_time: SupportsFloat = 60.0, retransmission_delay: SupportsFloat = 0.0) → tudatpy.kernel.estimation.observations_setup.ancillary_settings.ObservationAncilliarySimulationSettings¶

Function for creating ancilliary settings for two-way averaged Doppler observable.

Function for creating ancilliary settings for a two-way range observable. Specifically, this function can be used to create settings for the retransmission delay of the observable. NOTE: this function is provided for convenience, and is equivalent to calling n_way_doppler_ancilliary_settings() with a single retransmission delay.

Parameters:

  • integration_time (float, default = 60.0) – Integration time that is to be used for the averaged Doppler observable

  • retransmission_delay (float, default = 0.0) – Retransmission delay that is to be applied to the simulation of the two-way observable

Returns:

Instance of the ObservationAncilliarySimulationSettings with the required settings.

Return type:

ObservationAncilliarySimulationSettings

n_way_range_ancilliary_settings(link_end_delays: collections.abc.Sequence[typing.SupportsFloat] = [], frequency_bands: collections.abc.Sequence[tudat::observation_models::FrequencyBands] = []) → tudatpy.kernel.estimation.observations_setup.ancillary_settings.ObservationAncilliarySimulationSettings¶

Function for creating ancilliary settings for n-way range observable.

Function for creating ancilliary settings for a n-way range observable. Specifically, this function can be used to create settings for the retransmission delays of the observable, for each of the retransmitters.

Parameters:

retransmission_delays (list[ float ], default = None) – Retransmission delays that are to be applied to the simulation of the n-way observable. If kept empty, this results in 0 retransmission delay at each retransmitter. If defined, this list must be the same length as the number of retransmitters, and the \(i^{th}\) entry contains the retransmission delay of the \(i^{th}\) retrasmitter

Returns:

Instance of the ObservationAncilliarySimulationSettings with the required settings.

Return type:

ObservationAncilliarySimulationSettings

n_way_doppler_ancilliary_settings(integration_time: typing.SupportsFloat = 60.0, link_end_delays: collections.abc.Sequence[typing.SupportsFloat] = [], frequency_bands: collections.abc.Sequence[tudat::observation_models::FrequencyBands] = []) → tudatpy.kernel.estimation.observations_setup.ancillary_settings.ObservationAncilliarySimulationSettings¶

Function for creating ancilliary settings for n-way averaged Doppler observable.

Function for creating ancilliary settings for a n-way averaged Doppler observable. Specifically, this function can be used to create settings for the integration time of the observable, and the retransmission delays for each of the retransmitters.

Parameters:

  • integration_time (float, default = 60.0) – Integration time that is to be used for the averaged Doppler observable

  • retransmission_delays (list[ float ], default = None) – Retransmission delays that are to be applied to the simulation of the n-way observable. If kept empty, this results in 0 retransmission delay at each retransmitter. If defined, this list must be the same length as the number of retransmitters, and the \(i^{th}\) entry contains the retransmission delay of the \(i^{th}\) retrasmitter

Returns:

Instance of the ObservationAncilliarySimulationSettings with the required settings.

Return type:

ObservationAncilliarySimulationSettings

dsn_n_way_range_ancilliary_settings(frequency_bands: collections.abc.Sequence[tudat::observation_models::FrequencyBands], lowest_ranging_component: typing.SupportsFloat, link_end_delays: collections.abc.Sequence[typing.SupportsFloat] = []) → tudatpy.kernel.estimation.observations_setup.ancillary_settings.ObservationAncilliarySimulationSettings¶

No documentation found.

dsn_n_way_doppler_ancilliary_settings(frequency_bands: collections.abc.Sequence[tudat::observation_models::FrequencyBands], reference_frequency_band: tudat::observation_models::FrequencyBands, reference_frequency: typing.SupportsFloat, integration_time: typing.SupportsFloat = 60.0, link_end_delays: collections.abc.Sequence[typing.SupportsFloat] = []) → tudatpy.kernel.estimation.observations_setup.ancillary_settings.ObservationAncilliarySimulationSettings¶

No documentation found.

doppler_measured_frequency_ancillary_settings(frequency_bands: collections.abc.Sequence[tudat::observation_models::FrequencyBands]) → tudatpy.kernel.estimation.observations_setup.ancillary_settings.ObservationAncilliarySimulationSettings¶

No documentation found.

add_ancilliary_settings_to_observable(observation_simulation_settings_list: collections.abc.Sequence[tudat::simulation_setup::ObservationSimulationSettings<tudat::Time>], ancilliary_settings: tudatpy.kernel.estimation.observations_setup.ancillary_settings.ObservationAncilliarySimulationSettings, observable_type: tudatpy.kernel.estimation.observable_models_setup.model_settings.ObservableType) → None¶

No documentation found.

No documentation found.

dsn_default_turnaround_ratios(uplink_band: tudatpy.kernel.estimation.observations_setup.ancillary_settings.FrequencyBands, downlink_band: tudatpy.kernel.estimation.observations_setup.ancillary_settings.FrequencyBands) → float¶

No documentation found.

cassini_turnaround_ratios(uplink_band: tudatpy.kernel.estimation.observations_setup.ancillary_settings.FrequencyBands, downlink_band: tudatpy.kernel.estimation.observations_setup.ancillary_settings.FrequencyBands) → float¶

No documentation found.

Enumerations¶

ObservationAncilliarySimulationVariable

Enumeration of observation ancillary variable types.

ObservationIntermediateSimulationVariable

Members:

FrequencyBands

No documentation found.
class ObservationAncilliarySimulationVariable¶

Enumeration of observation ancillary variable types.

Examples

# Code snippet to print all available Observation Ancillary Variable Types
from tudatpy.estimation.observations_setup import ancillary_settings

num_observation_ancillary_variable_types = len(ancillary_settings.ObservationAncilliarySimulationVariable.__members__)
print(f'The length of all available Tudatpy  Observation Ancillary Variable Types is: {num_observation_ancillary_variable_types}')

# Print all Observation Ancillary Variable Types using the "name" property
for i in range(num_observation_ancillary_variable_types):
    print(i, ancillary_settings.ObservationAncilliarySimulationVariable(i).name)

Members:

link_ends_delays

doppler_integration_time

doppler_reference_frequency

frequency_bands

reception_reference_frequency_band

sequential_range_lowest_ranging_component

range_conversion_factor

property name¶
class ObservationIntermediateSimulationVariable¶

Members:

transmitter_frequency_intermediate

received_frequency_intermediate

property name¶
class FrequencyBands¶

No documentation found.

Members:

s_band

x_band

ka_band

ku_band

property name¶

Classes¶

ObservationAncilliarySimulationSettings

Base class for holding ancilliary settings for observation simulation.
class ObservationAncilliarySimulationSettings¶

Base class for holding ancilliary settings for observation simulation.

Base class for holding ancilliary settings for observation simulation. The user can create instances of this class via the elevation_angle_dependent_variable() function.

Examples

# Code snippet to show the creation of an ObservationAncillarySimulationSettings object
from tudatpy.estimation.observations_setup import ancillary_settings

# Example 1: Create ObservationAncillarySimulationSettings object using ancillary_settings.n_way_range_ancilliary_settings function
# In this case the frequency bands of the retransmitter - we set it to x band.
n_way_range_ancillary_settings = ancillary_settings.n_way_range_ancilliary_settings(frequency_bands=[ancillary_settings.FrequencyBands.x_band])

# Show that this is indeed an ObservationAncillarySimulationSettings object
print(n_way_range_ancillary_settings)

# Example 2: Create ObservationAncillarySimulationSettings object using ancillary_settings.doppler_ancilliary_settings function
# In this case the integration time (in seconds) has to be given as input - we set it to 60s
doppler_ancillary_settings = ancillary_settings.doppler_ancilliary_settings(60)

# Show that this is indeed an ObservationAncillarySimulationSettings object
print(doppler_ancillary_settings)

# [OPTIONAL] Verify that we indeed added Frequency Bands as Ancillary Simulation Variables for the n_way_range_ancillary_settings.
list_num = n_way_range_ancillary_settings.get_float_list_settings(ancillary_settings.ObservationAncilliarySimulationVariable.frequency_bands)
for num in list_num:
    name = ancillary_settings.ObservationAncilliarySimulationVariable(int(num)).name
    print(f'Ancillary Simulation Variable(s): {name}, corresponding to enumeration object n. {int(num)} of the ObservationAncilliarySimulationVariable Enumeration')
get_float_list_settings(self: tudatpy.kernel.estimation.observations_setup.ancillary_settings.ObservationAncilliarySimulationSettings, setting_type: tudatpy.kernel.estimation.observations_setup.ancillary_settings.ObservationAncilliarySimulationVariable, throw_exception: bool = True) → list[float]¶
Parameters:

  • setting_type (ObservationAncilliarySimulationVariable) – Type of the setting for which the value is to be returned

  • throw_exception (bool, default = false) – Boolean defining whether to throw an exception if the requested setting does not exist, or does not exist as list of floating point values.

Returns:

Value of the requested ancilliary variable (or empty list if it does not exist)

Return type:

list[ float ]

Examples

# Code snippet to show how to retrieve ObservationAncillarySimulationSettings info
# using the ObservationAncilliarySimulationSettings.get_float_settings function

from tudatpy.estimation.observations_setup import ancillary_settings

# Create Ancillary Settings
n_way_range_ancillary_settings = ancillary_settings.n_way_range_ancilliary_settings(frequency_bands=[ancillary_settings.FrequencyBands.x_band])

# Verify that we indeed added Frequency Bands as Ancillary Simulation Variables, using n_way_range_ancillary_settings.get_float_list_settings
list_num = n_way_range_ancillary_settings.get_float_list_settings(ancillary_settings.ObservationAncilliarySimulationVariable.frequency_bands)
for num in list_num:
    name = ancillary_settings.ObservationAncilliarySimulationVariable(int(num)).name
    print(f'Ancillary Simulation Variable(s): {name}, corresponding to enumeration object n. {int(num)} of the ObservationAncilliarySimulationVariable Enumeration')
get_float_settings(self: tudatpy.kernel.estimation.observations_setup.ancillary_settings.ObservationAncilliarySimulationSettings, setting_type: tudatpy.kernel.estimation.observations_setup.ancillary_settings.ObservationAncilliarySimulationVariable, throw_exception: bool = True) → float¶
Parameters:

  • setting_type (ObservationAncilliarySimulationVariable) – Type of the setting for which the value is to be returned

  • throw_exception (bool, default = false) – Boolean defining whether to throw an exception if the requested setting does not exist, or does not exist as a floating point value.

Returns:

Value of the requested ancilliary variable (or NaN if it does not exist)

Return type:

float

set_intermediate_double_data(self: tudatpy.kernel.estimation.observations_setup.ancillary_settings.ObservationAncilliarySimulationSettings, variable: tudat::observation_models::ObservationIntermediateSimulationVariable, value: typing.SupportsFloat) → None¶