iyTransmissionStandard

Standard method for handling transmission measurements.

Designed to be part of iy_main_agenda. Treatment of the cloudbox is incorporated (that is, no need to define iy_cloudbox_agenda).

The transmitter is assumed to be placed at the end of provided ppath. The transmitted signal is taken from iy_transmitter. This signal is propagated along the path, considering attenuation alone. That is, the result of the method (iy) is the output of iy_transmitter multiplied with the transmittance along the propagation path.

As mentioned, the given ppath determines the position of the transmitter. For clear-sky and no modification of ppath, this means that the transitter will either be found at the surface or at the top-of-the-atmosphere. If you want to maintain this even with an active cloudbox, calculate ppath as:

ppathCalc( cloudbox_on=0 )

Without setting cloudbox_on=0, the transmitter will end up inside or at the boundary of the cloudbox.

Some auxiliary radiative transfer quantities can be obtained. Auxiliary quantities are selected by iy_aux_vars and returned by iy_aux. Valid choices for auxiliary data are:

"Radiative background":
Index value flagging the radiative background. The following coding is used: 0=space, 1=surface and 2=cloudbox. The value is added to each column.
"Optical depth":
Scalar optical depth between the observation point and the end of the present propagation path. Calculated based on the (1,1)-element of the transmittance matrix (1-based indexing), i.e. only fully valid for scalar RT. The value is added to each column.

Important

No jacobian calculation is supported when gas scattering is included! This will be implemented in a future version.

Author(s): Patrick Eriksson, Richard Larsson

Parameters:

iy (Matrix, optional) – Monochromatic pencil beam radiance spectrum. See iy, defaults to self.iy [OUT]
iy_aux (ArrayOfMatrix, optional) – Data auxiliary to iy. See iy_aux, defaults to self.iy_aux [OUT]
diy_dx (ArrayOfTensor3, optional) – Derivative of iy with respect to retrieval quantities. See diy_dx, defaults to self.diy_dx [INOUT]
ppvar_p (Vector, optional) – Pressure along the propagation path. See ppvar_p, defaults to self.ppvar_p [OUT]
ppvar_t (Vector, optional) – Temperature along the propagation path. See ppvar_t, defaults to self.ppvar_t [OUT]
ppvar_nlte (EnergyLevelMap, optional) – Non-LTE temperatures/ratios along the propagation path. See ppvar_nlte, defaults to self.ppvar_nlte [OUT]
ppvar_vmr (Matrix, optional) – VMR values along the propagation path. See ppvar_vmr, defaults to self.ppvar_vmr [OUT]
ppvar_wind (Matrix, optional) – Winds along the propagation path. See ppvar_wind, defaults to self.ppvar_wind [OUT]
ppvar_mag (Matrix, optional) – Magnetic field along the propagation path. See ppvar_mag, defaults to self.ppvar_mag [OUT]
ppvar_pnd (Matrix, optional) – PND values along the propagation path. See ppvar_pnd, defaults to self.ppvar_pnd [OUT]
ppvar_f (Matrix, optional) – Doppler adjusted frequencies along the propagation path. See ppvar_f, defaults to self.ppvar_f [OUT]
ppvar_iy (Tensor3, optional) – iy-values along the propagation path. See ppvar_iy, defaults to self.ppvar_iy [OUT]
ppvar_trans_cumulat (Tensor4, optional) – The transmittance between the sensor and each point of the propagation path. See ppvar_trans_cumulat, defaults to self.ppvar_trans_cumulat [OUT]
ppvar_trans_partial (Tensor4, optional) – The transmittance between the points along the propagation path. See ppvar_trans_partial, defaults to self.ppvar_trans_partial [OUT]
stokes_dim (Index, optional) – The dimensionality of the Stokes vector (1-4). See stokes_dim, defaults to self.stokes_dim [IN]
f_grid (Vector, optional) – The frequency grid for monochromatic pencil beam calculations. See f_grid, defaults to self.f_grid [IN]
atmosphere_dim (Index, optional) – The atmospheric dimensionality (1-3). See atmosphere_dim, defaults to self.atmosphere_dim [IN]
p_grid (Vector, optional) – The pressure grid. See p_grid, defaults to self.p_grid [IN]
t_field (Tensor3, optional) – The field of atmospheric temperatures. See t_field, defaults to self.t_field [IN]
nlte_field (EnergyLevelMap, optional) – The field of NLTE temperatures and/or ratios. See nlte_field, defaults to self.nlte_field [IN]
vmr_field (Tensor4, optional) – VMR field. See vmr_field, defaults to self.vmr_field [IN]
abs_species (ArrayOfArrayOfSpeciesTag, optional) – Tag groups for gas absorption. See abs_species, defaults to self.abs_species [IN]
wind_u_field (Tensor3, optional) – Zonal component of the wind field. See wind_u_field, defaults to self.wind_u_field [IN]
wind_v_field (Tensor3, optional) – Meridional component of the magnetic field. See wind_v_field, defaults to self.wind_v_field [IN]
wind_w_field (Tensor3, optional) – Vertical wind component field. See wind_w_field, defaults to self.wind_w_field [IN]
mag_u_field (Tensor3, optional) – Zonal component of the magnetic field. See mag_u_field, defaults to self.mag_u_field [IN]
mag_v_field (Tensor3, optional) – Meridional component of the magnetic field. See mag_v_field, defaults to self.mag_v_field [IN]
mag_w_field (Tensor3, optional) – Vertical component of the magnetic field. See mag_w_field, defaults to self.mag_w_field [IN]
cloudbox_on (Index, optional) – Flag to activate the cloud box. See cloudbox_on, defaults to self.cloudbox_on [IN]
cloudbox_limits (ArrayOfIndex, optional) – The limits of the cloud box. See cloudbox_limits, defaults to self.cloudbox_limits [IN]
gas_scattering_do (Index, optional) – Flag to activate gas scattering. See gas_scattering_do, defaults to self.gas_scattering_do [IN]
pnd_field (Tensor4, optional) – Particle number density field. See pnd_field, defaults to self.pnd_field [IN]
dpnd_field_dx (ArrayOfTensor4, optional) – Partial derivatives of pnd_field. See dpnd_field_dx, defaults to self.dpnd_field_dx [IN]
scat_species (ArrayOfString, optional) – Array of Strings defining the scattering species to consider. See scat_species, defaults to self.scat_species [IN]
scat_data (ArrayOfArrayOfSingleScatteringData, optional) – Array of single scattering data. See scat_data, defaults to self.scat_data [IN]
iy_aux_vars (ArrayOfString, optional) – Selection of quantities for iy_aux and when applicable also y_aux. See iy_aux_vars, defaults to self.iy_aux_vars [IN]
jacobian_do (Index, optional) – Flag to activate (clear-sky) Jacobian calculations. See jacobian_do, defaults to self.jacobian_do [IN]
jacobian_quantities (ArrayOfRetrievalQuantity, optional) – The retrieval quantities in the Jacobian matrix. See jacobian_quantities, defaults to self.jacobian_quantities [IN]
ppath (Ppath, optional) – The propagation path for one line-of-sight. See ppath, defaults to self.ppath [IN]
iy_transmitter (Matrix, optional) – Monochromatic pencil beam radiance spectrum of transmitter signal. See iy_transmitter, defaults to self.iy_transmitter [IN]
propmat_clearsky_agenda (Agenda, optional) – Calculate the absorption coefficient matrix. See propmat_clearsky_agenda, defaults to self.propmat_clearsky_agenda [IN]
water_p_eq_agenda (Agenda, optional) – Calculation of the saturation pressure of water. See water_p_eq_agenda, defaults to self.water_p_eq_agenda [IN]
gas_scattering_agenda (Agenda, optional) – Calculation of the gas scattering extinction and phase matrix. See gas_scattering_agenda, defaults to self.gas_scattering_agenda [IN]
iy_agenda_call1 (Index, optional) – Flag to handle recursive calls of iy_main_agenda. See iy_agenda_call1, defaults to self.iy_agenda_call1 [IN]
iy_transmittance (Tensor3, optional) – Transmittance to be included in iy. See iy_transmittance, defaults to self.iy_transmittance [IN]
rte_alonglos_v (Numeric, optional) – Velocity along the line-of-sight to consider for a RT calculation. See rte_alonglos_v, defaults to self.rte_alonglos_v [IN]
verbosity (Verbosity) – ARTS verbosity. See verbosity, defaults to self.verbosity [IN]