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.

See the method selected for iy_main_agenda for quantities
that can be obtained by y_aux. However, in no case data of
along-the-path type can be extracted.

Authors: Patrick Eriksson

Synopsis

yCalc(

y, y_f, y_pol, y_pos, y_los, y_aux, jacobian, atmgeom_checked, atmfields_checked, atmosphere_dim, t_field, z_field, vmr_field, cloudbox_on, cloudbox_checked, sensor_checked, stokes_dim, f_grid, sensor_pos, sensor_los, transmitter_pos, mblock_za_grid, mblock_aa_grid, antenna_dim, sensor_response, sensor_response_f, sensor_response_pol, sensor_response_za, sensor_response_aa, iy_main_agenda, jacobian_agenda, jacobian_do, jacobian_quantities, jacobian_indices, iy_aux_vars )

Variables

OUT	y	(Vector)	The measurement vector.
OUT	y_f	(Vector)	The frequencies associated with y.
OUT	y_pol	(ArrayOfIndex)	The polarisation states associated with y.
OUT	y_pos	(Matrix)	The sensor positions associated with y.
OUT	y_los	(Matrix)	The line-of-sights associated with y.
OUT	y_aux	(ArrayOfVector)	Data auxilary to y.
OUT	jacobian	(Matrix)	The Jacobian matrix.
IN	atmgeom_checked	(Index)	OK-flag for the geometry of the model atmosphere.
IN	atmfields_checked	(Index)	OK-flag for atmospheric grids and (physical) fields.
IN	atmosphere_dim	(Index)	The atmospheric dimensionality (1-3).
IN	t_field	(Tensor3)	The field of atmospheric temperatures.
IN	z_field	(Tensor3)	The field of geometrical altitudes.
IN	vmr_field	(Tensor4)	VMR field.
IN	cloudbox_on	(Index)	Flag to activate the cloud box.
IN	cloudbox_checked	(Index)	OK-flag for variables associated with the cloudbox.
IN	sensor_checked	(Index)	OK-flag for sensor related variables.
IN	stokes_dim	(Index)	The dimensionality of the Stokes vector (1-4).
IN	f_grid	(Vector)	The frequency grid for monochromatic pencil beam calculations.
IN	sensor_pos	(Matrix)	The sensor position for each measurement block.
IN	sensor_los	(Matrix)	The sensor line-of-sight (LOS) for each measurement block.
IN	transmitter_pos	(Matrix)	Transmitter positions.
IN	mblock_za_grid	(Vector)	The zenith angle grid for each measurement block.
IN	mblock_aa_grid	(Vector)	The azimuthal angle grid for each measurement block.
IN	antenna_dim	(Index)	The dimensionality of the antenna pattern (1-2).
IN	sensor_response	(Sparse)	The matrix modelling the total sensor response.
IN	sensor_response_f	(Vector)	The frequencies associated with the output of sensor_response.
IN	sensor_response_pol	(ArrayOfIndex)	The polarisation states associated with the output of sensor_response.
IN	sensor_response_za	(Vector)	The relative zenith angles associated with the output of sensor_response.
IN	sensor_response_aa	(Vector)	The relative azimuth angles associated with the output of sensor_response.
IN	iy_main_agenda	(Agenda)	See agendas.cc.
IN	jacobian_agenda	(Agenda)	See agendas.cc.
IN	jacobian_do	(Index)	Flag to activate jacobian calculations.
IN	jacobian_quantities	(ArrayOfRetrievalQuantity)	The retrieval quantities in the Jacobian matrix.
IN	jacobian_indices	(ArrayOfArrayOfIndex)	First and last column index in jacobian for each retrieval quantity.
IN	iy_aux_vars	(ArrayOfString)	Selection of quantities for iy_aux and when applicable also y_aux.