yRadar
- Workspace.yRadar(self: pyarts.arts._Workspace, y: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.y, y_f: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.y_f, y_pol: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfIndex | None = self.y_pol, y_pos: pyarts.arts.WorkspaceVariable | pyarts.arts.Matrix | None = self.y_pos, y_los: pyarts.arts.WorkspaceVariable | pyarts.arts.Matrix | None = self.y_los, y_aux: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfVector | None = self.y_aux, y_geo: pyarts.arts.WorkspaceVariable | pyarts.arts.Matrix | None = self.y_geo, jacobian: pyarts.arts.WorkspaceVariable | pyarts.arts.Matrix | None = self.jacobian, atmgeom_checked: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.atmgeom_checked, atmfields_checked: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.atmfields_checked, iy_unit_radar: pyarts.arts.WorkspaceVariable | pyarts.arts.String | None = self.iy_unit_radar, iy_aux_vars: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfString | None = self.iy_aux_vars, stokes_dim: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.stokes_dim, f_grid: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.f_grid, cloudbox_on: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.cloudbox_on, cloudbox_checked: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.cloudbox_checked, sensor_pos: pyarts.arts.WorkspaceVariable | pyarts.arts.Matrix | None = self.sensor_pos, sensor_los: pyarts.arts.WorkspaceVariable | pyarts.arts.Matrix | None = self.sensor_los, sensor_checked: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.sensor_checked, jacobian_do: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.jacobian_do, jacobian_quantities: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfRetrievalQuantity | None = self.jacobian_quantities, iy_radar_agenda: pyarts.arts.WorkspaceVariable | pyarts.arts.Agenda | None = self.iy_radar_agenda, instrument_pol_array: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfArrayOfIndex | None = self.instrument_pol_array, range_bins: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.range_bins, ze_tref: pyarts.arts.WorkspaceVariable | pyarts.arts.Numeric | None = 273.15, k2: pyarts.arts.WorkspaceVariable | pyarts.arts.Numeric | None = -1, dbze_min: pyarts.arts.WorkspaceVariable | pyarts.arts.Numeric | None = -99, verbosity: pyarts.arts.WorkspaceVariable | pyarts.arts.Verbosity | None = self.verbosity) None
Replaces
yCalc()for radar/lidar calculations.The output format for
iywhen simulating radars and lidars differs from the standard one, andyCalc()can not be used for such simulations. This method works largely asyCalc(), but is tailored to handle the output fromiyRadarSingleScat(). Note thatiy_radar_agendareplacesiy_main_agenda.The method requires additional information about the sensor, regarding its recieving properties. First of all, recieved polarisation states are taken from
instrument_pol_array. Note that this WSV allows to define several measured polarisations for each transmitted signal. For example, it is possible to simulate transmittance of V and measuring backsacttered V and H.Secondly, the range averaging is described by
range_bins. These bins can either be specified in altitude or two-way travel time. In both case, the edges of the range bins shall be specified. All data (including auxiliary variables) are returned as the average inside the bins. If a bin is totally outside the model atmosphere, NaN is returned.The options for
iy_unit_radarare:"1":Backscatter coefficient. Unit is 1/(m*sr). At zero attenuation, this equals the scattering matrix value for the backward direction. See further AUG.
"Ze": Equivalent reflectivity. Unit is mm^6/m^3. Conversion formula is given below."dBZe": 10*log10(Ze/Z0), where Z0 is 1 mm^6/m^3.
The conversion from backscatter coefficient to Ze is:
Ze = 1e18 * lambda^4 / (k2 * pi^5) * sum(sigma)
where sum(sigma) = 4 * pi * b, and b is the backscatter coefficient.
The reference dielectric factor can either specified directly by the argument
k2. For example, to mimic the CloudSat data,k2shall be set to 0.75 (citaion needed). Ifk2is set to be negative (which is defualt), k2 is calculated as:k2 = abs( (n^2-1)/(n^2+2) )^2
where n is the refractive index of liquid water at temperature
ze_trefand the frequency of the radar, calculated by the MPM93 parameterization.A lower limit for dBZe is applied (
dbze_min). The main reason is to handle the fact that dBZe is not defined for Ze=0, and dBZe is set to the clip value when Ze < 10^(dbze_min/10).Author(s): Patrick Eriksson
- Parameters:
y (Vector, optional) – The measurement vector. See
y, defaults toself.y[OUT]y_f (Vector, optional) – The frequencies associated with
y. Seey_f, defaults toself.y_f[OUT]y_pol (ArrayOfIndex, optional) – The polarisation states associated with
y. Seey_pol, defaults toself.y_pol[OUT]y_pos (Matrix, optional) – The sensor positions associated with
y. Seey_pos, defaults toself.y_pos[OUT]y_los (Matrix, optional) – The line-of-sights associated with
y. Seey_los, defaults toself.y_los[OUT]y_aux (ArrayOfVector, optional) – Data auxilary to
y. Seey_aux, defaults toself.y_aux[OUT]y_geo (Matrix, optional) – The geo-position assigned to each element of
y. Seey_geo, defaults toself.y_geo[OUT]jacobian (Matrix, optional) – The Jacobian matrix. See
jacobian, defaults toself.jacobian[OUT]atmgeom_checked (Index, optional) – OK-flag for the geometry of the model atmosphere. See
atmgeom_checked, defaults toself.atmgeom_checked[IN]atmfields_checked (Index, optional) – OK-flag for atmospheric grids and (physical) fields. See
atmfields_checked, defaults toself.atmfields_checked[IN]iy_unit_radar (String, optional) – Unit for radar simulations. See
iy_unit_radar, defaults toself.iy_unit_radar[IN]iy_aux_vars (ArrayOfString, optional) – Selection of quantities for
iy_auxand when applicable alsoy_aux. Seeiy_aux_vars, defaults toself.iy_aux_vars[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]cloudbox_on (Index, optional) – Flag to activate the cloud box. See
cloudbox_on, defaults toself.cloudbox_on[IN]cloudbox_checked (Index, optional) – OK-flag for variables associated with the cloudbox. See
cloudbox_checked, defaults toself.cloudbox_checked[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]sensor_checked (Index, optional) – OK-flag for sensor related variables. See
sensor_checked, defaults toself.sensor_checked[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]iy_radar_agenda (Agenda, optional) – Calculation of pointwise backscattering. See
iy_radar_agenda, defaults toself.iy_radar_agenda[IN]instrument_pol_array (ArrayOfArrayOfIndex, optional) – Multiple definition of instrument polarisation. See
instrument_pol_array, defaults toself.instrument_pol_array[IN]range_bins (Vector, optional) – The range bins of an active instrument. See
range_bins, defaults toself.range_bins[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]dbze_min (Numeric, optional) – Clip value for dBZe. Defaults to
-99[IN]verbosity (Verbosity) – ARTS verbosity. See
verbosity, defaults toself.verbosity[IN]