ARTS built-in documentation server

Workspace Method xaStandard

Description

Standard function for creating xa.

The method creates xa based on jacobian_quantities and the various
atmospheric fields. In the case of scattering species, the data are
taken from particle_bulkprop_field. The following retrieval quantities
are handled:
   Temperature
   Absorption species
   Scattering species
   Pointing
   Polynomial baseline fit
   Sinusoidal baseline fit

Authors: Patrick Eriksson

Synopsis

xaStandard(

xa, jacobian_quantities, atmfields_checked, atmgeom_checked, atmosphere_dim, p_grid, lat_grid, lon_grid, t_field, vmr_field, abs_species, cloudbox_on, cloudbox_checked, particle_bulkprop_field, particle_bulkprop_names, wind_u_field, wind_v_field, wind_w_field, mag_u_field, mag_v_field, mag_w_field, surface_props_data, surface_props_names, water_p_eq_agenda )

Variables

OUT	xa	(Vector)	The a priori state vector.
IN	jacobian_quantities	(ArrayOfRetrievalQuantity)	The retrieval quantities in the Jacobian matrix.
IN	atmfields_checked	(Index)	OK-flag for atmospheric grids and (physical) fields.
IN	atmgeom_checked	(Index)	OK-flag for the geometry of the model atmosphere.
IN	atmosphere_dim	(Index)	The atmospheric dimensionality (1-3).
IN	p_grid	(Vector)	The pressure grid.
IN	lat_grid	(Vector)	The latitude grid.
IN	lon_grid	(Vector)	The longitude grid.
IN	t_field	(Tensor3)	The field of atmospheric temperatures.
IN	vmr_field	(Tensor4)	VMR field.
IN	abs_species	(ArrayOfArrayOfSpeciesTag)	Tag groups for gas absorption.
IN	cloudbox_on	(Index)	Flag to activate the cloud box.
IN	cloudbox_checked	(Index)	OK-flag for variables associated with the cloudbox.
IN	particle_bulkprop_field	(Tensor4)	Container for various data that describes scattering bulk properties.
IN	particle_bulkprop_names	(ArrayOfString)	Identification of the data in particle_bulkprop_field.
IN	wind_u_field	(Tensor3)	Zonal component of the wind field.
IN	wind_v_field	(Tensor3)	Meridional component of the magnetic field.
IN	wind_w_field	(Tensor3)	Vertical wind component field.
IN	mag_u_field	(Tensor3)	Zonal component of the magnetic field.
IN	mag_v_field	(Tensor3)	Meridional component of the magnetic field.
IN	mag_w_field	(Tensor3)	Vertical component of the magnetic field.
IN	surface_props_data	(Tensor3)	Various surface properties.
IN	surface_props_names	(ArrayOfString)	Name on surface properties found in surface_props_data.
IN	water_p_eq_agenda	(Agenda)	Agenda to calculate the saturation pressure of water.