iyMC
- Workspace.iyMC(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, 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_pos: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.rte_pos, rte_los: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.rte_los, 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, 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, z_field: pyarts.arts.WorkspaceVariable | pyarts.arts.Tensor3 | None = self.z_field, t_field: pyarts.arts.WorkspaceVariable | pyarts.arts.Tensor3 | None = self.t_field, vmr_field: pyarts.arts.WorkspaceVariable | pyarts.arts.Tensor4 | None = self.vmr_field, refellipsoid: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.refellipsoid, z_surface: pyarts.arts.WorkspaceVariable | pyarts.arts.Matrix | None = self.z_surface, cloudbox_on: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.cloudbox_on, cloudbox_limits: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfIndex | None = self.cloudbox_limits, stokes_dim: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.stokes_dim, f_grid: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.f_grid, scat_data: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfArrayOfSingleScatteringData | None = self.scat_data, iy_space_agenda: pyarts.arts.WorkspaceVariable | pyarts.arts.Agenda | None = self.iy_space_agenda, surface_rtprop_agenda: pyarts.arts.WorkspaceVariable | pyarts.arts.Agenda | None = self.surface_rtprop_agenda, propmat_clearsky_agenda: pyarts.arts.WorkspaceVariable | pyarts.arts.Agenda | None = self.propmat_clearsky_agenda, ppath_step_agenda: pyarts.arts.WorkspaceVariable | pyarts.arts.Agenda | None = self.ppath_step_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, pnd_field: pyarts.arts.WorkspaceVariable | pyarts.arts.Tensor4 | None = self.pnd_field, iy_unit: pyarts.arts.WorkspaceVariable | pyarts.arts.String | None = self.iy_unit, mc_std_err: pyarts.arts.WorkspaceVariable | pyarts.arts.Numeric | None = self.mc_std_err, mc_max_time: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.mc_max_time, mc_max_iter: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.mc_max_iter, mc_min_iter: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.mc_min_iter, mc_taustep_limit: pyarts.arts.WorkspaceVariable | pyarts.arts.Numeric | None = self.mc_taustep_limit, t_interp_order: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = 1, verbosity: pyarts.arts.WorkspaceVariable | pyarts.arts.Verbosity | None = self.verbosity) None
Interface to Monte Carlo part for
iy_main_agenda
.Basically an interface to
MCGeneral()
for doing monochromatic pencil beam calculations. This functions allows Monte Carlo (MC) calculations for sets of frequencies and sensor pos/los in a single run. Sensor responses can be included in the standard manner (throughyCalc()
).This function does not apply the MC approach when it comes to sensor properties. These properties are not considered when tracking photons, which is done in
MCGeneral()
(but then only for the antenna pattern).Output unit options (
iy_unit
) exactly as forMCGeneral()
.The MC calculation errors are all assumed be uncorrelated and each have a normal distribution. These properties are of relevance when weighting the errors with the sensor repsonse matrix. The seed is reset for each call of
MCGeneral()
to obtain uncorrelated errors.MC control arguments (mc_std_err, mc_max_time, mc_min_iter, mc_max_iter mc_taustep_limit) as for
MCGeneral()
. The arguments are applied for each monochromatic pencil beam calculation individually. As forMCGeneral()
, the value ofmc_error
shall be adopted toiy_unit
.The following auxiliary data can be obtained:
"Error (uncorrelated)"
:Calculation error. Size: [nf,ns,1,1]. (The later part of the text string is required. It is used as a flag to yCalc for how to apply the sensor data.)
where
nf: Number of frequencies.
ns: Number of Stokes elements.
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]diy_dx (ArrayOfTensor3, optional) – Derivative of
iy
with respect to retrieval quantities. Seediy_dx
, defaults toself.diy_dx
[OUT]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_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]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]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]z_field (Tensor3, optional) – The field of geometrical altitudes. See
z_field
, defaults toself.z_field
[IN]t_field (Tensor3, optional) – The field of atmospheric temperatures. See
t_field
, defaults toself.t_field
[IN]vmr_field (Tensor4, optional) – VMR field. See
vmr_field
, defaults toself.vmr_field
[IN]refellipsoid (Vector, optional) – Reference ellipsoid. See
refellipsoid
, defaults toself.refellipsoid
[IN]z_surface (Matrix, optional) – The surface altitude. See
z_surface
, defaults toself.z_surface
[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]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]scat_data (ArrayOfArrayOfSingleScatteringData, optional) – Array of single scattering data. See
scat_data
, defaults toself.scat_data
[IN]iy_space_agenda (Agenda, optional) – Downwelling radiation at the top of the atmosphere. See
iy_space_agenda
, defaults toself.iy_space_agenda
[IN]surface_rtprop_agenda (Agenda, optional) – Provides radiative properties of the surface. . See
surface_rtprop_agenda
, defaults toself.surface_rtprop_agenda
[IN]propmat_clearsky_agenda (Agenda, optional) – Calculate the absorption coefficient matrix. See
propmat_clearsky_agenda
, defaults toself.propmat_clearsky_agenda
[IN]ppath_step_agenda (Agenda, optional) – Calculation of a propagation path step. See
ppath_step_agenda
, defaults toself.ppath_step_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]pnd_field (Tensor4, optional) – Particle number density field. See
pnd_field
, defaults toself.pnd_field
[IN]iy_unit (String, optional) – Selection of output unit for radiative transfer methods. See
iy_unit
, defaults toself.iy_unit
[IN]mc_std_err (Numeric, optional) – Target precision (1 std. dev.) for Monte Carlo calculations. See
mc_std_err
, defaults toself.mc_std_err
[IN]mc_max_time (Index, optional) – The maximum time allowed for Monte Carlo calculations. See
mc_max_time
, defaults toself.mc_max_time
[IN]mc_max_iter (Index, optional) – The maximum number of iterations allowed for Monte Carlo. See
mc_max_iter
, defaults toself.mc_max_iter
[IN]mc_min_iter (Index, optional) – The minimum number of iterations allowed for Monte Carlo. See
mc_min_iter
, defaults toself.mc_min_iter
[IN]mc_taustep_limit (Numeric, optional) – Defines an upper step length in terms of optical thickness for Monte Carlo calculations. See
mc_taustep_limit
, defaults toself.mc_taustep_limit
[IN]t_interp_order (Index, optional) – Interpolation order of temperature for scattering data (so far only applied in phase matrix, not in extinction and absorption. Defaults to
1
[IN]verbosity (Verbosity) – ARTS verbosity. See
verbosity
, defaults toself.verbosity
[IN]