ARTS built-in documentation server

Workspace Method iyFOS

Description

Method in development. Don't use without contacting Patrick.

Regarding radiance unit, works exactly as iyEmissionStandard.

The *fos_n* argument determines the maximum scattering order that
will be considered. For example, 1 corresponds to that only single
scattering is considered. The value 0 is accepted and results
in calculations of clear-sky type. In the later case, particle
absorption/emission is considered if cloudbox is active. If
cloudbox is not active,clear-sky results are returned for all
values of *fos_n*.

The following auxiliary data can be obtained:
  "Pressure": The pressure along the propagation path.
     Size: [1,1,1,np].
  "Temperature": The temperature along the propagation path.
     Size: [1,1,1,np].
  "VMR, species X": VMR of the species with index X (zero based).
     For example, adding the string "VMR, species 0" extracts the
     VMR of the first species. Size: [1,1,1,np].
  "Absorption, summed": The total absorption matrix along the
     path. Size: [nf,ns,ns,np].
  "Absorption, species X": The absorption matrix along the path
     for an individual species (X works as for VMR).
     Size: [nf,ns,ns,np].
  "PND, type X": The particle number density for particle type X
       (ie. corresponds to book X in pnd_field). Size: [1,1,1,np].
  "Mass content, X": The particle content for mass category X.
       This corresponds to column X in particle_masses (zero-
       based indexing). Size: [1,1,1,np].
* "Radiative background": Index value flagging the radiative
     background. The following coding is used: 0=space and
     and 1=surface. Size: [nf,1,1,1].
  "iy": The radiance at each point along the path (iy_unit is.
     considered). Size: [nf,ns,1,np].
* "Optical depth": The scalar optical depth between the
     observation point and the end of the primary propagation path
     (ie. the optical depth to the surface or space.). Calculated
     in a pure scalar manner, and not dependent on direction.
     Size: [nf,1,1,1].
where
  nf: Number of frequencies.
  ns: Number of Stokes elements.
  np: Number of propagation path points.

The auxiliary data are returned in iy_aux with quantities
selected by iy_aux_vars. Most variables require that the method
is called directly or by iyCalc. For calculations using yCalc,
the selection is restricted to the variables marked with *.

Authors: Patrick Eriksson

Synopsis

iyFOS( iy, iy_aux, ppath, diy_dx, stokes_dim, f_grid, atmosphere_dim, p_grid, z_field, t_field, vmr_field, abs_species, wind_u_field, wind_v_field, wind_w_field, mag_u_field, mag_v_field, mag_w_field, cloudbox_on, cloudbox_limits, pnd_field, use_mean_scat_data, scat_data_array, particle_masses, iy_unit, iy_aux_vars, jacobian_do, ppath_agenda, blackbody_radiation_agenda, propmat_clearsky_agenda, iy_main_agenda, iy_space_agenda, iy_surface_agenda, iy_agenda_call1, iy_transmission, rte_pos, rte_los, rte_pos2, rte_alonglos_v, ppath_lraytrace, fos_scatint_angles, fos_iyin_za_angles, fos_za_interporder, fos_n )

Variables

OUTiy(Matrix)Monochromatic pencil beam radiance spectrum.
OUTiy_aux(ArrayOfTensor4)Data auxiliary to iy.
OUTppath(Ppath)The propagation path for one line-of-sight.
OUTdiy_dx(ArrayOfTensor3)Derivative of iy with respect to retrieval quantities.
INstokes_dim(Index)The dimensionality of the Stokes vector (1-4).
INf_grid(Vector)The frequency grid for monochromatic pencil beam calculations.
INatmosphere_dim(Index)The atmospheric dimensionality (1-3).
INp_grid(Vector)The pressure grid.
INz_field(Tensor3)The field of geometrical altitudes.
INt_field(Tensor3)The field of atmospheric temperatures.
INvmr_field(Tensor4)VMR field.
INabs_species(ArrayOfArrayOfSpeciesTag)Tag groups for scalar gas absorption.
INwind_u_field(Tensor3)Zonal component of the wind field.
INwind_v_field(Tensor3)Meridional component of the magnetic field.
INwind_w_field(Tensor3)Vertical wind component field.
INmag_u_field(Tensor3)Zonal component of the magnetic field.
INmag_v_field(Tensor3)Meridional component of the magnetic field.
INmag_w_field(Tensor3)Vertical component of the magnetic field.
INcloudbox_on(Index)Flag to activate the cloud box.
INcloudbox_limits(ArrayOfIndex)The limits of the cloud box.
INpnd_field(Tensor4)Particle number density field.
INuse_mean_scat_data(Index)Flag to use same scattering properties for all frequencies.
INscat_data_array(ArrayOfSingleScatteringData)Raw data of single scattering data.
INparticle_masses(Matrix)The mass of individual particles (or bulks).
INiy_unit(String)Selection of output unit for some radiative transfer methods.
INiy_aux_vars(ArrayOfString)Selection of quantities for iy_aux and when applicable also y_aux.
INjacobian_do(Index)Flag to activate jacobian calculations.
INppath_agenda(Agenda)See agendas.cc.
INblackbody_radiation_agenda(Agenda)See agendas.cc.
INpropmat_clearsky_agenda(Agenda)See agendas.cc.
INiy_main_agenda(Agenda)See agendas.cc.
INiy_space_agenda(Agenda)See agendas.cc.
INiy_surface_agenda(Agenda)See agendas.cc.
INiy_agenda_call1(Index)Flag to handle recursive calls of iy_main_agenda The agenda iy_main_agenda can be used recursively and this flag is used to tell the methods inside the agenda which is the primary call.
INiy_transmission(Tensor3)Transmission to be included in iy.
INrte_pos(Vector)A geographical position for starting radiative transfer calculations.
INrte_los(Vector)A line-of-sight for (complete) radiative transfer calculations.
INrte_pos2(Vector)A second geographical position to define the geometry for radiative transfer calculations.
INrte_alonglos_v(Numeric)Velocity along the line-of-sight to consider for a RT calculation.
INppath_lraytrace(Numeric)Maximum length of ray tracing steps when determining propagation paths.
INfos_scatint_angles(Matrix)So far just testing of FOS ...
INfos_iyin_za_angles(Vector)So far just testing of FOS ...
GINfos_za_interporder(Index, Default: 1)Polynomial order for zenith angle interpolation.
GINfos_n(Index, Default: 1)Max scattering order to consider.