Go to the documentation of this file.
46 #define DESCRIPTION(x) x
115 (
NAME(
"abs_cia_data" ),
118 "HITRAN Collision Induced Absorption (CIA) Data.\n"
120 "This variable holds HITRAN CIA data (binary absorption\n"
121 "cross-sections). The data itself is described in: Richard, C. et al.\n"
122 "(2012), New section of the HITRAN database: Collision-induced\n"
123 "absorption (CIA), J. Quant. Spectrosc. Radiat. Transfer, 113,\n"
124 "1276-1285, doi:10.1016/j.jqsrt.2011.11.004.\n"
126 "The binary absorption cross-sections have to be multiplied with the\n"
127 "densities of both molecules to get absorption coefficients.\n"
131 "The outer array dimension in the ArrayOfArrayOfCIARecord is the same\n"
132 "as that of *abs_species*. There will be CIA data only for those\n"
133 "species that contain a CIA tag, for all other species it will be\n"
134 "empty. The inner array dimension corresponds to the number of CIA tags\n"
135 "for this species (there could be for example both N2-N2 and N2-H2) in\n"
136 "the same species.\n"
138 "FIXME: Somewhere there should be a description of the CIA tag system.\n"
140 "Each individual CIARecord holds the complete information from one\n"
141 "HITRAN CIA file. For the given pair of molecules A HITRAN CIA data\n"
142 "file can hold several datasets (data for different temperatures but\n"
143 "fixed frequency range).\n"
147 "Binary absorption cross-sections: m^5*molecule^-2\n"
149 GROUP(
"ArrayOfCIARecord" )));
153 (
NAME(
"abs_coef" ),
156 "The matrix of total scalar absorption coefficients.\n"
158 "Contains the gas absorption summed over all species as a function of\n"
159 "*f_grid* and *abs_p*, i.e., for a single atmospheric profile.\n"
161 "This variable is not used explicitly in a standard calculation, where\n"
162 "absorption comes from the lookup table *abs_lookup*. However, it is\n"
163 "useful for testing the methods that actually calculate line-by-line\n"
164 "absorption, which have this variable as output. These methods are\n"
165 "called internally by the method *abs_lookupCalc*, which generates\n"
166 "the lookup table.\n"
168 "Dimensions: [f_grid, abs_p]\n"
176 (
NAME(
"abs_coef_per_species" ),
179 "Scalar absorption coefficients individually per tag group.\n"
181 "The Array contains one matrix of absorption coefficients for each\n"
182 "tag group, where the matrix format is the same as that of *abs_coef*\n"
184 GROUP(
"ArrayOfMatrix" )));
188 (
NAME(
"abs_cont_models" ),
191 "Continuum / full model absorption model description parameter.\n"
192 "See the WSV `abs_cont_names' for a detailed description\n"
193 "of the allowed continuum models. There should be one string here\n"
194 "for each entry in `abs_cont_names'.See also the online\n"
195 "documentation in arts/doc/doxygen/html/continua_cc.html.\n"
197 GROUP(
"ArrayOfString" )));
201 (
NAME(
"abs_cont_names" ),
204 "Continuum / full model absorption tag names. This variable should\n"
205 "contain a list of tag names of continuum and full models, respectively.\n"
206 "Associated with this WSV is the WSV\n"
207 "`abs_cont_models' which contains the specific model version of\n"
208 "each continuum / full model absorption tag and the WSV\n"
209 "`abs_cont_parameters' which should contain the continuum / full model\n"
210 "user defined parameters. The user defined parameters are only used when\n"
211 "the specified model is 'user'. See also the online documentation in\n"
212 "arts/doc/doxygen/html/continua_cc.html.\n"
214 "The following full water vapor models are implemented:\n"
215 "'H2O-MPM87': absorption model (line and continuum) according to \n"
217 " A contribution to modeling atmospheric millimeter-wave properties,\n"
218 " Frequenz, 41, 1987, 31-36\n"
220 " H. J. Liebe and D. H. Layton,\n"
221 " Millimeter-wave properties of the atmosphere:\n"
222 " Laboratory studies and propagation modeling,\n"
223 " U.S. Dept. of Commerce, National Telecommunications and Information\n"
224 " Administration, Institute for Communication Sciences,\n"
225 " 325 Broadway, Boulder, CO 80303-3328, report 87224.\n"
226 "'H2O-MPM89': absorption model (line and continuum) according to \n"
227 " H. J. Liebe,\n Int. J. Infrared and Millimeter Waves, 10(6), 1989, 631\n"
228 "'H2O-MPM93': absorption model (line and continuum) according to \n"
229 " H. J. Liebe and G. A. Hufford and M. G. Cotton,\n"
230 " Propagation modeling of moist air and suspended water/ice\n"
231 " particles at frequencies below 1000 GHz,\n"
232 " AGARD 52nd Specialists Meeting of the Electromagnetic Wave\n"
233 " Propagation Panel,\n Palma de Mallorca, Spain, 1993, May 17-21 \n"
234 " (ftp.its.bldrdoc.gov/pub/mpm93/)\n"
235 "'H2O-CP98': absorption model (line and continuum) according to \n"
236 " S. L. Cruz-Pol et al.,\n Radio Science, 33(5), 1319, 1998"
237 " (ece.uprm.edu/~pol/Atmosphere.html)\n"
238 "'H2O-PWR98': absorption model (line and continuum) according to \n"
239 " P. W. Rosenkranz,\n "
240 " Radio Science, 33(4), 919, 1998, Radio Science, 34(4), 1025, 1999\n"
241 " (ftp: mesa.mit.edu/phil/lbl_rt).\n"
243 "The following full oxygen models are implemented:\n"
244 "'O2-MPM93': absorption model (line and continuum) according to\n"
245 " H. J. Liebe and G. A. Hufford and M. G. Cotton,\n"
246 " Propagation modeling of moist air and suspended water/ice\n"
247 " particles at frequencies below 1000 GHz,\n"
248 " AGARD 52nd Specialists Meeting of the Electromagnetic Wave\n"
249 " Propagation Panel,\n Palma de Mallorca, Spain, 1993, May 17-21\n"
250 " (ftp.its.bldrdoc.gov/pub/mpm93/)\n"
251 "'O2-PWR93': absorption model (line and continuum) according to \n"
252 " P. W. Rosenkranz,\n Chapter 2, in M. A. Janssen, \n"
253 " Atmospheric Remote Sensing by Microwave Radiometry\n"
254 " John Wiley & Sons, Inc., 1993 (mesa.mit.edu/phil/lbl_rt)\n"
256 "The following continuum parameterizations are implemented:\n"
257 "H2O-H2O ('H2O-SelfContStandardType'):\n"
258 " P. W. Rosenkranz, \n"
259 " Radio Science, Vol. 33, No 4, Pages 919-928, 1998 and \n"
260 " Radio Science, Vol. 34, No 4, Page 1025, 1999 (mesa.mit.edu/phil/lbl_rt)\n"
261 "H2O-air ('H2O-ForeignContStandardType'): \n"
262 " P. W. Rosenkranz, \n"
263 " Radio Science, Vol. 33, No 4, Pages 919-928, 1998 and \n"
264 " Radio Science, Vol. 34, No 4, Page 1025, 1999 (mesa.mit.edu/phil/lbl_rt)\n"
265 "H2O-air ('H2O-ContMPM93'): \n"
266 " H. J. Liebe and G. A. Hufford and M. G. Cotton,\n"
267 " Propagation modeling of moist air and suspended water/ice\n"
268 " particles at frequencies below 1000 GHz,\n"
269 " AGARD 52nd Specialists Meeting of the Electromagnetic Wave\n"
270 " Propagation Panel,\n Palma de Mallorca, Spain, 1993, May 17-21\n"
271 " (ftp.its.bldrdoc.gov/pub/mpm93/)\n"
272 "O2-air ('O2-SelfContStandardType'):\n"
273 " P. W. Rosenkranz,\n"
274 " Chapter 2, in M. A. Janssen,\n"
275 " Atmospheric Remote Sensing by Microwave Radiometry,\n"
276 " John Wiley & Sons, Inc., 1993\n"
277 " (mesa.mit.edu/phil/lbl_rt)\n"
278 " and also described in \n"
279 " H. J. Liebe and G. A. Hufford and M. G. Cotton,\n"
280 " Propagation modeling of moist air and suspended water/ice\n"
281 " particles at frequencies below 1000 GHz,\n"
282 " AGARD 52nd Specialists Meeting of the Electromagnetic Wave\n"
283 " Propagation Panel,\n Palma de Mallorca, Spain, 1993, May 17-21\n"
284 " (ftp.its.bldrdoc.gov/pub/mpm93/)\n"
285 "N2-N2 ('N2-SelfContStandardType'):\n"
286 " The functional form of Rosenkranz but with more input parameters.\n"
287 " P. W. Rosenkranz,\n"
288 " Chapter 2, in M. A. Janssen,\n"
289 " Atmospheric Remote Sensing by Microwave Radiometry,\n"
290 " John Wiley & Sons, Inc., 1993 (mesa.mit.edu/phil/lbl_rt)\n"
291 "N2-N2 ('N2-SelfContMPM93'):\n"
292 " H. J. Liebe and G. A. Hufford and M. G. Cotton,\n"
293 " Propagation modeling of moist air and suspended water/ice\n"
294 " particles at frequencies below 1000 GHz,\n"
295 " AGARD 52nd Specialists Meeting of the Electromagnetic Wave\n"
296 " Propagation Panel, Palma de Mallorca, Spain, 1993, May 17-21 \n"
297 " (ftp.its.bldrdoc.gov/pub/mpm93/)\n"
298 "CO2-CO2 ('CO2-SelfContPWR93'):\n"
299 " P. W. Rosenkranz,\n"
300 " Chapter 2, in M. A. Janssen,\n"
301 " Atmospheric Remote Sensing by Microwave Radiometry,\n"
302 " John Wiley & Sons, Inc., 1993 (mesa.mit.edu/phil/lbl_rt)\n"
303 "CO2-N2 ('CO2-ForeignContPWR93'):\n"
304 " P. W. Rosenkranz,\n"
305 " Chapter 2, in M. A. Janssen,\n"
306 " Atmospheric Remote Sensing by Microwave Radiometry,\n"
307 " John Wiley & Sons, Inc., 1993 (mesa.mit.edu/phil/lbl_rt)\n"
309 "The following cloud absorption models are implemented:\n"
310 "Suspended water droplet ('liquidcloud-MPM93') \n"
311 " absorption parameterization from the MPM93 model:\n"
312 " H. J. Liebe and G. A. Hufford and M. G. Cotton,\n"
313 " Propagation modeling of moist air and suspended water/ice\n"
314 " particles at frequencies below 1000 GHz,\n"
315 " AGARD 52nd Specialists Meeting of the Electromagnetic Wave\n"
316 " Propagation Panel,\n Palma de Mallorca, Spain, 1993, May 17-21\n"
317 " (ftp.its.bldrdoc.gov/pub/mpm93/)\n"
318 "Ice water droplet absorption ('icecloud-MPM93') \n"
319 " parameterization from MPM93 model:\n"
320 " H. J. Liebe and G. A. Hufford and M. G. Cotton,\n"
321 " Propagation modeling of moist air and suspended water/ice\n"
322 " particles at frequencies below 1000 GHz,\n"
323 " AGARD 52nd Specialists Meeting of the Electromagnetic Wave\n"
324 " Propagation Panel,\n Palma de Mallorca, Spain, 1993, May 17-21\n"
325 " (ftp.its.bldrdoc.gov/pub/mpm93/)\n"
327 "The following rain extinction model is implemented:\n"
328 "Rain extinction parameterization ('rain-MPM93') from the\n"
329 " MPM93 model, described in:\n"
331 " MPM - An Atmospheric Millimeter-Wave Propagation Model,\n"
332 " Int. J. Infrared and Millimeter Waves, vol. 10(6),\n"
333 " pp. 631-650, 1989;\n"
335 " Olsen, R.L., D.V. Rogers, and D. B. Hodge,\n"
336 " The aR^b relation in the calculation of rain attenuation,\n"
337 " IEEE Trans. Antennas Propagat., vol. AP-26, pp. 318-329, 1978.\n"
338 " IMPORTANT NOTE: rain-MPM93 parameterizes the EXTINCTION by rain,\n"
339 " not just the absorption. Therefore it is not suitable for \n"
340 " calculating thermal emission by rain!\n"
341 " Please use rain-MPM93 only for calculation of attenuation.\n"
343 GROUP(
"ArrayOfString" )));
347 (
NAME(
"abs_cont_parameters" ),
350 "Continuum model parameters. See the WSV *abs_cont_names*\n"
351 "for a detailed description of the allowed continuum models. There\n"
352 "should be one parameter vector here for each entry in\n"
353 "*abs_cont_names*. See also the online documentation in\n"
354 "arts/doc/doxygen/html/continua_cc.html.\n"
356 GROUP(
"ArrayOfVector" )));
360 (
NAME(
"abs_f_interp_order" ),
363 "Frequency interpolation order for absorption lookup table.\n"
365 "The interpolation order to use when interpolating the absorption\n"
366 "lookup table in frequency. This is in particular needed for\n"
367 "calculations with Doppler shift, so that absorption is interpolated to\n"
368 "the shifted frequency grid. One is linear interpolation, two\n"
369 "quadratic, and so on.\n"
371 "As a special case, order 0 in this particular case means no\n"
372 "interpolation. In that case f_grid must match exactly the grid inside\n"
373 "the lookup table. This is the global default value, set in\n"
380 (
NAME(
"abs_lines" ),
383 "A list of spectral line data.\n"
385 GROUP(
"ArrayOfLineRecord" )));
389 (
NAME(
"abs_lineshape" ),
392 "Lineshape specification: function, norm, cutoff. There is one entry for\n"
393 "each abs_tag, not for each species. This means if you have several\n"
394 "abs_tags for different isotopologues or transitions of a species, you\n"
395 "may use different lineshapes.\n"
397 GROUP(
"ArrayOfLineshapeSpec" )));
401 (
NAME(
"abs_lines_per_species" ),
404 "A list of spectral line data for each tag.\n"
405 "Dimensions: (tag_groups.nelem()) (# of lines for this tag)\n"
407 GROUP(
"ArrayOfArrayOfLineRecord" )));
411 (
NAME(
"abs_lookup" ),
414 "An absorption lookup table.\n"
416 "It holds an absorption lookup table, as well as all information that\n"
417 "is necessary to use the table to extract absorption. Extraction\n"
418 "routines are implemented as member functions. \n"
420 "It has quite a complicated structure. For details see the Arts User\n"
421 "Guide section \"The gas absorption lookup table\" or the source code\n"
422 "documentation in gas_abs_lookup.h.\n"
424 GROUP(
"GasAbsLookup" )));
431 "Nonlinear species for absorption lookup table generation.\n"
433 "A list of absorption species that should be treated non-linearly.\n"
434 "This means that the H2O VMR should be varied when calculating the\n"
435 "lookup table for those species.\n"
437 "A typical example is for this to containt the Rosenkranz full\n"
438 "absorption model species for water vapor and oxygen \n"
439 "([\"H2O-PWR98\", \"O2-PWR93\"]).\n"
441 "It only makes sense to put a species here if is either a water vapor\n"
442 "species, or some other species that uses *abs_h2o*, that is, for which\n"
443 "the absorption coefficient depends directly on water vapor.\n"
445 "See user guide and online documentation of *abs_pts* and *abs_lookupCalc*\n"
446 "for more details and usage examples.\n"
448 GROUP(
"ArrayOfArrayOfSpeciesTag" )));
452 (
NAME(
"abs_nls_pert" ),
455 "Fractional perturbations for the nonlinear species in the absorption\n"
458 "This is a vector of fractional perturbations that should contain 1\n"
459 "(the unperturbed reference profile). A value of 0 may lead to error\n"
460 "messages from some absorption routines, so a possible content for this\n"
461 "variable is: [1e-24, 1, 2].\n"
462 "(This is similar to *abs_t_pert*, but multiplicative, not additive.)\n"
468 (
NAME(
"abs_nls_interp_order" ),
471 "The interpolation order to use when interpolating absorption between\n"
472 "the H2O values given by *abs_nls_pert*. This is used by methods\n"
473 "extracting absorption coefficients from the lookup table, and by\n"
474 "methods setting up parameters for lookup table generation. Has a\n"
475 "default value, which is set in general.arts.\n"
477 "Note that the number of points used in the interpolation scheme is\n"
478 "interpolation order + 1 (e.g., two for first order interpolation).\n"
484 (
NAME(
"abs_p_interp_order" ),
487 "The interpolation order to use when interpolating absorption\n"
488 "between pressure levels. This is used by methods extracting\n"
489 "absorption coefficients from the lookup table, and by methods\n"
490 "setting up parameters for lookup table generation. Has a\n"
491 "default value, which is set in general.arts.\n"
493 "Note that the number of points used in the interpolation scheme is\n"
494 "interpolation order + 1 (e.g., two for first order interpolation).\n"
500 (
NAME(
"abs_t_pert" ),
503 "Temperature perturbations for the absorption lookup table.\n"
505 "This is a vector containing temperature perturbations (in Kelvin) that\n"
506 "should be added to the reference temperature profile. (Similar to\n"
507 "*abs_nls_pert*, but additive, not multiplicative.) Should normally\n"
508 "contain 0, to include the reference profile itself. Example content:\n"
515 (
NAME(
"abs_t_interp_order" ),
518 "The interpolation order to use when interpolating absorption between\n"
519 "the temperature values given by *abs_t_pert*. This is used by methods\n"
520 "extracting absorption coefficients from the lookup table, and by\n"
521 "methods setting up parameters for lookup table generation. Has a\n"
522 "default value, which is set in general.arts.\n"
524 "Note that the number of points used in the interpolation scheme is\n"
525 "interpolation order + 1 (e.g., two for first order interpolation).\n"
531 (
NAME(
"abs_lookup_is_adapted" ),
534 "Flag to indicate whether *abs_lookupAdapt* has already been\n"
537 "Values: 0=false, 1=true.\n"
546 "List of pressures to be used for the calculation of absorption\n"
549 "This can be copied from the global *p_grid*, but could also be\n"
552 "Any absorption method should check that the length of this vector\n"
553 "is the same as that of *abs_t*\n"
555 "Dimension: [number of pressures]\n"
563 (
NAME(
"abs_species" ),
566 "Tag groups for scalar gas absorption.\n"
568 "This is an array of arrays of SpeciesTag tag definitions. It defines the\n"
569 "available tag groups for the calculation of scalar gas absorption\n"
570 "coefficients. See online documentation of method *abs_speciesSet* for\n"
571 "more detailed information how tag groups work and some examples.\n"
573 GROUP(
"ArrayOfArrayOfSpeciesTag" )));
577 (
NAME(
"abs_species_active" ),
580 "Indices of active absorption species.\n"
582 "This variable selects, which absorption species are active in\n"
583 "*abs_xsec_agenda*.\n"
585 "Dimension: A vector with one element for every active species, at max\n"
586 " same number of elements as abs_species.\n"
588 GROUP(
"ArrayOfIndex" )));
595 "List of temperatures to be used for the calculation of absorption\n"
598 "In contrast to the global *t_field*, this is just a vector. Any\n"
599 "absorption method should check that the length of this vector is the\n"
600 "same as that of *abs_p*\n"
602 "Dimension: [number of pressures]\n"
613 "Total absorption vector.\n"
615 "This variable contains the absorption coefficient vector which \n"
616 "is used in the RTE calculation. It is \n"
617 "the physical absorption which includes particle absorption \n"
618 "for all chosen particle types as well as gaseous absorption for\n"
619 "all chosen gaseous species.\n"
620 "The vector is calculated by the agenda *opt_prop_part_agenda* \n"
621 "The dimensision of the variable adapts to *stokes_dim*.\n"
623 "See further the ARTS user guide (AUG). Use the index to find where\n"
624 "this variable is discussed. The variable is listed as a subentry to\n"
625 "\"workspace variables\".\n"
627 "Usage: Output of the agenda *opt_prop_part_agenda* \n"
631 "Dimensions: [f_grid, stokes_dim]\n"
637 (
NAME(
"abs_vec_spt"),
640 "Absorption vector for a single particle type.\n"
642 "This variable contains the elements of absorption vector of a \n"
643 "single particle, given It is calculated in the agenda \n"
644 "*spt_calc_agenda*.\n"
646 "ARTS user guide (AUG) gives the formulas used for computing all \n"
647 "the elements of absorption vector.\n"
649 "Usage: Input and Output of the method abs_vec_sptCalc\n"
653 "Dimensions: [N_particletypes,stokes_dim]\n"
655 GROUP(
"Matrix" ) ));
662 "The VMRs (unit: absolute number) on the abs_p grid.\n"
663 "Dimensions: [tag_groups.nelem(), abs_p.nelem()]\n"
669 (
NAME(
"abs_xsec_agenda" ),
678 (
NAME(
"abs_xsec_agenda_checked" ),
681 "OK-flag for *abs_xsec_agenda*.\n"
683 "Set by *abs_xsec_agenda_checkedCalc*.\n"
689 (
NAME(
"abs_xsec_per_species" ),
692 "Absorption cross sections for the attenuation.\n"
694 "This variable contains absorption cross section xsec individually for\n"
695 "each tag group. The Array contains one matrix for each tag group, the\n"
696 "matrix format is the same as that of abs_coef.\n"
698 "Dimensions: [abs_species](f_grid, abs_p)\n"
700 "Unit: m^2 (alpha = xsec * n * VMR),\n"
701 " where n is total density.\n"
703 GROUP(
"ArrayOfMatrix" )));
707 (
NAME(
"antenna_dim" ),
710 "The dimensionality of the antenna pattern (1-2).\n"
712 "A dimensionality of 1 means that only the respons variation in the\n"
713 "zenith direction is considered. The provided respons shall then be the\n"
714 "integrated in the azimuth direction. For 2D, the respons of the\n"
715 "antenna has both a zenith and azimuth variation.\n"
717 "Usage: Set by the user.\n"
719 "Unit: Integer value [1-2].\n"
725 (
NAME(
"antenna_los" ),
728 "The relative line-of-sight of each antenna pattern.\n"
730 "This variable describes the line-of-sight of the individual antennae\n"
731 "relative to *sensor_los*. If only one antenna is present the matrix\n"
732 "should contain a row of zero(s). The number of columns corresponds to\n"
733 "the *antenna_dim*, with the first column containing zenith angles\n"
734 "and the second azimuth angles. If each measurement block corresponds\n"
735 "to a single antenna pattern, the normal choice is to set the angle(s)\n"
736 "of this variable to zero.\n"
738 "See further the ARTS user guide (AUG). Use the index to find where\n"
739 "this variable is discussed. The variable is listed as a subentry to\n"
740 "\"workspace variables\".\n"
742 "Usage: Set by the user.\n"
744 "Unit: [ degrees, degrees ]\n"
746 "Size: [ number of antennae, 1 or 2 ]\n"
752 (
NAME(
"antenna_response" ),
755 "The antenna pattern/response.\n"
757 "This WSV describes the antenna response as a function of polarisation\n"
758 "(pol), frequencue (f), zenith angle (za) and azimuth angle (aa).\n"
760 "Polarisation dimension: If this dimension has size 1, the data are\n"
761 "applied for all polarisations of concern. The data are otherwise used\n"
762 "in sequential order. This signifies that, in general, the first\n"
763 "polarisation \"layer\" corresponds to the first stokes dimension\n"
764 "etc. An exception is if a polarisation rotation has been applied. In\n"
765 "any case, it is up to the user to ensure that polarisations are\n"
766 "consistently defined.\n"
768 "Frequency dimension: If this dimension has size 1, the data are\n"
769 "applied for all frequencies of concern. The given frequency must be\n"
770 "inside the frequency range of concern. A linear interpolation is\n"
771 "otherwise applied.\n"
773 "Zenith angle dimension: This dimension must always have a size >= 2\n"
774 "The response outside covered grid range is treated as zero. If\n"
775 "*antenna_dim* equals 1, the data should correspond to the response\n"
776 "integrated in the azimuthal direction.\n"
778 "Azimuth angle dimension: If *antenna_dim* equals 1, this dimension\n"
779 "must have size 1. A size >= 2 is otherwise required. The response\n"
780 "outside covered grid range is treated as zero.\n"
782 "Usage: Set by the user.\n"
786 " ArrayOfString field_names[N_pol]\n"
787 " Vector f_grid[N_f]\n"
788 " Vector za_grid[N_za]\n"
789 " Vector aa_grid[N_aa]\n"
790 " Tensor4 data[N_pol][N_f][N_za][N_aa]\n"
792 GROUP(
"GriddedField4" )));
796 (
NAME(
"atmosphere_dim" ),
799 "The atmospheric dimensionality (1-3).\n"
801 "This variable defines the complexity of the atmospheric structure.\n"
802 "The dimensionality is given by an integer between 1 and 3, where 1\n"
803 "means 1D etc. This is the master variable for the atmospheric\n"
804 "dimensionality, variables which size changes with the dimensionality\n"
805 "are checked to match this variable. \n"
807 "Methods adapt automatically to this variable. That is, it should\n"
808 "not be needed to change any methods if the dimensionality is\n"
809 "changed. However, not all methods are working for higher dimensions.\n"
811 "Usage: Set by the user.\n"
813 "Unit: Integer value.\n"
819 (
NAME(
"atmfields_checked" ),
822 "OK-flag for atmospheric grids and (physical) fields.\n"
824 "The variable flags that clear-sky part of the atmosphere is\n"
825 "defined in formally correct way. Example on problems captured\n"
826 "include that the size of an atmospheric fields does not match the\n"
827 "length of the atmospheric grids, and physically incorrect data such\n"
828 "as negative temperatures.\n"
830 "Note that *z_field* is not covered by this variable, it is instead\n"
831 "treated to be part of the geometrical considerations where the ok-flag\n"
832 "is denoted as *atmgeom_checked*. The cloudbox is covered by\n"
833 "*cloudbox_checked*.\n"
835 "Shall be set by *atmfields_checkedCalc*. See that WSMs for treated\n"
836 "WSVs. Only the value 1 is taken as OK.\n"
842 (
NAME(
"atmgeom_checked" ),
845 "OK-flag for the geometry of the model atmosphere.\n"
847 "The variable flags that reference ellipsoid, the surface and *z_field*\n"
848 "contain formally correct values. Includes for example, that *z_field*\n"
849 "holds strictly increasing values at each geographical position.\n"
851 "See also *atmfields_checked*.\n"
853 "Shall be set by *atmgeom_checkedCalc*. Only the value 1 is taken\n"
860 (
NAME(
"atm_fields_compact" ),
863 "A compact combination of all atmospheric fields for a clear-sky\n"
864 "calculation on a common set of grids.\n"
866 "This concerns temperature, altitude, and gas VMRs.\n"
868 "The data are stored in a *GriddedField4*.\n"
870 "The order of the fields must be:\n"
871 "T[K] z[m] VMR_1[1] ... VMR_n[1]\n"
872 "(the field names for the gases do not have to start with VMR_)\n"
874 "Usage: Used inside batch calculations, to hold successive atmospheric\n"
875 " states from an *ArrayOfGriddedField4*.\n"
877 "Possible future extensions: Add a similar variable\n"
878 "particle_fields_compact for hydrometeors?\n"
882 " ArrayOfString field_names[N_fields]\n"
883 " Vector p_grid[N_p]\n"
884 " Vector lat_grid[N_lat]\n"
885 " Vector lon_grid[N_lon]\n"
886 " Tensor4 data[N_fields][N_p][N_lat][N_lon]\n"
888 GROUP(
"GriddedField4" )));
892 (
NAME(
"atm_fields_compact_all" ),
895 "A compact combination of all atmospheric fields for a clear-sky\n"
896 "and cloud particle scattering calculation on a common set of grids.\n"
898 "This concerns temperature, altitude, scattering particles and gas VMRs.\n"
900 "The data are stored in a *GriddedField4*.\n"
902 "The order of the fields must be:\n"
903 "T[K] z[m] LWC[kg/m3] IWC[kg/m3] Rain[kg/m2/s] Snow[kg/m2/s] VMR_1[1] ... VMR_n[1]\n"
904 "(the field names for the gases do not have to start with VMR_)\n"
906 "Usage: Used inside batch calculations, to hold successive atmospheric\n"
907 " states from an *ArrayOfGriddedField4*.\n"
911 " ArrayOfString field_names[N_fields]\n"
912 " Vector p_grid[N_p]\n"
913 " Vector lat_grid[N_lat]\n"
914 " Vector lon_grid[N_lon]\n"
915 " Tensor4 data[N_fields][N_p][N_lat][N_lon]\n"
917 GROUP(
"GriddedField4" )));
921 (
NAME(
"backend_channel_response" ),
924 "The response of each backend channel.\n"
926 "The response is given as an *ArrayOfGriddedField1*. The grid consists of\n"
927 "relative frequencies. These relative frequencies are added to \n"
928 "*f_backend* to obtain the absolute frequency for each response value.\n"
929 "The actual data are the response at each frequency grid point.\n"
931 "There are here two options. If the array has length 1, the same\n"
932 "response is applied for all channels. Accordingly, this assumes that\n"
933 "all channels have the same response function. The second option is to\n"
934 "specify the response for each channel seperately. This signifies that\n"
935 "the *backend_channel_response* array has either 1 or n elements, where\n"
936 "n is the length of *f_backend*\n"
938 "Usage: Set by the user.\n"
940 "Size: Array[N_ch]\n"
945 GROUP(
"ArrayOfGriddedField1" )));
949 (
NAME(
"backend_channel_response_multi" ),
952 "As *backend_channel_response* but describes an instrument with\n"
953 "muliple mixer/receiver chains.\n"
955 "See *f_backend_multi* for when to use this variable and size\n"
958 "Usage: Set by the user.\n "
960 GROUP(
"ArrayOfArrayOfGriddedField1" )));
964 (
NAME(
"batch_atm_fields_compact" ),
967 "An array of compact atmospheric states.\n"
969 "This is used to hold a set of *atm_fields_compact* for batch\n"
972 GROUP(
"ArrayOfGriddedField4" )));
976 (
NAME(
"batch_atm_fields_compact_all" ),
979 "An array of compact atmospheric states, including scattering particles.\n"
981 "This is used to hold a set of *atm_fields_compact_all* for batch\n"
984 GROUP(
"ArrayOfGriddedField4" )));
988 (
NAME(
"batch_cloudbox_limits" ),
991 "An array of *cloudbox_limits*.\n"
993 "This is used to hold a set of *cloudbox_limits* for batch\n"
996 GROUP(
"ArrayOfArrayOfIndex" )));
1000 (
NAME(
"batch_pnd_fields" ),
1003 "An array of compact pnd states.\n"
1005 "This is used to hold a set of 1D *pnd_field* for batch\n"
1008 GROUP(
"ArrayOfTensor4" )));
1012 (
NAME(
"blackbody_radiation" ),
1015 "The blackbody radiation for a given temperature.\n"
1017 "This variable can be seen as the source term for thermal emission.\n"
1018 "Normally, this variable should match the Planck function. The version\n"
1019 "of the Planck function taking frequency as input is considered as\n"
1020 "default for ARTS. The unit for radiance is then W / [m2 Hz sr].\n"
1021 "For frequencies where the Rayleigh-Jeans approximation is valid\n"
1022 "(but not recommended) option is to set this variable to be equal\n"
1023 "to the physical temperature, resulting in K as unit.\n"
1025 "Inside some methods, such as DOIT, the calculation of this source\n"
1026 "term can be hard-coded.\n"
1028 "Usage: Set by *blackbody_radiation_agenda*.\n"
1030 "Unit: See above.\n"
1032 "Dimensions: [ f_grid ]\n"
1034 GROUP(
"Vector" )));
1038 (
NAME(
"blackbody_radiation_agenda" ),
1043 GROUP(
"Agenda" )));
1047 (
NAME(
"cloudbox_checked" ),
1050 "OK-flag for variables associated with the cloudbox.\n"
1052 "This variable flags that cloudbox variables are defined in a formally\n"
1053 "and practically correct way. For example, that there is sufficient\n"
1054 "space between the cloudbox and edges of the model atmosphere (for\n"
1055 "2D and 3D). Pure clear-sky variables are covered by *basics_checked*.\n"
1057 "Relevant checks are performed by *cloudbox_checkedCalc. Only the\n"
1058 "value 1 is taken as OK.\n"
1064 (
NAME(
"cloudbox_limits" ),
1067 "The limits of the cloud box.\n"
1069 "This variable defines the extension of the cloud box. The cloud box \n"
1070 "is defined to be rectangular in the used coordinate system, with \n"
1071 "limits exactly at points of the involved grids. This means, for \n"
1072 "example, that the vertical limits of the cloud box are two pressure \n"
1073 "levels. For 2D, the angular extension of the cloud box is between \n"
1074 "two points of the latitude grid, and likewise for 3D but then also \n"
1075 "with a longitude extension between two grid points. The latitude and\n"
1076 "longitude limits for the cloud box cannot be placed at the end \n"
1077 "points of the corresponding grid as it must be possible to calculate\n"
1078 "the incoming intensity field.\n"
1080 "The variable *cloudbox_limits* is an array of index value with\n"
1081 "length twice *atmosphere_dim*. For each dimension there is a lower \n"
1082 "limit and an upper limit. The order of the dimensions is as usual \n"
1083 "pressure, latitude and longitude. The upper limit index must be \n"
1084 "greater then the lower limit index. For example, \n"
1085 "*cloudbox_limits* = [0 5 4 11 4 11] means that cloud box extends\n"
1086 "between pressure levels 0 and 5, and latitude and longitude points 4\n"
1089 "If *cloudbox_on* = 0, the content of this variable is neglected, but\n"
1090 "it must be initiated to some dummy values.\n"
1092 "See further the ARTS user guide (AUG). Use the index to find where\n"
1093 "this variable is discussed. The variable is listed as a subentry to\n"
1094 "\"workspace variables\".\n"
1096 "Usage: Set by the user, either directly or using a method\n"
1097 " checking the extension of scattering particles.\n"
1099 "Unit: Index values.\n"
1101 "Size: [ 2 * atmosphere_dim ]\n"
1103 GROUP(
"ArrayOfIndex" )));
1107 (
NAME(
"cloudbox_on" ),
1110 "Flag to activate the cloud box.\n"
1112 "Scattering calculations are confined to a part of the atmosphere\n"
1113 "denoted as the cloud box. The extension of the cloud box is given by\n"
1114 "*cloudbox_limits*. This variable tells methods if a cloud box is\n"
1115 "activated or not. \n"
1117 "See further the ARTS user guide (AUG). Use the index to find where\n"
1118 "this variable is discussed. The variable is listed as a subentry to\n"
1119 "\"workspace variables\".\n"
1121 "Usage: Set by the user.\n"
1129 (
NAME(
"complex_refr_index"),
1132 "Complex refractive index (n) data.\n"
1134 "The variable works as a lookup-table of complex refractive index.\n"
1135 "The matter type (water, ice ...) is unspecified, it is up to the\n"
1136 "user to fill the variable with data for the expected matter.\n"
1137 "This variable type can be used to describe n of both the surface and\n"
1138 "atmospheric particles. For the surface, a dedicated variable exists:\n"
1139 "*surface_complex_refr_index*.\n"
1141 "The column dimension has always size 2, where the first and second\n"
1142 "column holds the real and imaginary part of n, respectively. The row\n"
1143 "dimension matches temperature, and the page dimension is frequency.\n"
1144 "Both the temperature and frequency dimensions grids are allowed to\n"
1145 "have length 1, which is interpreted as n being constant in that\n"
1148 "When mapping these data to the required frequencies and temperatures\n"
1149 "a bi-linear interpolation is applied.\n"
1154 " Vector f_grid[N_f]\n"
1155 " Vector T_grid[N_T]\n"
1156 " ArrayOfString Complex[2]\n"
1157 " Tensor3 data[N_f][N_T][2]\n"
1159 GROUP(
"GriddedField3" ) ));
1166 "Derivative of *iy* with respect to retrieval quantities.\n"
1168 "The variable gives the derivative if *iy* with respect to some\n"
1169 "variables (but not all jacobian variables). Handled are only variables\n"
1170 "affecting monochromatic pencil beam radiances where an (semi-)\n"
1171 "analytical expression can be applied (and that this calculation way\n"
1172 "has been selected when the jacobian has been set-up).\n"
1174 "Usage: Output of *iy_main_agenda*.\n"
1177 " [n_quantities][ n_retrieval_points, f_grid, stokes_dim ]\n"
1179 GROUP(
"ArrayOfTensor3" )));
1183 (
NAME(
"doit_conv_flag" ),
1186 "Flag for the convergence test.\n"
1188 "This variable is initialized with 0 inside the method \n"
1189 "*doit_i_fieldIterate*.\n"
1190 "If after an iteration the convergence test is fulfilled, 1 is \n"
1191 "assigned which means that the iteration is completed. \n"
1193 "Usage: Method output. \n"
1199 (
NAME(
"doit_conv_test_agenda" ),
1204 GROUP(
"Agenda" )));
1208 (
NAME(
"doit_i_field" ),
1211 "Radiation field.\n"
1213 "This variable is used to store the monochromatic radiation field \n"
1214 "inside the cloudbox which is found by an iterative solution (DOIT).\n"
1215 "Refer to AUG for further information.\n"
1217 "Usage: Method output. \n"
1219 "Unit: W / (m^2 Hz sr) for each Stokes component.\n"
1221 "Size: [(cloudbox_limits[1] - cloudbox_limits[0]) +1, \n"
1222 " (cloudbox_limits[3] - cloudbox_limits[2]) +1, \n"
1223 " (cloudbox_limits[5] - cloudbox_limits[4]) +1, \n"
1224 " N_za, N_aa, N_i ]\n"
1226 "Note: For 1D, the size of the azimuth angle dimension (N_aa) is always 1.\n"
1228 GROUP(
"Tensor6" )));
1232 (
NAME(
"doit_i_field2" ),
1235 "Radiation field.\n"
1237 "This variable is used to store the monochromatic radiation field \n"
1238 "inside the cloudbox which is found by an iterative solution (DOIT).\n"
1239 "Refer to AUG for further information.\n"
1241 "Usage: Method output. \n"
1243 "Unit: W / (m^2 Hz sr) for each Stokes component.\n"
1245 "Size: [(cloudbox_limits[1] - cloudbox_limits[0]) +1, \n"
1246 " (cloudbox_limits[3] - cloudbox_limits[2]) +1, \n"
1247 " (cloudbox_limits[5] - cloudbox_limits[4]) +1, \n"
1248 " N_za, N_aa, N_i ]\n"
1250 GROUP(
"Tensor7" )));
1254 (
NAME(
"doit_i_field1D_spectrum" ),
1257 "Radiation field for the whole frequency spectrum. \n"
1259 "This variable holds the radiation field. In contrast to \n"
1260 "*doit_i_field* this variable has an additional freqeuncy \n"
1261 "dimension. This variable is only used for 1D DOIT \n"
1264 "Usage: Output of *DoitCloudboxFieldPut*\n"
1266 "Unit: W / (m^2 Hz sr)\n"
1269 " (cloudbox_limits[1] - cloudbox_limits[0]) +1, \n"
1270 " N_za, N_aa, N_i ]\n"
1272 GROUP(
"Tensor4" )));
1276 (
NAME(
"doit_i_field_old" ),
1279 "Intensity field inside the cloudbox.\n"
1281 "This variable is used to store the intensity field inside the\n"
1282 "cloudbox while performing the iteration. One has to store the\n"
1283 "intensity field of the previous iteration to be able to do the \n"
1284 "convergence test after each iteration.\n"
1285 "Refer to AUG for more information.\n"
1287 "Usage: Method output. \n"
1289 "Unit: W / (m^2 Hz sr) for each Stokes component.\n"
1291 "Size: [(cloudbox_limits[1] - cloudbox_limits[0]) +1, \n"
1292 " (cloudbox_limits[3] - cloudbox_limits[2]) +1, \n"
1293 " (cloudbox_limits[5] - cloudbox_limits[4]) +1, \n"
1294 " N_za, N_aa, N_i ]\n"
1296 GROUP(
"Tensor6" )));
1300 (
NAME(
"doit_is_initialized" ),
1303 "Flag to determine if *DoitInit* was called.\n"
1305 "This flag is checked by *ScatteringDoit* to make sure that\n"
1306 "*DoitInit* was called before.\n"
1312 (
NAME(
"doit_iteration_counter" ),
1315 "Counter for number of iterations.\n"
1317 "This variable holds the number of iterations \n"
1318 "while solving the VRTE using the DOIT method. \n"
1324 (
NAME(
"doit_mono_agenda" ),
1329 GROUP(
"Agenda" )));
1333 (
NAME(
"doit_rte_agenda" ),
1338 GROUP(
"Agenda" )));
1342 (
NAME(
"doit_scat_field_agenda" ),
1347 GROUP(
"Agenda" )));
1351 (
NAME(
"doit_scat_field" ),
1354 "Scattered field inside the cloudbox.\n"
1356 "This variable holds the value of the scattering integral for all\n"
1357 "points inside the cloudbox. For more information refer to AUG.\n"
1359 "Usage: Input to *doit_i_fieldUpdate...*. \n"
1361 "Unit: W / (m^2 Hz sr) for each Stokes component.\n"
1363 "Size: [(cloudbox_limits[1] - cloudbox_limits[0]) +1, \n"
1364 " (cloudbox_limits[3] - cloudbox_limits[2]) +1, \n"
1365 " (cloudbox_limits[5] - cloudbox_limits[4]) +1, \n"
1366 " N_za, N_aa, N_i ]\n"
1368 GROUP(
"Tensor6" )));
1372 (
NAME(
"doit_za_grid_opt" ),
1375 "Optimized zenith angle grid.\n"
1377 "Output of the method *doit_za_grid_optCalc*.\n"
1379 "Usage: Output of *doit_za_grid_optCalc* \n"
1383 GROUP(
"Vector" )));
1387 (
NAME(
"doit_za_grid_size" ),
1390 "Number of equidistant grid points of the zenith angle grid, \n"
1391 "defined from 0 to 180 deg, for the scattering integral calculation. \n"
1393 "Usage: Output of *DoitAngularGridsSet*.\n"
1399 (
NAME(
"doit_za_interp" ),
1402 "Flag for interplation method in zenith angle dimension.\n"
1404 "0 - linear interpolation \n"
1405 "1 - cubic interpolation \n"
1407 "Usage: Set by user in *doit_za_interpSet*. \n"
1413 (
NAME(
"ext_mat" ),
1416 "Total extinction matrix.\n"
1418 "This variable contains the extinction coefficient matrix which\n"
1419 "is used in the RT calculation in the cloudbox . It is the physical\n"
1420 "extinction matrix which includes particles extinction for all chosen\n"
1421 "particle types and gaseous extinction for all chosen gaseous species.\n"
1423 "See further the ARTS user guide (AUG). Use the index to find where\n"
1424 "this variable is discussed. The variable is listed as a subentry to\n"
1425 "\"workspace variables\".\n"
1427 "Usage: Output of the agendas *opt_prop_gas_agenda* \n"
1428 " and *opt_prop_part_agenda* \n"
1430 "Unit: [Hz, m^2, m^2] "
1432 "Dimensions: [f_grid, stokes_dim, stokes_dim]\n"
1434 GROUP(
"Tensor3" )));
1438 (
NAME(
"ext_mat_spt" ),
1441 "Extinction matrix for a single particle type.\n"
1443 "This variable contains the elements for extinction matrix of a \n"
1444 "single particle for a given propagation direction. It is calculated\n"
1445 "input as well as the output of the agenda *spt_calc_agenda*. \n"
1447 "Usage: Output of *spt_calc_agenda* \n"
1451 "Dimensions: [N_particletypes, stokes_dim, stokes_dim]\n"
1453 GROUP(
"Tensor3" )));
1457 (
NAME(
"file_index" ),
1460 "Index number for files.\n"
1462 "See *WriteXMLIndexed* for further information.\n"
1464 "Usage: Input to *WriteXMLIndexed* and *ReadXMLIndexed*. \n"
1470 (
NAME(
"forloop_agenda" ),
1475 GROUP(
"Agenda" )));
1479 (
NAME(
"forloop_index" ),
1482 "The index for for-loops.\n"
1484 "This is the index that is used by method *ForLoop* to loop over\n"
1485 "*forloop_agenda*. \n"
1491 (
NAME(
"fos_iyin_za_angles" ),
1494 "So far just testing of FOS ..."
1496 GROUP(
"Vector" )));
1500 (
NAME(
"fos_scatint_angles" ),
1503 "So far just testing of FOS ..."
1505 GROUP(
"Matrix" )));
1509 (
NAME(
"f_backend" ),
1512 "The frequency position of each backend (spectrometer) channel.\n"
1514 "Usage: Set by the user.\n "
1518 GROUP(
"Vector" )));
1522 (
NAME(
"f_backend_multi" ),
1525 "As *f_backend* but describes an instrument with muliple\n"
1526 "mixer/receiver chains.\n"
1528 "This variable is needed when e.g. the receiver has several mixers\n"
1529 "or the the receiver measures several polarisation and the channels\n"
1530 "differ in position or response function. \n"
1532 "The array has one element for each \"receiver chain\". The array\n"
1533 "length must match *backend_channel_response_multi*, and possibly\n"
1534 "also *lo_multi*.\n"
1536 "Usage: Set by the user.\n "
1540 GROUP(
"ArrayOfVector" )));
1547 "The frequency grid for monochromatic pencil beam calculations.\n"
1549 "Usage: Set by the user.\n "
1553 GROUP(
"Vector" )));
1560 "Frequency index. \n"
1562 "Not all methods handle all monochromatic frequencies (of *f_grid*) in\n"
1563 "parellel and this variable is used for communication between methods,\n"
1564 "holding the index of the frequency treated presently.\n"
1566 "In some contexts, a negative f_index means all frequencies.\n"
1568 "Usage: Method output.\n"
1577 "Gravity at zero altitude.\n"
1579 "This variable is \"little g\" at the reference ellipsiod. That is,\n"
1580 "for Earth this is a value around 9.81 m/s2\n"
1582 GROUP(
"Numeric" )));
1586 (
NAME(
"g0_agenda" ),
1591 GROUP(
"Agenda" )));
1595 (
NAME(
"isotopologue_quantum" ),
1598 "Quantum physical values for the Zeeman effect to work not easily available in other databases.\n"
1601 "This variable should contain total spin [denoted S, with units in angular momentum]\n"
1602 "and the molecular Landé g-factor [denoted g_s, with, to the author, unknown units].\n"
1604 "The variable can, e.g., be loaded from a file formated as '@ isotopologue g_s S'\n"
1606 GROUP(
"SpeciesAuxData" )));
1610 (
NAME(
"isotopologue_ratios" ),
1613 "Isotopologue ratios. This variable can be set to default values by\n"
1614 "calling *isotopologue_ratiosInitFromBuiltin*\n"
1616 GROUP(
"SpeciesAuxData" )));
1623 "Monochromatic pencil beam radiance spectrum.\n"
1625 "This variable holds a single spectrum, with values corresponding\n"
1626 "to infinite frequency and spatial resolution (compare to *y*).\n"
1628 "The variable is used to represent spectra at all positions of the\n"
1629 "propagation path and can e.g. temporarily hold radiation entering\n"
1630 "the atmpophere from space. The unit depends on if emission is \n"
1631 "considered or not (no conversion to e.g. brightness temperature shall\n"
1634 "Usage: Used by radiative transfer methods.\n"
1636 "Unit: W / (m^2 Hz sr) or transmission.\n"
1638 "Dimensions: [ f_grid, stokes_dim ]\n"
1640 GROUP(
"Matrix" )));
1647 "Monochromatic pencil beam data for one measurement block.\n"
1649 "The data for all *iy* of a measurement block appended to a vector,\n"
1650 "following the sorting order used for *y*.\n"
1652 "Usage: Used internally.\n"
1654 "Unit: W / (m^2 Hz sr) or transmission.\n"
1656 "Dimensions: [ naa*nza*nf*stokes_dim ] where naa is length of\n"
1657 " mblock_aa_grid, za length of mblock_za_grid and nf is\n"
1658 " length of f_grid.\n"
1660 GROUP(
"Vector" )));
1664 (
NAME(
"iy_agenda_call1" ),
1667 "Flag to handle recursive calls of *iy_main_agenda*\n"
1669 "The agenda *iy_main_agenda* can be used recursively and this flag\n"
1670 "is used to tell the methods inside the agenda which is the primary\n"
1671 " call. This is handled automatically for methods using\n"
1672 "*iy_main_agenda*, such as *yCalc*, but the user must set this\n"
1673 "variable to 1 if the agenda is called directly inside the control\n"
1674 "file (which should be a rare case).\n"
1683 "Data auxiliary to *iy*.\n"
1685 "Different data beside the direct result of the radiative transfer\n"
1686 "calculations (*iy*)can be obtained by this variable. These auxilary\n"
1687 "data are selected by *iy_aux_vars*.\n"
1689 "The size of the data is made as compact as possible (in contrast to\n"
1690 "*y_aux*). For example, the frequency and Stokes dimensions are set to\n"
1691 "1 when along-the-path temperature is stored. Further, for overall\n"
1692 "radiative transfer character, such as total ransmission, the last\n"
1693 "dimension is set to have size 1.\n"
1695 "See also *iy_aux_vars*.\n"
1697 "Usage: Provided by some radiative transfer methods.\n"
1699 "Dimensions: [quantity][ 1 or f_grid, 1 or stokes_dim, 1 or stokes_dim,\n"
1700 " 1 or propgation path point ]\n"
1702 GROUP(
"ArrayOfTensor4" )));
1706 (
NAME(
"iy_aux_vars" ),
1709 "Selection of quantities for *iy_aux* and when applicable also *y_aux*.\n"
1711 "Each element of this string array determines the quantity for the\n"
1712 "corresponding element in *iy_aux* and *y_aux* (ie. the quantities\n"
1713 "are stored in the order given in *iy_aux_vars*).\n"
1715 "The possible choices vary between the methods. See the WSM you select\n"
1716 "for *iy_main_agenda* for the complete set of choices. However,\n"
1717 "if the calculations are done through *yCalc*, you can not select\n"
1718 "along-the-path variables (but e.g. \"Transmission, total\" is a\n"
1721 GROUP(
"ArrayOfString" )));
1725 (
NAME(
"iy_cloudbox_agenda" ),
1730 GROUP(
"Agenda" )));
1734 (
NAME(
"iy_main_agenda" ),
1739 GROUP(
"Agenda" )));
1743 (
NAME(
"iy_space_agenda" ),
1748 GROUP(
"Agenda" )));
1752 (
NAME(
"iy_sub_agenda" ),
1757 GROUP(
"Agenda" )));
1761 (
NAME(
"iy_surface_agenda" ),
1766 GROUP(
"Agenda" )));
1770 (
NAME(
"iy_transmission" ),
1773 "Transmission to be included in *iy*.\n"
1775 "The calculation of *iy* can be performed over several propation path\n"
1776 "branches, and there can be recursive calls of *iy_main_agenda*.\n"
1777 "This variable gives the transmission from the end point of the present\n"
1778 "branch and the sensor for such recursive cases.\n"
1780 "This variable is used purely internally. The exact usage can vary\n"
1781 "between different RT integration schemes.\n"
1783 "Usage: Internally inside iy_main_agenda.\n"
1787 "Dimensions: [ f_grid, stokes_dim, stokes_dim ]\n"
1789 GROUP(
"Tensor3" )));
1793 (
NAME(
"iy_transmitter_agenda" ),
1798 GROUP(
"Agenda" )));
1802 (
NAME(
"iy_unit" ),
1805 "Selection of output unit for some radiative transfer methods.\n"
1807 "This variable allows that the unit of the output radiance/intensity\n"
1808 "is changed. The possible choices differ between the radiative\n"
1809 "methods, including not considering the variable at all.\n"
1810 "Accordingly, for details see the radiative method you have selected.\n"
1812 GROUP(
"String" )));
1816 (
NAME(
"jacobian" ),
1819 "The Jacobian matrix.\n"
1821 "The matrix holding the Jacobians of the retrieval quantities. Each\n"
1822 "quantity, and its subdivision into atmospheric grids, are stored as\n"
1823 "columns in the matrix. The matrix has to be initialised before the\n"
1824 "quantities can be defined. Initialisation WSM is *jacobianInit*.\n"
1825 "Retrieval quantities are then added with *jacobianAdd...* methods.\n"
1826 "See the online help. Pure numerical calculation is described by\n"
1827 "*jacobian_calc_agenda* and are performed by *jacobianCalc*.\n"
1829 "Units: See the different retrieval quantities.\n"
1831 "Dimension: [ y, number of retrieval quantities and grids ]\n"
1833 GROUP(
"Matrix" )));
1837 (
NAME(
"jacobian_agenda" ),
1842 GROUP(
"Agenda" )));
1846 (
NAME(
"jacobian_do" ),
1849 "Flag to activate jacobian calculations.\n"
1851 "If this variable is set to 0, no jacobian calculations will be\n"
1852 "even if such calculations have been set-up (through the jacobianAddXxx\n"
1859 (
NAME(
"jacobian_indices" ),
1862 "First and last column index in *jacobian* for each retrieval quantity."
1864 "This variable tells which part of *jacobian* that corresponds to \n"
1865 "each jacobian quantity.\n"
1867 "Usage: Set by *jacobianClose*.\n"
1869 GROUP(
"ArrayOfArrayOfIndex" )));
1873 (
NAME(
"jacobian_quantities" ),
1876 "The retrieval quantities in the Jacobian matrix.\n"
1878 "An array of retrieval quantities for which the jacobians are\n"
1881 "Usage: Quantities are added by the jacobianAdd WSMs.\n"
1883 GROUP(
"ArrayOfRetrievalQuantity" )));
1887 (
NAME(
"lambertian_nza" ),
1890 "Number of zenith angles considered in Lambertian surface scattering.\n"
1892 "For Lambertian surface scattering, the down-welling radiation field\n"
1893 "is estimated by making calculations for *lambertian_nza* directions.\n"
1894 "For details see WSM *surfaceLambertianSimple*.\n"
1896 "Usage: Set by the user.\n"
1909 GROUP(
"Numeric" )));
1913 (
NAME(
"lat_grid" ),
1916 "The latitude grid.\n"
1918 "The latitudes for which the atmospheric fields are defined. The\n"
1919 "atmosphere is undefined outside the range covered by the grid.\n"
1920 "The grid must be sorted in increasing order, with no repetitions.\n"
1922 "Geocentric latitudes are used.\n"
1924 "For 1D calculations this vector shall be set to be empty.\n"
1926 "For 2D cases the latitudes shall be interpreted as the angular\n"
1927 "distance inside the orbit plane from the equator (values\n"
1928 "outside +-90 deg are allowed).\n"
1930 "For 3D, the valid latitude range is [-90,90].\n"
1932 "See further the ARTS user guide (AUG). Use the index to find where\n"
1933 "this variable is discussed. The variable is listed as a subentry to\n"
1934 "\"workspace variables\".\n"
1936 "Usage: Set by the user.\n"
1940 GROUP(
"Vector" )));
1944 (
NAME(
"lat_true" ),
1947 "Latitudinal geolocation for 1D and 2D data.\n"
1949 "The variables *lat_grid* and *lon_grid* contain true positions only\n"
1950 "for 3D. For 1D and 2D, the geographical position is given by\n"
1951 "*lat_true* and *lon_true*. Can be left empty when not used.\n"
1954 " 1D: *lat_true* shall have length 1\n"
1956 " 2D: Both *lat_true* and *lon_true* shall have a length matching\n"
1957 " *lat_grid*. That is, *lat_true* and *lon_true* shall not be\n"
1958 " seen as grids, they are vectors giving the actual lat or lon\n"
1959 " for each point corresponding to *lat_grid*.\n"
1961 "Usage: Set by the user.\n"
1965 GROUP(
"Vector" )));
1969 (
NAME(
"line_mixing_data" ),
1972 "Line mixing data.\n"
1973 "Dimensions: First dimension has same size as *abs_species*.\n"
1974 " Second dimension corresponds to entries of line mixing data.\n"
1975 " The LineMixingRecords contain the species index,\n"
1976 " the isotopologue index, the QuantumNumberRecord and the line mixing data.\n"
1978 GROUP(
"ArrayOfArrayOfLineMixingRecord" )));
1982 (
NAME(
"line_mixing_data_lut" ),
1985 "Lookup table to match the LineRecords in abs_lines_per_species to entries\n"
1986 "in the line mixing data stored in *line_mixing_data*.\n"
1987 "The Index points to the matching entry in *line_mixing_data* or\n"
1988 "-1 if there is no line mixing data available for this line.\n"
1990 "Dimensions: First dimension has same size as *abs_species*.\n"
1991 " Second dimension is zero for line mixing species without line mixing data.\n"
1992 " and the same size as *abs_lines_per_species* for line mixing species.\n"
1994 GROUP(
"ArrayOfArrayOfIndex" )));
2001 "The local oscillator frequency.\n"
2003 "A local oscillator frequency is used in a heterodyne system when\n"
2004 "the mixer folds the spectra from from radio frequencies (RF) to\n"
2005 "intermediate frequencies (IF).\n"
2009 "Usage: Set by the user.\n"
2011 GROUP(
"Numeric" )));
2015 (
NAME(
"lo_multi" ),
2018 "Local oscillator frequencies.\n"
2020 "As *lo* but describes an instrument with multiple mixers. A vector\n"
2021 "element for each LO. The size of this variable and\n"
2022 "*sideband_response_multi* shall match, and probably also\n"
2023 "*sideband_mode_multi*.\n"
2027 "Usage: Set by the user.\n"
2029 GROUP(
"Vector" )));
2040 GROUP(
"Numeric" )));
2044 (
NAME(
"lon_grid" ),
2047 "The longitude grid.\n"
2049 "The longitudes for which the atmospheric fields are defined. The\n"
2050 "atmosphere is undefined outside the range covered by the grid.\n"
2051 "The grid must be sorted in increasing order, with no repetitions.\n"
2053 "For 1D and 2D, this WSV shall be set to be empty.\n"
2055 "Allowed values for longitudes is the range [-360,360]. The difference\n"
2056 "between last and first value can not exceed 360 degrees. A difference\n"
2057 "of exactly 360 deg. means that the complete globe is covered and no\n"
2058 "propagation paths will reach a longitude edge.\n"
2060 "See further the ARTS user guide (AUG). Use the index to find where\n"
2061 "this variable is discussed. The variable is listed as a subentry to\n"
2062 "\"workspace variables\".\n"
2064 "Usage: Set by the user.\n"
2068 GROUP(
"Vector" )));
2072 (
NAME(
"lon_true" ),
2075 "Longitudinal geolocation for 1D and 2D data.\n"
2077 "The variables *lat_grid* and *lon_grid* contain true positions only\n"
2078 "for 3D. For 1D and 2D, the geographical position is given by\n"
2079 "*lat_true* and *lon_true*. Can be left empty when not used.\n"
2082 " 1D: *lon_true* shall have length 1\n"
2084 " 2D: Both *lat_true* and *lon_true* shall have a length matching\n"
2085 " *lat_grid*. That is, *lat_true* and *lon_true* shall not be\n"
2086 " seen as grids, they are vectors giving the actual lat or lon\n"
2087 " for each point corresponding to *lat_grid*.\n"
2089 "Usage: Set by the user.\n"
2093 GROUP(
"Vector" )));
2097 (
NAME(
"mag_u_field" ),
2100 "Zonal component of the magnetic field.\n"
2102 "The East-West magnetic field component. Positive values, when\n"
2103 "pointing eastward.\n"
2105 "Can be set to be empty, which is interpreted as zero field strength\n"
2110 "Dimensions: [ p_grid, lat_grid, lon_grid ] or [ 0 0 0 ].\n"
2112 GROUP(
"Tensor3" )));
2116 (
NAME(
"mag_v_field" ),
2119 "Meridional component of the magnetic field.\n"
2121 "The North-South magnetic field component. Positive values, when\n"
2122 "pointing northward.\n"
2124 "Can be set to be empty, which is interpreted as zero field strength\n"
2129 "Dimensions: [ p_grid, lat_grid, lon_grid ] or [ 0 0 0 ].\n"
2131 GROUP(
"Tensor3" )));
2135 (
NAME(
"mag_w_field" ),
2138 "Vertical component of the magnetic field.\n"
2140 "Positive values, when pointing upward.\n"
2142 "Can be set to be empty, which is interpreted as zero field strength\n"
2147 "Dimensions: [ p_grid, lat_grid, lon_grid ] or [ 0 0 0 ].\n"
2149 GROUP(
"Tensor3" )));
2153 (
NAME(
"main_agenda" ),
2158 GROUP(
"Agenda" )));
2162 (
NAME(
"massdensity_field" ),
2165 "The field of atmospheric scattering particle types in unit of massdensity\n"
2166 "(like IWC/LWC/Rain/Aerosol etc.).\n"
2168 "If *massdensity_field* is obtained from Chevallier91L data, the scat. particles are\n"
2169 "hydrometeors of type: CLW[kg/m^3] CIW[kg/m^3] Rain[kg/(m2*s)] Snow[kg/(m2*s)]\n"
2171 "NOTE: naming discussion: *massdensity_field* should be renamed in the future\n"
2172 "to a more general term (not limited to massdensities).\n"
2174 "Possible future extension: In the future a *massdensity_field_raw* might be needed,\n"
2175 "which contains the not-interpolated mass concentrations of scattering particles.\n"
2176 "This is not needed in the moment, since *massdensity_field* is only used with \n"
2177 "batch profile data (where all atmospheric variables are on the same grid).\n"
2179 "Usage:\tmassdensity data is used to calculate pnd_fields\n"
2181 "Unit:\tdepending on what is read, usually [kg/m3]\n"
2183 "Dimension:\t[ type, p_grid, lat_grid, lon_grid ]\n"
2186 GROUP(
"Tensor4" )));
2190 (
NAME(
"mblock_aa_grid" ),
2193 "The azimuthal angle grid for each measurement block.\n"
2195 "This variable should normally contain the azimuth grid of the\n"
2196 "antenna pattern. The grid is given as an angular off-set with\n"
2197 "respect to the angles in *sensor_los*.\n"
2199 "See further the ARTS user guide (AUG). Use the index to find where\n"
2200 "this variable is discussed. The variable is listed as a subentry to\n"
2201 "\"workspace variables\".\n"
2203 "Usage: Set by the user.\n"
2207 GROUP(
"Vector" )));
2211 (
NAME(
"mblock_index" ),
2214 "Measurement block index. \n"
2216 "Used to tell agendas the index of present measurement block.\n"
2218 "Usage: Used internally.\n"
2224 (
NAME(
"mblock_za_grid" ),
2227 "The zenith angle grid for each measurement block.\n"
2229 "This variable should normally contain the zenith grid of the\n"
2230 "antenna pattern. The grid is given as an angular off-set with\n"
2231 "respect to the angles in *sensor_los*.\n"
2233 "See further the ARTS user guide (AUG). Use the index to find where\n"
2234 "this variable is discussed. The variable is listed as a subentry to\n"
2235 "\"workspace variables\".\n"
2237 "Usage: Set by the user.\n"
2241 GROUP(
"Vector" )));
2245 (
NAME(
"mc_antenna" ),
2248 "Antenna pattern description for dedicated MC calculaions.\n"
2250 "Usage: Input to MCGeneral. Set by *mc_antennaSetGaussian* and similar\n"
2253 GROUP(
"MCAntenna" )));
2257 (
NAME(
"mc_cloud_opt_path" ),
2260 "The cloud optical path integrated over the field of view.\n"
2262 "Usage: Output from mc_IWP_cloud_opt_pathCalc \n"
2264 GROUP(
"Numeric" )));
2268 (
NAME(
"mc_cloud_opt_path_error" ),
2271 "Standad error in the cloud optical path integrated over the field\n"
2274 "Usage: Output from mc_IWP_cloud_opt_pathCalc \n"
2276 GROUP(
"Numeric" )));
2280 (
NAME(
"mc_error" ),
2283 "Error in simulated *y* when using a Monte Carlo approach.\n"
2285 "Usage: Output from Monte Carlo functions. \n"
2287 "Units: Depends on *iy_unit*.\n"
2289 "Size: [ stokes_dim ]\n"
2291 GROUP(
"Vector" )));
2295 (
NAME(
"mc_iteration_count" ),
2298 "Counts the number of iterations (or photons) used in the MC\n "
2299 "scattering algorithm.\n"
2301 "Usage: Set by MCGeneral and other MC methods.\n"
2310 "The ice water path integrated over the field of view\n"
2312 "Usage: Output from mc_IWP_cloud_opt_pathCalc \n"
2314 GROUP(
"Numeric" )));
2318 (
NAME(
"mc_IWP_error" ),
2321 "The standard error of ice water path integrated over the field of view\n"
2323 "Usage: Output from mc_IWP_cloud_opt_pathCalc \n"
2325 GROUP(
"Numeric" )));
2329 (
NAME(
"mc_points" ),
2332 "Counts the number of MC endpoints in each grid cell.\n"
2334 "Usage: Set by MCGeneral and other MC methods.\n"
2336 GROUP(
"Tensor3" )));
2340 (
NAME(
"mc_seed" ),
2343 "The integer seed for the random number generator used by\n"
2344 "Monte Carlo methods.\n"
2346 "Usage: Set by MCSetSeed.\n"
2352 (
NAME(
"mc_std_err" ),
2355 "Target precision (1 std. dev.) for Monte Carlo calculations.\n"
2357 "Usage: Set by the user.\n"
2359 GROUP(
"Numeric" )));
2363 (
NAME(
"mc_min_iter" ),
2366 "The minimum number of iterations allowed for Monte Carlo\n"
2369 "Usage: Set by the user.\n"
2375 (
NAME(
"mc_max_time" ),
2378 "The maximum time allowed for Monte Carlo calculations.\n"
2380 "Usage: Set by the user.\n"
2388 (
NAME(
"mc_max_iter" ),
2391 "The maximum number of iterations allowed for Monte Carlo\n"
2394 "Usage: Set by the user.\n"
2400 (
NAME(
"met_amsu_data" ),
2403 "The AMSU data set.\n"
2405 "This is intended as input for the method ybatchMetProfiles. It holds the\n"
2406 "latitude, longitude, satellite zenith angle and amsu-b corrected and \n"
2407 "uncorrected brightness temperatures. It also has information about \n"
2408 "the particular pixel corresponds to a land or sea point. This will be \n"
2409 "read in the method ybatchMetProfiles and the profiles corresponding to \n"
2410 "each latitude and longitude will be read in.\n"
2412 "See documentation of WSM *ybatchMetProfiles* for more information.\n"
2414 GROUP(
"Matrix" )));
2418 (
NAME(
"met_profile_calc_agenda" ),
2423 GROUP(
"Agenda" )));
2430 "Number of elements of a Vector or Array.\n"
2439 "Number of columns (elements in lowest dimension) of a Matrix or Tensor.\n"
2448 "Number of rows (elements in 2nd lowest dimension) of a Matrix or Tensor.\n"
2457 "Number of elements in 3rd lowest dimension of a Tensor.\n"
2466 "Number of elements in 4th lowest dimension of a Tensor.\n"
2472 (
NAME(
"nshelves" ),
2475 "Number of elements in 5th lowest dimension of a Tensor.\n"
2481 (
NAME(
"nvitrines" ),
2484 "Number of elements in 6th lowest dimension of a Tensor.\n"
2490 (
NAME(
"nlibraries" ),
2493 "Number of elements in 7th lowest dimension of a Tensor.\n"
2499 (
NAME(
"molarmass_dry_air" ),
2502 "The average molar mass of dry air.\n"
2504 "This could also be referred to as the average molecular weight for\n"
2505 "dry air. The definition of \"dry air\" can differ between planets and\n"
2506 "methods using the WSV. For Earth, this should be a value around\n"
2509 GROUP(
"Numeric" )));
2513 (
NAME(
"opt_prop_part_agenda" ),
2518 GROUP(
"Agenda" )));
2522 (
NAME(
"output_file_format" ),
2525 "Output file format. \n"
2527 "This variable sets the format for output files. It could be set to\n"
2528 "\"ascii\" for plain xml files, \"zascii\" for zipped xml files, or\n"
2531 "To change the value of this variable use the workspace methods\n"
2532 "*output_file_formatSetAscii*, *output_file_formatSetZippedAscii*, and\n"
2533 "*output_file_formatSetBinary*\n"
2535 GROUP(
"String" )));
2539 (
NAME(
"particle_masses" ),
2542 "The mass of individual particles (or bulks).\n"
2544 "Each row corresponds to a particle type (i.e. an element in\n"
2545 "*scat_data_array*). The user is free to define different mass\n"
2546 "categories and assign a mass for each category. Each column\n"
2547 "of *particle_masses* corresponds to such a mass category. A\n"
2548 "particle can have a non-zero mass for more than one category.\n"
2550 "For example, if you work with clouds, your mass categories could\n"
2551 "be ice and liquid, corresponding to IWC and LWC, respectively.\n"
2552 "The mass of particles inside the melting layer, having a mixed\n"
2553 "phase, could be divided between the two columns of the matrix.\n"
2555 "Shall either be empty, or have a row size consistent with the\n"
2556 "scattering variables (*scat_data_array*, *pnd_field*).\n"
2558 "Usage: Set by the user.\n"
2562 "Dimensions: [ particle type, mass category ]\n"
2564 GROUP(
"Matrix" )));
2568 (
NAME(
"part_species" ),
2571 "Array of Strings defining (scattering) particles to consider and their\n"
2572 "connection to particle fields.\n"
2574 "Each String contains the information for particles to be connected to\n"
2575 "one specific particle field (e.g., a hydrometeor density profile). It\n"
2576 "has to have the following structure with elements separated by dashes:\n"
2578 "- particle field name [*String*]\n"
2579 "\t the name of the particle bulk field (mass content, precip rate, or\n"
2580 "\t similar) to act on. Free form, but needs to match (name, order)\n"
2581 "\t *atm_fields_compact* field names.\n"
2582 "- particle size distribution [*String*]:\n"
2583 "\t the size distribution function/parameterisation to apply. For currently\n"
2584 "\t possible PSDs see *pnd_fieldSetup*.\n"
2585 "- particle type [*String*]:\n"
2586 "\t the type (material/phase) of the individual particles to select from\n"
2587 "\t *scat_data_array* (Ice, Water, or similar). Free form, but will select\n"
2588 "\t particles with matching *scat_meta*.type.\n"
2589 "- sizemin and sizemax [*Numeric*]:\n"
2590 "\t the minimum and maximum size (volume equivalent sphere radius in um) of\n"
2591 "\t the individual particles to consider. Minimum and maximum size may be\n"
2592 "\t omitted (meaning full size range will be selected), the symbol '*' can\n"
2593 "\t be used as a wildcard (selecting all particles at the respective size\n"
2596 "Example: [''IWC-MH97-Ice-2-1000'', ''LWC-HM98_STCO-Water-0.1-10'', ...]\n"
2598 GROUP(
"ArrayOfString" )));
2602 (
NAME(
"pha_mat" ),
2605 "Ensemble averaged phase matrix.\n"
2607 "This workspace variable represents the actual physical phase\n"
2608 "matrix (averaged over all particle types) for given propagation\n"
2609 "directions. It is calculated in the method *pha_matCalc*\n"
2611 "ARTS user guide (AUG) gives the formula used for computing this\n"
2612 "variable. Use the index to find where this variable is discussed.\n"
2613 "The variable is listed as a subentry to \"workspace variables\".\n"
2615 "Usage: Output of the method *pha_matCalc*\n"
2619 "Dimensions: [ scat_za_grid, scat_aa_grid, stokes_dim, stokes_dim ]\n"
2621 GROUP(
"Tensor4" )));
2625 (
NAME(
"pha_mat_spt" ),
2628 "Phase matrix for a single particle type.\n"
2630 "This variable contains the elements of phase matrix for a single \n"
2631 "particle for given propagation direction. \n"
2632 "It is the calculated in the agenda *pha_mat_spt_agenda*. \n"
2633 "The elements of the phase matrix are calculated from \n"
2634 "the single scattering data. "
2635 "ARTS user guide (AUG) gives the formulas used for computing all \n"
2636 "elements of the phase matrix for a given particle type.\n"
2645 "Dimensions: [N_particletypes, *scat_za_grid*, *scat_aa_grid*, *stokes_dim*, *stokes_dim*]\n"
2647 GROUP(
"Tensor5" )));
2651 (
NAME(
"pha_mat_spt_agenda" ),
2656 GROUP(
"Agenda" )));
2660 (
NAME(
"pha_mat_sptDOITOpt" ),
2663 "Interpolated phase matrix.\n"
2665 "This variable contains the data of the phase matrix in the \n"
2666 "scattering frame interpolated on the actual frequency (the variable\n"
2667 "is used inside *doit_mono_agenda*) and also interpolated on all \n"
2668 "possible scattering angles following from all combinations of \n"
2669 "*scat_za_grid* and *scat_aa_grid*. \n"
2671 "Usage: Input of the method *pha_mat_sptFromDataDOITOpt*\n"
2676 "[particle types]\n"
2677 "[T, scat_za_grid,scat_aa_grid, scat_za_grid, scat_aa_grid,\n"
2678 "stokes_dim, stokes_dim]\n"
2680 GROUP(
"ArrayOfTensor7" )));
2684 (
NAME(
"planet_rotation_period" ),
2687 "The sidereal rotation period of the planet.\n"
2689 "This is time that it takes for the planet to complete one revolution\n"
2690 "around its axis of rotation relative to the stars. For Earth, this\n"
2691 "is a value roughly 4 min less than 24 h.\n"
2693 "A negative value signifies a retrograde rotation, i.e. opposite to\n"
2694 "the rotation of Earth.\n"
2697 GROUP(
"Numeric" )));
2701 (
NAME(
"pnd_field" ),
2704 "Particle number density field.\n"
2706 "This variable corresponds to the particle number density fields\n"
2707 "for all particle types being read in the WSMs *ParticleTypeAdd*\n"
2708 "or *ParticleTypeAddAll* and interpolated to the calculation grids\n"
2709 "*p_grid*, *lat_grid*, and *lon_grid* inside the cloudbox.\n"
2710 "Note: To ensure no particles existing outside the cloudbox,\n"
2711 "*pnd_field* is required to be 0 at its outer limits (corresponding\n"
2712 "to the cloudbox limits).\n"
2714 "An alternative method to create *pnd_field* is *pnd_fieldSetup*.\n"
2716 "Usage: Calculated internally.\n"
2720 "Size: [N_particletypes, \n"
2721 " (cloudbox_limits[1] - cloudbox_limits[0]) +1, \n"
2722 " (cloudbox_limits[3] - cloudbox_limits[2]) +1, \n"
2723 " (cloudbox_limits[5] - cloudbox_limits[4]) +1 ] \n"
2725 GROUP(
"Tensor4" )));
2729 (
NAME(
"pnd_field_raw" ),
2732 "The particle number density field data.\n"
2734 "This variable contains the particle number density data for all \n"
2735 "chosen particle types. It includes the grids corresponding to the \n"
2736 "grids in the database. \n"
2737 "*pnd_field_raw* is an Array of GriddedField3. It includes a\n"
2738 "GriddedField3 for each particle type which contains the data and \n"
2741 "Usage: Used in the methods *ParticleTypeAdd* and \n"
2742 " *ParticleTypeAddAll*\n"
2746 "Size: Array[N_pt]\n"
2747 " GriddedField3 \n "
2751 " [N_p, N_lat, N_lon] \n"
2753 GROUP(
"ArrayOfGriddedField3" )));
2760 "The propagation path for one line-of-sight.\n"
2762 "This variable describes the total (pencil beam) propagation path for\n"
2763 "a given combination of starting point and line-of-sight. The path is\n"
2764 "described by a data structure of type Ppath. This structure contains\n"
2765 "also additional fields to faciliate the calculation of spectra and\n"
2766 "interpolation of the atmospheric fields.\n"
2768 "The data struture is too extensive to be described here, but it is\n"
2769 "described carefully in the ARTS user guide (AUG). Use the index to\n"
2770 "find where the data structure, Ppath, for propagation paths is \n"
2771 "discussed. It is listed as a subentry to \"data structures\".\n"
2773 "Usage: Output from *ppath_agenda*.\n"
2779 (
NAME(
"ppath_agenda" ),
2784 GROUP(
"Agenda" )));
2788 (
NAME(
"ppath_inside_cloudbox_do" ),
2791 "Flag to perform ray tracing inside the cloudbox.\n"
2793 "Standard propagation path calculations stop at the boundary of the\n"
2794 "cloudbox, or stop directly if started inside the cloudbox. This WSV\n"
2795 "allows scattering methods to obtain propagation paths inside the\n"
2796 "cloudbox. Hence, this variable is for internal usage primarily.\n"
2798 "Usage: For communication between modules of arts.\n"
2804 (
NAME(
"ppath_lmax" ),
2807 "Maximum length between points describing propagation paths.\n"
2809 "See *ppath_stepGeometric* for a description of this variable.\n"
2811 "Usage: Ppath methods such as *ppath_stepGeometric*.\n"
2813 GROUP(
"Numeric" )));
2817 (
NAME(
"ppath_lraytrace" ),
2820 "Maximum length of ray tracing steps when determining propagation\n"
2823 "See *ppath_stepRefractionEuler* for a description of this variable.\n"
2825 "Usage: Refraction ppath methods such as *ppath_stepRefractionEuler*.\n"
2827 GROUP(
"Numeric" )));
2831 (
NAME(
"ppath_step" ),
2834 "A propagation path step.\n"
2836 "The main intention of this variable is communication with the agenda\n"
2837 "*ppath_step_agenda*.\n"
2839 "See *ppath_step_agenda* for more information on this variable and\n"
2840 "the calculation of propagation paths. Or read the chapter on\n"
2841 "propagation paths in the ARTS user guide.\n"
2843 "Usage: In/output to/from *ppath_step_agenda*.\n"
2845 "Members: See AUG.\n"
2851 (
NAME(
"ppath_step_agenda" ),
2856 GROUP(
"Agenda" )));
2860 (
NAME(
"propmat_clearsky" ),
2863 "This contains the absorption coefficients for one point in the\n"
2864 "atmosphere (one set of pressure, temperature, magnetic field, and\n"
2865 "VMR values). There are two distinct cases:\n"
2867 "Case a: For all frequencies and all species:\n"
2868 "Dimension: [ abs_species, f_grid, stokes_dim, stokes_dim ]\n"
2870 "Case b: For a single frequency for all species:\n"
2871 "Dimension: [ abs_species, 1, stokes_dim, stokes_dim]\n"
2875 GROUP(
"Tensor4" )));
2879 (
NAME(
"propmat_clearsky_agenda" ),
2884 GROUP(
"Agenda" )));
2888 (
NAME(
"propmat_clearsky_agenda_checked" ),
2891 "OK-flag for *propmat_clearsky_agenda*.\n"
2893 "Set by *propmat_clearsky_agenda_checkedCalc*.\n"
2899 (
NAME(
"propmat_clearsky_field" ),
2902 "Gas absorption field.\n"
2904 "Contains the (polarized) gas absorption coefficients for all species\n"
2905 "as a function of *f_grid*, *p_grid*, *lat_grid*, and *lon_grid*. \n"
2907 "This is mainly for testing and plotting gas absorption. For RT\n"
2908 "calculations, gas absorption is calculated or extracted locally,\n"
2909 "therefore there is no need to store a global field. But this variable\n"
2910 "is handy for easy plotting of absorption vs. pressure, for example.\n"
2914 "Dimensions: [species, f_grid, *stokes_dim*, stokes_dim, p_grid, lat_grid, lon_grid]\n"
2916 GROUP(
"Tensor7" )));
2923 "The pressure grid.\n"
2925 "The pressure levels on which the atmospheric fields are defined.\n"
2926 "This variable must always be defined. The grid must be sorted in\n"
2927 "decreasing order, with no repetitions.\n"
2929 "No gap between the lowermost pressure level and the surface is \n"
2930 "allowed. The uppermost pressure level defines the practical upper\n"
2931 "limit of the atmosphere as vacuum is assumed above.\n"
2933 "See further the ARTS user guide (AUG). Use the index to find where\n"
2934 "this variable is discussed. The variable is listed as a subentry to\n"
2935 "\"workspace variables\".\n"
2937 "Usage: Set by the user.\n"
2941 GROUP(
"Vector" )));
2948 "Reference pressure calculation of hydrostatic equilibrium.\n"
2950 "The altitude specified by this pressure is used as the reference\n"
2951 "when calculating hydrostatic equilibrium. That is, the geometrical\n"
2952 "altitude at this pressure is not changed.\n"
2954 "Usage: Set by the user.\n"
2958 GROUP(
"Numeric" )));
2962 (
NAME(
"range_bins" ),
2965 "The range bins of an active instrument.\n"
2967 "The bins are assumed to cover a range without gaps, and the bins are\n"
2968 "defined by their edges. That is, the length of this vector is the\n"
2969 "number of bins + 1.\n"
2971 "The bins can potentially be defined in two ways, by altitude or time.\n"
2972 "See the method you are using, if this variable shall hold time or\n"
2973 "altitude (or maybe both options are treated).\n"
2977 GROUP(
"Vector" )));
2981 (
NAME(
"refr_index_air" ),
2984 "Real part of the refractive index of air.\n"
2986 "The variable contains the refractive index summed over all relevant\n"
2987 "constituents, at one position in the atmosphere. This refractive\n"
2988 "is related to the phase velocity. See also *refr_index_air_group*.\n"
2992 GROUP(
"Numeric" )));
2996 (
NAME(
"refr_index_air_agenda" ),
3001 GROUP(
"Agenda" )));
3005 (
NAME(
"refr_index_air_group" ),
3008 "Group index of refractivity.\n"
3010 "This variable is defined as the ratio between group velocity and the\n"
3011 "speed of ligh in vacuum. That is, it is defined as the \"standard\"\n"
3012 "refractive index, but refers to the group velocity instead of the\n"
3013 "phase velocity. See also *refr_index_air*.\n"
3017 GROUP(
"Numeric" )));
3021 (
NAME(
"refellipsoid" ),
3024 "Reference ellipsoid.\n"
3026 "This vector specifies the shape of the reference ellipsoid. The\n"
3027 "vector must have length 2, where the two elements are:\n"
3028 " 1: Equatorial radius.\n"
3029 " 2: The eccentricity.\n"
3030 "The eccentricity is sqrt(1-b*b/a*a) where a and b are equatorial and\n"
3031 "polar radius, respectively. If the eccentricity is set to 0, an\n"
3032 "average radius should be used instead of the equatorial one.\n"
3034 "The eccentricity must be 0 for 1D calculations, as a spherical Earth\n"
3035 "is implied by setting *atmosphere_dim* to 1. For 2D, the selected\n"
3036 "ellipsoid parameters should be selected according to cross-section\n"
3037 "between the real ellipsoid and the 2D plane considered. That is\n"
3038 "the applied ellipsoid shall have een converted to match the internal\n"
3039 "treatment of 2D cases. For 3D, models can be used, such as WGS84.\n"
3041 "Usage: Set by the user.\n"
3045 GROUP(
"Vector" )));
3049 (
NAME(
"rte_alonglos_v" ),
3052 "Velocity along the line-of-sight to consider for a RT calculation.\n"
3054 "This variable gives the velocity of the imaginary detector in\n"
3055 "monochromatic pencil beam calculations. The relevant velocity is\n"
3056 "the projection along the line-of-sight (ie. total velocity shall not\n"
3057 "be given). A positive value means a movement of the detector in the\n"
3058 "same direction as the line-of-sight.\n"
3060 "This variable is required to include Doppler effects due to\n"
3061 "velocities of the observer, relative the centre of the coordinate\n"
3062 "system used that is fixed to the planets centre point.\n"
3066 GROUP(
"Numeric" )));
3070 (
NAME(
"rte_los" ),
3073 "A line-of-sight for (complete) radiative transfer calculations.\n"
3075 "This variable gives the observation direction for monochromatic\n"
3076 "pencil beam calculations. Hence, it is the line-of-sight at the end\n"
3077 "point of the propagation path.\n"
3079 "For 1D and 2D cases, *rte_los* is a vector of length 1 holding the \n"
3080 "zenith angle. For 3D, the length of the vector is 2, where the\n"
3081 "additional element is the azimuthal angle. These angles are defined\n"
3082 "in the ARTS user guide (AUG). Look in the index for \"zenith angle\"\n"
3083 "and \"azimuthal angle\".\n"
3085 "Usage: See above.\n"
3087 "Units: [ degree, degree ]\n"
3089 "Size: [ 1 or 2 ]\n"
3091 GROUP(
"Vector" )));
3095 (
NAME(
"rte_pos" ),
3098 "A geographical position for starting radiative transfer calculations.\n"
3100 "This variable gives the observation position for monochromatic\n"
3101 "pencil beam calculations. Hence, it is the end point of the\n"
3102 "propagation path.\n"
3104 "This variable is a vector with a length equalling the atmospheric\n"
3105 "dimensionality. The first element is the geometrical altitude.\n"
3106 "Element 2 is the latitude and element 3 is the longitude.\n"
3108 "Usage: See above. \n"
3110 "Units: [ m, degree, degree ]\n"
3112 "Size: [ atmosphere_dim ]\n"
3114 GROUP(
"Vector" )));
3118 (
NAME(
"rte_pos2" ),
3121 "A second geographical position to define the geometry for\n"
3122 "radiative transfer calculations.\n"
3124 "This variable is used when the propagation path is defined by two\n"
3125 "positions, instead of a position (*rte_pos*) and a line-of-sight\n"
3126 "(*rte_los*). That is, this variable basically replaces *rte_los*\n"
3127 "for the cases of consideration. In practice, *rte_los* is determined\n"
3128 "by finding the propagation path between *rte_pos* and *rte_pos2*.\n"
3130 "As *rte_pos* with the exception that a \"latitude\" must also be\n"
3131 "specified for 1D. This is the angular distance to *rte_pos*, where\n"
3132 "this distance is defined as the 2D-\"latitude\".\n"
3134 "Usage: See above. \n"
3136 "Units: [ m, degree, degree ]\n"
3138 "Size: [ atmosphere_dim ]\n"
3140 GROUP(
"Vector" )));
3144 (
NAME(
"rtp_mag" ),
3147 "Magnetic field at a radiative transfer point.\n"
3149 "See *mag_u_field* etc. for a definition of the different components.\n"
3150 "For this variable the components are put together and thus defines\n"
3151 "magnetic field vector. Hence, this is a vector of length three, even\n"
3152 "if any of the input fields is set to be empty.\n"
3154 "The WSV is used as input to methods and agendas calculating radiative\n"
3155 "properties for a given conditions.\n"
3157 "Usage: Communication variable.\n"
3161 "Size: [ u-component, v-component, w-component ]\n"
3163 GROUP(
"Vector" )));
3167 (
NAME(
"rtp_los" ),
3170 "Line-of-sight at a radiative transfer point.\n"
3172 "This variable holds the local line-of-sight. The angles of this\n"
3173 "vector are defined as for *rte_los*.\n"
3175 "The WSV is used as input to methods and agendas calculating radiative\n"
3176 "properties for a given conditions.\n"
3178 "Usage: Communication variable.\n"
3180 "Units: [ degree, degree ]\n"
3182 "Size: [ 1 or 2 ]\n"
3184 GROUP(
"Vector" )));
3188 (
NAME(
"rtp_pos" ),
3191 "Position of a radiative transfer point.\n"
3193 "This angles vector is defined as *rte_pos*, but holds position along\n"
3194 "the propgation path, or the start point for new paths, in contrast\n"
3195 "to *rte_pos* that is position of the (imaginary) detector.\n"
3197 "The WSV is used as input to methods and agendas calculating radiative\n"
3198 "properties for a given conditions.\n"
3200 "Usage: Communication variable.\n"
3202 "Units: [ m, degree, degree ]\n"
3204 "Size: [ atmosphere_dim ]\n"
3206 GROUP(
"Vector" )));
3210 (
NAME(
"rtp_pressure" ),
3213 "Pressure at a radiative transfer point.\n"
3215 "This scalar variable holds the local pressure.\n"
3217 "The WSV is used as input to methods and agendas calculating radiative\n"
3218 "properties for a given conditions.\n"
3220 "Usage: Communication variable.\n"
3224 GROUP(
"Numeric" )));
3228 (
NAME(
"rtp_temperature" ),
3231 "Temperature at a radiative transfer point.\n"
3233 "This scalar variable can hold the local temperature. It is intended\n"
3234 "mainly for communication with various methods and agendas, such as\n"
3235 "methods and agendas calculating absorption coefficients.\n"
3236 "The WSV is used as input to methods and agendas calculating radiative\n"
3237 "properties for a given conditions.\n"
3239 "Usage: Communication variable.\n"
3243 GROUP(
"Numeric" )));
3247 (
NAME(
"rtp_vmr" ),
3250 "Absorption species abundances for radiative transfer calculations.\n"
3252 "This vector variable holds the local abundance of the constituents\n"
3253 "included in *abs_species*.\n"
3255 "The WSV is used as input to methods and agendas calculating radiative\n"
3256 "properties for a given conditions.\n"
3258 "Usage: Communication variable.\n"
3260 "Units: [ Differ between the elements, can be VMR, kg/m3 or #/m3. ]\n"
3262 "Size: Should match abs_species.nelem()\n"
3264 GROUP(
"Vector" )));
3268 (
NAME(
"scat_aa_grid" ),
3271 "Azimuthal angle grid.\n"
3273 "The azimutal angle grid, on which the intensity field is stored. \n"
3274 "This grid is used for RT calculations inside the cloudbox, \n"
3275 "therefore one has to define it if the cloudbox is activated by \n"
3276 "the flag *cloudbox_on*.\n"
3277 "The grid must be sorted in increasing order, with no repetitions.\n"
3279 "Usage: Set by the user.\n"
3283 GROUP(
"Vector" )));
3287 (
NAME(
"scat_aa_index" ),
3290 "Azimuth angle index for scattering calculations.\n"
3292 "This variable is used in methods used for computing scattering\n"
3294 "It holds the information about the azimuth angles for which the \n"
3295 "scattering calculations are done. The angles used for computing \n"
3296 "scattering properties of particles can be different from that used \n"
3297 "for radiative transfer calculation. \n"
3299 "Usage: Method output.\n"
3305 (
NAME(
"scat_meta" ),
3308 "Structure for the scattering meta data.\n"
3310 "This variable holds the scattering meta data for a single particle.\n"
3311 "This data is needed for particle size distribution calculations.\n"
3313 "Currently \"area_projected\" is not used by ARTS, but was included for \n"
3314 "future extensions of pnd calculations in ARTS.\n"
3316 "Usage: Set by the user.\n"
3318 "Dimensions/Units: Array[particle types]\n"
3319 "\tString[description]\t\t[particle description]\n"
3320 "\tString[material]\t\t[''Ice'', ''Water''...]\n"
3321 "\tString[shape]\t\t\t[''spheroidal'', ''cylindrical'']\n"
3322 "\tNumeric[density]\t\t[kg/m3]\n"
3323 "\tNumeric[diameter_max]\t\t[m]\n"
3324 "\tNumeric[volume]\t\t\t[m3]\n"
3325 "\tNumeric[area_projected]\t\t[m2]\n"
3326 "\tNumeric[aspect_ratio]\t\t[]\n"
3327 "\tVector[scat_f_grid]\t\t[Hz]\n"
3328 "\tVector[scat_T_grid]\t\t[K]\n"
3329 "\tString[particle_type]\t[]\n"
3330 "\tGriddedField3[complex_refr_index]\t[]\n"
3332 GROUP(
"ScatteringMetaData" )));
3336 (
NAME(
"scat_meta_array" ),
3339 "An Array of scattering meta data (*scat_meta*).\n"
3341 "The elements of the array hold the meta data for single particles used\n"
3342 "both for PSD and scattering properties calculations with *pnd_fieldSetup*,\n"
3343 "*particle_massesFromMetaDataAndPart_species* and *scat_data_arrayFromMeta*.\n"
3345 "Note: This array must contain as many elements as *scat_data_array*\n"
3347 "Usage: Set by the user.\n"
3349 "For more details of its content; see also *scat_meta*."
3351 GROUP(
"ArrayOfScatteringMetaData" )));
3355 (
NAME(
"scat_data_array_mono" ),
3358 "Monochromatic single scattering data.\n"
3360 "This variable holds the single scattering properties for all \n"
3361 "hydrometeor species. It is calculated from *scat_data_array* by \n"
3362 "*scat_data_array_monoCalc*, which interpolates *scat_data_array* for the \n"
3363 "required frequency.\n"
3365 GROUP(
"ArrayOfSingleScatteringData" )));
3369 (
NAME(
"scat_data_per_part_species" ),
3372 "Auxiliary array holding the number of *scat_data_array* particle\n"
3373 "entries associated with each entry in *part_species*. \n"
3375 "Size of *scat_data_per_part_species* has to be equal the size of *part_species*.\n"
3377 "Usage: WSM *ScatteringParticlesSelect* creates *scat_data_per_part_species*.\n"
3379 GROUP(
"ArrayOfIndex" )));
3383 (
NAME(
"scat_data_array" ),
3386 "Raw data of single scattering data.\n"
3388 "This variable holds the single scattering properties for all \n"
3389 "hydrometeor species included in a calculation by using the \n"
3390 "methods *ParticleTypeAdd* or *ParticleTypeAddAll*. \n"
3391 "For more information refer to ArtsWiki.\n"
3393 "Option: See also *ScatteringParticleTypeAndMetaRead* for reading \n"
3394 "*SingleScatteringData* and *ScatteringMetaData*.\n"
3396 "The unit of the single scattering properties is m^2.\n"
3398 "This may be used in combination with *scat_meta_array*\n"
3400 "Usage: Method ouput.\n"
3402 "Dimensions: Array[particle types] \n"
3403 " SingleScatteringData \n"
3404 " Enum[particle type attribute]\n"
3405 " String[description] \n"
3408 " Vector[za_grid]\n"
3409 " Vector[aa_grid]\n"
3410 " Tensor7[pha_mat_data]\n"
3411 " [f_grid, T_grid, za_grid, aa_grid, za_grid, aa_grid, matrix_element]\n"
3412 " ^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^\n"
3413 " scattered incoming\n"
3414 " Tensor5[ext_mat_data]\n"
3415 " [f_grid, T_grid, za_grid, aa_grid, matrix_element]\n"
3416 " Tensor5[abs_vec_data]\n"
3417 " [f_grid, T_grid, za_grid, aa_grid, matrix_element]\n"
3419 GROUP(
"ArrayOfSingleScatteringData" )));
3423 (
NAME(
"scat_i_lat" ),
3426 "Intensity field on cloudbox boundary (constant latitude slice).\n"
3428 "This variable gives the intensity field from all directions defined \n"
3429 "in *scat_aa_grid* and *scat_za_grid* on each grid point on the two \n"
3431 "latitude levels of the cloudbox boundary. It contains all four \n"
3432 "components of the Stokes vector.\n"
3434 "This variable is used as interface between the clear sky and the \n"
3435 "scattering calculations. \n"
3437 "See further the ARTS user guide (AUG). Use the index to find where\n"
3438 "this variable is discussed. The variable is listed as a subentry to\n"
3439 "\"workspace variables\".\n"
3441 "Usage: In/Output from/to *ScatteringDoit* and *ScatteringDisort*\n"
3443 "Unit: W / (m^2 Hz sr) \n"
3445 "Dimensions: [ f_grid, p_grid, 2, lon_grid, \n"
3446 " scat_za_grid \n scat_aa_grid, stokes_dim ]\n"
3448 GROUP(
"Tensor7" )));
3452 (
NAME(
"scat_i_lon" ),
3455 "Intensity field on cloudbox boundary (equal longitude slice).\n"
3457 "This variable gives the intensity field from all directions defined \n"
3458 "in *scat_aa_grid* and *scat_za_grid* on each grid point on the equal\n"
3459 "longitude level of the boundary of the cloudbox, which is defined \n"
3460 "by the workspace variable *cloudbox_limits*. It contains all four \n"
3461 "components of the Stokes vector.\n"
3463 "This variable is used as interface between the clear sky and the \n"
3464 "scattering calculations. \n"
3466 "See further the ARTS user guide (AUG). Use the index to find where\n"
3467 "this variable is discussed. The variable is listed as a subentry to\n"
3468 "\"workspace variables\".\n"
3470 "Usage: Output from *ScatteringDoit* and *ScatteringDisort* \n"
3472 "Unit: W / (m^2 Hz sr) \n"
3474 "Dimensions: [ f_grid, p_grid, lat_grid, 2, \n"
3475 " scat_za_grid, scat_aa_grid, stokes_dim]\n"
3477 GROUP(
"Tensor7" )));
3481 (
NAME(
"scat_i_p" ),
3484 "Intensity field on cloudbox boundary (equal pressure slice).\n"
3486 "This variable gives the intensity field from all directions defined \n"
3487 "in *scat_aa_grid* and *scat_za_grid* on each grid point on the equal\n"
3488 "pressure levels of the cloudbox boundary. It contains all four \n"
3489 "components of the Stokes vector.\n"
3491 "This variable is used as interface between the clear sky and the \n"
3492 "scattering calculations. \n"
3494 "See further the ARTS user guide (AUG). Use the index to find where\n"
3495 "this variable is discussed. The variable is listed as a subentry to\n"
3496 "\"workspace variables\".\n"
3498 "Usage: In/Output from *ScatteringDoit* and *ScatteringDisort* \n"
3500 "Unit: W / (m^2 Hz sr) \n"
3502 "Dimensions: [ f_grid, 2, lat_grid, lon_grid, \n"
3503 " scat_za_grid, scat_aa_grid, stokes_dim]\n"
3505 GROUP(
"Tensor7" )));
3509 (
NAME(
"scat_lat_index" ),
3512 "Latitude index for scattering calculations.\n"
3514 "This variable is used in methods used for computing scattering\n"
3515 "properties of particles like *opt_prop_sptFromData* and *pha_matCalc*.\n"
3516 "It holds the information about the position for which the \n"
3517 "scattering calculations are done. \n"
3519 "Usage: Input to the methods *spt_calc_agenda*,\n"
3520 " *pha_mat_spt_agenda*\n"
3526 (
NAME(
"scat_lon_index" ),
3529 "Longitude index for scattering calculations.\n"
3531 "This variable is used in methods used for computing scattering\n"
3532 "properties of particles like *opt_prop_sptFromData* and *pha_matCalc*.\n"
3533 "It holds the information about the position for which the \n"
3534 "scattering calculations are done. \n"
3536 "Usage: Input to the methods *spt_calc_agenda*,\n"
3537 " *pha_mat_spt_agenda*\n"
3543 (
NAME(
"scat_p_index" ),
3546 "Pressure index for scattering calculations.\n"
3548 "This variable is used in methods used for computing scattering\n"
3549 "properties of particles like *opt_prop_sptFromData* and *pha_matCalc*.\n"
3550 "It holds the information about the location for which the \n"
3551 "scattering calculations are done.\n"
3553 "Usage: Input to the methods *spt_calc_agenda*,\n"
3554 " *pha_mat_spt_agenda*\n"
3560 (
NAME(
"scat_za_grid" ),
3563 "Zenith angle grid.\n"
3565 "The zenith angle grid, on which the intensity field is stored. \n"
3566 "This grid is used for RT calculations inside the cloudbox, therefore\n"
3567 "the grid has to be defined\n"
3568 "if the cloudbox is activated by the flag *cloudbox_on*.\n"
3569 "The grid must be sorted in increasing order, with no repetitions.\n"
3571 "Usage: Set by the user.\n"
3575 GROUP(
"Vector" )));
3579 (
NAME(
"scat_za_index" ),
3582 "Zenith angle index for scattering calculations.\n"
3584 "This variable is used internally in WSMs for computing scattering \n"
3587 "Usage: Input to the agendas *spt_calc_agenda*, \n "
3588 " *pha_mat_spt_agenda*.\n"
3594 (
NAME(
"sensor_checked" ),
3597 "OK-flag for sensor related variables.\n"
3599 "This variable flags that sensor variables are defined in a formally\n"
3600 "and practically correct way. For example, it checks for correct\n"
3601 "dimensions of *sensor_pos* and *sensor_los*.\n"
3603 "Shall be set by *sensor_checkedCalc*. See that WSM for treated WSVs.\n"
3604 "Only the value 1 is taken as OK.\n"
3610 (
NAME(
"sensor_description_amsu" ),
3613 "Sensor description for simple AMSU setup.\n"
3615 "This is a compact description of an AMSU-type sensor. The matrix\n"
3616 "contains one row for each instrument channel. Each row contains three\n"
3617 "elements: LO position [Hz], offset of the channel center from the LO\n"
3618 "[Hz], and channel width [Hz].\n"
3620 "Usage: Set by the user.\n"
3622 "Unit: All entries in Hz.\n"
3624 "Size: [number of channels, 3]\n"
3626 GROUP(
"Matrix" )));
3630 (
NAME(
"sensor_los" ),
3633 "The sensor line-of-sight (LOS) for each measurement block.\n"
3635 "Line-of-sights are specified by giving the zenith and azimuth angles.\n"
3636 "Column 1 holds the zenith angle. This angle is simply the angle \n"
3637 "between the zenith and LOS directions. For 1D and 3D the valid\n"
3638 "range is [0 180], while for 2D angles down to -180 degrees are\n"
3639 "allowed. Negative angles signifies for 2D observations towards\n"
3640 "lower latitudes, while positive angles means observations towards\n"
3641 "higher latitudes. Nadir corresponds throughout to 180 degrees.\n"
3643 "The azimuth angle is given with respect to the meridian plane. That\n"
3644 "is, the plane going through the north and south poles. The valid \n"
3645 "range is [-180,180] where angles are counted clockwise; 0 means\n"
3646 "that the viewing or propagation direction is north-wise and +90 means\n"
3647 "that the direction of concern goes eastward.\n"
3649 "See further the ARTS user guide (AUG). Use the index to find where\n"
3650 "this variable is discussed. The variable is listed as a subentry to\n"
3651 "\"workspace variables\".\n"
3653 "Usage: Set by the user.\n"
3655 "Unit: [ degrees, degrees ]\n"
3657 "Size: [ number of measurement blocks, 1 or 2 ]\n"
3659 GROUP(
"Matrix" )));
3663 (
NAME(
"sensor_norm" ),
3666 "Flag if sensor response should be normalised or not (0 or 1).\n"
3668 "If the flag is set to 1 each sensor response is normalised (where\n"
3669 "applicable). If set to 0 the sensor responses are left as provided.\n"
3671 "See further the ARTS user guide (AUG). Use the index to find where\n"
3672 "this variable is discussed. The variable is listed as a sub-entry to\n"
3673 "\"workspace variables\".\n"
3675 "Usage: Set by the user.\n"
3681 (
NAME(
"sensor_pol" ),
3684 "Sensor polarisations.\n"
3686 "The default for output is to give data for the selected Stokes\n"
3687 "elements (1:stokes_dim). This variable defines the polarisations\n"
3688 "that are actually measured (= or just what shall be outputted).\n"
3689 "This variable is used as input for WSM that handles the extraction\n"
3690 "of polarisation components. This in contrast to *sensor_response_pol*\n"
3691 "and that are used for internal bookkeeping\n"
3693 "The polarisation states/components are coded as\n"
3695 " 1 = I, total intensity.\n"
3696 " 2 = Q, second Stokes component, Iv - Ih.\n"
3697 " 3 = U, third Stokes component, I+45 - I-45.\n"
3698 " 4 = V, forth Stokes component, Irc - Ilc\n"
3699 " 5 = Iv, intensity of vertically polarised component.\n"
3700 " 6 = Ih, intensity of horizontally polarised component.\n"
3701 " 7 = I+45, intensity of +45 deg linearly polarised component.\n"
3702 " 8 = I-45, intensity of -45 deg linearly polarised component.\n"
3703 " 9 = Irhc, intensity of right-hand circularly polarised component.\n"
3704 " 10 = Ilhc, intensity of left-hand circularly polarised component.\n"
3706 "See the documentation for definition of the Stokes vector and the\n"
3707 "different components.\n"
3709 "If the sensor measures the vertical and horisontal componenets, this\n"
3710 "variable shall accordingly be set to [5,6].\n"
3712 "The conversion to Planck-BT of components 2-4 requires that component\n"
3713 "1 is kept, and is then included as first element.\n"
3715 "The shift from the Stokes vector can be made at any stage when of the\n"
3716 "sensor response set-up. The responses used must of course be adopted\n"
3717 "correspondingly. Or reversed, if the antenna response is defined for\n"
3718 "Iv and Ih it could be useful to shift polarisation as first sensor\n"
3721 "Usage: Set by the user.\n"
3723 GROUP(
"ArrayOfIndex" )));
3727 (
NAME(
"sensor_pol_array" ),
3730 "Multiple definition of sensor polarisation.\n"
3732 "Defined as *sensor_pol* but used when multiple reciever polarisation\n"
3733 "are possible/required.\n"
3735 "Usage: Set by the user.\n"
3737 GROUP(
"ArrayOfArrayOfIndex" )));
3741 (
NAME(
"sensor_pos" ),
3744 "The sensor position for each measurement block.\n"
3746 "The sensor positions are specified as a matrix, where the number of\n"
3747 "columns shall be equal to *atmosphere_dim*. Column 1 shall contain\n"
3748 "the altitude of the sensor platform, column 2 the latitude and the \n"
3749 "last column the longitude. The number of rows corresponds to the\n"
3750 "number of measurement blocks.\n"
3752 "Valid range for latitudes in 3D is [-90,90], while for 2D any value\n"
3753 "is accepted. Accepted range for longitudes are [-360,360].\n"
3755 "See further the ARTS user guide (AUG). Use the index to find where\n"
3756 "this variable is discussed. The variable is listed as a subentry to\n"
3757 "\"workspace variables\".\n"
3759 "Usage: Set by the user.\n"
3761 "Unit: [ m, degrees, degrees ]\n"
3763 "Size: [ number of measurement blocks, atmosphere_dim ]\n"
3765 GROUP(
"Matrix" )));
3769 (
NAME(
"sensor_response" ),
3772 "The matrix modelling the total sensor response.\n"
3774 "This matrix describes the sensor respons for one measurement block\n"
3775 "The response is assumed to be identical for each such block.\n"
3777 "The matrix is the product of all the individual sensor response\n"
3778 "matrices. Therefore its dimensions are depending on the total sensor\n"
3779 "configuration. The *sensor_response* has to initialised by the \n"
3780 "*sensor_responseInit* method.\n"
3782 "Usage: Output/input to the *sensor_response...* methods.\n"
3786 "Dimension: See the individual *sensor_response...* method. \n"
3788 GROUP(
"Sparse" )));
3792 (
NAME(
"sensor_response_aa" ),
3795 "The relative azimuth angles associated with the output of\n"
3796 "*sensor_response*.\n"
3798 "Definition of angle matches *mblock_aa_grid*. Works otherwise as\n"
3799 "*sensor_response_f*.\n"
3801 "The variable shall not be set manually, it will be set together with\n"
3802 "*sensor_response* by sensor response WSMs.\n"
3804 "Usage: Set by sensor response methods.\n"
3806 "Unit: [ degrees ]\n"
3808 GROUP(
"Vector" )));
3812 (
NAME(
"sensor_response_aa_grid" ),
3815 "The azimuth angle grid associated with *sensor_response*.\n"
3817 "A variable for communication between sensor response WSMs. Matches\n"
3818 "initially *mblock_aa_grid*, but is later adjusted according to the\n"
3819 "sensor specifications. Only defined when a common grid exists. Values\n"
3820 "are here not repeated as in *sensor_response_aa*\n"
3822 "The zenith and azimuth dimensions are joined into a single dimension\n"
3823 "after the antenna. The variables *sensor_response_za_grid* and \n"
3824 "*sensor_response_aa_grid* have then the same length after the antenna\n"
3825 "(if antenna_dim = 2), holding data taken from the columns of \n"
3828 "Usage: Set by sensor response methods.\n"
3830 "Unit: [ degrees ]\n"
3832 GROUP(
"Vector" )));
3836 (
NAME(
"sensor_response_agenda" ),
3841 GROUP(
"Agenda" )));
3845 (
NAME(
"sensor_response_f" ),
3848 "The frequencies associated with the output of *sensor_response*.\n"
3850 "This vector gives the frequency for each element of the measurement\n"
3851 "vector produced inside one measurement block. The frequencies of\n"
3852 "the total measurement vector, *y*, are obtained by repeating these\n"
3853 "frequencies n times, where n is the number of measurement blocks\n"
3854 "(e.g. the number of rows in *sensor_pos*).\n"
3856 "The variable shall not be set manually, it will be set together with\n"
3857 "*sensor_response* by sensor response WSMs.\n"
3859 "Usage: Set by sensor response methods.\n"
3863 GROUP(
"Vector" )));
3867 (
NAME(
"sensor_response_f_grid" ),
3870 "The frequency grid associated with *sensor_response*.\n"
3872 "A variable for communication between sensor response WSMs. Matches\n"
3873 "initially *f_grid*, but is later adjusted according to the sensor\n"
3874 "specifications. Only defined when a common grid exists. Values are\n"
3875 "here not repeated as in *sensor_response_f*\n"
3877 "Usage: Set by sensor response methods.\n"
3881 GROUP(
"Vector" )));
3885 (
NAME(
"sensor_response_pol" ),
3888 "The polarisation states associated with the output of\n"
3889 "*sensor_response*.\n"
3891 "Works basically as *sensor_response_f*.\n"
3893 "See *sensor_pol* for coding of polarisation states.\n"
3895 "The variable shall not be set manually, it will be set together with\n"
3896 "*sensor_response* by sensor response WSMs.\n"
3898 "Usage: Set by sensor response methods.\n"
3902 GROUP(
"ArrayOfIndex" )));
3906 (
NAME(
"sensor_response_pol_grid" ),
3909 "The \"polarisation grid\" associated with *sensor_response*.\n"
3911 "A variable for communication between sensor response WSMs. It is\n"
3912 "initially 1:stokes_dim, but can later adjusted according to the \n"
3913 "sensor specifications. Only defined when a common grid exists. \n"
3915 "See *sensor_pol* for coding of polarisation states.\n"
3917 "Usage: Set by sensor response methods.\n"
3921 GROUP(
"ArrayOfIndex" )));
3925 (
NAME(
"sensor_response_za" ),
3928 "The relative zenith angles associated with the output of\n"
3929 "*sensor_response*.\n"
3931 "Definition of angle matches *mblock_za_grid*. Works otherwise as\n"
3932 "*sensor_response_f*.\n"
3934 "The variable shall not be set manually, it will be set together with\n"
3935 "*sensor_response* by sensor response WSMs.\n"
3937 "Usage: Set by sensor response methods.\n"
3939 "Unit: [ degrees ]\n"
3941 GROUP(
"Vector" )));
3945 (
NAME(
"sensor_response_za_grid" ),
3948 "The zenith angle grid associated with *sensor_response*.\n"
3950 "A variable for communication between sensor response WSMs. Matches\n"
3951 "initially *mblock_za_grid*, but is later adjusted according to the\n"
3952 "sensor specifications. Only defined when a common grid exists. Values\n"
3953 "are here not repeated as in *sensor_response_za*\n"
3955 "The zenith and azimuth dimensions are joined into a single dimension\n"
3956 "after the antenna. The variables *sensor_response_za_grid* and \n"
3957 "*sensor_response_aa_grid* have then the same length after the antenna\n"
3958 "(if antenna_dim = 2), holding data taken from the columns of \n"
3961 "Usage: Set by sensor response methods.\n"
3963 "Unit: [ degrees ]\n"
3965 GROUP(
"Vector" )));
3969 (
NAME(
"sensor_time" ),
3972 "The time for each measurement block.\n"
3974 "This WSV is used when a time must be assigned to the measurements.\n"
3975 "No specific time format has (yet) been specified.\n"
3977 "Usage: Set by the user.\n"
3979 "Unit: [ arbitrary ]\n"
3981 "Size: [ number of measurement blocks ]\n"
3983 GROUP(
"Vector" )));
3987 (
NAME(
"sideband_mode" ),
3990 "Description of target sideband.\n"
3992 "A text string describing which of the two sidebands (of a heterodyne\n"
3993 "instrument) that can be seen as \"main\" band. Possible choices are:\n"
3994 " \"lower\" : Low frequency sideband shall be considered as target.\n"
3995 " \"upper\" : High frequency sideband shall be considered as target.\n"
3997 "Usage: Set by the user.\n"
3999 GROUP(
"String" )));
4003 (
NAME(
"sideband_mode_multi" ),
4006 "Description of target sideband for a multiple LO receiver.\n"
4008 "As *sideband_mode* but handles an instrument with several LO chains.\n"
4009 "See further *lo_multi* and *sideband_response_multi*. This length of\n"
4010 "this array must match the size of those WSVs.\n"
4012 "Usage: Set by the user.\n"
4014 GROUP(
"ArrayOfString" )));
4019 (
NAME(
"sideband_response" ),
4022 "Description of (mixer) sideband response.\n"
4024 "This variable describes the response of each sideband of a heterodyne\n"
4025 "receiver. The response is given as a GriddedField1, with frequency as the\n"
4026 "grid. The actual data describe the sideband filter function at each\n"
4027 "frequency grid point. An interpolation is applied to obtain the\n"
4028 "response for other frequencies.\n"
4030 "The frequency grid should be given in terms of IF, with end points\n"
4031 "symmetrically placed around zero. That is, the grid must contain\n"
4032 "both negative and positive values. The sideband response (after \n"
4033 "summation with *lo*) is not allowed to extend outside the range\n"
4034 "for which spectral data exist (normally determined by *f_grid*).\n"
4036 "Usage: Set by the user.\n"
4040 " Vector f_grid[N_f]\n"
4041 " Vector data[N_f]\n"
4043 GROUP(
"GriddedField1" )));
4047 (
NAME(
"sideband_response_multi" ),
4050 "Description of multiple (mixer) sideband responses.\n"
4052 "As *sideband_response* but describes an instrument with multiple\n"
4053 "mixers. An array element for each LO. The size of this variable and\n"
4054 "*lo_multi* shall match.\n"
4058 "Usage: Set by the user.\n"
4060 GROUP(
"ArrayOfGriddedField1" )));
4064 (
NAME(
"scat_data" ),
4067 "Structure for the single scattering data.\n"
4069 "See futher the ArtsWiki documentation were the SingleScatteringData\n"
4070 "structure is disussed.\n"
4072 "Usage: Set by the user.\n"
4074 "Dimensions: SingleScatteringData \n"
4075 " Enum[particle type attribute]\n"
4076 " String[description] \n"
4079 " Vector[za_grid]\n"
4080 " Vector[aa_grid]\n"
4081 " Tensor7[pha_mat_data]\n"
4082 " [f_grid, T_grid, za_grid, aa_grid, za_grid, aa_grid, matrix_element]\n"
4083 " ^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^\n"
4084 " scattered incoming\n"
4085 " Tensor5[ext_mat_data]\n"
4086 " [f_grid, T_grid, za_grid, aa_grid, matrix_element]\n"
4087 " Tensor5[abs_vec_data]\n"
4088 " [f_grid, T_grid, za_grid, aa_grid, matrix_element]\n"
4090 GROUP(
"SingleScatteringData" )));
4094 (
NAME(
"specular_los" ),
4097 "The specular direction (for reflection by a flat surface).\n"
4099 "The specualr dirtection as a standard line-of-sight vector.\n"
4103 "Size: [ 1 or 2 ]\n"
4105 GROUP(
"Vector" )));
4109 (
NAME(
"spt_calc_agenda" ),
4114 GROUP(
"Agenda" )));
4118 (
NAME(
"stokes_dim" ),
4121 "The dimensionality of the Stokes vector (1-4).\n"
4123 "Usage: Set by the user.\n"
4129 (
NAME(
"stokes_rotation" ),
4132 "Rotation of the Stokes H and V directions.\n"
4134 "This variable allows to introduce a rotation of the Stokes coordinate\n"
4135 "system. Such a rotation could be needed to handle the scanning\n"
4136 "procedure of some instruments, such as AMSU-A. The variable is\n"
4137 "applied by the *sensor_responseStokesRotation* WSM.\n"
4139 "The rotation is given as an angle for each direction. In general, the\n"
4140 "number of rotations to be specified follows *sensor_response_za_grid*\n"
4141 "and *sensor_response_aa_grid*. For example, if no antenna is included\n"
4142 "or a 1D antenna is used, and the rotation is applied before the\n"
4143 "antenna is included in *sensor_response*, there should be one angle\n"
4144 "for each element of *mblock_za_grid*. After inclusion of an antenna\n"
4145 "response, the relevant number of angles is determined by\n"
4148 "It is assumed that the rotation is common for all frequency elements.\n"
4152 "Size: [ number of zenith angles, number of azimuth angles ]\n"
4154 "Usage: Set by the user.\n"
4156 GROUP(
"Matrix" )));
4160 (
NAME(
"surface_complex_refr_index"),
4163 "Complex refractive index of the surface, at a single point.\n"
4165 "See *complex_refr_index* for the expected format and how the data\n"
4168 GROUP(
"GriddedField3" ) ));
4172 (
NAME(
"surface_emission" ),
4174 (
"The emission from the surface.\n"
4176 "See specific methods generating *surface_emission* and the user\n"
4177 "guide for more information.\n"
4179 "Dimensions: [ f_grid, stokes_dim ]\n"
4181 GROUP(
"Matrix" )));
4185 (
NAME(
"surface_emissivity_DISORT" ),
4187 (
"The surface emissivity specified on lat_grid and lon_grid.\n"
4189 "Remnant from a first solution for surface emissivity fields.\n"
4190 "Should be replaced with more flexible solution allowing emissivity\n"
4191 "to vary with incidence angle.\n"
4193 "Dimensions: [ lat_grid, lon_grid ]\n"
4195 GROUP(
"Matrix" )));
4199 (
NAME(
"surface_los" ),
4202 "Directions for which to calculate downwelling radiation when\n"
4203 "considering a surface reflection.\n"
4205 "See further the user guide.\n"
4209 "Size: [ any number, 1 or 2 ]\n"
4211 GROUP(
"Matrix" )));
4215 (
NAME(
"surface_normal" ),
4218 "The normal vector for a point at the surface.\n"
4220 "The vector is given as a zenith and azimuth (the later only for 3D)\n"
4221 "angle, following the definition of line-of-sights. For example,\n"
4222 "this vector is always [0] for 1D, as there is no surface topography\n"
4223 "for this atmospheric dimensionality.\n"
4227 "Size: [ 1 or 2 ]\n"
4229 GROUP(
"Vector" )));
4233 (
NAME(
"surface_rmatrix" ),
4236 "The reflection coefficients for the directions given by\n"
4237 "*surface_los* to the direction of interest.\n"
4239 "The rows and columns of this tensor holds the reflection\n"
4240 "coefficient matrix for one frequency and one LOS. The reflection\n"
4241 "coefficients shall take into accound the angular weighting if the\n"
4242 "downwelling radiation.\n"
4244 "See specific methods generating *surface_rmatrix* and the user guide\n"
4245 "for more information.\n"
4247 "Usage: Input to methods for *surface_rtprop_agenda*."
4251 "Dimensions: [ surface_los, f_grid, stokes_dim, stokes_dim ]\n"
4253 GROUP(
"Tensor4" )));
4257 (
NAME(
"surface_rtprop_agenda" ),
4262 GROUP(
"Agenda" )));
4266 (
NAME(
"surface_skin_t" ),
4269 "Surface skin temperature.\n"
4271 "This temperature shall be selected considering the radiative\n"
4272 "properties of the surface, and can differ from the \"bulk\"\n"
4275 "Usage: Input to methods for *surface_rtprop_agenda*.\n"
4277 GROUP(
"Numeric" )));
4281 (
NAME(
"surface_reflectivity" ),
4284 "Surface reflectivity, for a given position and angle.\n"
4286 "This variable describes the surface reflectivity at one position\n"
4287 "and one incidence angle. It works as *surface_scalar_reflectivity*\n"
4288 "but is also defined for vector radiative transfer.\n"
4290 "The first dimension of the variable shall either match *f_grid* or\n"
4291 "be 1. The later case is interpreted as the reflectivity is the same\n"
4292 "for all frequencies.\n"
4294 "Usage: Input to some surface properties methods.\n"
4296 "Dimensions: [ f_grid or 1, stokes_dim, stokes_dim]\n"
4298 GROUP(
"Tensor3" )));
4302 (
NAME(
"surface_scalar_reflectivity" ),
4305 "Surface reflectivity, assuming it can be described as a scalar value.\n"
4307 "This variable describes the surface reflectivity at one position\n"
4308 "and one incidence angle.\n"
4310 "The variable can only be used for scalar radiative transfer, that\n"
4311 "is, *stokes_dim* equals 1. Use *surface_reflectivity* for vector\n"
4312 "radiative transfer.\n"
4314 "The length of the vector shall either match *f_grid* or be 1. The \n"
4315 "later case is interpreted as the reflectivity is the same for all\n"
4316 "frequencies (ie. matches a constant vector).\n"
4318 "Usage: Input to some surface properties methods.\n"
4320 "Dimensions: [ f_grid or 1]\n"
4322 GROUP(
"Vector" )));
4326 (
NAME(
"test_agenda" ),
4331 GROUP(
"Agenda" )));
4338 "Stores the starting time for time measurements.\n"
4344 (
NAME(
"transmitter_pos" ),
4347 "Transmitter positions.\n"
4349 "Used for radio link calculations and gives then the position of the\n"
4350 "transmitting device. The corresponding positions of the receiver are\n"
4351 "given by *sensor_pos*. The number of rows in *transmitter_pos* and\n"
4352 "*sensor_pos* must be equal.\n"
4354 "This WSV is also defined as *sensor_pos* regarding the content of the\n"
4355 "columns, accepted range for latitudes etc. With one exception, this\n"
4356 "WSV is demanded to have two columns also for 1D. The additional\n"
4357 "second value is the angular distance between the transmitter and the\n"
4358 "reciver. This angle is defined as \"latitude\" for 2D, with the\n"
4359 "sensor fixed at the angle of 0 degree.\n"
4361 "Each row this matrix defines *rte_pos2* for the measurement block,\n"
4362 "exactly as *sensor_pos* is translated to *rte_pos*.\n"
4364 "If no transmitter is involved in the calculations, the variable can\n"
4365 "be set to be empty.\n"
4367 "Usage: Set by the user.\n"
4369 "Unit: [ m, degrees, degrees ]\n"
4371 GROUP(
"Matrix" )));
4375 (
NAME(
"t_field" ),
4378 "The field of atmospheric temperatures.\n"
4380 "This variable gives the atmospheric temperature at each crossing of\n"
4381 "the pressure, latitude and longitude grids.\n"
4383 "The temperature for a point between the grid crossings is obtained \n"
4384 "by (multi-)linear interpolation of the *t_field*.\n"
4386 "See further the ARTS user guide (AUG). Use the index to find where\n"
4387 "this variable is discussed. The variable is listed as a subentry to\n"
4388 "\"workspace variables\".\n"
4390 "Usage: Output of *AtmFieldsCalc*.\n"
4394 "Dimensions: [ p_grid, lat_grid, lon_grid ]\n"
4396 GROUP(
"Tensor3" )));
4400 (
NAME(
"t_field_raw" ),
4403 "Raw data for atmospheric temperatures.\n"
4405 "This variable gives the atmospheric temperature as stored in the \n"
4406 "database for the atmospheric scenarios.\n"
4408 "See further the ARTS user guide (AUG). Use the index to find where\n"
4409 "this variable is discussed. The variable is listed as a subentry to\n"
4410 "\"workspace variables\".\n"
4412 "Usage: Set by the user by choosing a climatology.\n"
4416 "Size GriddedField3 \n "
4420 " [N_p, N_lat, N_lon] \n"
4422 GROUP(
"GriddedField3" )));
4426 (
NAME(
"t_surface" ),
4429 "The surface temperature.\n"
4431 "This variable holds the temperature of the surface at each latitude\n"
4432 "and longitude grid crossing. The normal case should be that this \n"
4433 "temperature field is interpolated to obtain *surface_skin_t*.\n"
4434 "Accordingly, for 1D cases it could be a better idea to specify\n"
4435 "*surface_skin_t* directly.\n"
4437 "These temperature shall be selected considering the radiative\n"
4438 "properties of the surface, and can differ from the \"bulk\"\n"
4441 "Usage: Set by user.\n"
4445 "Dimensions: [ lat_grid, lon_grid ]\n"
4447 GROUP(
"Matrix" )));
4451 (
NAME(
"use_mean_scat_data" ),
4454 "Flag to use same scattering properties for all frequencies.\n"
4456 "This flag is not considered y all scattering methods, but (at least)\n"
4457 "by *iyFOS* and *iyBeerLambertStandardCloudbox*.\n"
4459 "If set to 1, the scattering properties are extracted for a single\n"
4460 "frequency, and these properties are applied for all frequncies when\n"
4461 "performing the actual radiative transfer calculations. This can save\n"
4462 "considerable time. The option can be when the width of the band is\n"
4463 "small comapred to the mean frequency. The properties are extracted\n"
4464 "for the mean of min and max of *f_grid*.\n"
4466 "If set to 0, standard calculations are made (scattering properties\n"
4467 "extracted for each frequency).\n"
4469 "Usage: Set by user.\n"
4475 (
NAME(
"verbosity" ),
4480 "The verbosity variable is implicitly passed to all workspace methods.\n"
4481 "It can be used to dynamically control the reporting level during\n"
4484 "Usage: Set by user.\n"
4486 "See also: *verbosityInit*\n"
4488 " *verbositySetAgenda*\n"
4489 " *verbositySetScreen*\n"
4490 " *verbositySetFile*\n"
4492 GROUP(
"Verbosity" )));
4496 (
NAME(
"vmr_field" ),
4501 "This variable gives the volume mixing ratio of the chosen gaseous \n"
4502 "species as a function of p_grid, lat_grid, lon_grid. \n"
4504 "See further the ARTS user guide (AUG). Use the index to find where\n"
4505 "this variable is discussed. The variable is listed as a subentry to\n"
4506 "\"workspace variables\".\n"
4508 "Units: [ Differ between the elements, can be VMR, kg/m3 or #/m3. ]\n"
4510 "Dimensions: [species, p_grid, lat_grid, lon_grid]\n"
4512 GROUP(
"Tensor4" )));
4516 (
NAME(
"vmr_field_raw" ),
4519 "VMR data for the chosen gaseous species.\n"
4521 "This variable contains the volume mixing ratios (VMR) for all \n"
4522 "chosen gaseous species. It includes the grids corresponding to the \n"
4523 "grids in the database. \n"
4524 "*vmr_field_raw* is an Array of Array of Tensor3. It contains one \n"
4525 "gridded field for each species which contains the data and \n"
4527 "For the calculation the data is \n"
4528 "interpolated on *p_grid*, *lat_grid* and *lon_grid*\n"
4530 "Usage: Output of *AtmRawRead*\n"
4531 " Input to *AtmFieldsCalc*.\n"
4533 "Unit: absolute number\n"
4535 "Size: Array[N_pt]\n"
4536 " GriddedField3 \n "
4540 " [N_p, N_lat, N_lon] \n"
4542 GROUP(
"ArrayOfGriddedField3" )));
4546 (
NAME(
"wind_u_field" ),
4549 "Zonal component of the wind field.\n"
4551 "The East-West wind component. Air moving towards higher\n"
4552 "longitudes is a positive wind. This wind causes no Doppler shift\n"
4553 "for 1D and 2D simulations.\n"
4555 "Can be set to be empty, which is interpreted as zero wind speed\n"
4560 "Dimensions: [ p_grid, lat_grid, lon_grid ] or [ 0 0 0 ].\n"
4562 GROUP(
"Tensor3" )));
4566 (
NAME(
"wind_v_field" ),
4569 "Meridional component of the magnetic field.\n"
4571 "The North-South wind component. Air moving towards higher\n"
4572 "latitudes is a positive wind.\n"
4574 "Can be set to be empty, which is interpreted as zero wind speed\n"
4579 "Dimensions: [ p_grid, lat_grid, lon_grid ] or [ 0 0 0 ]\n"
4581 GROUP(
"Tensor3" )));
4585 (
NAME(
"wind_w_field" ),
4588 "Vertical wind component field.\n"
4590 "Upward moving air corresponds to a positive wind speed.\n"
4592 "Can be set to be empty, which is interpreted as zero wind speed\n"
4597 "Dimensions: [ p_grid, lat_grid, lon_grid ] or [ 0 0 0 ]\n"
4599 GROUP(
"Tensor3" )));
4603 (
NAME(
"wmrf_channels" ),
4606 "Channel selection for WMRF fast calculation.\n"
4608 "This variable can be used to select one or several instrument channels\n"
4609 "from the list of all possible channels. Zero-based indexing is used, so\n"
4610 "Channel 0 is the first instrument channel!\n"
4612 GROUP(
"ArrayOfIndex" )));
4616 (
NAME(
"wmrf_weights" ),
4619 "The weights for a WMRF fast calculation.\n"
4621 "Weights are stored in a sparse matrix. This can be used as a\n"
4622 "sensor_response matrix.\n"
4624 "The dimension of the matrix is (nchan, nfreq), where nchan\n"
4625 "is the number of instrument channels and nfreq is the number\n"
4626 "of monochromatic frequencies.\n"
4628 GROUP(
"Sparse" )));
4632 (
NAME(
"xml_output_type" ),
4635 "Flag to determine whether XML output shall be binary or ascii.\n"
4637 "This flag has to be set using the workspace method\n"
4638 "*output_file_formatSetAscii* or *output_file_formatSetBinary*.\n"
4639 "One of these methods MUST be called before writing the first\n"
4642 "Usage: Set by user.\n"
4651 "The measurement vector.\n"
4653 "This vector holds radiances averaged in frequency and spatially,\n"
4654 "and can contain many spectra appended. \n"
4656 "Usage: Output from radiative transfer calculations considering\n"
4657 " sensor response.\n"
4659 "Unit: Undefined. Possibilities include: K, W/(m^2 Hz sr) and\n "
4660 " optical thickness.\n"
4662 GROUP(
"Vector" )));
4669 "Data auxilary to *y*.\n"
4671 "Different data beside the direct result of the radiative transfer\n"
4672 "calculations can be obtained by this variable. These auxilary data\n"
4673 "are selected by *iy_aux_vars*.\n"
4675 "In contrast to *iy_aux*, this variable can only hold quantities such\n"
4676 "as total transmission, and other quantites that could be the result\n"
4677 "of a complete radiative transfer calculation. The data are weighted\n"
4678 "with sensor properties in the same way as for *y*.\n"
4680 "See also *iy_aux_vars*.\n"
4682 "Usage: Output of *yCalc*.\n"
4684 "Dimensions: [quantity][ element of y ]\n"
4686 GROUP(
"ArrayOfVector" )));
4693 "The frequencies associated with *y*.\n"
4695 "A value is returned for each element of *y*. Depending on the sensor\n"
4696 "set-up and number of measurement blocks, this can be a copy of\n"
4697 "*sensor_response_f*, sveral copies of this vector appended, or some\n"
4698 "other frequenices.\n"
4700 "Usage: Output from radiative transfer calculations considering\n"
4701 " sensor response.\n"
4705 GROUP(
"Vector" )));
4712 "The line-of-sights associated with *y*.\n"
4714 "Definition of angles matches *sensor_los* (such as first column holds\n"
4715 "zenith angles), but gives actual observed LOS. That is, the values of\n"
4716 "both *sensor_los* and *antenna_los* are considered. Data are provided\n"
4717 "for each element of *y*, following y_f, and the number of rows equals\n"
4718 "the length of *y*.\n"
4720 "Usage: Output from radiative transfer calculations considering\n"
4721 " sensor response.\n"
4723 "Unit: [ degrees, degrees ]\n"
4725 GROUP(
"Matrix" )));
4732 "The polarisation states associated with *y*.\n"
4734 "Data are provided for each element of *y*, following y_f, and the\n"
4735 "length of this variable and *y* is equal.\n"
4737 "See *sensor_pol* for coding of polarisation components.\n"
4739 "Usage: Output from radiative transfer calculations considering\n"
4740 " sensor response.\n"
4744 GROUP(
"ArrayOfIndex" )));
4751 "The sensor positions associated with *y*.\n"
4753 "Definition of positions matches *sensor_pos* (such as first column\n"
4754 "holds the altitude). Data are provided for each element of *y*,\n"
4755 "following y_f, and the number of rows equals the length of *y*.\n"
4757 "Usage: Output from radiative transfer calculations considering\n"
4758 " sensor response.\n"
4760 "Unit: [ degrees, degrees ]\n"
4762 GROUP(
"Matrix" )));
4769 "The measurement vector for a single measurement block.\n"
4771 "Exactly as *y*, but holds data only for a single measurement block.\n"
4773 "Usage: Used internally.\n"
4775 GROUP(
"Vector" )));
4782 "Batch of spectra.\n"
4784 "Each element of *ybatch* corresponds to a spectrum vector *y*. \n"
4785 "See further *ybatchCalc*.\n"
4787 "Usage: Most commonly produced by *ybatchCalc*.\n"
4789 "Unit: Undefined. Possibilities include: K, W/(m^2 Hz sr) and\n "
4790 " optical thickness.\n"
4792 "Dimensions: Number of array elements equals number of batch cases,\n"
4793 " Vectors have length(y)\n"
4795 GROUP(
"ArrayOfVector" )));
4799 (
NAME(
"ybatch_aux" ),
4802 "Data auxilary to *ybatch*.\n"
4804 "Each element of *ybatch_aux* corresponds to a auxiliary data *y_aux*. \n"
4805 "See further *y_aux* and *ybatchCalc*.\n"
4807 "Usage: Most commonly produced by *ybatchCalc*.\n"
4809 "Dimensions: Number of array elements equals number of batch cases,\n"
4811 GROUP(
"ArrayOfArrayOfVector" )));
4815 (
NAME(
"ybatch_calc_agenda" ),
4820 GROUP(
"Agenda" )));
4824 (
NAME(
"ybatch_index" ),
4827 "Index of batch case.\n"
4829 "See further *ybatchCalc*.\n"
4831 "Usage: Set by *ybatchCalc*, for communication with\n"
4832 " *ybatch_calc_agenda*.\n"
4838 (
NAME(
"ybatch_jacobians" ),
4841 "All the Jacobians associated with ybatch.\n"
4843 "The batch index here is the array dimension.\n"
4845 "Usage: Most commonly produced by *ybatch*.\n"
4847 "Unit: Depends on unit of y and on Jacobian type.\n"
4849 "Dimensions: [number of batch cases] \n"
4851 " number of retrieval quantities and grids)\n"
4853 GROUP(
"ArrayOfMatrix" )));
4857 (
NAME(
"ybatch_n" ),
4860 "Number of batch cases for *ybatchCalc*.\n"
4862 "See further *ybatchCalc*.\n"
4864 "Usage: Input to *ybatchCalc*.\n"
4870 (
NAME(
"ybatch_start" ),
4873 "Start index for *ybatchCalc*.\n"
4875 "This is set to a default of zero in *general.arts*.\n"
4877 "See further *ybatchCalc*.\n"
4879 "Usage: Input to *ybatchCalc*.\n"
4885 (
NAME(
"z_field" ),
4888 "The field of geometrical altitudes.\n"
4890 "This variable gives the geometrical altitude, above the ellipsoid, of\n"
4891 "each crossing of the pressure, latitude and longitude grids. For 1D\n"
4892 "cases the altitudes give the geometrical position of the pressure\n"
4895 "For each geographical position (lat,lon), the values must be sorted\n"
4896 "in increasing order, with no repetitions. Otherwise the altitudes\n"
4897 "can be set to arbitrary values. Hydrostatic equilibrium is not\n"
4898 "applied automatically. If hydrostatic equilibrium applies, *z_field*\n"
4899 "must be set by a method ensuring that this criterium is fulfilled.\n"
4901 "The radius (from the coordinate centre) for a point between the grid\n"
4902 "crossings is obtained by a (multi-)linear interpolation of the sum\n"
4903 "of the ellipsoid radius and *z_field*.\n"
4905 "See further the ARTS user guide (AUG). Use the index to find where\n"
4906 "this variable is discussed. The variable is listed as a subentry to\n"
4907 "\"workspace variables\".\n"
4909 "Usage: Output of *AtmFieldsCalc*\n"
4913 "Dimensions: [ p_grid, lat_grid, lon_grid ]\n"
4915 GROUP(
"Tensor3" )));
4919 (
NAME(
"z_field_raw" ),
4922 "Raw data for geometrical altitudes.\n"
4924 "This variable gives the geometrical altitudes as stored in the \n"
4925 "database for atmospheric scenarios.\n"
4927 "See further the ARTS user guide (AUG). Use the index to find where\n"
4928 "this variable is discussed. The variable is listed as a subentry to\n"
4929 "\"workspace variables\".\n"
4931 "Usage: Set by the user by choosing a climatology.\n"
4935 "Size GriddedField3 \n "
4939 " [N_p, N_lat, N_lon] \n"
4941 GROUP(
"GriddedField3" )));
4945 (
NAME(
"z_hse_accuracy" ),
4948 "Minimum accuracy for calculation of hydrostatic equilibrium.\n"
4950 "Usage: Set by the user.\n"
4954 GROUP(
"Numeric" )));
4958 (
NAME(
"z_surface" ),
4961 "The surface altitude.\n"
4963 "This variable defines the shape of the surface, by giving the\n"
4964 "geometrical altitude above the geiod for each crossing of the \n"
4965 "latitude and longitude grids. Any shape of the surface is accepted.\n"
4966 "No gap between the surface and the lowermost pressure level is \n"
4969 "The radius (from the coordinate centre) for a point between the grid\n"
4970 "crossings is obtained by a linear (1D) or bi-linear (2D) \n"
4971 "interpolation of the sum of the ellipsoid radius and *z_surface*.\n"
4972 "That is, the radius for the surface is assumed to vary linear along \n"
4973 "the latitudes and longitudes in *lat_grid* and *lon_grid*.\n"
4975 "See further the ARTS user guide (AUG). Use the index to find where\n"
4976 "this variable is discussed. The variable is listed as a subentry to\n"
4977 "\"workspace variables\".\n"
4979 "Usage: Set by user.\n"
4983 "Dimensions: [ lat_grid, lon_grid ]\n"
4985 GROUP(
"Matrix" )));
static Array< WsvRecord > wsv_data
This file contains the definition of Array.
The implementation for String, the ARTS string class.
static void define_wsv_data()
Propagation path structure and functions.
This class contains all static information for one workspace variable.
This file contains the declaration and partly the implementation of the workspace class.
my_basic_string< char > String
The String type for ARTS.
static map< String, Index > WsvMap
Header file for sparse matrices.
Index get_wsv_id(const String &name)
Get index of WSV.
INDEX Index
The type to use for all integer numbers and indices.
Auxiliary header stuff related to workspace variable groups.
The global header file for ARTS.