model_state_vecFromRadarOnionPeeling

Workspace.model_state_vecFromRadarOnionPeeling(self, model_state_vec: pyarts3.arts.Vector | None = None, measurement_vec_fit: pyarts3.arts.Vector | None = None, measurement_jac: pyarts3.arts.Matrix | None = None, atm_field: pyarts3.arts.AtmField | None = None, measurement_vec: pyarts3.arts.Vector | None = None, measurement_sensor: pyarts3.arts.ArrayOfSensorObsel | None = None, radar_range_limits: pyarts3.arts.Matrix | None = None, jac_targets: pyarts3.arts.JacobianTargets | None = None, surf_field: pyarts3.arts.SurfaceField | None = None, scat_species: pyarts3.arts.ArrayOfScatteringSpecies | None = None, ray_path_observer_agenda: pyarts3.arts.Agenda | None = None, spectral_propmat_agenda: pyarts3.arts.Agenda | None = None, transmitted_stokes: pyarts3.arts.Stokvec | None = None, range_mode: pyarts3.arts.String | None = None, unit: pyarts3.arts.String | None = None, ze_tref: pyarts3.arts.Numeric | None = None, k2: pyarts3.arts.Numeric | None = None, dbze_min: pyarts3.arts.Numeric | None = None, pext_scaling: pyarts3.arts.Numeric | None = None, measurement_noise_floor: pyarts3.arts.Numeric | None = None, state_min: pyarts3.arts.Numeric | None = None, state_max: pyarts3.arts.Numeric | None = None, max_step: pyarts3.arts.Numeric | None = None, tolerance: pyarts3.arts.Numeric | None = None, max_iterations: pyarts3.arts.Index | None = None, max_sweeps: pyarts3.arts.Index | None = None) → None

Retrieve an atmospheric radar profile by analytical onion peeling.

Range gates are processed from the sensor outwards. At each gate, the strongest not-yet-peeled atmospheric state coordinate is updated by a bounded Newton iteration. The forward value and derivative are provided by measurement_vecFromRadarSingleScattering(), so gaseous and particulate attenuation, ARO polarization, non-commuting outgoing/return propagation matrices, sensor polarization, and range-bin integration are identical to the standard radar forward model.

Unlike the ARTS2 implementation, this method does not create or consume a large dBZe/temperature inversion table. Scattering properties are evaluated directly through scat_species. jac_targets defines the retrieved state, including its grids and transformations. All targets must currently be atmospheric targets. The returned model_state_vec, updated atm_field, measurement_vec_fit, and measurement_jac are mutually consistent and can be used directly as the initial state and forward/Jacobian inputs of OEM.

Observations at or below measurement_noise_floor are ignored. state_min, state_max, and max_step apply in model-state coordinates, after any target transformation. Gates with no sensitivity to an unpeeled state coordinate are left unused. A non-convergent gate is reported as an error. This formulation is not restricted to the old two-species liquid/ice layout; phase selection may instead be expressed by the scattering-species properties and atmospheric state chosen by the caller.

Authors: Patrick Eriksson, OpenAI Codex

Parameters:

  • model_state_vec (Vector, optional) – A state vector of the model. See model_state_vec, defaults to self.model_state_vec [OUT]

  • measurement_vec_fit (Vector, optional) – As measurement_vec, but fitted to the model. See measurement_vec_fit, defaults to self.measurement_vec_fit [OUT]

  • measurement_jac (Matrix, optional) – The first order partial derivatives of the measurement_vec. See measurement_jac, defaults to self.measurement_jac [OUT]

  • atm_field (AtmField, optional) – An atmospheric field in ARTS, this is the main atmospheric data structure in ARTS. See atm_field, defaults to self.atm_field [OUT]

  • measurement_vec (Vector, optional) – The measurement vector for, e.g., a sensor. See measurement_vec, defaults to self.measurement_vec [IN]

  • measurement_sensor (ArrayOfSensorObsel, optional) – A list of sensor elements that fully describe one or more observing sensor(s). See measurement_sensor, defaults to self.measurement_sensor [IN]

  • radar_range_limits (Matrix, optional) – Range-gate limits for active-radar measurements. See radar_range_limits, defaults to self.radar_range_limits [IN]

  • jac_targets (JacobianTargets, optional) – A list of targets for the Jacobian Matrix calculations. See jac_targets, defaults to self.jac_targets [IN]

  • surf_field (SurfaceField, optional) – The surface field. See surf_field, defaults to self.surf_field [IN]

  • scat_species (ArrayOfScatteringSpecies, optional) – The scattering species. See scat_species, defaults to self.scat_species [IN]

  • ray_path_observer_agenda (Agenda, optional) – Gets the propagation path as it is observed. See ray_path_observer_agenda, defaults to self.ray_path_observer_agenda [IN]

  • spectral_propmat_agenda (Agenda, optional) – Computes the propagation matrix, the non-LTE source vector, and their derivatives. See spectral_propmat_agenda, defaults to self.spectral_propmat_agenda [IN]

  • transmitted_stokes (Stokvec, optional) – Transmitted Stokes vector; its I component must equal one. Defaults to 1 1 0 0 [IN]

  • range_mode (String, optional) – Range coordinate: Altitude, Distance, RoundTripTime, or Legacy. Defaults to "Legacy" [IN]

  • unit (String, optional) – Forward and observation unit: 1, Ze, or dBZe. Defaults to "1" [IN]

  • ze_tref (Numeric, optional) – Liquid-water reference temperature [K] for automatic k2. Defaults to 273.15 [IN]

  • k2 (Numeric, optional) – Reference dielectric factor squared; negative selects Liebe-93. Defaults to -1 [IN]

  • dbze_min (Numeric, optional) – Lower clipping value for dBZe. Defaults to -99 [IN]

  • pext_scaling (Numeric, optional) – Multiplicative factor for particulate extinction (0 to 2). Defaults to 1 [IN]

  • measurement_noise_floor (Numeric, optional) – Measurements at or below this value are ignored. Defaults to -1e+99 [IN]

  • state_min (Numeric, optional) – Lower bound in model-state coordinates. Defaults to 0 [IN]

  • state_max (Numeric, optional) – Upper bound in model-state coordinates. Defaults to 1e+99 [IN]

  • max_step (Numeric, optional) – Maximum absolute Newton step in model-state coordinates. Defaults to 1e+99 [IN]

  • tolerance (Numeric, optional) – Relative gate-fit convergence tolerance. Defaults to 1e-06 [IN]

  • max_iterations (Index, optional) – Maximum Newton iterations per gate. Defaults to 12 [IN]

  • max_sweeps (Index, optional) – Maximum repeated outward sweeps for interpolating state grids. Defaults to 8 [IN]