MCRadar
- Workspace.MCRadar(self: pyarts.arts._Workspace, y: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.y, mc_error: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.mc_error, mc_antenna: pyarts.arts.WorkspaceVariable | pyarts.arts.MCAntenna | None = self.mc_antenna, f_grid: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.f_grid, f_index: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.f_index, sensor_pos: pyarts.arts.WorkspaceVariable | pyarts.arts.Matrix | None = self.sensor_pos, sensor_los: pyarts.arts.WorkspaceVariable | pyarts.arts.Matrix | None = self.sensor_los, stokes_dim: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.stokes_dim, atmosphere_dim: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.atmosphere_dim, ppath_lmax: pyarts.arts.WorkspaceVariable | pyarts.arts.Numeric | None = self.ppath_lmax, ppath_step_agenda: pyarts.arts.WorkspaceVariable | pyarts.arts.Agenda | None = self.ppath_step_agenda, ppath_lraytrace: pyarts.arts.WorkspaceVariable | pyarts.arts.Numeric | None = self.ppath_lraytrace, propmat_clearsky_agenda: pyarts.arts.WorkspaceVariable | pyarts.arts.Agenda | None = self.propmat_clearsky_agenda, 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, refellipsoid: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.refellipsoid, z_surface: pyarts.arts.WorkspaceVariable | pyarts.arts.Matrix | None = self.z_surface, t_field: pyarts.arts.WorkspaceVariable | pyarts.arts.Tensor3 | None = self.t_field, vmr_field: pyarts.arts.WorkspaceVariable | pyarts.arts.Tensor4 | None = self.vmr_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, scat_data: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfArrayOfSingleScatteringData | None = self.scat_data, mc_y_tx: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.mc_y_tx, range_bins: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.range_bins, atmfields_checked: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.atmfields_checked, atmgeom_checked: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.atmgeom_checked, scat_data_checked: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.scat_data_checked, cloudbox_checked: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.cloudbox_checked, iy_unit_radar: pyarts.arts.WorkspaceVariable | pyarts.arts.String | None = self.iy_unit_radar, mc_max_scatorder: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.mc_max_scatorder, mc_seed: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.mc_seed, mc_max_iter: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.mc_max_iter, ze_tref: pyarts.arts.WorkspaceVariable | pyarts.arts.Numeric | None = 273.15, k2: pyarts.arts.WorkspaceVariable | pyarts.arts.Numeric | None = -1, t_interp_order: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = 1, verbosity: pyarts.arts.WorkspaceVariable | pyarts.arts.Verbosity | None = self.verbosity) None
A radar 3D foward Monte Carlo radiative algorithm, that allows for 2D antenna patterns and arbitrary sensor positions. Surface reflections are currently ignored.
The main output variable
y
andmc_error
represent the radar reflectivity integrated over the antenna function, and the estimated error in this vector, respectively.Unlike with yRadar, the range bins gives the boundaries of the range bins as either round-trip time or distance from radar.
The WSV
mc_y_tx
gives the polarization state of the transmitter.The WSV
mc_max_scatorder
prescribes the maximum scattering order to consider, after which ‘photon’-tracing will be terminated. A value of one calculates only single scattering.The WSV
mc_max_iter
describes the maximum number of ‘photons’ used in the simulation (more photons means smallermc_error
). The method will terminate once the max_iter criterium is met. If negative values are given for these parameters then it is ignored.Here “1” and “Ze” are the allowed options for
iy_unit_radar
. The value ofmc_error
follows the selection foriy_unit_radar
(both for in- and output. SeeyRadar()
for details of the units.Author(s): Ian S. Adams
- Parameters:
y (Vector, optional) – The measurement vector. See
y
, defaults toself.y
[OUT]mc_error (Vector, optional) – Error in simulated
y
when using a Monte Carlo approach. Seemc_error
, defaults toself.mc_error
[OUT]mc_antenna (MCAntenna, optional) – Antenna pattern description for dedicated MC calculaions. See
mc_antenna
, defaults toself.mc_antenna
[IN]f_grid (Vector, optional) – The frequency grid for monochromatic pencil beam calculations. See
f_grid
, defaults toself.f_grid
[IN]f_index (Index, optional) – Frequency index. See
f_index
, defaults toself.f_index
[IN]sensor_pos (Matrix, optional) – The sensor position for each measurement block. See
sensor_pos
, defaults toself.sensor_pos
[IN]sensor_los (Matrix, optional) – The sensor line-of-sight (LOS) for each measurement block. See
sensor_los
, defaults toself.sensor_los
[IN]stokes_dim (Index, optional) – The dimensionality of the Stokes vector (1-4). See
stokes_dim
, defaults toself.stokes_dim
[IN]atmosphere_dim (Index, optional) – The atmospheric dimensionality (1-3). See
atmosphere_dim
, defaults toself.atmosphere_dim
[IN]ppath_lmax (Numeric, optional) – Maximum length between points describing propagation paths. See
ppath_lmax
, defaults toself.ppath_lmax
[IN]ppath_step_agenda (Agenda, optional) – Calculation of a propagation path step. See
ppath_step_agenda
, defaults toself.ppath_step_agenda
[IN]ppath_lraytrace (Numeric, optional) – Maximum length of ray tracing steps when determining propagation. See
ppath_lraytrace
, defaults toself.ppath_lraytrace
[IN]propmat_clearsky_agenda (Agenda, optional) – Calculate the absorption coefficient matrix. See
propmat_clearsky_agenda
, defaults toself.propmat_clearsky_agenda
[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]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]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]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]scat_data (ArrayOfArrayOfSingleScatteringData, optional) – Array of single scattering data. See
scat_data
, defaults toself.scat_data
[IN]mc_y_tx (Vector, optional) – Normalized Stokes vector for transmittance (e.g., radar). See
mc_y_tx
, defaults toself.mc_y_tx
[IN]range_bins (Vector, optional) – The range bins of an active instrument. See
range_bins
, defaults toself.range_bins
[IN]atmfields_checked (Index, optional) – OK-flag for atmospheric grids and (physical) fields. See
atmfields_checked
, defaults toself.atmfields_checked
[IN]atmgeom_checked (Index, optional) – OK-flag for the geometry of the model atmosphere. See
atmgeom_checked
, defaults toself.atmgeom_checked
[IN]scat_data_checked (Index, optional) – OK-flag for
scat_data
. Seescat_data_checked
, defaults toself.scat_data_checked
[IN]cloudbox_checked (Index, optional) – OK-flag for variables associated with the cloudbox. See
cloudbox_checked
, defaults toself.cloudbox_checked
[IN]iy_unit_radar (String, optional) – Unit for radar simulations. See
iy_unit_radar
, defaults toself.iy_unit_radar
[IN]mc_max_scatorder (Index, optional) – The maximum scattering order allowed for Monte Carlo. See
mc_max_scatorder
, defaults toself.mc_max_scatorder
[IN]mc_seed (Index, optional) – The integer seed for the random number generator used by. See
mc_seed
, defaults toself.mc_seed
[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]ze_tref (Numeric, optional) – Reference temperature for conversion to Ze. Defaults to
273.15
[IN]k2 (Numeric, optional) – Reference dielectric factor. Defaults to
-1
[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]