ARTS built-in documentation server

Workspace Method yCalc

Description

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_grid 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.

Authors: Patrick Eriksson

Synopsis

yCalc( y, y_f, y_pol, y_pos, y_los, y_aux, y_geo, jacobian, atmgeom_checked, atmfields_checked, atmosphere_dim, nlte_field, cloudbox_on, cloudbox_checked, scat_data_checked, sensor_checked, stokes_dim, f_grid, sensor_pos, sensor_los, transmitter_pos, mblock_dlos_grid, sensor_response, sensor_response_f, sensor_response_pol, sensor_response_dlos, iy_unit, iy_main_agenda, jacobian_agenda, jacobian_do, jacobian_quantities, iy_aux_vars )

Variables

OUTy(Vector)The measurement vector.
OUTy_f(Vector)The frequencies associated with y.
OUTy_pol(ArrayOfIndex)The polarisation states associated with y.
OUTy_pos(Matrix)The sensor positions associated with y.
OUTy_los(Matrix)The line-of-sights associated with y.
OUTy_aux(ArrayOfVector)Data auxilary to y.
OUTy_geo(Matrix)The geo-positioning associated with y.
OUTjacobian(Matrix)The Jacobian matrix.
INatmgeom_checked(Index)OK-flag for the geometry of the model atmosphere.
INatmfields_checked(Index)OK-flag for atmospheric grids and (physical) fields.
INatmosphere_dim(Index)The atmospheric dimensionality (1-3).
INnlte_field(EnergyLevelMap)The field of NLTE temperatures and/or ratios.
INcloudbox_on(Index)Flag to activate the cloud box.
INcloudbox_checked(Index)OK-flag for variables associated with the cloudbox.
INscat_data_checked(Index)OK-flag for scat_data.
INsensor_checked(Index)OK-flag for sensor related variables.
INstokes_dim(Index)The dimensionality of the Stokes vector (1-4).
INf_grid(Vector)The frequency grid for monochromatic pencil beam calculations.
INsensor_pos(Matrix)The sensor position for each measurement block.
INsensor_los(Matrix)The sensor line-of-sight (LOS) for each measurement block.
INtransmitter_pos(Matrix)Transmitter positions.
INmblock_dlos_grid(Matrix)The set of angular pencil beam directions for each measurement block.
INsensor_response(Sparse)The matrix modelling the total sensor response.
INsensor_response_f(Vector)The frequencies associated with the output of sensor_response.
INsensor_response_pol(ArrayOfIndex)The polarisation states associated with the output of sensor_response.
INsensor_response_dlos(Matrix)The relative zenith and azimuth angles associated with the output of sensor_response.
INiy_unit(String)Selection of output unit for radiative transfer methods.
INiy_main_agenda(Agenda)Agenda calculating the single monochromatic pencil beam spectrum.
INjacobian_agenda(Agenda)Pure numerical Jacobian calculation agenda.
INjacobian_do(Index)Flag to activate (clear-sky) Jacobian calculations.
INjacobian_quantities(ArrayOfRetrievalQuantity)The retrieval quantities in the Jacobian matrix.
INiy_aux_vars(ArrayOfString)Selection of quantities for iy_aux and when applicable also y_aux.