iyEmissionStandard
- Workspace.iyEmissionStandard(self: pyarts.arts._Workspace, iy: pyarts.arts.WorkspaceVariable | pyarts.arts.Matrix | None = self.iy, iy_aux: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfMatrix | None = self.iy_aux, diy_dx: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfTensor3 | None = self.diy_dx, ppvar_p: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.ppvar_p, ppvar_t: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.ppvar_t, ppvar_nlte: pyarts.arts.WorkspaceVariable | pyarts.arts.EnergyLevelMap | None = self.ppvar_nlte, ppvar_vmr: pyarts.arts.WorkspaceVariable | pyarts.arts.Matrix | None = self.ppvar_vmr, ppvar_wind: pyarts.arts.WorkspaceVariable | pyarts.arts.Matrix | None = self.ppvar_wind, ppvar_mag: pyarts.arts.WorkspaceVariable | pyarts.arts.Matrix | None = self.ppvar_mag, ppvar_f: pyarts.arts.WorkspaceVariable | pyarts.arts.Matrix | None = self.ppvar_f, ppvar_iy: pyarts.arts.WorkspaceVariable | pyarts.arts.Tensor3 | None = self.ppvar_iy, ppvar_trans_cumulat: pyarts.arts.WorkspaceVariable | pyarts.arts.Tensor4 | None = self.ppvar_trans_cumulat, ppvar_trans_partial: pyarts.arts.WorkspaceVariable | pyarts.arts.Tensor4 | None = self.ppvar_trans_partial, iy_id: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.iy_id, stokes_dim: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.stokes_dim, f_grid: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.f_grid, atmosphere_dim: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.atmosphere_dim, p_grid: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.p_grid, t_field: pyarts.arts.WorkspaceVariable | pyarts.arts.Tensor3 | None = self.t_field, nlte_field: pyarts.arts.WorkspaceVariable | pyarts.arts.EnergyLevelMap | None = self.nlte_field, vmr_field: pyarts.arts.WorkspaceVariable | pyarts.arts.Tensor4 | None = self.vmr_field, abs_species: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfArrayOfSpeciesTag | None = self.abs_species, wind_u_field: pyarts.arts.WorkspaceVariable | pyarts.arts.Tensor3 | None = self.wind_u_field, wind_v_field: pyarts.arts.WorkspaceVariable | pyarts.arts.Tensor3 | None = self.wind_v_field, wind_w_field: pyarts.arts.WorkspaceVariable | pyarts.arts.Tensor3 | None = self.wind_w_field, mag_u_field: pyarts.arts.WorkspaceVariable | pyarts.arts.Tensor3 | None = self.mag_u_field, mag_v_field: pyarts.arts.WorkspaceVariable | pyarts.arts.Tensor3 | None = self.mag_v_field, mag_w_field: pyarts.arts.WorkspaceVariable | pyarts.arts.Tensor3 | None = self.mag_w_field, cloudbox_on: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.cloudbox_on, iy_unit: pyarts.arts.WorkspaceVariable | pyarts.arts.String | None = self.iy_unit, iy_aux_vars: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfString | None = self.iy_aux_vars, jacobian_do: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.jacobian_do, jacobian_quantities: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfRetrievalQuantity | None = self.jacobian_quantities, ppath: pyarts.arts.WorkspaceVariable | pyarts.arts.Ppath | None = self.ppath, rte_pos2: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.rte_pos2, propmat_clearsky_agenda: pyarts.arts.WorkspaceVariable | pyarts.arts.Agenda | None = self.propmat_clearsky_agenda, water_p_eq_agenda: pyarts.arts.WorkspaceVariable | pyarts.arts.Agenda | None = self.water_p_eq_agenda, rt_integration_option: pyarts.arts.WorkspaceVariable | pyarts.arts.String | None = self.rt_integration_option, iy_main_agenda: pyarts.arts.WorkspaceVariable | pyarts.arts.Agenda | None = self.iy_main_agenda, iy_space_agenda: pyarts.arts.WorkspaceVariable | pyarts.arts.Agenda | None = self.iy_space_agenda, iy_surface_agenda: pyarts.arts.WorkspaceVariable | pyarts.arts.Agenda | None = self.iy_surface_agenda, iy_cloudbox_agenda: pyarts.arts.WorkspaceVariable | pyarts.arts.Agenda | None = self.iy_cloudbox_agenda, iy_agenda_call1: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.iy_agenda_call1, iy_transmittance: pyarts.arts.WorkspaceVariable | pyarts.arts.Tensor3 | None = self.iy_transmittance, rte_alonglos_v: pyarts.arts.WorkspaceVariable | pyarts.arts.Numeric | None = self.rte_alonglos_v, surface_props_data: pyarts.arts.WorkspaceVariable | pyarts.arts.Tensor3 | None = self.surface_props_data, verbosity: pyarts.arts.WorkspaceVariable | pyarts.arts.Verbosity | None = self.verbosity) None
Standard method for radiative transfer calculations with emission.
Designed to be part of
iy_main_agenda
. That is, only valid outside the cloudbox (no scattering). For details se the user guide.The possible choices for
iy_unit
are"1"
: No conversion, i.e. [W/(m^2 Hz sr)] (radiance per frequency unit)."RJBT"
: Conversion to Rayleigh-Jean brightness temperature."PlanckBT"
: Conversion to Planck brightness temperature."W/(m^2 m sr)"
: Conversion to [W/(m^2 m sr)] (radiance per wavelength unit)."W/(m^2 m-1 sr)"
: Conversion to [W/(m^2 m-1 sr)] (radiance per wavenumber unit).
Expressions applied and considerations for the unit conversion of radiances are discussed in Sec. 5.7 of the ARTS-2.0 article.
iy_unit
is only applied ifiy_agenda_call1
is 1. This means that no unit ocnversion is applied for internal iterative calls.Recognised choices for
rt_integration_option
are:"first order"
: A first order integration is applied."second order"
: A second order integration is applied."default"
: Another way to select the first order option.
Some auxiliary radiative transfer quantities can be obtained. Auxiliary quantities are selected by
iy_aux_vars
and returned byiy_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.
"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.
If nothing else is stated, only the first column of
iy_aux
is filled, i.e. the column matching Stokes element I, while remaing columns are are filled with zeros.Author(s): Patrick Eriksson, Richard Larsson, Oliver Lemke
- Parameters:
iy (Matrix, optional) – Monochromatic pencil beam radiance spectrum. See
iy
, defaults toself.iy
[OUT]iy_aux (ArrayOfMatrix, optional) – Data auxiliary to
iy
. Seeiy_aux
, defaults toself.iy_aux
[OUT]diy_dx (ArrayOfTensor3, optional) – Derivative of
iy
with respect to retrieval quantities. Seediy_dx
, defaults toself.diy_dx
[INOUT]ppvar_p (Vector, optional) – Pressure along the propagation path. See
ppvar_p
, defaults toself.ppvar_p
[OUT]ppvar_t (Vector, optional) – Temperature along the propagation path. See
ppvar_t
, defaults toself.ppvar_t
[OUT]ppvar_nlte (EnergyLevelMap, optional) – Non-LTE temperatures/ratios along the propagation path. See
ppvar_nlte
, defaults toself.ppvar_nlte
[OUT]ppvar_vmr (Matrix, optional) – VMR values along the propagation path. See
ppvar_vmr
, defaults toself.ppvar_vmr
[OUT]ppvar_wind (Matrix, optional) – Winds along the propagation path. See
ppvar_wind
, defaults toself.ppvar_wind
[OUT]ppvar_mag (Matrix, optional) – Magnetic field along the propagation path. See
ppvar_mag
, defaults toself.ppvar_mag
[OUT]ppvar_f (Matrix, optional) – Doppler adjusted frequencies along the propagation path. See
ppvar_f
, defaults toself.ppvar_f
[OUT]ppvar_iy (Tensor3, optional) – iy-values along the propagation path. See
ppvar_iy
, defaults toself.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 toself.ppvar_trans_cumulat
[OUT]ppvar_trans_partial (Tensor4, optional) – The transmittance between the points along the propagation path. See
ppvar_trans_partial
, defaults toself.ppvar_trans_partial
[OUT]iy_id (Index, optional) – Identification number of
iy
. Seeiy_id
, defaults toself.iy_id
[IN]stokes_dim (Index, optional) – The dimensionality of the Stokes vector (1-4). See
stokes_dim
, defaults toself.stokes_dim
[IN]f_grid (Vector, optional) – The frequency grid for monochromatic pencil beam calculations. See
f_grid
, defaults toself.f_grid
[IN]atmosphere_dim (Index, optional) – The atmospheric dimensionality (1-3). See
atmosphere_dim
, defaults toself.atmosphere_dim
[IN]p_grid (Vector, optional) – The pressure grid. See
p_grid
, defaults toself.p_grid
[IN]t_field (Tensor3, optional) – The field of atmospheric temperatures. See
t_field
, defaults toself.t_field
[IN]nlte_field (EnergyLevelMap, optional) – The field of NLTE temperatures and/or ratios. See
nlte_field
, defaults toself.nlte_field
[IN]vmr_field (Tensor4, optional) – VMR field. See
vmr_field
, defaults toself.vmr_field
[IN]abs_species (ArrayOfArrayOfSpeciesTag, optional) – Tag groups for gas absorption. See
abs_species
, defaults toself.abs_species
[IN]wind_u_field (Tensor3, optional) – Zonal component of the wind field. See
wind_u_field
, defaults toself.wind_u_field
[IN]wind_v_field (Tensor3, optional) – Meridional component of the magnetic field. See
wind_v_field
, defaults toself.wind_v_field
[IN]wind_w_field (Tensor3, optional) – Vertical wind component field. See
wind_w_field
, defaults toself.wind_w_field
[IN]mag_u_field (Tensor3, optional) – Zonal component of the magnetic field. See
mag_u_field
, defaults toself.mag_u_field
[IN]mag_v_field (Tensor3, optional) – Meridional component of the magnetic field. See
mag_v_field
, defaults toself.mag_v_field
[IN]mag_w_field (Tensor3, optional) – Vertical component of the magnetic field. See
mag_w_field
, defaults toself.mag_w_field
[IN]cloudbox_on (Index, optional) – Flag to activate the cloud box. See
cloudbox_on
, defaults toself.cloudbox_on
[IN]iy_unit (String, optional) – Selection of output unit for radiative transfer methods. See
iy_unit
, defaults toself.iy_unit
[IN]iy_aux_vars (ArrayOfString, optional) – Selection of quantities for
iy_aux
and when applicable alsoy_aux
. Seeiy_aux_vars
, defaults toself.iy_aux_vars
[IN]jacobian_do (Index, optional) – Flag to activate (clear-sky) Jacobian calculations. See
jacobian_do
, defaults toself.jacobian_do
[IN]jacobian_quantities (ArrayOfRetrievalQuantity, optional) – The retrieval quantities in the Jacobian matrix. See
jacobian_quantities
, defaults toself.jacobian_quantities
[IN]ppath (Ppath, optional) – The propagation path for one line-of-sight. See
ppath
, defaults toself.ppath
[IN]rte_pos2 (Vector, optional) – A second geographical position to define the geometry for. See
rte_pos2
, defaults toself.rte_pos2
[IN]propmat_clearsky_agenda (Agenda, optional) – Calculate the absorption coefficient matrix. See
propmat_clearsky_agenda
, defaults toself.propmat_clearsky_agenda
[IN]water_p_eq_agenda (Agenda, optional) – Calculation of the saturation pressure of water. See
water_p_eq_agenda
, defaults toself.water_p_eq_agenda
[IN]rt_integration_option (String, optional) – Switch between integration approaches for radiative transfer steps. See
rt_integration_option
, defaults toself.rt_integration_option
[IN]iy_main_agenda (Agenda, optional) – Calculation of a single monochromatic pencil beam spectrum. See
iy_main_agenda
, defaults toself.iy_main_agenda
[IN]iy_space_agenda (Agenda, optional) – Downwelling radiation at the top of the atmosphere. See
iy_space_agenda
, defaults toself.iy_space_agenda
[IN]iy_surface_agenda (Agenda, optional) – Upwelling radiation from the surface. See
iy_surface_agenda
, defaults toself.iy_surface_agenda
[IN]iy_cloudbox_agenda (Agenda, optional) – Intensity at boundary or interior of the cloudbox. See
iy_cloudbox_agenda
, defaults toself.iy_cloudbox_agenda
[IN]iy_agenda_call1 (Index, optional) – Flag to handle recursive calls of
iy_main_agenda
. Seeiy_agenda_call1
, defaults toself.iy_agenda_call1
[IN]iy_transmittance (Tensor3, optional) – Transmittance to be included in
iy
. Seeiy_transmittance
, defaults toself.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 toself.rte_alonglos_v
[IN]surface_props_data (Tensor3, optional) – Various surface properties. See
surface_props_data
, defaults toself.surface_props_data
[IN]verbosity (Verbosity) – ARTS verbosity. See
verbosity
, defaults toself.verbosity
[IN]