iyIndependentBeamApproximation
- Workspace.iyIndependentBeamApproximation(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, ppath: pyarts.arts.WorkspaceVariable | pyarts.arts.Ppath | None = self.ppath, diy_dx: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfTensor3 | None = self.diy_dx, atm_fields_compact: pyarts.arts.WorkspaceVariable | pyarts.arts.GriddedField4 | None = self.atm_fields_compact, iy_id: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.iy_id, 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, lat_grid: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.lat_grid, lon_grid: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.lon_grid, lat_true: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.lat_true, lon_true: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.lon_true, t_field: pyarts.arts.WorkspaceVariable | pyarts.arts.Tensor3 | None = self.t_field, z_field: pyarts.arts.WorkspaceVariable | pyarts.arts.Tensor3 | None = self.z_field, vmr_field: pyarts.arts.WorkspaceVariable | pyarts.arts.Tensor4 | None = self.vmr_field, nlte_field: pyarts.arts.WorkspaceVariable | pyarts.arts.EnergyLevelMap | None = self.nlte_field, 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, cloudbox_limits: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfIndex | None = self.cloudbox_limits, pnd_field: pyarts.arts.WorkspaceVariable | pyarts.arts.Tensor4 | None = self.pnd_field, particle_masses: pyarts.arts.WorkspaceVariable | pyarts.arts.Matrix | None = self.particle_masses, ppath_agenda: pyarts.arts.WorkspaceVariable | pyarts.arts.Agenda | None = self.ppath_agenda, ppath_lmax: pyarts.arts.WorkspaceVariable | pyarts.arts.Numeric | None = self.ppath_lmax, ppath_lraytrace: pyarts.arts.WorkspaceVariable | pyarts.arts.Numeric | None = self.ppath_lraytrace, iy_agenda_call1: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.iy_agenda_call1, iy_unit: pyarts.arts.WorkspaceVariable | pyarts.arts.String | None = self.iy_unit, iy_transmittance: pyarts.arts.WorkspaceVariable | pyarts.arts.Tensor3 | None = self.iy_transmittance, rte_pos: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.rte_pos, rte_los: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.rte_los, rte_pos2: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.rte_pos2, jacobian_do: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.jacobian_do, iy_aux_vars: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfString | None = self.iy_aux_vars, iy_independent_beam_approx_agenda: pyarts.arts.WorkspaceVariable | pyarts.arts.Agenda | None = self.iy_independent_beam_approx_agenda, return_atm1d: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = 0, skip_vmr: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = 0, skip_pnd: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = 0, return_masses: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = 0, verbosity: pyarts.arts.WorkspaceVariable | pyarts.arts.Verbosity | None = self.verbosity) None
Samples atmosphere along ppath and make 1D-type RT calculation.
The main application of this method should be to apply 1D scattering solvers on 2D or 3D atmospheres. The 1D calculation is set up inside
iy_independent_beam_approx_agenda
.The method calculates the ppath until reaching the surface or the top-of-the atmosphere. If the sensor is inside the atmosphere the ppath is extended from the sensor vertically to cover the remaining part of the atmosphere. All atmospheric fields are interpolated to the obtain ppath, to form a 1D view of the atmosphere. This 1D atmosphere forms the input to
iy_independent_beam_approx_agenda
lat_true
andlon_true
for the 1D view is set to the intersection with the surface of the ppath described above.The function accepts that the input atmosphere is 1D, as well as that there is no active cloudbox.
The constructed 1D atmosphere is exported if the GIN
return_atm1d
is set to 1. The default then is to include all atmospheric fields, butvmr_field
andpnd_field
can be deselected by two of the GIN-s. The order of the fields is specified by the first grid in the structure member grids. Ifatm_fields_compact
is denoted as A, then A.grids{0}{i} gives the name of field with index i. Each book invmr_field
andpnd_field
is stored separately. For example, the first book inpnd_field
is stored with the name “Scattering element 0”.Author(s): Patrick Eriksson
- 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]ppath (Ppath, optional) – The propagation path for one line-of-sight. See
ppath
, defaults toself.ppath
[OUT]diy_dx (ArrayOfTensor3, optional) – Derivative of
iy
with respect to retrieval quantities. Seediy_dx
, defaults toself.diy_dx
[INOUT]atm_fields_compact (GriddedField4, optional) – A compact set of atmospheric fields on a common set of grids. See
atm_fields_compact
, defaults toself.atm_fields_compact
[OUT]iy_id (Index, optional) – Identification number of
iy
. Seeiy_id
, defaults toself.iy_id
[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]lat_grid (Vector, optional) – The latitude grid. See
lat_grid
, defaults toself.lat_grid
[IN]lon_grid (Vector, optional) – The longitude grid. See
lon_grid
, defaults toself.lon_grid
[IN]lat_true (Vector, optional) – Latitudinal geolocation for 1D and 2D data. See
lat_true
, defaults toself.lat_true
[IN]lon_true (Vector, optional) – Longitudinal geolocation for 1D and 2D data. See
lon_true
, defaults toself.lon_true
[IN]t_field (Tensor3, optional) – The field of atmospheric temperatures. See
t_field
, defaults toself.t_field
[IN]z_field (Tensor3, optional) – The field of geometrical altitudes. See
z_field
, defaults toself.z_field
[IN]vmr_field (Tensor4, optional) – VMR field. See
vmr_field
, defaults toself.vmr_field
[IN]nlte_field (EnergyLevelMap, optional) – The field of NLTE temperatures and/or ratios. See
nlte_field
, defaults toself.nlte_field
[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]cloudbox_limits (ArrayOfIndex, optional) – The limits of the cloud box. See
cloudbox_limits
, defaults toself.cloudbox_limits
[IN]pnd_field (Tensor4, optional) – Particle number density field. See
pnd_field
, defaults toself.pnd_field
[IN]particle_masses (Matrix, optional) – The mass of individual particles (or bulks). See
particle_masses
, defaults toself.particle_masses
[IN]ppath_agenda (Agenda, optional) – Calculation of complete propagation paths. See
ppath_agenda
, defaults toself.ppath_agenda
[IN]ppath_lmax (Numeric, optional) – Maximum length between points describing propagation paths. See
ppath_lmax
, defaults toself.ppath_lmax
[IN]ppath_lraytrace (Numeric, optional) – Maximum length of ray tracing steps when determining propagation. See
ppath_lraytrace
, defaults toself.ppath_lraytrace
[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_unit (String, optional) – Selection of output unit for radiative transfer methods. See
iy_unit
, defaults toself.iy_unit
[IN]iy_transmittance (Tensor3, optional) – Transmittance to be included in
iy
. Seeiy_transmittance
, defaults toself.iy_transmittance
[IN]rte_pos (Vector, optional) – A geographical position for starting radiative transfer calculations. See
rte_pos
, defaults toself.rte_pos
[IN]rte_los (Vector, optional) – A line-of-sight for (complete) radiative transfer calculations. See
rte_los
, defaults toself.rte_los
[IN]rte_pos2 (Vector, optional) – A second geographical position to define the geometry for. See
rte_pos2
, defaults toself.rte_pos2
[IN]jacobian_do (Index, optional) – Flag to activate (clear-sky) Jacobian calculations. See
jacobian_do
, defaults toself.jacobian_do
[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]iy_independent_beam_approx_agenda (Agenda, optional) – Agenda dedicated to
iyIndependentBeamApproximation()
. Seeiy_independent_beam_approx_agenda
, defaults toself.iy_independent_beam_approx_agenda
[IN]return_atm1d (Index, optional) – Flag to trigger that
atm_fields_compact
is filled. . Defaults to0
[IN]skip_vmr (Index, optional) – Flag to not include vmr data in
atm_fields_compact
. Defaults to0
[IN]skip_pnd (Index, optional) – Flag to not include pnd data in
atm_fields_compact
. Defaults to0
[IN]return_masses (Index, optional) – Flag to include particle category masses in
atm_fields_compact
.Conversion is done byparticle_masses
. Defaults to0
[IN]verbosity (Verbosity) – ARTS verbosity. See
verbosity
, defaults toself.verbosity
[IN]