SequentialRangingReal#

class SequentialRangingReal(name: str, instrument: Instrument, sigma: ArrayWUnits = None, meas_bias=None, state_definition=None, sequence_definition=None, epoch_sec=None, computed_measurements_dict=None, partials_method: str = None, eps_dict: dict = None, media_corrections: MediaCorrections | None = None, light_time_frame: str = 'barycentric', rlt_bodies: tuple = None, solar_corona: bool = True, electronic_delays: bool = True, light_time_settings: dict = None)#

Bases: Measurement

Models the real sequential ranging measurement model.

Generates computed sequential ranging observables between a DSN ground station and a spacecraft using the precise round-trip light-time (RTLT) formulation, including relativistic corrections and optional media corrections. Observables are expressed in Range Units (RU).

Count observable

The sequential ranging observable integrates the piecewise-linear uplink ramp frequency \(f_T(t)\) over the round-trip window \([t_1,\,t_3]\), converts to Range Units, and reduces modulo the ranging-code period \(M\):

\[\rho_{RU} = \Bigl(\mathrm{RU}\cdot \int_{t_1}^{t_3} f_T(t)\,dt\Bigr)\bmod M + b_{RU}\]

where \(\mathrm{RU}\) is the Range Unit conversion factor, \(M\) is the modulo length of the ranging code in RU, and \(b_{RU}\) is an optional station range bias.

Media corrections

When a MediaCorrections object is attached, the total one-way excess path delay (Moyer eq. 10-27) is

\[\Delta\tau_{total} = \frac{1}{c}\bigl( p_{tropo,t_3} + p_{tropo,t_1} + p_{iono,t_3} + p_{iono,t_1} \bigr)\]

and the media-corrected observable becomes (Moyer eq. 13-127):

\[\rho_{RU}^{corr} = \rho_{RU} + \mathrm{RU}\cdot f_{T,1}\cdot\Delta\tau_{total}\]

Note that the ionospheric contribution enters with a positive sign (opposite to Doppler).

Parameters:
namestr

Name of the measurement model.

instrumentInstrument

Ground station or antenna instrument (e.g. GroundStation).

sigmaArrayWUnits, optional

Measurement standard deviation. Defaults to None.

meas_biasfloat or ArrayWUnits, optional

Range bias of the ground station [RU], used when the state vector holds no range_bias_RU of this station. One value applies to every pass; more hold one per pass, grouped by set_pass_epochs(). The same holds for a range_bias_RU state component. Defaults to None.

state_definitionlist, optional

StateVector definition list. Defaults to None.

sequence_definitionMissionSequence, optional

Mission sequence whose per-leg state definitions replace state_definition. Defaults to None.

epoch_secEpochArray, optional

Epoch expressed in seconds of day. Defaults to None.

computed_measurements_dictdict, optional

Auxiliary tracking-data dictionary required by computed_measurements() (only optional when the model is used for observed measurements alone). Holds the TRK-2-34 [1] auxiliary quantities of each tracking pass, typically extracted from the DSN TRK-2-34 archive SFDU records — see the OSIRIS-REx real-measurement tutorial (advanced_RealMSR_OSIRIS_REx_OD) for a worked example of building it. Unless noted otherwise, each key maps to a list/array with one entry per observation epoch:

  • 'RU' : seconds-to-Range-Unit conversion factor (pre-frequency-multiplication), derived from the SFDU 7 exciter scalars as 16 * exc_scalar_num / exc_scalar_den.

  • 'M' : sequential-ranging modulo [RU] (SFDU 7); computed range observables are reported modulo this value.

  • 'M2_num', 'M2_den' : numerator and denominator of the spacecraft transponder turn-around ratio M2 (SFDU 16).

  • 'ul_freq' : uplink frequency at the time tag [Hz] (SFDU 7, TRK-2-34 3-70).

  • 'rcv_time_tag_delay', 'transmit_time_tag_delay' : receiver and transmitter time-tag delays [s] (TRK-2-34 3-10/3-11); -1 marks an invalid entry and is treated as 0.

  • 'ul_zheight_corr', 'dl_zheight_corr' : uplink and downlink z-height corrections [s] (SFDUs 2 and 3); -99.0 marks an invalid entry and is treated as 0.

  • 'ul_stn_cal', 'dl_stn_cal' : uplink and downlink ground-station calibrations [RU] (SFDU 7, TRK-2-34 3-68).

  • 'scft_transpd_delay' : spacecraft transponder delay [RU], scalar (mission constant).

  • 'scft_transpd_delay_s' : the same transponder delay expressed in seconds, scalar.

  • 'array_delay' : arraying-equipment path delay [s], optional; -1 / -99 mark invalid entries and are treated as 0.

  • 'exc_scalar_num', 'exc_scalar_den' : exciter scalars (SFDU 7), optional; written with generated measurements so that 'RU' can be read back.

  • 'rng_type', 'version_num' : ranging type and format version (SFDU 7), optional; carried into generated measurements.

  • 'ramp_sec', 'ramp_day', 'ramp_freq', 'ramp_rate', 'ramp_type' : transmitter frequency ramp table (SFDU 9) — seconds of day, day of year, ramp reference frequency [Hz], ramp rate [Hz/s], and ramp type of each ramp record (one entry per ramp record, not per observation).

  • 'ramp_year' : year of each ramp record (SFDU 9 year), optional; needed when the ramp table or a round trip crosses a new year.

Defaults to None.

partials_method{“analytical”, “fd”}, optional

Which H-tilde implementation to use. "analytical" (the default) uses the Moyer partials, which differentiate the same light-time solution the forward model produced and reuse its cached endpoints, for roughly 380x less cost than "fd" on this model. "fd" finite-differences the real forward model – one full forward run per state component, slow, but it differentiates exactly the observable being fitted. Defaults to None, i.e. "analytical".

eps_dictdict, optional

Perturbation magnitudes for finite-difference partials. Spacecraft entries are keyed dx to dvz; station, Earth-orientation, zenith-delay and electronic-delay entries are keyed by StateDefinition parameter kind, e.g. gs_delta_location_CYL, eop_delta_ut1 or transponder_delay_bias, and are read only by partials_method="fd" – the analytical partials differentiate those parameters in closed form. Omitted keys fall back to the in-code defaults; see station_eps_defaults. Defaults to None.

media_correctionsMediaCorrections, optional

Media-correction object (troposphere / ionosphere). Defaults to None.

light_time_frame{“barycentric”, “geocentric”}, optional

Space-time frame of the round-trip light-time solution. "barycentric" (Moyer 2000, Sec. 8.3.6) is valid for any spacecraft. "geocentric" (Moyer 2000, Sec. 8.3.1) keeps only the Earth’s relativistic delay and is meant for spacecraft near the Earth; see _compute_geocentric_RTLT() for what it neglects. Defaults to "barycentric".

rlt_bodiestuple, optional

(spice_id, GM) pairs of the bodies other than the Sun in the relativistic light-time term. Defaults to None, i.e. Constants.RLT_BODIES; an empty tuple leaves only the Sun. The default takes Mars, Jupiter and Saturn at their barycentres, which is not accurate enough for a Jupiter or Saturn orbiter: pass the planet centres instead (see Constants.RLT_BODIES).

solar_coronabool, optional

Apply the solar-corona delay to the light time. Defaults to True.

electronic_delaysbool, optional

Apply the time-tag, z-height, spacecraft transponder and arraying delays of computed_measurements_dict. Defaults to True.

light_time_settingsdict, optional

Convergence settings of the light-time solution, any of the keys of Measurement.LIGHT_TIME_SETTINGS: "tolerance" [s], "max_iterations" per leg and "et_tai_iterations". Missing keys take the default. Raise the tolerance for a spacecraft beyond about 8 AU, where 1e-12 s is below the float spacing of the light time and a leg runs to max_iterations. Defaults to None, i.e. all defaults.

Attributes:
component_labels

Names of the two components of a vector observable.

computed_measurements_dict

Auxiliary TRK-2-34 tracking-data dictionary needed for the generation of the computed measurements of a real radiometric model.

default_dataset_name

Dataset name used when the caller does not supply one.

dl_station_cal

Downlink station calibration [RU] written into simulated auxiliary data.

dsn_bands

DSN frequency-band parameters of this model, a read-only mapping from band letter to DSNBand.

epoch_sec

Observation epochs expressed as seconds of day.

instrument

The instrument.

media_corrections

Tropospheric and ionospheric path-delay model, or None if not set.

name

The name of the model.

ramp_entries

Number of entries of a simulated ramp table, at least 2.

ramp_margin

Span [s] a simulated ramp table extends before the first and after the last observation.

ramp_rate

Uplink frequency ramp rate [Hz/s] of the ramp table the default_*_aux builders simulate.

ramp_type

SFDU 9 ramp_type code of the segments of a simulated ramp table.

range_modulo

Code modulo [RU] of the sequential ranging default_seqranging_aux() simulates, a positive whole number.

ranging_type

SFDU 7 rng_type code of the simulated sequential ranging.

ranging_version

SFDU 7 version_num of the simulated sequential ranging.

rcv_time_tag_delay

Receive time-tag delay [s] written into simulated auxiliary data.

sigma

The standard deviation of the measurement model.

solar_corona_coefficient

Coefficient of the solar-corona group delay [us GHz^2 m^2] of a real model built with solar_corona=True.

transponder_delay

Spacecraft transponder delay [RU] written into simulated auxiliary data by the default_*_aux builders.

ul_station_cal

Uplink station calibration [RU] written into simulated auxiliary data.

Methods

align_aux_to_epochs(source, key, target[, ...])

Sample a TRK-2-34 record at the epochs of another record by time tag.

compute_partials(target, epoch_array, frame)

Stacks together measurement _partials for an epoch array at different epochs.

computed_measurements(target, epoch_array, ...)

Generate the computed two-way DSN sequential ranging measurement.

default_seqranging_aux(tstart, tend[, N, ...])

Default computed_measurements_dict for synthetic sequential ranging.

generate_measurement_dataset(dataset_name, ...)

Generates a MeasurementDataSet object that can be used by filters downstream.

observed_measurements(file_name, meas_name, ...)

Reads measurements from a .json file.

residuals(observed_meas, computed_meas)

Generates the sequential ranging residuals, wrapped to the range ambiguity.

resolve_elevation_mask(elevation_mask)

Normalise an elevation mask to degrees.

rtlt_grad_pos_exact(n_hat_dn, n_hat_up, ...)

Exact round-trip light-time gradient with respect to the spacecraft position.

rtlt_grad_station_exact(n_hat_dn, n_hat_up, ...)

Exact round-trip light-time gradients with respect to the station position.

rtlt_leg_weights(n_hat_dn, n_hat_up, v_sc, ...)

Sensitivity of the round-trip light time to a delay inside each leg's solution.

set_pass_epochs(pass_epochs)

Enable per-pass biases.

set_trajectory(trajectory)

Attach the reference trajectory supplying the STMs.

transponder_delay_seconds(delay_RU, ...)

Convert a spacecraft transponder delay from range units to seconds.

update_reference_state(state_vector)

Attach the estimated state the model should read its parameters from.

validate_aux(aux[, label])

Check that an auxiliary-data dictionary is internally consistent.

write_observed_measurements(target, ...)

Generates synthetic measurements and write them as a .json file.

See also

scarabaeus.Measurement

Abstract base class for all measurement models.

scarabaeus.DopplerReal

Companion real Doppler model.

scarabaeus.MediaCorrections

Tropospheric and ionospheric path-delay model.

References

[1]

“TRK-2-34, DSN Tracking System Data Archival Format”, DSN No. 820-013, TRK-2-34, Rev. N.

static align_aux_to_epochs(source: dict, key: str, target: dict, invalid=None) → ndarray#

Sample a TRK-2-34 record at the epochs of another record by time tag.

Each SFDU record of a tracking file has its own cadence (e.g. the uplink z-height correction every second, the ranging aux at the ranging cadence), so its rows do not correspond to the measurement rows. The value in force at each target epoch is the latest source entry at or before it (zero-order hold); target epochs earlier than the whole source take its first entry.

Parameters:
sourcedict

Record holding year, doy, sec and key.

keystr

Field of source to sample.

targetdict

Record holding the year, doy, sec time tags to sample at, typically the measurement record (e.g. trk["2W_doppler"]).

invalidfloat, optional

Source entries equal to this value are skipped (e.g. 0 for the uplink frequency of rows with no uplink).

Returns:
np.ndarray

source[key] at each target epoch, of length len(target["sec"]).

Raises:
Measurement.AuxDataError

If source holds no valid entry of key.

static resolve_elevation_mask(elevation_mask: ArrayWUnits | float) → float#

Normalise an elevation mask to degrees.

Parameters:
elevation_maskArrayWUnits or float

Minimum elevation angle. An ArrayWUnits is converted from its own units, so radians work as well as degrees. A bare number is taken to be in degrees, which is what the parameter has always meant and what every default (10.0) is.

Returns:
float

The mask in degrees.

Raises:
ElevationMaskError

If the mask is not a number or an angle, or is outside 0 to 90 degrees. Also if it is a bare number that is not a whole number of degrees and is no more than pi/2: 0.17 could be 0.17 deg or 10 deg meant in radians, and reading it the wrong way silently keeps or drops the observations near the horizon. Such a mask has to carry its units. A larger bare number is read as degrees, since as radians it would be above 90 deg and be refused anyway.

Examples

Measurement.resolve_elevation_mask(10.0)                      # 10.0
Measurement.resolve_elevation_mask(ArrayWUnits(0.2, rad))     # 11.459...
Measurement.resolve_elevation_mask(ArrayWUnits(0.5, deg))     # 0.5
Measurement.resolve_elevation_mask(0.5)       # ElevationMaskError
static rtlt_grad_pos_exact(n_hat_dn: ndarray, n_hat_up: ndarray, v_sc: ndarray, v_gs: ndarray, c: float) → ndarray#

Exact round-trip light-time gradient with respect to the spacecraft position.

Chains Moyer (2000) Eqs. 12-12 (downleg) and 12-17 (upleg) through the reflection time \(t_2\), holding the reception time \(t_3\) fixed, so that \(\rho = t_3 - t_1\) and \(\partial \rho / \partial \mathbf{r}_{SC} = -\partial t_1 / \partial \mathbf{r}_{SC}\) [s/km]. With the Eq. 8-59/8-60 definitions, the spacecraft transmits on the downleg and the station on the upleg:

\[ \begin{align}\begin{aligned}\dot{p}_{23} = \hat{\mathbf{r}}_{23} \cdot \mathbf{v}_{SC} / c = -\hat{\mathbf{n}}_{dn} \cdot \mathbf{v}_{SC} / c, \qquad \dot{p}_{12} = \hat{\mathbf{r}}_{12} \cdot \mathbf{v}_{GS} / c = \hat{\mathbf{n}}_{up} \cdot \mathbf{v}_{GS} / c\\\dot{r}_{12} = \hat{\mathbf{n}}_{up} \cdot (\mathbf{v}_{SC} - \mathbf{v}_{GS}) / c, \qquad \dot{r}_{12} + \dot{p}_{12} = \hat{\mathbf{n}}_{up} \cdot \mathbf{v}_{SC} / c\end{aligned}\end{align} \]

where the station terms cancel in the last sum. The gradient is then

\[\frac{\partial t_2}{\partial \mathbf{r}_{SC}} = -\frac{\hat{\mathbf{n}}_{dn}}{c\,(1 - \dot{p}_{23})}, \qquad \frac{\partial \rho}{\partial \mathbf{r}_{SC}} = -\frac{(1 - \dot{r}_{12} - \dot{p}_{12})\, \partial t_2 / \partial \mathbf{r}_{SC} - \hat{\mathbf{n}}_{up} / c} {1 - \dot{p}_{12}}\]
Parameters:
n_hat_dnnumpy.ndarray, shape (3,)

Unit vector GS to SC on the downleg, \(\hat{\mathbf{n}}_{dn} = (\mathbf{r}_{SC}(t_2) - \mathbf{r}_{GS}(t_3)) / \rho_{dn}\).

n_hat_upnumpy.ndarray, shape (3,)

Unit vector GS to SC on the upleg, \(\hat{\mathbf{n}}_{up} = (\mathbf{r}_{SC}(t_2) - \mathbf{r}_{GS}(t_1)) / \rho_{up}\).

v_scnumpy.ndarray, shape (3,)

Spacecraft velocity at \(t_2\) [km/s], in the space-time frame the light time is solved in (see _light_time_velocity()).

v_gsnumpy.ndarray, shape (3,)

Ground station velocity at \(t_1\) [km/s], in the same frame.

cfloat

Speed of light [km/s].

Returns:
numpy.ndarray, shape (3,)

\(\partial \rho / \partial \mathbf{r}_{SC}\) [s/km].

References

[1]

Moyer, T. D. (2000). Formulation for Observed and Computed Values of Deep Space Network Data Types for Navigation. JPL Publication 00-7.

static rtlt_grad_station_exact(n_hat_dn: ndarray, n_hat_up: ndarray, v_sc: ndarray, v_gs: ndarray, c: float) → tuple#

Exact round-trip light-time gradients with respect to the station position.

The station enters at reception \(t_3\) and at transmission \(t_1\), through the same Moyer (2000) 12-12/12-17 chain as rtlt_grad_pos_exact(). Displacing the receiver at \(t_3\) moves the reflection time \(t_2\) (Eq. 12-12, with the station as the receiver), and the upleg carries that change to \(t_1\) through its own \(\dot{p}_{12}\) denominator (Eq. 12-17); displacing the transmitter at \(t_1\) enters the upleg only:

\[\frac{\partial \rho}{\partial \mathbf{r}_{GS}(t_3)} = -\frac{(1 - \dot{r}_{12} - \dot{p}_{12})\,\hat{\mathbf{n}}_{dn}} {c\,(1 - \dot{p}_{23})(1 - \dot{p}_{12})}, \qquad \frac{\partial \rho}{\partial \mathbf{r}_{GS}(t_1)} = -\frac{\hat{\mathbf{n}}_{up}}{c\,(1 - \dot{p}_{12})}\]

with \(\dot{p}\) and \(\dot{r}\) as defined in rtlt_grad_pos_exact(): each leg’s range over c weighted by rtlt_leg_weights(). Their sum is -rtlt_grad_pos_exact(...): a common translation of station and spacecraft leaves the light time unchanged. Dropping the denominators, i.e. using \(-\hat{\mathbf{n}}/c\) on each leg, is off by the transmitters’ velocities over c, about 1e-4 relative with heliocentric velocities.

Parameters:
n_hat_dnnumpy.ndarray, shape (3,)

Unit vector GS to SC on the downleg.

n_hat_upnumpy.ndarray, shape (3,)

Unit vector GS to SC on the upleg.

v_scnumpy.ndarray, shape (3,)

Spacecraft velocity at \(t_2\) [km/s].

v_gsnumpy.ndarray, shape (3,)

Ground station velocity at \(t_1\) [km/s].

cfloat

Speed of light [km/s].

Returns:
grad_t3numpy.ndarray, shape (3,)

\(\partial \rho / \partial \mathbf{r}_{GS}(t_3)\) [s/km], in the frame of the input vectors.

grad_t1numpy.ndarray, shape (3,)

\(\partial \rho / \partial \mathbf{r}_{GS}(t_1)\) [s/km], in the same frame.

See also

rtlt_grad_pos_exact

definitions of the inputs.

static rtlt_leg_weights(n_hat_dn: ndarray, n_hat_up: ndarray, v_sc: ndarray, v_gs: ndarray, c: float) → tuple#

Sensitivity of the round-trip light time to a delay inside each leg’s solution.

Uses the Moyer (2000) 12-12/12-17 chain of rtlt_grad_pos_exact(). A delay \(\delta\tau_{23}\) in the downleg equation moves the reflection time \(t_2\), and the upleg carries that change to \(t_1\); a delay \(\delta\tau_{12}\) in the upleg equation moves \(t_1\) only:

\[\frac{\partial \rho}{\partial \tau_{23}} = \frac{1 - \dot{r}_{12} - \dot{p}_{12}}{(1 - \dot{p}_{23})(1 - \dot{p}_{12})}, \qquad \frac{\partial \rho}{\partial \tau_{12}} = \frac{1}{1 - \dot{p}_{12}}\]

with \(\dot{p}\) and \(\dot{r}\) as defined in rtlt_grad_pos_exact(). Both are 1 to within the transmitters’ velocities over c, about 1e-4 with heliocentric velocities. They apply to what the iteration solves for, the geometric range and the Shapiro delay, and not to the media, corona and electronic delays, which are added after it converges.

Parameters:
n_hat_dnnumpy.ndarray, shape (3,)

Unit vector GS to SC on the downleg.

n_hat_upnumpy.ndarray, shape (3,)

Unit vector GS to SC on the upleg.

v_scnumpy.ndarray, shape (3,)

Spacecraft velocity at \(t_2\) [km/s].

v_gsnumpy.ndarray, shape (3,)

Ground station velocity at \(t_1\) [km/s].

cfloat

Speed of light [km/s].

Returns:
w_dnfloat

\(\partial \rho / \partial \tau_{23}\), dimensionless.

w_upfloat

\(\partial \rho / \partial \tau_{12}\), dimensionless.

See also

rtlt_grad_pos_exact

definitions of the inputs.

static transponder_delay_seconds(delay_RU: float, reference_frequency: float, range_unit: float) → float#

Convert a spacecraft transponder delay from range units to seconds.

The delay is divided by range_unit * reference_frequency, the rate of the clock the delay is counted against.

Parameters:
delay_RUfloat

Transponder delay as the mission specifies it [RU].

reference_frequencyfloat

The band’s range-unit reference frequency [1/s], i.e. Measurement.DSNBand.ru_reference_frequency.

range_unitfloat

The range unit, from the pass’s exciter scalars.

Returns:
float

The delay [s].

Notes

Pass the band’s reference frequency, not its uplink frequency. The two differ by 18% in X band, and the delay enters the round-trip light time directly rather than acting as a scale factor, so substituting the uplink makes the delay 2.4 us longer – 1.4 km of two-way range. Tried on real tracking data, that drove the sequential-ranging residuals from 55-206 RU to 2330-2694 RU, so the reference frequency is what the data supports. Why a downlink-scale reference is the right one is an open question; see the attribute’s own note.

static validate_aux(aux: dict, label: str = '') → None#

Check that an auxiliary-data dictionary is internally consistent.

An aux dict describes two things sampled on two different grids: one value per observation, and one entry per ramp-table segment. Everything in each group has to be the same length, and a value meant to be per-observation has to be a sequence rather than a bare number.

Nothing checks that on the way in otherwise, and the failures it prevents surface far from their cause:

  • Mismatched lengths reach RampTableManager.integrate(), which indexes ramp_freq with an index derived from ramp_sec and raised IndexError: index 9 is out of bounds for axis 0 with size 5 from inside the forward model.

  • A ragged per-observation group reaches write_observed_measurements(), whose own check then refuses to write the file – correct, but one step later than here.

Parameters:
auxdict

The dictionary to check, as a default_*_aux helper or _read_aux() produces it.

labelstr, optional

Named in the error, to say which dictionary was wrong.

Raises:
TypeError

If aux is not a dict. None is reported specifically, since that means the model was never given its auxiliary data.

ValueError

If the per-observation group or the ramp group is ragged. The message groups the keys by the length they have, since the odd one out is usually obvious once they are laid side by side.

Examples

aux = doppler_model.default_doppler_aux(t0, tf, N=20, band="S")
scb.Measurement.validate_aux(aux, label="DSS-25 Range Rate")
compute_partials(target: Spacecraft, epoch_array: EpochArray, frame: Frame = J2000 (0 - SOLAR SYSTEM BARYCENTER)) → list#

Stacks together measurement _partials for an epoch array at different epochs.

Parameters:
targetSpacecraft

The target spacecraft.

epoch_arrayEpochArray

The epochs.

frameFrame, optional

The reference frame. Defaults to a J2000 Frame object.

Returns:
_partialslist

A list with all the _partials evaluated at different epochs in the epoch_array.

computed_measurements(target: Spacecraft, epoch_array: EpochArray = None, epoch_start: EpochArray = None, epoch_end: EpochArray = None, tstep: float = 1, frame: Frame = J2000 (0 - SOLAR SYSTEM BARYCENTER), noisy: bool = False, eps_override: dict = None) → ArrayWFrame#

Generate the computed two-way DSN sequential ranging measurement.

Parameters:
targetSpacecraft

target spacecraft for the two-way measurement model

epoch_arrayEpochArray

An array of epochs (times) at which the measurements should be computed. If provided, it overrides epoch_start, epoch_end, and tstep.

epoch_startEpoch

The starting epoch for the range measurement computations. Required if epoch_array is not provided.

epoch_endEpoch

The ending epoch for the range measurement computations. Required if epoch_array is not provided.

tstepfloat

The time step, in seconds, between consecutive range measurements. If epoch_array is not provided. Defaults to 1 second.

frameFrame

The reference frame in which the measurement is generated.

noisy: bool

Whether to add AWGN at the model’s sigma to the computed sequential ranging measurement. For simulating observations; leave False when computing predicted measurements for a filter. Defaults to False.

eps_override: dict

Dictionary of delta’s to compute the numeric _partials

Returns:
computed_measArrayWFrame

An ArrayWFrame object with the computed measurement values expressed in RU (adimensional)

Raises:
Measurement.AuxDataError

If computed_measurements_dict is missing, lacks a key, or holds a per-epoch entry whose length differs from the epochs.

Measurement.MissingSigmaError

If noisy is True and the model has no sigma.

Measurement.StationKernelRequiredError

If the station is defined by body-fixed coordinates instead of an ephemeris.

RuntimeError

If a light-time solution fails (e.g. does not converge); it names the epoch and the target, and chains the original error.

RampTableManager.RampTableYearError

If the ramp table or a round trip crosses a new year and computed_measurements_dict has no 'ramp_year'.

MediaCorrections.IncompleteTroposphereError

If media_corrections has only one of the two troposphere files.

Measurement.MissingPassIndexError

If the bias holds one value per pass (more than one element) and no epoch-to-pass mapping is set.

Notes

This model has been developed following the details in Moyer 2000. [1]: “TRK-2-34, DSN Tracking System Data Archival Format”, DSN No. 820-013, TRK-2-34, Rev. N

noisy=False gives the predicted observable, against which real observations are differenced. noisy=True adds white Gaussian noise of standard deviation sigma to it, which simulates observations.

A round trip that starts before the first ramp record has no defined transmit frequency. Its computed value is NaN, with a warning, and Measurement.generate_measurement_dataset() flags it as an outlier.

Estimated electronic delays lengthen the round-trip light time on top of the tracking data’s own: uplink_delay_bias_[tag] of this station at t1, transponder_delay_bias of target at t2 and downlink_delay_bias_[tag] of this station at t3. Each holds one value for every pass and applies even with electronic_delays=False.

default_seqranging_aux(tstart: EpochArray, tend: EpochArray, N: int = 1, ramp_margin: float = None, n_ramp: int = None, band: str = 'X') → dict#

Default computed_measurements_dict for synthetic sequential ranging.

The simulated values are this model’s radiometric defaults: dsn_bands, range_modulo, ranging_type, ranging_version, ramp_rate, ramp_type, transponder_delay, rcv_time_tag_delay, ul_station_cal and dl_station_cal. Set them on the model before calling to change the simulated data.

Parameters:
tstart, tendEpochArray

Span the simulated observations cover.

Nint, optional

Number of observations. Every per-observation entry is this long, including year/doy/sec. Defaults to 1.

ramp_marginfloat, optional

Seconds the ramp grid extends beyond the span at each end. Defaults to ramp_margin. The ramp grid runs wider than the observation span because the ramp is queried at the uplink transmit time, one round-trip light time before the first time tag.

n_rampint, optional

Number of ramp-table entries. Defaults to ramp_entries.

bandstr, optional

A key of dsn_bands, "X" or "S" by default (case-insensitive), resolved by Measurement._resolve_dsn_band(). It sets the uplink frequency, turnaround ratio, exciter scalar and range unit. Defaults to "X".

Returns:
SeqRanging_aux_datadict

Aux values needed for computing measurements. Every per-observation array is N long and every ramp array is n_ramp long; see Measurement._default_aux_grids().

generate_measurement_dataset(dataset_name: str | None = None, target: Body = None, observed_meas: tuple | list | None = None, epochs: EpochArray | None = None, frame: Frame = J2000 (0 - SOLAR SYSTEM BARYCENTER), noisy: bool = False) → list[MeasurementDataSet]#

Generates a MeasurementDataSet object that can be used by filters downstream.

Parameters:
dataset_namestr, optional

The name of the MeasurementDataSet, which becomes the residual key in solution.json. Defaults to default_dataset_name — "<instrument>_<measurement_type>".

targetSpacecraft

The target spacecraft.

observed_meastuple or list, optional

Observed measurements as (epoch_array, meas_sec, meas_obs, outlier_flag). The computed values are evaluated at epoch_array. Give this or epochs, not both. Defaults to None.

epochsEpochArray, optional

Epochs to simulate the measurements at, with no outliers flagged. Give this or observed_meas, not both. Defaults to None.

frameFrame, optional

The reference frame. Defaults to a J2000 Frame object.

noisybool, optional

Indicates if noise is added to the measurements or not. Defaults to False.

Returns:
mds_listlist[MeasurementDataSet]

A list of MeasurementDataSet objects representing the measurements with their key properties to be used by a filter.

Raises:
ValueError

If neither or both of observed_meas and epochs are given, if observed_meas carries fewer than four entries (the fourth is the outlier-flag array, without which the observations cannot be kept on one index set with their flags), or if the model has more than two components.

Notes

This is the single bridge from a measurement model to the estimator: fit() and compute() both come through here, and MeasurementDataSet is populated nowhere else. It pairs each observation with its computed value, residual, partial and sigma on one consistent set of indices, which is what lets several models with different epochs and different observables be combined into one filter update.

That is also why it, rather than the caller, unpacks t1, t2, t3 from computed_measurements(). The estimator needs the epochs alongside the observable – t2 to match measurements across models, t1 to detrend residuals during outlier rejection – so they have to survive the trip into the dataset. See computed_measurements() for what each epoch means and why a single-epoch observable collapses all three.

The MeasurementDataSet output is generated in 6 steps:

  1. Computed measurements

  2. Partials

  3. Residuals

  4. Sigmas

  5. Outlier flag

  6. Pack everything in a list

  7. Pack the list in a MeasurementDataSet object

observed_measurements(file_name, meas_name: str = 'meas_sim', units: Units = unitless, frame: Frame = J2000 (0 - SOLAR SYSTEM BARYCENTER), **read_kwargs) → ObsData#

Reads measurements from a .json file.

Parameters:
file_namestr

The filename of the .json file containig the measurement information.

meas_namestr, optional

The name of the measurement data to access from the dictionary. Defaults to 'meas_sim'. Files written before the rename use 'meas_ideal'; either name resolves to whichever block the file actually contains, with a DeprecationWarning on the fallback.

unitsUnits, optional

Units to be used to write the output AWU. Defaults to unitless.

frameFrame, optional

Frame to be used to write the output AWF. Defaults to a J2000 Frame object.

**read_kwargs

Options for the model’s own _read_aux(), forwarded unchanged. Models with no auxiliary data to read ignore them.

This is where sc_transponder_delay_RU goes for the DSN radiometric models, which is the only such option today. It is not a named parameter here because this signature is shared by every measurement model, optical ones included.

Returns:
ObsData

A ObsData named tuple with five fields, addressable by name or index:

  • [0] meas_time_etEpochArray

    Observation epochs. Built from the file’s UTC station tag via YDS2et(); see the comment at the conversion below for why this carries SPICE’s time model deliberately.

  • [1] meas_secnumpy.ndarray

    The observation times as seconds of day, as given in the file.

  • [2] meas_obsArrayWFrame

    The observed quantities, with units and frame attached.

  • [3] meas_outliersnumpy.ndarray

    Per-observation outlier flags, 1 = reject. Seeded from the file’s own outlier_flag and additionally set here for records carrying the -1 no-data sentinel and for the rows the model knows to be invalid (_flag_invalid_rows()). Downstream this is the authoritative flag array: it is what the filter, outlier_flags() and the editors gate on, and generate_measurement_dataset() writes into it when the forward model cannot compute an observation.

  • [4] aux_dictdict

    Ancillary per-observation data read by the model’s _read_aux (ramp tables, transponder ratios, electronic delays, …). None for models that need none.

Notes

The writing of the json assumes or requires units and frames.

Every row in the file is returned, including rows flagged bad. Nothing is dropped here, so the observations, the aux_dict and any later outlier rejection all stay on one consistent set of indices.

residuals(observed_meas: ArrayWFrame, computed_meas: ArrayWFrame) → ArrayWFrame#

Generates the sequential ranging residuals, wrapped to the range ambiguity.

Parameters:
observed_measArrayWFrame

The observed measurements values (O) [RU].

computed_measArrayWFrame

The computed measurements values (C) [RU].

Returns:
residualsArrayWFrame

AWF with the residual O-C wrapped into \([-M/2, M/2)\).

Notes

Both O and C are reported modulo \(M\), and C carries the bias and media terms added after the modulo, so a plain O-C lands anywhere in \((-M, M)\): a point whose O and C sit on opposite sides of a wrap jumps by a whole modulus, which is frequent with a small \(M\). The residual is the difference closest to zero, see _wrap_to_modulo().

set_pass_epochs(pass_epochs: list[list] | None)#

Enable per-pass biases.

Parameters:
pass_epochslist[list[float]] | None

Observation epochs grouped by pass, e.g. [[t0, t1], [t10, t11]]. Pass None to revert to global-bias mode.

set_trajectory(trajectory)#

Attach the reference trajectory supplying the STMs.

Read only by the analytical light-time partials, which map a deviation between the endpoints of an observable (see _short_arc_stm()).

Parameters:
trajectoryTrajectory

Trajectory carrying the STMs. Must span every epoch the model evaluates.

update_reference_state(state_vector: StateArray)#

Attach the estimated state the model should read its parameters from.

Call this once per iteration, before generate_measurement_dataset(). The model then pulls the entries belonging to this instrument, matched on its SPICE ID:

  • meas_bias_ideal_*, as an ArrayWUnits.

  • gs_delta_location_ECEF_*, as an ArrayWFrame.

Parameters:
state_vectorStateArray

The current estimated state. Its layout is also recorded, so that the partials can build a column for every estimated parameter beyond position and velocity.

write_observed_measurements(target: Spacecraft, epoch_array: EpochArray = None, epoch_start: EpochArray = None, epoch_end: EpochArray = None, tstep: float = 1, frame: Frame = J2000 (0 - SOLAR SYSTEM BARYCENTER), noisy: bool = False, file_name: str = 'ideal_measurement', check_visibility: bool = False, elevation_mask: ArrayWUnits | float = 10.0, folder_path_override: str = None, fmt: str = 'json') → None#

Generates synthetic measurements and write them as a .json file. The input of this method encapsulate the ones needed for the “computed_meas” method in each measurement model class.

Parameters:
targetSpacecraft

The target spacecraft for which the range measurement is to be computed.

epoch_arrayEpochArray, optional

An array of epochs (times) at which the range measurements should be computed. If provided, overrides epoch_start, epoch_end, and tstep.

epoch_startEpochArray, optional

The starting epoch for the range measurement computations. Required if epoch_array is not provided.

epoch_endEpochArray, optional

The ending epoch for the range measurement computations. Required if epoch_array is not provided.

tstepfloat, optional

The time step, in seconds, between consecutive range measurements. If epoch_array is not provided. Defaults to 1 second.

frameFrame , optional

The reference frame in which the range computation is performed. Defaults to None.

noisybool , optional

Whether to add noise to the computed range measurement. Defaults to False.

file_namestr, optional

The filename of the JSON in which the measurement is saved, Defaults to 'ideal_measurement'.

check_visibilitybool, optional

When True, epochs where the instrument cannot observe the target are removed before generating measurements. The specific check is instrument-dependent: GroundStation uses an elevation-angle test; Camera uses a FOV projection test. Defaults to False.

elevation_maskArrayWUnits or float, optional

Minimum elevation angle used by the GroundStation visibility check. An ArrayWUnits is converted from its own units; a bare number is read as degrees (see resolve_elevation_mask(), which refuses a bare one that could be radians). Ignored for Camera instruments. Only relevant when check_visibility=True. Defaults to 10.0 degrees.

folder_path_overridestr, optional

If provided, the JSON file is saved directly to this path instead of the default data/measurements/radiometric or data/measurements/optical folder. The directory is created automatically if it does not exist. Defaults to None.

fmt{“json”, “pickle”}, optional

On-disk format; selects the .json or .pkl extension appended to file_name. Read back transparently by observed_measurements(). Defaults to "json".

Returns:
None
AUX_KEYS = Measurement.TrackingAuxKeys(required=('RU', 'M', 'M2_num', 'M2_den', 'ul_freq', 'rcv_time_tag_delay', 'transmit_time_tag_delay', 'ul_zheight_corr', 'dl_zheight_corr', 'ul_stn_cal', 'dl_stn_cal'), optional=('array_delay', 'exc_scalar_num', 'exc_scalar_den', 'rng_type', 'version_num'), record_fields={'rng_modulo': 'M', 'scft_transpd_turn_num': 'M2_num', 'scft_transpd_turn_den': 'M2_den'}, outlier_flag='outlier_flag_sranging')#

Auxiliary-data layout of this model.

DL_STATION_CAL = 850000.0#

Default downlink station calibration [RU] of simulated auxiliary data, the starting dl_station_cal of a model.

Representative, not physical: real passes carry the station value.

DSN_BANDS = {'S': Measurement.DSNBand(name='S', uplink_multiplier=221, downlink_multiplier=240, turnaround_num=240, turnaround_den=221, exciter_scalar_num=221.0, exciter_scalar_den=7072.0, uplink_frequency=2110362223.0 Hz, ru_reference_frequency=2303391185.181818 Hz), 'X': Measurement.DSNBand(name='X', uplink_multiplier=749, downlink_multiplier=880, turnaround_num=880, turnaround_den=749, exciter_scalar_num=221.0, exciter_scalar_den=23968.0, uplink_frequency=7152313596.9977 Hz, ru_reference_frequency=8445767679.0 Hz)}#

Default DSN frequency-band parameters, keyed by band letter, each a DSNBand. A model starts with these as dsn_bands.

Supported bands are 'X' and 'S'. 'X' holds the values the measurement models used as literals before they were collected here, so it is the default everywhere and reproduces the previous numbers exactly.

[1]

Moyer, T. D., Formulation for Observed and Computed Values of Deep Space Network Data Types for Navigation, JPL Publication 00-7, Monograph 2, Deep Space Communications and Navigation Series, Chapter 13.

[2]

DSN Telecommunications Link Design Handbook, 810-005, Module 201, Frequency and Channel Assignments.

LIGHT_TIME_FRAMES = ('barycentric', 'geocentric')#
LIGHT_TIME_SETTINGS = {'et_tai_iterations': 2, 'max_iterations': 10, 'tolerance': 1e-12}#

Default settings of the round-trip light-time solution of the real measurement models, which take a dictionary with any of these keys as light_time_settings. They apply to both solvers, _compute_precise_RTLT() and _compute_geocentric_RTLT().

  • "tolerance" [s]: each leg (t3 to t2, then t2 to t1) is corrected with Moyer 2000 eq. 8-72 until the correction is no larger than this. 1e-12 s is 0.3 mm of one-way path. The correction cannot fall much below the float spacing of the one-way light time: 9.1e-13 s from 4096 s (8.2 AU), 1.8e-12 s from 8192 s (16 AU). A tolerance under that floor makes every leg run to "max_iterations", so raise it for distant spacecraft.

  • "max_iterations": iteration cap of each leg. A leg that reaches it keeps its last estimate and does not raise.

  • "et_tai_iterations": evaluations of the ET - TAI series (Moyer 2000 eq. 2-26) when the reception time is converted from TAI to ET. Each one is made at the ET the previous one gave. The first starts from the approximate series, eq. 2-27.

[1]

Moyer, T.D. (2000). Formulation for Observed and Computed Values of Deep Space Network Data Types for Navigation. JPL Publication 00-7, Monograph 2, Deep Space Communications and Navigation Series, Sec. 8.3.6 and Eq. 2-26.

PARTIALS_METHODS = ('fd', 'analytical')#
RAMP_AUX_KEYS = ('ramp_sec', 'ramp_day', 'ramp_freq', 'ramp_rate', 'ramp_type')#

Auxiliary-data keys of the ramp table every real radiometric model carries: start second of day, day of year, frequency, rate and type of each ramp segment.

RAMP_ENTRIES = 12#

Default number of entries of a simulated ramp table, the starting ramp_entries of a model.

RAMP_MARGIN = 3600.0 sec#

Default span a simulated ramp table extends before the first and after the last observation, the starting ramp_margin of a model.

The uplink transmit time precedes the first tag by the round-trip light time, so a table that starts at the first tag raises RampCoverageError. One hour clears a spacecraft out to the asteroid belt.

RAMP_RATE = 0.2826 sec^-2#

Default uplink frequency ramp rate of a simulated ramp table, the starting ramp_rate of a model.

A representative DSN ramp slope, not a physical constant: real passes carry their measured rate in the ramp table.

RAMP_TYPE = 1#

Default ramp type of a simulated ramp table, the SFDU 9 ramp_type code of a ramped segment; the starting ramp_type of a model.

RAMP_YEAR_KEY = 'ramp_year'#

Auxiliary-data key of the year of each ramp segment. Optional: a table read without it is assumed to lie in the year of the observations.

RANGE_MODULO = 1073741824#

Default sequential-ranging code modulo, \(2^{30}\), the starting range_modulo of a model.

The observable wraps at this count, so a range change larger than the modulo is ambiguous. Carried per observation in the auxiliary data because a pass may use a shorter code.

RANGING_TYPE = 0#

Default SFDU 7 rng_type code of simulated sequential ranging, the starting ranging_type of a model.

RANGING_VERSION = 2#

Default SFDU 7 version_num of simulated sequential ranging, the starting ranging_version of a model.

RCV_TIME_TAG_DELAY = 0.0008 sec#

Default receive time-tag delay of simulated auxiliary data, the starting rcv_time_tag_delay of a model.

Representative, not physical: real passes carry the station value.

TRANSPONDER_DELAY = 1e-05#

Default spacecraft transponder delay [RU] of simulated auxiliary data, the starting transponder_delay of a model.

Representative, not physical: real passes carry the calibrated delay.

UL_STATION_CAL = 5000.0#

Default uplink station calibration [RU] of simulated auxiliary data, the starting ul_station_cal of a model.

Representative, not physical: real passes carry the station value.

property component_labels: tuple[str, str]#

Names of the two components of a vector observable.

A two-component measurement is split into one scalar dataset per component, and these are the suffixes those datasets carry — so they end up as the residual keys in solution.json. Each model sets them in its __init__ beside _measurement_type: AngularIdeal measures ("ra", "dec"), CentroidingIdeal ("sample", "line").

property computed_measurements_dict: dict#

Auxiliary TRK-2-34 tracking-data dictionary needed for the generation of the computed measurements of a real radiometric model. See the computed_measurements_dict parameter of DopplerReal and SequentialRangingReal for the keys each requires.

property default_dataset_name: str#

Dataset name used when the caller does not supply one.

"<instrument>_<measurement_type>", which is the convention the radiometric datasets already read as — DSS-14_RangeIdeal — and now the optical ones too. For a camera-based model the instrument is the camera, so a centroiding dataset comes out as NAC_CentroidingIdeal.

Note that an AngularIdeal observer is the spacecraft, not the camera (its name is resolved through SPICE), so a run that images with several cameras should pass dataset_name explicitly to tell them apart.

property dl_station_cal: float#

Downlink station calibration [RU] written into simulated auxiliary data. Starts as DL_STATION_CAL.

property dsn_bands: MappingProxyType#

DSN frequency-band parameters of this model, a read-only mapping from band letter to DSNBand. Starts as DSN_BANDS.

The band of a real model is looked up here, for the reference frequency that converts the transponder delay to seconds and the range unit of a tracking file without exciter scalars, and so is the band of the default_*_aux builders, which take its turnaround ratio, exciter scalars and uplink frequency.

Set a whole new mapping to change it; its keys are upper-cased.

Examples

X = model.dsn_bands["X"]
model.dsn_bands = {
    **model.dsn_bands,
    "X": dataclasses.replace(X, uplink_frequency=scb.ArrayWUnits(7.18e9, 1 / sec)),
}
property epoch_sec: EpochArray#

Observation epochs expressed as seconds of day.

property instrument: Instrument#

The instrument.

property media_corrections#

Tropospheric and ionospheric path-delay model, or None if not set.

property name: str#

The name of the model.

property ramp_entries: int#

Number of entries of a simulated ramp table, at least 2. Starts as RAMP_ENTRIES.

property ramp_margin: ArrayWUnits#

Span [s] a simulated ramp table extends before the first and after the last observation. Starts as RAMP_MARGIN; see _default_aux_grids() for why it is needed.

Set an ArrayWUnits time, or a bare, non-negative number of seconds.

property ramp_rate: ArrayWUnits#

Uplink frequency ramp rate [Hz/s] of the ramp table the default_*_aux builders simulate. Starts as RAMP_RATE.

Set an ArrayWUnits, converted to 1/s^2, or a bare number in Hz/s.

property ramp_type: int#

SFDU 9 ramp_type code of the segments of a simulated ramp table. Starts as RAMP_TYPE.

property range_modulo: int#

Code modulo [RU] of the sequential ranging default_seqranging_aux() simulates, a positive whole number. Starts as RANGE_MODULO.

A real pass keeps the modulo of its tracking file.

property ranging_type: int#

SFDU 7 rng_type code of the simulated sequential ranging. Starts as RANGING_TYPE.

property ranging_version: int#

SFDU 7 version_num of the simulated sequential ranging. Starts as RANGING_VERSION.

property rcv_time_tag_delay: ArrayWUnits#

Receive time-tag delay [s] written into simulated auxiliary data. Starts as RCV_TIME_TAG_DELAY.

Set an ArrayWUnits time, or a bare number of seconds.

property sigma: ArrayWUnits#

The standard deviation of the measurement model.

property solar_corona_coefficient: float#

Coefficient of the solar-corona group delay [us GHz^2 m^2] of a real model built with solar_corona=True. Starts as MediaCorrections.SOLAR_CORONA_DELAY_COEFF; see MediaCorrections._compute_SC_lt.

A fixed change of the delay model. To estimate a correction from the data, estimate solar_corona_scale instead.

station_eps_defaults = {'body_orientation_delta': 0.0001 rad, 'eop_delta_celestial_pole_x': 0.0001 rad, 'eop_delta_celestial_pole_y': 0.0001 rad, 'eop_delta_pole_x': 0.0001 rad, 'eop_delta_pole_y': 0.0001 rad, 'eop_delta_ut1': 1.0 sec, 'gs_delta_location_CYL': 1.0 km, 'gs_delta_location_ECEF': 1.0 km, 'iono_zenith_delay': 10.0 m, 'love_h2': 100.0, 'pole_dec': 0.0001 rad, 'pole_pm': 1e-06, 'pole_ra': 0.0001 rad, 'pole_w0': 0.0001 rad, 'shida_l2': 100.0, 'tropo_zenith_delay': 10.0 m}#

Finite-difference perturbations for station parameters, used only by partials_method="fd" (_compute_partials_with_fd()); every analytical path differentiates the station in closed form. They live in the same eps_dict as the spacecraft dx/dvx entries, keyed by StateDefinition parameter kind, so a model has one perturbation dictionary rather than two. The values are large because an RTLT solution and ramp integration lose significance in a small perturbation; they are numerical choices, not prior sigmas. The light time carries about 1e-13 s of noise per leg (SSB positions near 1.5e8 km), and a unit Love number moves a station by centimetres, so a Doppler fed by a step near one is mostly that noise. The tide and the zenith delays are exactly linear in their parameters, so their steps are as large as needed.

property transponder_delay: float#

Spacecraft transponder delay [RU] written into simulated auxiliary data by the default_*_aux builders. Starts as TRANSPONDER_DELAY.

Only simulated data: a real pass takes the sc_transponder_delay_RU given to observed_measurements, or else the delay in its tracking file.

property ul_station_cal: float#

Uplink station calibration [RU] written into simulated auxiliary data. Starts as UL_STATION_CAL.