yCalc

Calculation of complete measurement vectors (y).

The method performs radiative transfer calculations from a sensor perspective. Radiative transfer calculations are performed for monochromatic pencil beams, following iy_main_agenda and associated agendas. Obtained radiances are weighted together by sensor_response, to include the characteristics of the sensor. The measurement vector obtained can contain anything from a single frequency value to a series of measurement scans (each consisting of a series of spectra), all depending on the settings. Spectra and jacobians are calculated in parallel.

The frequency, polarisation etc. for each measurement value is given by y_f, y_pol, y_pos and y_los.

The content of y_aux follows iy_aux_vars. See the method selected for iy_main_agenda for allowed choices.

The geo-positions (y_geo) are set based on sensor_response. When an antenna pattern is considered, there are several pencil beams, and thus also several goe-positions, associated with each value of y. The geo-position assigned to a value in y is the geo_pos of the pencil beam related to the highest value in sensor_response. This means that mblock_dlos must contain the bore-sight direction (0,0), if you want y_geo to exactly match the bore-sight direction.

The Jacobian provided (jacobian) is adopted to selected retrieval units, but no transformations are applied. Transformations are included by calling jacobianAdjustAndTransform().

Author(s): Patrick Eriksson

Parameters:

y (Vector, optional) – The measurement vector. See y, defaults to self.y [OUT]
y_f (Vector, optional) – The frequencies associated with y. See y_f, defaults to self.y_f [OUT]
y_pol (ArrayOfIndex, optional) – The polarisation states associated with y. See y_pol, defaults to self.y_pol [OUT]
y_pos (Matrix, optional) – The sensor positions associated with y. See y_pos, defaults to self.y_pos [OUT]
y_los (Matrix, optional) – The line-of-sights associated with y. See y_los, defaults to self.y_los [OUT]
y_aux (ArrayOfVector, optional) – Data auxilary to y. See y_aux, defaults to self.y_aux [OUT]
y_geo (Matrix, optional) – The geo-position assigned to each element of y. See y_geo, defaults to self.y_geo [OUT]
jacobian (Matrix, optional) – The Jacobian matrix. See jacobian, defaults to self.jacobian [OUT]
atmgeom_checked (Index, optional) – OK-flag for the geometry of the model atmosphere. See atmgeom_checked, defaults to self.atmgeom_checked [IN]
atmfields_checked (Index, optional) – OK-flag for atmospheric grids and (physical) fields. See atmfields_checked, defaults to self.atmfields_checked [IN]
atmosphere_dim (Index, optional) – The atmospheric dimensionality (1-3). See atmosphere_dim, defaults to self.atmosphere_dim [IN]
nlte_field (EnergyLevelMap, optional) – The field of NLTE temperatures and/or ratios. See nlte_field, defaults to self.nlte_field [IN]
cloudbox_on (Index, optional) – Flag to activate the cloud box. See cloudbox_on, defaults to self.cloudbox_on [IN]
cloudbox_checked (Index, optional) – OK-flag for variables associated with the cloudbox. See cloudbox_checked, defaults to self.cloudbox_checked [IN]
scat_data_checked (Index, optional) – OK-flag for scat_data. See scat_data_checked, defaults to self.scat_data_checked [IN]
sensor_checked (Index, optional) – OK-flag for sensor related variables. See sensor_checked, defaults to self.sensor_checked [IN]
stokes_dim (Index, optional) – The dimensionality of the Stokes vector (1-4). See stokes_dim, defaults to self.stokes_dim [IN]
f_grid (Vector, optional) – The frequency grid for monochromatic pencil beam calculations. See f_grid, defaults to self.f_grid [IN]
sensor_pos (Matrix, optional) – The sensor position for each measurement block. See sensor_pos, defaults to self.sensor_pos [IN]
sensor_los (Matrix, optional) – The sensor line-of-sight (LOS) for each measurement block. See sensor_los, defaults to self.sensor_los [IN]
transmitter_pos (Matrix, optional) – Transmitter positions. See transmitter_pos, defaults to self.transmitter_pos [IN]
mblock_dlos (Matrix, optional) – The set of angular pencil beam directions for each measurement block. See mblock_dlos, defaults to self.mblock_dlos [IN]
sensor_response (Sparse, optional) – The matrix modelling the total sensor response. See sensor_response, defaults to self.sensor_response [IN]
sensor_response_f (Vector, optional) – The frequencies associated with the output of sensor_response. See sensor_response_f, defaults to self.sensor_response_f [IN]
sensor_response_pol (ArrayOfIndex, optional) – The polarisation states associated with the output of. See sensor_response_pol, defaults to self.sensor_response_pol [IN]
sensor_response_dlos (Matrix, optional) – The relative zenith and azimuth angles associated with the output of. See sensor_response_dlos, defaults to self.sensor_response_dlos [IN]
iy_unit (String, optional) – Selection of output unit for radiative transfer methods. See iy_unit, defaults to self.iy_unit [IN]
iy_main_agenda (Agenda, optional) – Calculation of a single monochromatic pencil beam spectrum. See iy_main_agenda, defaults to self.iy_main_agenda [IN]
jacobian_agenda (Agenda, optional) – Pure numerical Jacobian calculations. See jacobian_agenda, defaults to self.jacobian_agenda [IN]
jacobian_do (Index, optional) – Flag to activate (clear-sky) Jacobian calculations. See jacobian_do, defaults to self.jacobian_do [IN]
jacobian_quantities (ArrayOfRetrievalQuantity, optional) – The retrieval quantities in the Jacobian matrix. See jacobian_quantities, defaults to self.jacobian_quantities [IN]
iy_aux_vars (ArrayOfString, optional) – Selection of quantities for iy_aux and when applicable also y_aux. See iy_aux_vars, defaults to self.iy_aux_vars [IN]
verbosity (Verbosity) – ARTS verbosity. See verbosity, defaults to self.verbosity [IN]