ARTS 2.5.0 (git: 9ee3ac6c)
workspace.cc
Go to the documentation of this file.
1/* Copyright (C) 2000-2012
2 Stefan Buehler <sbuehler@ltu.se>
3 Patrick Eriksson <patrick.eriksson@chalmers.se>
4
5 This program is free software; you can redistribute it and/or modify it
6 under the terms of the GNU General Public License as published by the
7 Free Software Foundation; either version 2, or (at your option) any
8 later version.
9
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
18 USA. */
19
32#include "workspace_ng.h"
33
34// Some #defines to make the records better readable:
35#define NAME(x) x
36#define DESCRIPTION(x) x
37#define GROUP(x) x
38
40 //--------------------< Build the wsv data >--------------------
41 // Initialize to empty, just in case.
42 wsv_data.resize(0);
43
44 /* Templace record entry:
45
46 wsv_data.push_back
47 (WsvRecord
48 ( NAME( "workspace_variable_name" ),
49 DESCRIPTION
50 (
51 "Brief description of the variable (1 line).\n"
52 "\n"
53 "Detailed description of the variable. Don't be too short here,\n"
54 "this is the main place where your documentation should be. I\n"
55 "really recommend to edit this in a text buffer, so that you can\n"
56 "do some re-formatting until it looks nice. Only at the end put it\n"
57 "in quotes and add the line breaks.\n"
58 "\n"
59 "Use blank lines to separate paragraphs. There really should be a\n"
60 "detailed descriptions of all component of your variable, if it\n"
61 "has a complicated type. Also some detailed discussion of the\n"
62 "dimensions if necessary. Also some detailed discussion of the\n"
63 "members if your variable is a structure.\n"
64 "\n"
65 "Usage: Set by user (or "Method output.")\n"
66 "\n"
67 "Units: E.g., kg/m\n"
68 "\n"
69 "Dimensions: [ first dimension, second dimension, ... ]\n"
70 "or\n"
71 "Size: [ .., nrows, ncols ]\n"
72 "\n"
73 "Members: Here you would list the members if your\n"
74 " variable is a structure.\n"
75 "\n"
76 "Dimensions: [x, y]\n"
77 "\n"
78 "Unit: Which unit this variable uses\n"
79 "\n"
80 "Give the keywords above only if they apply, i.e., Members only\n"
81 "for a structure, Units only for a physical variable.\n"
82 "Use either Dimensions or Size, depending on what is most appropiate\n"
83 "for the variable.\n"
84 ),
85 GROUP( "VariableType" )));
86
87*/
88
89 /*----------------------------------------------------------------------
90 Let's put in the variables in alphabetical order. This gives a clear
91 rule for where to place a new variable and this gives a nicer
92 results when the methods are listed by "arts -w all". No
93 distinction is made between uppercase and lowercase letters. The
94 sign "_" comes after all letters.
95 Patrick Eriksson 2002-05-08
96 ----------------------------------------------------------------------*/
97
98 wsv_data.push_back(WsvRecord(
99 NAME("aa_grid"),
101 "Azimuthal angle grid.\n"
102 "\n"
103 "The azimutal angle grid, on which the *cloudbox_field* is stored. \n"
104 "This grid is used for RT calculations inside the cloudbox, \n"
105 "therefore one has to define it if the cloudbox is activated by \n"
106 "the flag *cloudbox_on*. Furthermore the zenith angle grid is also used"
107 "for RT calculations of clear-sky *spectral radiance field*.\n"
108 "The grid must be sorted in increasing order, with no repetitions.\n"
109 "\n"
110 "Usage: Set by the user.\n"
111 "\n"
112 "Unit: degrees \n"),
113 GROUP("Vector")));
114
115 wsv_data.push_back(WsvRecord(
116 NAME("aa_index"),
118 "Azimuth angle index for scattering calculations.\n"
119 "\n"
120 "This variable is used in methods used for computing scattering\n"
121 "properties. \n"
122 "It holds the information about the azimuth angles for which the \n"
123 "scattering calculations are done. The angles used for computing \n"
124 "scattering properties of particles can be different from that used \n"
125 "for radiative transfer calculation. \n"
126 "\n"
127 "Usage: Method output.\n"),
128 GROUP("Index")));
129
130 wsv_data.push_back(WsvRecord(
131 NAME("abs_cia_data"),
133 "HITRAN Collision Induced Absorption (CIA) Data.\n"
134 "\n"
135 "This variable holds HITRAN CIA data (binary absorption\n"
136 "cross-sections). The data itself is described in: Richard, C. et al.\n"
137 "(2012), New section of the HITRAN database: Collision-induced\n"
138 "absorption (CIA), J. Quant. Spectrosc. Radiat. Transfer, 113,\n"
139 "1276-1285, doi:10.1016/j.jqsrt.2011.11.004.\n"
140 " \n"
141 "The binary absorption cross-sections have to be multiplied with the\n"
142 "densities of both molecules to get absorption coefficients.\n"
143 "\n"
144 "Dimensions:\n"
145 "\n"
146 "The outer array dimension in the ArrayOfArrayOfCIARecord is the same\n"
147 "as that of *abs_species*. There will be CIA data only for those\n"
148 "species that contain a CIA tag, for all other species it will be\n"
149 "empty. The inner array dimension corresponds to the number of CIA tags\n"
150 "for this species (there could be for example both N2-N2 and N2-H2) in\n"
151 "the same species.\n"
152 "\n"
153 "The CIA *abs_species* tags are described in *abs_speciesSet*.\n"
154 "\n"
155 "Each individual CIARecord holds the complete information from one\n"
156 "HITRAN CIA file. For the given pair of molecules A HITRAN CIA data\n"
157 "file can hold several datasets (data for different temperatures but\n"
158 "fixed frequency range).\n"
159 "\n"
160 "Units: \n"
161 "Frequencies: Hz\n"
162 "Binary absorption cross-sections: m^5*molecule^-2\n"),
163 GROUP("ArrayOfCIARecord")));
164
165 wsv_data.push_back(WsvRecord(
166 NAME("abs_cont_models"),
168 "Continuum / full model absorption model description parameter.\n"
169 "\n"
170 "See the WSV `abs_cont_names' for a detailed description\n"
171 "of the allowed continuum models. There should be one string here\n"
172 "for each entry in `abs_cont_names'.See also the online\n"
173 "documentation in arts/doc/doxygen/html/continua_cc.html.\n"),
174 GROUP("ArrayOfString")));
175
176 wsv_data.push_back(WsvRecord(
177 NAME("abs_cont_names"),
179 "Continuum / full model absorption tag names.\n"
180 "\n"
181 "This variable should contain a list of tag names\n"
182 "of continuum and full models, respectively.\n"
183 "Associated with this WSV is the WSV\n"
184 "`abs_cont_models' which contains the specific model version of\n"
185 "each continuum / full model absorption tag and the WSV\n"
186 "`abs_cont_parameters' which should contain the continuum / full model\n"
187 "user defined parameters. The user defined parameters are only used when\n"
188 "the specified model is 'user'. See also the online documentation in\n"
189 "arts/doc/doxygen/html/continua_cc.html.\n"
190 "\n"
191 "The following full water vapor models are implemented:\n"
192 "'H2O-MPM87': absorption model (line and continuum) according to \n"
193 " H. J. Liebe,\n"
194 " A contribution to modeling atmospheric millimeter-wave properties,\n"
195 " Frequenz, 41, 1987, 31-36\n"
196 " and\n"
197 " H. J. Liebe and D. H. Layton,\n"
198 " Millimeter-wave properties of the atmosphere:\n"
199 " Laboratory studies and propagation modeling,\n"
200 " U.S. Dept. of Commerce, National Telecommunications and Information\n"
201 " Administration, Institute for Communication Sciences,\n"
202 " 325 Broadway, Boulder, CO 80303-3328, report 87224.\n"
203 "'H2O-MPM89': absorption model (line and continuum) according to \n"
204 " H. J. Liebe,\n Int. J. Infrared and Millimeter Waves, 10(6), 1989, 631\n"
205 "'H2O-MPM93': absorption model (line and continuum) according to \n"
206 " H. J. Liebe and G. A. Hufford and M. G. Cotton,\n"
207 " Propagation modeling of moist air and suspended water/ice\n"
208 " particles at frequencies below 1000 GHz,\n"
209 " AGARD 52nd Specialists Meeting of the Electromagnetic Wave\n"
210 " Propagation Panel,\n Palma de Mallorca, Spain, 1993, May 17-21 \n"
211 " (ftp.its.bldrdoc.gov/pub/mpm93/)\n"
212 "'H2O-CP98': absorption model (line and continuum) according to \n"
213 " S. L. Cruz-Pol et al.,\n Radio Science, 33(5), 1319, 1998"
214 " (ece.uprm.edu/~pol/Atmosphere.html)\n"
215 "'H2O-PWR98': absorption model (line and continuum) according to \n"
216 " P. W. Rosenkranz,\n "
217 " Radio Science, 33(4), 919, 1998, Radio Science, 34(4), 1025, 1999\n"
218 " (ftp: mesa.mit.edu/phil/lbl_rt).\n"
219 "\n"
220 "The following full oxygen models are implemented:\n"
221 "'O2-MPM93': absorption model (line and continuum) according to\n"
222 " H. J. Liebe and G. A. Hufford and M. G. Cotton,\n"
223 " Propagation modeling of moist air and suspended water/ice\n"
224 " particles at frequencies below 1000 GHz,\n"
225 " AGARD 52nd Specialists Meeting of the Electromagnetic Wave\n"
226 " Propagation Panel,\n Palma de Mallorca, Spain, 1993, May 17-21\n"
227 " (ftp.its.bldrdoc.gov/pub/mpm93/)\n"
228 "'O2-PWR93': absorption model (line and continuum) according to \n"
229 " P. W. Rosenkranz,\n Chapter 2, in M. A. Janssen, \n"
230 " Atmospheric Remote Sensing by Microwave Radiometry\n"
231 " John Wiley & Sons, Inc., 1993 (mesa.mit.edu/phil/lbl_rt)\n"
232 "\n"
233 "The following continuum parameterizations are implemented:\n"
234 "H2O-H2O ('H2O-SelfContStandardType'):\n"
235 " P. W. Rosenkranz, \n"
236 " Radio Science, Vol. 33, No 4, Pages 919-928, 1998 and \n"
237 " Radio Science, Vol. 34, No 4, Page 1025, 1999 (mesa.mit.edu/phil/lbl_rt)\n"
238 "H2O-air ('H2O-ForeignContStandardType'): \n"
239 " P. W. Rosenkranz, \n"
240 " Radio Science, Vol. 33, No 4, Pages 919-928, 1998 and \n"
241 " Radio Science, Vol. 34, No 4, Page 1025, 1999 (mesa.mit.edu/phil/lbl_rt)\n"
242 "H2O-air ('H2O-ContMPM93'): \n"
243 " H. J. Liebe and G. A. Hufford and M. G. Cotton,\n"
244 " Propagation modeling of moist air and suspended water/ice\n"
245 " particles at frequencies below 1000 GHz,\n"
246 " AGARD 52nd Specialists Meeting of the Electromagnetic Wave\n"
247 " Propagation Panel,\n Palma de Mallorca, Spain, 1993, May 17-21\n"
248 " (ftp.its.bldrdoc.gov/pub/mpm93/)\n"
249 "O2-air ('O2-SelfContStandardType'):\n"
250 " P. W. Rosenkranz,\n"
251 " Chapter 2, in M. A. Janssen,\n"
252 " Atmospheric Remote Sensing by Microwave Radiometry,\n"
253 " John Wiley & Sons, Inc., 1993\n"
254 " (mesa.mit.edu/phil/lbl_rt)\n"
255 " and also described in \n"
256 " H. J. Liebe and G. A. Hufford and M. G. Cotton,\n"
257 " Propagation modeling of moist air and suspended water/ice\n"
258 " particles at frequencies below 1000 GHz,\n"
259 " AGARD 52nd Specialists Meeting of the Electromagnetic Wave\n"
260 " Propagation Panel,\n Palma de Mallorca, Spain, 1993, May 17-21\n"
261 " (ftp.its.bldrdoc.gov/pub/mpm93/)\n"
262 "N2-N2 ('N2-SelfContStandardType'):\n"
263 " The functional form of Rosenkranz but with more input parameters.\n"
264 " P. W. Rosenkranz,\n"
265 " Chapter 2, in M. A. Janssen,\n"
266 " Atmospheric Remote Sensing by Microwave Radiometry,\n"
267 " John Wiley & Sons, Inc., 1993 (mesa.mit.edu/phil/lbl_rt)\n"
268 "N2-N2 ('N2-SelfContMPM93'):\n"
269 " H. J. Liebe and G. A. Hufford and M. G. Cotton,\n"
270 " Propagation modeling of moist air and suspended water/ice\n"
271 " particles at frequencies below 1000 GHz,\n"
272 " AGARD 52nd Specialists Meeting of the Electromagnetic Wave\n"
273 " Propagation Panel, Palma de Mallorca, Spain, 1993, May 17-21 \n"
274 " (ftp.its.bldrdoc.gov/pub/mpm93/)\n"
275 "CO2-CO2 ('CO2-SelfContPWR93'):\n"
276 " P. W. Rosenkranz,\n"
277 " Chapter 2, in M. A. Janssen,\n"
278 " Atmospheric Remote Sensing by Microwave Radiometry,\n"
279 " John Wiley & Sons, Inc., 1993 (mesa.mit.edu/phil/lbl_rt)\n"
280 "CO2-N2 ('CO2-ForeignContPWR93'):\n"
281 " P. W. Rosenkranz,\n"
282 " Chapter 2, in M. A. Janssen,\n"
283 " Atmospheric Remote Sensing by Microwave Radiometry,\n"
284 " John Wiley & Sons, Inc., 1993 (mesa.mit.edu/phil/lbl_rt)\n"
285 "\n"
286 "The following cloud absorption models are implemented:\n"
287 "Suspended water droplet ('liquidcloud-MPM93') \n"
288 " absorption parameterization from the MPM93 model:\n"
289 " H. J. Liebe and G. A. Hufford and M. G. Cotton,\n"
290 " Propagation modeling of moist air and suspended water/ice\n"
291 " particles at frequencies below 1000 GHz,\n"
292 " AGARD 52nd Specialists Meeting of the Electromagnetic Wave\n"
293 " Propagation Panel,\n Palma de Mallorca, Spain, 1993, May 17-21\n"
294 " (ftp.its.bldrdoc.gov/pub/mpm93/)\n"
295 "Ice water droplet absorption ('icecloud-MPM93') \n"
296 " parameterization from MPM93 model:\n"
297 " H. J. Liebe and G. A. Hufford and M. G. Cotton,\n"
298 " Propagation modeling of moist air and suspended water/ice\n"
299 " particles at frequencies below 1000 GHz,\n"
300 " AGARD 52nd Specialists Meeting of the Electromagnetic Wave\n"
301 " Propagation Panel,\n Palma de Mallorca, Spain, 1993, May 17-21\n"
302 " (ftp.its.bldrdoc.gov/pub/mpm93/)\n"
303 "\n"
304 "The following rain extinction model is implemented:\n"
305 "Rain extinction parameterization ('rain-MPM93') from the\n"
306 " MPM93 model, described in:\n"
307 " H. J. Liebe,\n"
308 " MPM - An Atmospheric Millimeter-Wave Propagation Model,\n"
309 " Int. J. Infrared and Millimeter Waves, vol. 10(6),\n"
310 " pp. 631-650, 1989;\n"
311 " and based on:\n"
312 " Olsen, R.L., D.V. Rogers, and D. B. Hodge,\n"
313 " The aR^b relation in the calculation of rain attenuation,\n"
314 " IEEE Trans. Antennas Propagat., vol. AP-26, pp. 318-329, 1978.\n"
315 " IMPORTANT NOTE: rain-MPM93 parameterizes the EXTINCTION by rain,\n"
316 " not just the absorption. Therefore it is not suitable for \n"
317 " calculating thermal emission by rain!\n"
318 " Please use rain-MPM93 only for calculation of attenuation.\n"),
319 GROUP("ArrayOfString")));
320
321 wsv_data.push_back(WsvRecord(
322 NAME("abs_cont_parameters"),
324 "Continuum model parameters. See the WSV *abs_cont_names*\n"
325 "\n"
326 "for a detailed description of the allowed continuum models. There\n"
327 "should be one parameter vector here for each entry in\n"
328 "*abs_cont_names*. See also the online documentation in\n"
329 "arts/doc/doxygen/html/continua_cc.html.\n"),
330 GROUP("ArrayOfVector")));
331
332 wsv_data.push_back(WsvRecord(
333 NAME("abs_f_interp_order"),
335 "Frequency interpolation order for absorption lookup table.\n"
336 "\n"
337 "The interpolation order to use when interpolating the absorption\n"
338 "lookup table in frequency. This is in particular needed for\n"
339 "calculations with Doppler shift, so that absorption is interpolated to\n"
340 "the shifted frequency grid. One is linear interpolation, two\n"
341 "quadratic, and so on.\n"
342 "\n"
343 "As a special case, order 0 in this particular case means no\n"
344 "interpolation. In that case f_grid must match exactly the grid inside\n"
345 "the lookup table. This is the global default value, set in\n"
346 "general.arts.\n"),
347 GROUP("Index")));
348
349
350 wsv_data.push_back(WsvRecord(
351 NAME("abs_hitran_relmat_data"),
353 "HITRAN line mixing data to compute the relaxation matrix.\n"
354 "\n"
355 "This variable holds HITRAN line mixing data\n"
356 "as per J. Lamouroux, L. Realia, X. Thomas, et al., J.Q.S.R.T. 151 (2015), 88-96\n"),
357 GROUP("HitranRelaxationMatrixData")));
358
359 wsv_data.push_back(WsvRecord(NAME("abs_lines"),
360 DESCRIPTION("A list of spectral line data.\n"),
361 GROUP("ArrayOfAbsorptionLines")));
362
363 wsv_data.push_back(WsvRecord(
364 NAME("abs_lines_per_species"),
366 "A list of spectral line data for each tag.\n"
367 "\n"
368 "Dimensions: [*abs_species*.nelem()][Depends on how many bands there are in *abs_lines*]\n"),
369 GROUP("ArrayOfArrayOfAbsorptionLines")));
370
371 wsv_data.push_back(WsvRecord(
372 NAME("abs_lookup"),
374 "An absorption lookup table.\n"
375 "\n"
376 "It holds an absorption lookup table, as well as all information that\n"
377 "is necessary to use the table to extract absorption. Extraction\n"
378 "routines are implemented as member functions. \n"
379 "\n"
380 "It has quite a complicated structure. For details see the Arts User\n"
381 "Guide section \"The gas absorption lookup table\" or the source code\n"
382 "documentation in gas_abs_lookup.h.\n"),
383 GROUP("GasAbsLookup")));
384
385 wsv_data.push_back(WsvRecord(
386 NAME("abs_nls"),
388 "Nonlinear species for absorption lookup table generation.\n"
389 "\n"
390 "A list of absorption species that should be treated non-linearly.\n"
391 "This means that the H2O VMR should be varied when calculating the\n"
392 "lookup table for those species.\n"
393 "\n"
394 "A typical example is for this to containt the Rosenkranz full\n"
395 "absorption model species for water vapor and oxygen \n"
396 "([\"H2O-PWR98\", \"O2-PWR93\"]).\n"
397 "\n"
398 "See user guide and online documentation of *abs_lookupCalc*\n"
399 "for more details and usage examples.\n"),
400 GROUP("ArrayOfArrayOfSpeciesTag")));
401
402 wsv_data.push_back(WsvRecord(
403 NAME("abs_nls_pert"),
405 "Fractional perturbations for the nonlinear species in the absorption\n"
406 "lookup table.\n"
407 "\n"
408 "This is a vector of fractional perturbations that should contain 1\n"
409 "(the unperturbed reference profile). A value of 0 may lead to error\n"
410 "messages from some absorption routines, so a possible content for this\n"
411 "variable is: [1e-24, 1, 2].\n"
412 "(This is similar to *abs_t_pert*, but multiplicative, not additive.)\n"),
413 GROUP("Vector")));
414
415 wsv_data.push_back(WsvRecord(
416 NAME("abs_nls_interp_order"),
418 "The interpolation order to use when interpolating absorption between\n"
419 "the H2O values given by *abs_nls_pert*.\n"
420 "\n"
421 "This is used by methods extracting absorption coefficients\n"
422 "from the lookup table, and by methods setting up\n"
423 "parameters for lookup table generation. Has a\n"
424 "default value, which is set in general.arts.\n"
425 "\n"
426 "Note that the number of points used in the interpolation scheme is\n"
427 "interpolation order + 1 (e.g., two for first order interpolation).\n"),
428 GROUP("Index")));
429
430 wsv_data.push_back(WsvRecord(
431 NAME("abs_p_interp_order"),
433 "The interpolation order to use when interpolating absorption\n"
434 "between pressure levels.\n"
435 "\n"
436 "This is used by methods extracting absorption coefficients\n"
437 "from the lookup table, and by methods\n"
438 "setting up parameters for lookup table generation. Has a\n"
439 "default value, which is set in general.arts.\n"
440 "\n"
441 "Note that the number of points used in the interpolation scheme is\n"
442 "interpolation order + 1 (e.g., two for first order interpolation).\n"),
443 GROUP("Index")));
444
445 wsv_data.push_back(WsvRecord(
446 NAME("abs_t_pert"),
448 "Temperature perturbations for the absorption lookup table.\n"
449 "\n"
450 "This is a vector containing temperature perturbations (in Kelvin) that\n"
451 "should be added to the reference temperature profile. (Similar to\n"
452 "*abs_nls_pert*, but additive, not multiplicative.) Should normally\n"
453 "contain 0, to include the reference profile itself. Example content:\n"
454 "[-5, 0, 5].\n"),
455 GROUP("Vector")));
456
457 wsv_data.push_back(WsvRecord(
458 NAME("abs_t_interp_order"),
460 "The interpolation order to use when interpolating absorption between\n"
461 "the temperature values given by *abs_t_pert*.\n"
462 "\n"
463 "This is used by methods\n"
464 "extracting absorption coefficients from the lookup table, and by\n"
465 "methods setting up parameters for lookup table generation. Has a\n"
466 "default value, which is set in general.arts.\n"
467 "\n"
468 "Note that the number of points used in the interpolation scheme is\n"
469 "interpolation order + 1 (e.g., two for first order interpolation).\n"),
470 GROUP("Index")));
471
472 wsv_data.push_back(WsvRecord(
473 NAME("abs_lookup_is_adapted"),
475 "Flag to indicate whether *abs_lookupAdapt* has already been\n"
476 "called.\n"
477 "\n"
478 "Values: 0=false, 1=true.\n"),
479 GROUP("Index")));
480
481 wsv_data.push_back(WsvRecord(
482 NAME("abs_p"),
484 "List of pressures to be used for the calculation of absorption\n"
485 "coefficients.\n"
486 "\n"
487 "This can be copied from the global *p_grid*, but could also be\n"
488 "different.\n"
489 "\n"
490 "Any absorption method should check that the length of this vector\n"
491 "is the same as that of *abs_t*\n"
492 "\n"
493 "Dimension: [p_grid]\n"
494 "\n"
495 "Unit: Pa\n"),
496 GROUP("Vector")));
497
498 wsv_data.push_back(WsvRecord(
499 NAME("abs_species"),
501 "Tag groups for gas absorption.\n"
502 "\n"
503 "This is an array of arrays of SpeciesTag tag definitions. It defines the\n"
504 "available tag groups for the calculation of scalar gas absorption\n"
505 "coefficients. See online documentation of method *abs_speciesSet* for\n"
506 "more detailed information how tag groups work and some examples.\n"),
507 GROUP("ArrayOfArrayOfSpeciesTag")));
508
509 wsv_data.push_back(WsvRecord(
510 NAME("abs_species_active"),
512 "Indices of active absorption species.\n"
513 "\n"
514 "This variable selects, which absorption species are active in\n"
515 "*abs_xsec_agenda*.\n"
516 "\n"
517 "Dimension: A vector with one element for every active species, at max\n"
518 " same number of elements as abs_species.\n"),
519 GROUP("ArrayOfIndex")));
520
521 wsv_data.push_back(WsvRecord(
522 NAME("abs_t"),
524 "List of temperatures to be used for the calculation of absorption\n"
525 "coefficients.\n"
526 "\n"
527 "In contrast to the global *t_field*, this is just a vector. Any\n"
528 "absorption method should check that the length of this vector is the\n"
529 "same as that of *abs_p*\n"
530 "\n"
531 "Dimension: [p_grid]\n"
532 "\n"
533 "Unit: K\n"),
534 GROUP("Vector")));
535
536 wsv_data.push_back(WsvRecord(
537 NAME("abs_nlte"),
539 "NLTE temperatures or ratios to be used for the calculation of\n"
540 "absorption coefficients.\n"
541 "\n"
542 "In contrast to the global *nlte_field*, this is just a matrix. Any\n"
543 "absorption method should check that the columns of this vector is the\n"
544 "same as that of *abs_p*\n"
545 "\n"
546 "Dimension: [nltes, 1, 1, p_grid] or [ 0, 0, 0, 0 ]\n"
547 "\n"
548 "Unit: K\n"),
549 GROUP("EnergyLevelMap")));
550
551 wsv_data.push_back(WsvRecord(
552 NAME("abs_vec"),
554 "Total absorption vector.\n"
555 "\n"
556 "This variable contains the absorption coefficient vector which\n"
557 "is used in the RTE calculation. It is the physical absorption which\n"
558 "includes particle absorption for all considered scattering elements as\n"
559 "well as gaseous absorption for all selected gaseous species.\n"
560 "The vector is calculated by *opt_prop_bulkCalc*\n"
561 "The dimension of the variable adapts to *stokes_dim*.\n"
562 "\n"
563 "See ARTS user guide (AUG) for further information. Use the index to find\n"
564 "where this variable is discussed. The variable is listed as a subentry\n"
565 "to \"workspace variables\".\n"
566 "\n"
567 "Usage: Output of *opt_prop_bulkCalc* \n"
568 "\n"
569 "Unit: m^2\n" //FIXME: really m2? not 1/m?
570 "\n"
571 "Dimensions: [f_grid, stokes_dim]\n"),
572 GROUP("StokesVector")));
573
574 wsv_data.push_back(WsvRecord(
575 NAME("abs_vec_spt"),
577 "Absorption vectors of the scattering elements.\n"
578 "\n"
579 "This variable contains the elements of the absorption vector of the\n"
580 "individual scattering elements. It is calculated in the agenda \n"
581 "*spt_calc_agenda*.\n"
582 "\n"
583 "See ARTS user guide (AUG) for further information.\n"
584 "\n"
585 "Usage: Input and Output of the method abs_vec_sptCalc\n"
586 "\n"
587 "Unit: m^2\n" //FIXME: really m2? not 1/m?
588 "\n"
589 "Dimensions: [number of scattering elements, stokes_dim]\n"),
590 GROUP("ArrayOfStokesVector")));
591
592 wsv_data.push_back(WsvRecord(
593 NAME("abs_vmrs"),
594 DESCRIPTION("The VMRs (unit: absolute number) on the abs_p grid.\n"
595 "\n"
596 "Dimensions: [tag_groups.nelem(), abs_p.nelem()]\n"),
597 GROUP("Matrix")));
598
599 wsv_data.push_back(
600 WsvRecord(NAME("abs_xsec_agenda_checked"),
601 DESCRIPTION("OK-flag for *abs_xsec_agenda*.\n"
602 "\n"
603 "Set by *abs_xsec_agenda_checkedCalc*.\n"),
604 GROUP("Index")));
605
606 wsv_data.push_back(WsvRecord(
607 NAME("abs_xsec_agenda"),
609 "Agenda to calculate scalar gas absorption cross sections.\n"),
610 GROUP("Agenda")));
611
612 wsv_data.push_back(WsvRecord(
613 NAME("abs_xsec_per_species"),
615 "Absorption cross sections for the attenuation.\n"
616 "\n"
617 "This variable contains absorption cross section xsec individually for\n"
618 "each tag group. The Array contains one matrix for each tag group, the\n"
619 "matrix format is the same as that of abs_coef.\n"
620 "\n"
621 "Dimensions: [abs_species](f_grid, abs_p)\n"
622 "\n"
623 "Unit: m^2 (alpha = xsec * n * VMR),\n"
624 " where n is total density.\n"),
625 GROUP("ArrayOfMatrix")));
626
627 wsv_data.push_back(WsvRecord(
628 NAME("agenda_array_index"),
630 "Index of the current agenda in *ArrayOfAgenda*.\n"
631 "\n"
632 "This is set during the execution of an agenda from an *ArrayOfAgenda*.\n"
633 "It indicates the index of the current agenda inside the array.\n"
634 "\n"
635 "Unit: Integer value.\n"),
636 GROUP("Index")));
637
638 wsv_data.push_back(WsvRecord(
639 NAME("antenna_dim"),
641 "The dimensionality of the antenna pattern (1-2).\n"
642 "\n"
643 "A dimensionality of 1 means that only the respons variation in the\n"
644 "zenith direction is considered. The provided respons shall then be the\n"
645 "integrated in the azimuth direction. For 2D, the respons of the\n"
646 "antenna has both a zenith and azimuth variation.\n"
647 "\n"
648 "Usage: Set by the user.\n"
649 "\n"
650 "Unit: Integer value [1-2].\n"),
651 GROUP("Index")));
652
653 wsv_data.push_back(WsvRecord(
654 NAME("antenna_dlos"),
656 "The relative line-of-sight of each antenna pattern.\n"
657 "\n"
658 "This variable describes the line-of-sight of the individual antennae\n"
659 "relative to *sensor_los*. If each measurement block corresponds to\n"
660 "a single antenna pattern, the normal choice is to set the angle(s) of\n"
661 "this variable to zero.\n"
662 "\n"
663 "The first column holds the relative zenith angle. This column is\n"
664 "mandatory for all atmospheric dimensionalities. For 3D, there can\n"
665 "also be a second column, giving relative azimuth angles. If this\n"
666 "column is not present (for 3D) zero azimuth off-sets are assumed.\n"
667 "\n"
668 "See further the ARTS user guide (AUG). Use the index to find where\n"
669 "this variable is discussed. The variable is listed as a subentry to\n"
670 "\"workspace variables\".\n"
671 "\n"
672 "Usage: Set by the user.\n"
673 "\n"
674 "Unit: [ degrees, degrees ]\n"
675 "\n"
676 "Size: [ number of antennae, 1 or 2 ]\n"),
677 GROUP("Matrix")));
678
679 wsv_data.push_back(WsvRecord(
680 NAME("antenna_response"),
682 "The antenna pattern/response.\n"
683 "\n"
684 "This WSV describes the antenna response as a function of polarisation\n"
685 "(pol), frequencue (f), zenith angle (za) and azimuth angle (aa).\n"
686 "\n"
687 "Polarisation dimension: If this dimension has size 1, the data are\n"
688 "applied for all polarisations of concern. The data are otherwise used\n"
689 "in sequential order. This signifies that, in general, the first\n"
690 "polarisation \"layer\" corresponds to the first stokes dimension\n"
691 "etc. An exception is if a polarisation rotation has been applied. In\n"
692 "any case, it is up to the user to ensure that polarisations are\n"
693 "consistently defined.\n"
694 "\n"
695 "Frequency dimension: If this dimension has size 1, the data are\n"
696 "applied for all frequencies of concern. The given frequency must be\n"
697 "inside the frequency range of concern. A linear interpolation is\n"
698 "otherwise applied.\n"
699 "\n"
700 "Zenith angle dimension: This dimension must always have a size >= 2\n"
701 "The response outside covered grid range is treated as zero. If\n"
702 "*antenna_dim* equals 1, the data should correspond to the response\n"
703 "integrated in the azimuthal direction.\n"
704 "\n"
705 "Azimuth angle dimension: If *antenna_dim* equals 1, this dimension\n"
706 "must have size 1. A size >= 2 is otherwise required. The response\n"
707 "outside covered grid range is treated as zero.\n"
708 "\n"
709 "Usage: Set by the user.\n"
710 "\n"
711 "Dimensions: \n"
712 " GriddedField4:\n"
713 " ArrayOfString field_names[N_pol]\n"
714 " Vector f_grid[N_f]\n"
715 " Vector za_grid[N_za]\n"
716 " Vector aa_grid[N_aa]\n"
717 " Tensor4 data[N_pol][N_f][N_za][N_aa]\n"),
718 GROUP("GriddedField4")));
719
720 wsv_data.push_back(WsvRecord(
721 NAME("atmosphere_dim"),
723 "The atmospheric dimensionality (1-3).\n"
724 "\n"
725 "This variable defines the complexity of the atmospheric structure.\n"
726 "The dimensionality is given by an integer between 1 and 3, where 1\n"
727 "means 1D etc. This is the master variable for the atmospheric\n"
728 "dimensionality, variables which size changes with the dimensionality\n"
729 "are checked to match this variable. \n"
730 "\n"
731 "Methods adapt automatically to this variable. That is, it should\n"
732 "not be needed to change any methods if the dimensionality is\n"
733 "changed. However, not all methods are working for higher dimensions.\n"
734 "\n"
735 "Usage: Set by the user.\n"
736 "\n"
737 "Unit: Integer value.\n"),
738 GROUP("Index")));
739
740 wsv_data.push_back(WsvRecord(
741 NAME("atmfields_checked"),
743 "OK-flag for atmospheric grids and (physical) fields.\n"
744 "\n"
745 "The variable flags that clear-sky part of the atmosphere is\n"
746 "defined in formally correct way. Example on problems captured\n"
747 "include that the size of an atmospheric fields does not match the\n"
748 "length of the atmospheric grids, and physically incorrect data such\n"
749 "as negative temperatures.\n"
750 "\n"
751 "Note that *z_field* is not covered by this variable, it is instead\n"
752 "treated to be part of the geometrical considerations where the ok-flag\n"
753 "is denoted as *atmgeom_checked*. The cloudbox is covered by\n"
754 "*cloudbox_checked*.\n"
755 "\n"
756 "Shall be set by *atmfields_checkedCalc*. See that WSMs for treated\n"
757 "WSVs. Only the value 1 is taken as OK.\n"),
758 GROUP("Index")));
759
760 wsv_data.push_back(WsvRecord(
761 NAME("atmgeom_checked"),
763 "OK-flag for the geometry of the model atmosphere.\n"
764 "\n"
765 "The variable flags that reference ellipsoid, the surfae and *z_field*\n"
766 "contain formally correct values. Includes for example, that *z_field*\n"
767 "holds strictly increasing values at each geographical position.\n"
768 "\n"
769 "See also *atmfields_checked*.\n"
770 "\n"
771 "Shall be set by *atmgeom_checkedCalc*. Only the value 1 is taken\n"
772 "as OK.\n"),
773 GROUP("Index")));
774
775 wsv_data.push_back(WsvRecord(
776 NAME("atm_fields_compact"),
778 "A compact set of atmospheric fields on a common set of grids.\n"
779 "\n"
780 "Data is supposed to contain basic atmsopheric fields for a RT\n"
781 "calculation, i.e., temperature, altitude, and gas VMRs. It can\n"
782 "furthermore contain fields describing scattering species like mass\n"
783 "content, mass flux, number density of diverse scattering species.\n"
784 "\n"
785 "VMR fields are unitless, scattering species fields are supposed to be\n"
786 "in SI units (i.e. kg/m3 for mass contents, kg/m2/s for mass flux,\n"
787 "1/m3 for number densities).\n"
788 "\n"
789 "The data are stored in a *GriddedField4*.\n"
790 "\n"
791 "The first field in the matrix (i.e., first matrix column) has to be\n"
792 "atmospheric pressure. Apart from this, the order of the fields is\n"
793 "free. Field content (apart from pressure) is identified by their\n"
794 "given field name tag. Furthermore, absorption species (e.g. VMR)\n"
795 "fields and scattering species fields are related to *abs_species*\n"
796 "and *scat_species* entries, respectively, by their field name tags.\n"
797 "The tags must exhibit the following structure:\n"
798 "\n"
799 "0) species identifier:\n"
800 " Fields, supposed to be sorted into *vmr_field*, must be headed the\n"
801 " tag 'abs_species'. Names of scattering species fields likewise must\n"
802 " be headed by the 'scat_species' tag. Temperature and altitude\n"
803 " fields do not hold any heading tag.\n"
804 "1) species name:\n"
805 " The (core) name of the field: 'T' for temperature, 'z' for\n"
806 " altitude, the absorption species name (e.g. 'H2O, 'O3', etc.) for\n"
807 " absorption species, the scattering species name (e.g. 'IWC') for\n"
808 " scattering species. For scattering species, this part is matched\n"
809 " against the scattering species name part of the *scat_species*\n"
810 " tags.\n"
811 "2) field type:\n"
812 " This has to be given for scattering species only, indicating the\n"
813 " type of the scattering species fields, i.e. 'mass_density',\n"
814 " 'mass_flux', 'number_density', 'mean_mass'.\n"
815 "Dashes ('-') serve as delimiter, separating the elements of each\n"
816 "field name tag.\n"
817 "\n"
818 "Usage: Used inside batch calculations, to hold successive atmospheric\n"
819 " states from an *ArrayOfGriddedField4*.\n"
820 "\n"
821 "Dimensions: \n"
822 " GriddedField4:\n"
823 " ArrayOfString field_names[N_fields]\n"
824 " Vector p_grid[N_p]\n"
825 " Vector lat_grid[N_lat]\n"
826 " Vector lon_grid[N_lon]\n"
827 " Tensor4 data[N_fields][N_p][N_lat][N_lon]\n"),
828 GROUP("GriddedField4")));
829
830 wsv_data.push_back(WsvRecord(
831 NAME("avk"),
833 "Averaging kernel matrix.\n"
834 "\n"
835 "This matrix is the partial derivative of the retrieved state vector\n"
836 "with respect to the measurement vector (*y*).\n"
837 "\n"
838 "Usage: Used and set by inversion methods. \n"),
839 GROUP("Matrix")));
840
841 wsv_data.push_back(WsvRecord(
842 NAME("backend_channel_response"),
844 "The response of each backend channel.\n"
845 "\n"
846 "The response is given as an *ArrayOfGriddedField1*. The grid consists of\n"
847 "relative frequencies. These relative frequencies are added to \n"
848 "*f_backend* to obtain the absolute frequency for each response value.\n"
849 "The actual data are the response at each frequency grid point.\n"
850 "\n"
851 "There are here two options. If the array has length 1, the same\n"
852 "response is applied for all channels. Accordingly, this assumes that\n"
853 "all channels have the same response function. The second option is to\n"
854 "specify the response for each channel seperately. This signifies that\n"
855 "the *backend_channel_response* array has either 1 or n elements, where\n"
856 "n is the length of *f_backend*\n"
857 "\n"
858 "Usage: Set by the user.\n"
859 "\n"
860 "Size: Array[N_ch]\n"
861 " GriddedField1 \n "
862 " [N_f] \n"
863 " [N_f] \n"),
864 GROUP("ArrayOfGriddedField1")));
865
866 wsv_data.push_back(WsvRecord(
867 NAME("backend_channel_response_multi"),
869 "As *backend_channel_response* but describes an instrument with\n"
870 "muliple mixer/receiver chains.\n"
871 "\n"
872 "See *f_backend_multi* for when to use this variable and size\n"
873 "constraints.\n"
874 "\n"
875 "Usage: Set by the user.\n "),
876 GROUP("ArrayOfArrayOfGriddedField1")));
877
878 wsv_data.push_back(WsvRecord(
879 NAME("batch_atm_fields_compact"),
881 "An array of compact atmospheric states.\n"
882 "\n"
883 "This is used to hold a set of *atm_fields_compact* for batch\n"
884 "calculations. For further information see *atm_fields_compact*.\n"),
885 GROUP("ArrayOfGriddedField4")));
886
887 wsv_data.push_back(WsvRecord(
888 NAME("band_identifiers"),
890 "An array of identifiers for bands.\n"
891 "\n"
892 "Used by line mixing calculations to identify which bands to match to the\n"
893 "line database.\n"),
894 GROUP("ArrayOfQuantumIdentifier")));
895
896 wsv_data.push_back(WsvRecord(
897 NAME("batch_cloudbox_limits"),
898 DESCRIPTION("An array of *cloudbox_limits*.\n"
899 "\n"
900 "This is used to hold a set of *cloudbox_limits* for batch\n"
901 "calculations. \n"),
902 GROUP("ArrayOfArrayOfIndex")));
903
904 wsv_data.push_back(WsvRecord(
905 NAME("batch_pnd_fields"),
906 DESCRIPTION("An array of compact pnd states.\n"
907 "\n"
908 "This is used to hold a set of 1D *pnd_field* for batch\n"
909 "calculations. \n"),
910 GROUP("ArrayOfTensor4")));
911
912 wsv_data.push_back(WsvRecord(
913 NAME("channel2fgrid_indexes"),
915 "Definition of backend frequency response, link to *f_grid*.\n"
916 "\n"
917 "The WSV is used to describe the frequency response of backend channels\n"
918 "together with the accompanying WSV *channel2fgrid_weights*.\n"
919 "\n"
920 "This WSV links each channel to the elements of *f_grid*. In short it\n"
921 "lists what elements of *f_grid* that are relevant for each channel.\n"
922 "\n"
923 "More precisely, the first dimension gives the number of output channels.\n"
924 "Each ArrayOfIndex gives the index of the values in *f_grid* associated\n"
925 "with the channel of concern. For a pure double-sideband receiver, where\n"
926 "there is one monochromatic frequency per passband, this argument could\n"
927 "look like: [[0,5],[1,4],[2,3],[7,8],[7,8]].\n"),
928 GROUP("ArrayOfArrayOfIndex")));
929
930 wsv_data.push_back(WsvRecord(
931 NAME("channel2fgrid_weights"),
933 "Definition of backend frequency response, weighting of *f_grid*.\n"
934 "\n"
935 "The WSV is used to describe the frequency response of backend channels\n"
936 "together with the accompanying WSV *channel2fgrid_indexes*.\n"
937 "\n"
938 "This WSV shall have excatly the same sizes as *channel2fgrid_indexes*.\n"
939 "Each element gives the weight to be assigned to the associated\n"
940 "monochromatic frequency. \n"),
941 GROUP("ArrayOfVector")));
942
943 wsv_data.push_back(WsvRecord(
944 NAME("cloudbox_checked"),
946 "OK-flag for variables associated with the cloudbox.\n"
947 "\n"
948 "This variable flags that cloudbox variables are defined in a formally\n"
949 "and practically correct way. For example, that there is sufficient\n"
950 "space between the cloudbox and edges of the model atmosphere (for\n"
951 "2D and 3D). Pure clear-sky variables are covered by\n"
952 "*atmfields_checked* (and *atmgeom_checked*).\n"
953 "\n"
954 "Relevant checks are performed by *cloudbox_checkedCalc. Only the\n"
955 "value 1 is taken as OK.\n"),
956 GROUP("Index")));
957
958 wsv_data.push_back(WsvRecord(
959 NAME("cloudbox_field"),
961 "The spectral radiance field inside the cloudbx.\n"
962 "\n"
963 "This variable is used to store the radiance field inside the cloud\n"
964 "box, probably determined by a scattering solver method.\n"
965 "\n"
966 "That is, this variable matches *spectral_radiance_field* but holds\n"
967 "a field that is restricted to the cloud box.\n"
968 "\n"
969 "Unit: W / (m^2 Hz sr) for each Stokes component.\n"
970 "\n"
971 " Size: [f_grid,\n"
972 " p_grid, \n"
973 " lat_grid, \n"
974 " lon_grid, \n"
975 " za_grid,\n"
976 " aa_grid,\n"
977 " stokes_dim ]\n"
978 "\n"
979 "Note: For 1D, the size of the latitude, longitude and azimuth\n"
980 "dimension (N_aa) are all 1.\n"),
981 GROUP("Tensor7")));
982
983 wsv_data.push_back(WsvRecord(
984 NAME("cloudbox_field_mono"),
986 "Monochromatic radiation field inside the cloudbox.\n"
987 "\n"
988 "This variable is used to store the monochromatic radiation field \n"
989 "inside the cloudbox which is found by an iterative solution (DOIT).\n"
990 "Refer to AUG for further information.\n"
991 "\n"
992 "Usage: Method output. \n"
993 "\n"
994 "Unit: W / (m^2 Hz sr) for each Stokes component.\n"
995 "\n"
996 "Size: [(cloudbox_limits[1] - cloudbox_limits[0]) +1, \n"
997 " (cloudbox_limits[3] - cloudbox_limits[2]) +1, \n"
998 " (cloudbox_limits[5] - cloudbox_limits[4]) +1, \n"
999 " N_za, N_aa, N_i ]\n"
1000 "\n"
1001 "Note: For 1D, the size of the azimuth angle dimension (N_aa) is\n"
1002 "always 1.\n"),
1003 GROUP("Tensor6")));
1004
1005 wsv_data.push_back(WsvRecord(
1006 NAME("cloudbox_field_mono_old"),
1008 "As *cloudbox_field_mono* but from previous iteration.\n"
1009 "\n"
1010 "This variable is used to store the intensity field inside the\n"
1011 "cloudbox while performing the iteration. One has to store the\n"
1012 "intensity field of the previous iteration to be able to do the \n"
1013 "convergence test after each iteration.\n"
1014 "Refer to AUG for more information.\n"
1015 "\n"
1016 "Usage: Method output. \n"
1017 "\n"
1018 "Unit: W / (m^2 Hz sr) for each Stokes component.\n"
1019 "\n"
1020 "Size: [(cloudbox_limits[1] - cloudbox_limits[0]) +1, \n"
1021 " (cloudbox_limits[3] - cloudbox_limits[2]) +1, \n"
1022 " (cloudbox_limits[5] - cloudbox_limits[4]) +1, \n"
1023 " N_za, N_aa, N_i ]\n"),
1024 GROUP("Tensor6")));
1025
1026 wsv_data.push_back(WsvRecord(
1027 NAME("cloudbox_limits"),
1029 "The limits of the cloud box.\n"
1030 "\n"
1031 "This variable defines the extension of the cloud box. The cloud box \n"
1032 "is defined to be rectangular in the used coordinate system, with \n"
1033 "limits exactly at points of the involved grids. This means, for \n"
1034 "example, that the vertical limits of the cloud box are two pressure \n"
1035 "levels. For 2D, the angular extension of the cloud box is between \n"
1036 "two points of the latitude grid, and likewise for 3D but then also \n"
1037 "with a longitude extension between two grid points. The latitude and\n"
1038 "longitude limits for the cloud box cannot be placed at the end \n"
1039 "points of the corresponding grid as it must be possible to calculate\n"
1040 "the incoming intensity field.\n"
1041 "\n"
1042 "The variable *cloudbox_limits* is an array of index value with\n"
1043 "length twice *atmosphere_dim*. For each dimension there is a lower \n"
1044 "limit and an upper limit. The order of the dimensions is as usual \n"
1045 "pressure, latitude and longitude. The upper limit index must be \n"
1046 "greater then the lower limit index. For example, \n"
1047 "*cloudbox_limits* = [0 5 4 11 4 11] means that cloud box extends\n"
1048 "between pressure levels 0 and 5, and latitude and longitude points 4\n"
1049 "and 11.\n"
1050 "\n"
1051 "If *cloudbox_on* = 0, the content of this variable is neglected, but\n"
1052 "it must be initiated to some dummy values.\n"
1053 "\n"
1054 "See further the ARTS user guide (AUG). Use the index to find where\n"
1055 "this variable is discussed. The variable is listed as a subentry to\n"
1056 "\"workspace variables\".\n"
1057 "\n"
1058 "Usage: Set by the user, either directly or using a method\n"
1059 " checking the extension of scattering particles.\n"
1060 "\n"
1061 "Unit: Index values.\n"
1062 "\n"
1063 "Size: [ 2 * atmosphere_dim ]\n"),
1064 GROUP("ArrayOfIndex")));
1065
1066 wsv_data.push_back(WsvRecord(
1067 NAME("cloudbox_on"),
1069 "Flag to activate the cloud box.\n"
1070 "\n"
1071 "Scattering calculations are confined to a part of the atmosphere\n"
1072 "denoted as the cloud box. The extension of the cloud box is given by\n"
1073 "*cloudbox_limits*. This variable tells methods if a cloud box is\n"
1074 "activated or not. \n"
1075 "\n"
1076 "See further the ARTS user guide (AUG). Use the index to find where\n"
1077 "this variable is discussed. The variable is listed as a subentry to\n"
1078 "\"workspace variables\".\n"
1079 "\n"
1080 "Usage: Set by the user.\n"
1081 "\n"
1082 "Unit: Boolean.\n"),
1083 GROUP("Index")));
1084
1085 wsv_data.push_back(WsvRecord(
1086 NAME("complex_refr_index"),
1088 "Complex refractive index (n) data.\n"
1089 "\n"
1090 "The variable works as a lookup-table of complex refractive index.\n"
1091 "The matter type (water, ice ...) is unspecified, it is up to the\n"
1092 "user to fill the variable with data for the expected matter.\n"
1093 "This variable type can be used to describe n of both the surface and\n"
1094 "atmospheric particles. For the surface, a dedicated variable exists:\n"
1095 "*surface_complex_refr_index*.\n"
1096 "\n"
1097 "The column dimension has always size 2, where the first and second\n"
1098 "column holds the real and imaginary part of n, respectively. The row\n"
1099 "dimension matches temperature, and the page dimension is frequency.\n"
1100 "Both the temperature and frequency dimensions grids are allowed to\n"
1101 "have length 1, which is interpreted as n being constant in that\n"
1102 "dimension.\n"
1103 "\n"
1104 "When mapping these data to the required frequencies and temperatures\n"
1105 "a bi-linear interpolation is applied.\n"
1106 "\n"
1107 "Unit: -\n"
1108 "\n"
1109 "Dimensions: \n"
1110 " Vector f_grid[N_f]\n"
1111 " Vector T_grid[N_T]\n"
1112 " ArrayOfString Complex[2]\n"
1113 " Tensor3 data[N_f][N_T][2]\n"),
1114 GROUP("GriddedField3")));
1115
1116 wsv_data.push_back(WsvRecord(
1117 NAME("covmat_block"),
1119 "Holds matrices used to set blocks in *covmat_sx* and *covmat_se*.\n"
1120 "\n"
1121 "The matrix contained in this block will be added to the blocks in\n"
1122 "in *covmat_sx* and *covmat_se* by the corresponding WSMs. Its dimensions\n"
1123 "must agree with gridpoints of the correlated retrieval quantities."
1124 "\n"
1125 "Usage: Used by the retrievalAdd functions.\n"),
1126 GROUP("Sparse")));
1127
1128 wsv_data.push_back(WsvRecord(
1129 NAME("covmat_inv_block"),
1131 "Holds matrices used to set the inverse blocks in *covmat_sx* and *covmat_se*.\n"
1132 "\n"
1133 "The matrix contained in this block will be used as the inverse of the matrix\n"
1134 "contained in covmat_block.\n"
1135 "\n"
1136 "Usage: Used by the retrievalAdd functions.\n"),
1137 GROUP("Sparse")));
1138
1139 wsv_data.push_back(WsvRecord(
1140 NAME("covmat_se"),
1142 "Covariance matrix for observation uncertainties.\n"
1143 "\n"
1144 "This matrix (Se) describes the uncertainty of the measurement vector (*y*),\n"
1145 "and can be writtenn as\n"
1146 " Se = Seps + Kb * Sb * Kb',\n"
1147 "where Seps describes direct measurement errors (such as thermal noise),\n"
1148 "Kb is Jacobian for forward model parameters, and Sb describes the uncertainty\n"
1149 "of the forwatrd model parameters.\n"
1150 "\n"
1151 "Usage: Used by inversion methods.\n"
1152 "\n"
1153 "Dimensions: \n"
1154 " [ y, y ]\n"),
1155 GROUP("CovarianceMatrix")));
1156
1157 wsv_data.push_back(WsvRecord(
1158 NAME("covmat_sx"),
1160 "Covariance matrix of a priori distribution\n"
1161 "\n"
1162 "This covariance matrix describes the Gaussian a priori distribution\n"
1163 "for an OEM retrieval. It is represented using a symmetric block matrix.\n"
1164 "covmat_sx can be used in two ways: Either with a block for each retrieval\n"
1165 "quantity or with a single block containing the full covariance matrix.\n"
1166 "\n"
1167 "Using a single block for each retrieval quantity has is advantageous for\n"
1168 "if the retrieval quantities are assumed to be independent. In this case,\n"
1169 "the covariance blocks can be added separately for each quantity and will\n"
1170 "allow optimizing matrix multiplications and inverses required for the OEM\n"
1171 "calculation.\n"
1172 "\n"
1173 "The other case of using a single-block covariance matrix is supported\n"
1174 "for convenience as well.\n"
1175 "\n"
1176 "Usage: Used by inversion methods.\n"
1177 "\n"
1178 "Dimensions: \n"
1179 " [ x, x ]\n"),
1180 GROUP("CovarianceMatrix")));
1181
1182 wsv_data.push_back(WsvRecord(
1183 NAME("covmat_so"),
1185 "Covariance matrix describing the retrieval error due to uncertainties of\n"
1186 "the observation system.\n"
1187 "\n"
1188 "That is: So = G * Se * G', where G is the gain matrix (*dxdy*).\n"
1189 "\n"
1190 "Usage: Set by the covmat_soCalc workspace method to characterize the error.\n"
1191 "of a successful OEM calculation.\n"
1192 "\n"
1193 "Dimensions:\n"
1194 " [x,x]\n"),
1195 GROUP("Matrix")));
1196
1197 wsv_data.push_back(WsvRecord(
1198 NAME("covmat_ss"),
1200 "Covariance matrix describing the retrieval error due to smoothing.\n"
1201 "\n"
1202 "That is: Ss = (A-I) * Sx * (A-I)', where A is the averaging kernel "
1203 "matrix (*avk*).\n"
1204 "\n"
1205 "Usage: Set by the covmat_ssCalc workspace method to characterize the.\n"
1206 "errors of a successful OEM calculation."
1207 "\n"
1208 "Dimensions:\n"
1209 " [x,x]\n"),
1210 GROUP("Matrix")));
1211
1212 wsv_data.push_back(WsvRecord(
1213 NAME("dabs_coef_dx"),
1215 "The partial derivatives of the matrix of total scalar absorption\n"
1216 "coefficients.\n"
1217 "\n"
1218 "Contains the derivative of the gas absorption summed over all\n"
1219 "species as a function of *f_grid* and *abs_p*, i.e., for a single\n"
1220 "atmospheric profile for some parameter.\n"
1221 "\n"
1222 "This variable is not used explicitly in a standard calculation, where\n"
1223 "absorption comes from the lookup table *abs_lookup*. However, it is\n"
1224 "useful for testing the methods that actually calculate line-by-line\n"
1225 "absorption, which have this variable as output. These methods are\n"
1226 "called internally by the method *abs_lookupCalc*, which generates\n"
1227 "the lookup table.\n"
1228 "\n"
1229 "Dimensions: [n_quantities][f_grid, abs_p]\n"
1230 "\n"
1231 "Unit: 1/m/quantity\n"),
1232 GROUP("ArrayOfMatrix")));
1233
1234 wsv_data.push_back(WsvRecord(
1235 NAME("dabs_xsec_per_species_dx"),
1237 "Derivative of *abs_xsec_per_species* with respect to retrieval\n"
1238 "quantities.\n"
1239 "\n"
1240 "The variable gives the derivative of *abs_xsec_per_species* with\n"
1241 "respect to some variables (but not all jacobian variables). Handled\n"
1242 "are only variables that are involved in xsec and cannot be\n"
1243 "calculated at transmission level\n"
1244 "\n"
1245 "Usage: Output of *abs_xsec_agenda*.\n"
1246 "\n"
1247 "Dimensions: \n"
1248 " [*abs_species*][n_quantities][*f_grid*, *abs_p* ]\n"),
1249 GROUP("ArrayOfArrayOfMatrix")));
1250
1251 wsv_data.push_back(WsvRecord(
1252 NAME("dobatch_calc_agenda"),
1254 "Agenda defining the calculations to perform for each batch case.\n"),
1255 GROUP("Agenda")));
1256
1257 wsv_data.push_back(WsvRecord(
1258 NAME("dobatch_cloudbox_field"),
1260 "Batch of radiation fields.\n"
1261 "\n"
1262 "Each element of *dobatch_cloudbox_field* corresponds to a radiation field.\n"
1263 "See further *DOBatchCalc*.\n"
1264 "\n"
1265 "Usage: Most commonly produced by *DOBatchCalc*.\n"
1266 "\n"
1267 "Unit: See *cloudbox_field*.\n"
1268 "\n"
1269 "Dimensions: Number of array elements equals number of batch cases.\n"),
1270 GROUP("ArrayOfTensor7")));
1271
1272 wsv_data.push_back(WsvRecord(
1273 NAME("dobatch_radiance_field"),
1275 "Batch of radiance fields.\n"
1276 "\n"
1277 "Each element of *dobatch_radiance_field* corresponds to a radiance field.\n"
1278 "See further *DOBatchCalc*.\n"
1279 "\n"
1280 "Usage: Most commonly produced by *DOBatchCalc*.\n"
1281 "\n"
1282 "Unit: See *radiance_field*.\n"
1283 "\n"
1284 "Dimensions: Number of array elements equals number of batch cases.\n"),
1285 GROUP("ArrayOfTensor5")));
1286
1287 wsv_data.push_back(WsvRecord(
1288 NAME("dobatch_irradiance_field"),
1290 "Batch of irradiance fields.\n"
1291 "\n"
1292 "Each element of *dobatch_irradiance_field* corresponds to a irradiance field.\n"
1293 "See further *DOBatchCalc*.\n"
1294 "\n"
1295 "Usage: Most commonly produced by *DOBatchCalc*.\n"
1296 "\n"
1297 "Unit: See *irradiance_field*.\n"
1298 "\n"
1299 "Dimensions: Number of array elements equals number of batch cases.\n"),
1300 GROUP("ArrayOfTensor4")));
1301
1302 wsv_data.push_back(WsvRecord(
1303 NAME("dobatch_spectral_irradiance_field"),
1305 "Batch of spectral irradiance fields.\n"
1306 "\n"
1307 "Each element of *dobatch_spectral_irradiance_field* corresponds to a\n"
1308 "spectral irradiance field.\n"
1309 "See further *DOBatchCalc*.\n"
1310 "\n"
1311 "Usage: Most commonly produced by *DOBatchCalc*.\n"
1312 "\n"
1313 "Unit: See *spectral_irradiance_field*.\n"
1314 "\n"
1315 "Dimensions: Number of array elements equals number of batch cases.\n"),
1316 GROUP("ArrayOfTensor5")));
1317
1318 wsv_data.push_back(WsvRecord(
1319 NAME("diy_dx"),
1321 "Derivative of *iy* with respect to retrieval quantities.\n"
1322 "\n"
1323 "The variable gives the derivative if *iy* with respect to some\n"
1324 "variables (but not all jacobian variables). Handled are only variables\n"
1325 "affecting monochromatic pencil beam radiances where an (semi-)\n"
1326 "analytical expression can be applied (and that this calculation way\n"
1327 "has been selected when the jacobian was been set-up).\n"
1328 "\n"
1329 "The values in *diy_dx* considers the retrieval unit selected (such as\n"
1330 "\"nd\"), but no transformations are applied.\n"
1331 "\n"
1332 "Usage: Output of *iy_main_agenda*.\n"
1333 "\n"
1334 "Dimensions: \n"
1335 " [n_quantities][ n_retrieval_points, f_grid, stokes_dim ]\n"),
1336 GROUP("ArrayOfTensor3")));
1337
1338 wsv_data.push_back(WsvRecord(
1339 NAME("dpnd_data_dx"),
1341 "Partial derivates of *pnd_data*.\n"
1342 "\n"
1343 "The variable gives the particle derivate of *pnd_data* with respect\n"
1344 "to the quantities set in *dpnd_data_dx_names*.\n"
1345 "\n"
1346 "Dimensions: [ n_quantities, n_points, n_scattering_elements ]\n"),
1347 GROUP("Tensor3")));
1348
1349 wsv_data.push_back(WsvRecord(
1350 NAME("dpnd_data_dx_names"),
1352 "Selection of partial derivatives of *pnd_data*.\n"
1353 "\n"
1354 "This variable tells an element in *pnd_agenda_array* for which\n"
1355 "quantities partial derivatives shall be calculated.\n"
1356 "\n"
1357 "Dimensions: [ n_quantities ]\n"),
1358 GROUP("ArrayOfString")));
1359
1360 wsv_data.push_back(WsvRecord(
1361 NAME("dpnd_field_dx"),
1363 "Partial derivatives of *pnd_field*.\n"
1364 "\n"
1365 "The variable gives the particle derivative of *pnd_field* with respect\n"
1366 "to scattering species variables included in *jacobian_quantities*.\n"
1367 "\n"
1368 "The length of this array shall match the size of *jacobian_quantities*.\n"
1369 "For retrieval quantities that are not scattering species, the matching\n"
1370 "Tensor4 is of no relevance and must be set to be empty.\n"
1371 "\n"
1372 "Dimensions: [n_quantities][ n_scattering_elements, n_p, n_lat, n_lon ]\n"),
1373 GROUP("ArrayOfTensor4")));
1374
1375 wsv_data.push_back(WsvRecord(
1376 NAME("dpropmat_clearsky_dx"),
1378 // FIXMEDOC
1379 "Partial derivative of absorption coefficients.\n"
1380 "\n"
1381 "This contains the partial derivative of absorption coefficients for\n"
1382 "one point in the atmosphere (one set of pressure, temperature, zn"
1383 "magnetic field, and VMR values) with respect to one of the input\n"
1384 "parameters.\n"
1385 "\n"
1386 "Dimension: [ n_quantities ] [naa, nza, nf, f(stokes_dim)]\n"
1387 "\n"
1388 "*jacobian_quantities* should be used to set the input variable for\n"
1389 "partial derivation\n"
1390 "\n"
1391 "Unit: 1/m/jacobian_quantity\n"),
1392 GROUP("ArrayOfPropagationMatrix")));
1393
1394 wsv_data.push_back(WsvRecord(
1395 NAME("dpsd_data_dx"),
1397 "Partial derivates of *psd_data*.\n"
1398 "\n"
1399 "The variable gives the particle derivate of *psd_data* with respect\n"
1400 "to the quantities set in *dpnd_data_dx_names*.\n"
1401 "\n"
1402 "Dimensions: [ n_quantities, n_points, n_scattering_elements ]\n"),
1403 GROUP("Tensor3")));
1404
1405 wsv_data.push_back(WsvRecord(
1406 NAME("dnlte_source_dx"),
1408 "NLTE partial derivatives output is two parts: S*dB/dx+dS/dx*B.\n"
1409 "\n"
1410 "Dimensions: [ quantities ] [nza, naa, nf, stokes_dim] or [0]\n"
1411 "\n"
1412 "Unit: 1/m/jacobian_quantity\n"),
1413 GROUP("ArrayOfStokesVector")));
1414
1415 wsv_data.push_back(WsvRecord(
1416 NAME("doit_conv_flag"),
1418 "Flag for the convergence test.\n"
1419 "\n"
1420 "This variable is initialized with 0 inside the method \n"
1421 "*cloudbox_field_monoIterate*.\n"
1422 "If after an iteration the convergence test is fulfilled, 1 is \n"
1423 "assigned which means that the iteration is completed. \n"
1424 "\n"
1425 "Usage: Method output. \n"),
1426 GROUP("Index")));
1427
1428 wsv_data.push_back(
1429 WsvRecord(NAME("doit_conv_test_agenda"),
1430 DESCRIPTION("Agenda executing the DOIT convergence test.\n"),
1431 GROUP("Agenda")));
1432
1433 wsv_data.push_back(WsvRecord(
1434 NAME("doit_is_initialized"),
1435 DESCRIPTION("Flag to determine if *DoitInit* was called.\n"
1436 "\n"
1437 "This flag is checked by *DoitCalc* to make sure that\n"
1438 "*DoitInit* was called before.\n"),
1439 GROUP("Index")));
1440
1441 wsv_data.push_back(
1442 WsvRecord(NAME("doit_iteration_counter"),
1443 DESCRIPTION("Counter for number of iterations.\n"
1444 "\n"
1445 "This variable holds the number of iterations \n"
1446 "while solving the VRTE using the DOIT method. \n"),
1447 GROUP("Index")));
1448
1449 wsv_data.push_back(WsvRecord(
1450 NAME("doit_mono_agenda"),
1451 DESCRIPTION("Agenda performing monochromatic DOIT calculation.\n"),
1452 GROUP("Agenda")));
1453
1454 wsv_data.push_back(WsvRecord(
1455 NAME("doit_rte_agenda"),
1457 "Agenda performing the DOIT cloudbox radiative transfer update.\n"),
1458 GROUP("Agenda")));
1459
1460 wsv_data.push_back(WsvRecord(
1461 NAME("doit_scat_field_agenda"),
1463 "Agenda calculating the scattering integral field in DOIT.\n"),
1464 GROUP("Agenda")));
1465
1466 wsv_data.push_back(WsvRecord(
1467 NAME("doit_scat_field"),
1469 "Scattered field inside the cloudbox.\n"
1470 "\n"
1471 "This variable holds the value of the scattering integral for all\n"
1472 "points inside the cloudbox. For more information refer to AUG.\n"
1473 "\n"
1474 "Usage: Input to *cloudbox_fieldUpdate...*. \n"
1475 "\n"
1476 "Unit: W / (m^2 Hz sr) for each Stokes component.\n"
1477 "\n"
1478 "Size: [(cloudbox_limits[1] - cloudbox_limits[0]) +1, \n"
1479 " (cloudbox_limits[3] - cloudbox_limits[2]) +1, \n"
1480 " (cloudbox_limits[5] - cloudbox_limits[4]) +1, \n"
1481 " N_za, N_aa, N_i ]\n"),
1482 GROUP("Tensor6")));
1483
1484 wsv_data.push_back(
1485 WsvRecord(NAME("doit_za_grid_opt"),
1486 DESCRIPTION("Optimized zenith angle grid.\n"
1487 "\n"
1488 "Output of the method *doit_za_grid_optCalc*.\n"
1489 "\n"
1490 "Usage: Output of *doit_za_grid_optCalc*\n"
1491 "\n"
1492 "Unit: degrees \n"),
1493 GROUP("Vector")));
1494
1495 wsv_data.push_back(WsvRecord(
1496 NAME("doit_za_grid_size"),
1498 "Number of equidistant grid points of the zenith angle grid.\n"
1499 "\n"
1500 "Grid points are defined from 0 to 180 deg, for the scattering\n"
1501 "integral calculation.\n"
1502 "\n"
1503 "Usage: Output of *DOAngularGridsSet*.\n"),
1504 GROUP("Index")));
1505
1506 wsv_data.push_back(WsvRecord(
1507 NAME("doit_za_interp"),
1508 DESCRIPTION("Flag for interplation method in zenith angle dimension.\n"
1509 "\n"
1510 "0 - linear interpolation \n"
1511 "1 - cubic interpolation \n"
1512 "\n"
1513 "Usage: Set by user in *doit_za_interpSet*. \n"),
1514 GROUP("Index")));
1515
1516 wsv_data.push_back(WsvRecord(
1517 NAME("dsurface_emission_dx"),
1519 "The derivative of *surface_emission* with respect to quantities\n"
1520 "listed in *dsurface_names*.\n"
1521 "\n"
1522 "Usage: Used internally of radiative transfer methods\n"
1523 "\n"
1524 "Dimensions: [dsurface_names][f_grid, stokes_dim]\n"),
1525 GROUP("ArrayOfMatrix")));
1526
1527 wsv_data.push_back(WsvRecord(
1528 NAME("dsurface_names"),
1529 DESCRIPTION("Name of surface retrieval quantities.\n"
1530 "\n"
1531 "Usage: Used internally of radiative transfer methods\n"
1532 "\n"
1533 "Dimensions: [retrieval quantity]\n"),
1534 GROUP("ArrayOfString")));
1535
1536 wsv_data.push_back(WsvRecord(
1537 NAME("dsurface_rmatrix_dx"),
1539 "The derivative of *surface_rmatrix* with respect to quantities\n"
1540 "listed in *dsurface_names*.\n"
1541 "\n"
1542 "Usage: Used internally of radiative transfer methods\n"
1543 "\n"
1544 "Dimensions: [dsurface_names][surface_los, f_grid, stokes_dim, stokes_dim]\n"),
1545 GROUP("ArrayOfTensor4")));
1546
1547 wsv_data.push_back(WsvRecord(
1548 NAME("dxdy"),
1550 "Contribution function (or gain) matrix.\n"
1551 "\n"
1552 "This matrix is the partial derivative of the retrieved state vector\n"
1553 "with respect to the measurement vector (*y*).\n"
1554 "\n"
1555 "Usage: Used and set by inversion methods. \n"),
1556 GROUP("Matrix")));
1557
1558 wsv_data.push_back(WsvRecord(
1559 NAME("ecs_data"),
1561 "Error corrected sudden data\n"
1562 "\n"
1563 "Dimensions: [num IDs] [num Species]\n"),
1564 GROUP("MapOfErrorCorrectedSuddenData")));
1565
1566 wsv_data.push_back(WsvRecord(
1567 NAME("ext_mat"),
1569 "Total extinction matrix.\n"
1570 "\n"
1571 "This variable contains the extinction coefficient matrix, which\n"
1572 "is used in the RT calculation in the cloudbox. It is the physical\n"
1573 "extinction matrix which includes particle extinction for all chosen\n"
1574 "scattering species and gaseous extinction for all chosen gaseous species.\n"
1575 "\n"
1576 "See the ARTS user guide (AUG) for further information. Use the index to\n"
1577 "find where this variable is discussed. The variable is listed as a\n"
1578 "subentry to \"workspace variables\".\n"
1579 "\n"
1580 "Usage: Output of *opt_prop_bulkCalc* \n"
1581 "\n"
1582 "Unit: m^2\n" //FIXME: really m2? not 1/m?
1583 "\n"
1584 "Dimensions: [f_grid, stokes_dim, stokes_dim]\n"),
1585 GROUP("PropagationMatrix")));
1586
1587 wsv_data.push_back(WsvRecord(
1588 NAME("ext_mat_spt"),
1590 "Extinction matrix for all individual scattering elements.\n"
1591 "\n"
1592 "This variable contains the elements of the extinction matrix of all\n"
1593 "individual scattering elements for a given propagation direction. It is\n"
1594 "calculated input as well as the output of the agenda *spt_calc_agenda*.\n"
1595 "\n"
1596 "Usage: Output of *spt_calc_agenda* \n"
1597 "\n"
1598 "Unit: m^2\n" //FIXME: really m2? not 1/m?
1599 "\n"
1600 "Dimensions: [number of scattering elements, stokes_dim, stokes_dim]\n"),
1601 GROUP("ArrayOfPropagationMatrix")));
1602
1603 wsv_data.push_back(WsvRecord(
1604 NAME("file_index"),
1606 "Index number for files.\n"
1607 "\n"
1608 "See *WriteXMLIndexed* for further information.\n"
1609 "\n"
1610 "Usage: Input to *WriteXMLIndexed* and *ReadXMLIndexed*. \n"),
1611 GROUP("Index")));
1612
1613 wsv_data.push_back(WsvRecord(NAME("forloop_agenda"),
1614 DESCRIPTION("Agenda performing a for loop.\n"),
1615 GROUP("Agenda")));
1616
1617 wsv_data.push_back(WsvRecord(
1618 NAME("forloop_index"),
1620 "The index for for-loops.\n"
1621 "\n"
1622 "This is the index that is used by method *ForLoop* to loop over\n"
1623 "*forloop_agenda*. \n"),
1624 GROUP("Index")));
1625
1626 wsv_data.push_back(WsvRecord(NAME("fos_iyin_za_angles"),
1627 DESCRIPTION("So far just testing of FOS ...\n"),
1628 GROUP("Vector")));
1629
1630 wsv_data.push_back(WsvRecord(NAME("fos_scatint_angles"),
1631 DESCRIPTION("So far just testing of FOS ...\n"),
1632 GROUP("Matrix")));
1633
1634 wsv_data.push_back(WsvRecord(
1635 NAME("f_backend"),
1637 "The frequency position of each backend (spectrometer) channel.\n"
1638 "\n"
1639 "Usage: Set by the user.\n "
1640 "\n"
1641 "Unit: Hz\n"),
1642 GROUP("Vector")));
1643
1644 wsv_data.push_back(WsvRecord(
1645 NAME("f_backend_multi"),
1647 "As *f_backend* but describes an instrument with muliple\n"
1648 "mixer/receiver chains.\n"
1649 "\n"
1650 "This variable is needed when e.g. the receiver has several mixers\n"
1651 "or the the receiver measures several polarisation and the channels\n"
1652 "differ in position or response function. \n"
1653 "\n"
1654 "The array has one element for each \"receiver chain\". The array\n"
1655 "length must match *backend_channel_response_multi*, and possibly\n"
1656 "also *lo_multi*.\n"
1657 "\n"
1658 "Usage: Set by the user.\n "
1659 "\n"
1660 "Unit: Hz\n"),
1661 GROUP("ArrayOfVector")));
1662
1663 wsv_data.push_back(WsvRecord(
1664 NAME("f_grid"),
1666 "The frequency grid for monochromatic pencil beam calculations.\n"
1667 "\n"
1668 "Usage: Set by the user.\n "
1669 "\n"
1670 "Unit: Hz\n"),
1671 GROUP("Vector")));
1672
1673 wsv_data.push_back(WsvRecord(
1674 NAME("f_index"),
1676 "Frequency index.\n"
1677 "\n"
1678 "Not all methods handle all monochromatic frequencies (of *f_grid*) in\n"
1679 "parellel and this variable is used for communication between methods,\n"
1680 "holding the index of the frequency treated presently.\n"
1681 "\n"
1682 "In some contexts, a negative f_index means all frequencies.\n"
1683 "\n"
1684 "Usage: Method output.\n"),
1685 GROUP("Index")));
1686
1687 wsv_data.push_back(WsvRecord(
1688 NAME("geo_pos"),
1690 "Geo-position of a measurement.\n"
1691 "\n"
1692 "An empty vector is allowed, then flagging that no geo-positioning\n"
1693 "has been performed.\n"
1694 "\n"
1695 "Otherwise, this should be a vector having length 5. The elements are:\n"
1696 " altitude\n"
1697 " latitude\n"
1698 " longitide\n"
1699 " zenith angle\n"
1700 " azimuth angle\n"
1701 "\n"
1702 "Dimensions: 0 or 5\n"
1703 "\n"
1704 "Unit: [ m, deg, deg, deg, deg ]\n"),
1705 GROUP("Vector")));
1706
1707 wsv_data.push_back(WsvRecord(
1708 NAME("g0"),
1710 "Gravity at zero altitude.\n"
1711 "\n"
1712 "This variable is \"little g\" at the reference ellipsiod. That is,\n"
1713 "for Earth this is a value around 9.81 m/s2\n"),
1714 GROUP("Numeric")));
1715
1716 wsv_data.push_back(
1717 WsvRecord(NAME("g0_agenda"),
1718 DESCRIPTION("Agenda providing the gravity constant.\n"),
1719 GROUP("Agenda")));
1720
1721 wsv_data.push_back(WsvRecord(
1722 NAME("geo_pos_agenda"),
1724 "Agenda deriving the geo-position of a pencil beam calculation.\n"),
1725 GROUP("Agenda")));
1726
1727 wsv_data.push_back(WsvRecord(
1728 NAME("heating_rates"),
1730 "The heating rates of atmospheric layers.\n"
1731 "\n"
1732 "The heating rate is defined as the rate of temperature change of an \n"
1733 "atmospheric layer due to heating by absorption of radiation or if it\n"
1734 "is negative due to loss of energy by emission of radiation.\n"
1735 "\n"
1736 "Units: K s^-1\n"
1737 "\n"
1738 "Size: [ p_grid, \n"
1739 " lat_grid, \n"
1740 " lon_grid ]\n"),
1741 GROUP("Tensor3")));
1742
1743 wsv_data.push_back(
1744 WsvRecord(NAME("hitran_xsec_data"),
1745 DESCRIPTION("Data for Hitran cross section species.\n"),
1746 GROUP("ArrayOfXsecRecord")));
1747
1748 wsv_data.push_back(WsvRecord(
1749 NAME("instrument_pol"),
1751 "Definition of the polarisation of an instrument.\n"
1752 "\n"
1753 "The default for output is to give data for the selected Stokes\n"
1754 "elements (1:stokes_dim). This variable defines the polarisations\n"
1755 "that are actually measured, or are transmitted.\n"
1756 "\n"
1757 "The polarisation states/components are coded as\n"
1758 " 0 = Undefined.\n"
1759 " 1 = I, total intensity.\n"
1760 " 2 = Q, second Stokes component, Iv - Ih.\n"
1761 " 3 = U, third Stokes component, I+45 - I-45.\n"
1762 " 4 = V, forth Stokes component, Irc - Ilc\n"
1763 " 5 = Iv, intensity of vertically polarised component.\n"
1764 " 6 = Ih, intensity of horizontally polarised component.\n"
1765 " 7 = I+45, intensity of +45 deg linearly polarised component.\n"
1766 " 8 = I-45, intensity of -45 deg linearly polarised component.\n"
1767 " 9 = Ilhc, intensity of left-hand circularly polarised component.\n"
1768 " 10 = Irhc, intensity of right-hand circularly polarised component.\n"
1769 "\n"
1770 "See the documentation for definition of the Stokes vector and the\n"
1771 "different components.\n"
1772 "\n"
1773 "If the instrument measures, or transmits, vertical and horizontal\n"
1774 "components, this variable shall accordingly be set to [5,6].\n"
1775 "\n"
1776 "Conversion to Planck-BT of components 2-4 requires that component\n"
1777 "1 is kept, and must be included as first element.\n"
1778 "\n"
1779 "The shift from the Stokes vector can be made at any stage when of the\n"
1780 "sensor response set-up. The responses used must of course be adopted\n"
1781 "correspondingly. Or reversed, if the antenna response is defined for\n"
1782 "Iv or Ih it could be useful to shift polarisation as first sensor\n"
1783 "operation.\n"
1784 "\n"
1785 "Usage: Set by the user.\n"),
1786 GROUP("ArrayOfIndex")));
1787
1788 wsv_data.push_back(WsvRecord(
1789 NAME("instrument_pol_array"),
1791 "Multiple definition of instrument polarisation.\n"
1792 "\n"
1793 "Defined as *instrument_pol* but used when multiple polarisations\n"
1794 "are possible/required.\n"
1795 "\n"
1796 "Usage: Set by the user.\n"),
1797 GROUP("ArrayOfArrayOfIndex")));
1798
1799 wsv_data.push_back(WsvRecord(
1800 NAME("inversion_iteration_counter"),
1802 "Iteration counter variable for *inversion_iterate_agenda*.\n"),
1803 GROUP("Index")));
1804
1805 wsv_data.push_back(WsvRecord(
1806 NAME("inversion_iterate_agenda"),
1808 "Agenda recalculating spectra and Jacobian for iterative inversion methods.\n"),
1809 GROUP("Agenda")));
1810
1811 wsv_data.push_back(WsvRecord(
1812 NAME("irradiance_field"),
1814 "Irradiance field also known as flux density.\n"
1815 "\n"
1816 "Radiant flux received by a surface per unit area for each hemisphere.\n"
1817 "The last dimension denotes the hemispheres. The first component is\n"
1818 "the downward irradiance and the second component is the upward irradiance\n"
1819 "\n"
1820 "Units: W m^-2\n"
1821 "\n"
1822 "Size: [ p_grid, \n"
1823 " lat_grid, \n"
1824 " lon_grid, \n"
1825 " 2 ]\n"),
1826 GROUP("Tensor4")));
1827
1828 wsv_data.push_back(
1829 WsvRecord(NAME("isotopologue_ratios"),
1830 DESCRIPTION("Contains the isotopologue ratios.\n"
1831 "\n"
1832 "This variable can be set to default values by\n"
1833 "calling *isotopologue_ratiosInitFromBuiltin*\n"),
1834 GROUP("SpeciesIsotopologueRatios")));
1835
1836 wsv_data.push_back(WsvRecord(
1837 NAME("iy"),
1839 "Monochromatic pencil beam radiance spectrum.\n"
1840 "\n"
1841 "This variable holds a single spectrum, with values corresponding\n"
1842 "to infinite frequency and spatial resolution (compare to *y*).\n"
1843 "\n"
1844 "The variable is used to represent spectra at all positions of the\n"
1845 "propagation path and can e.g. temporarily hold radiation entering\n"
1846 "the atmosphere from space.\n"
1847 "\n"
1848 "Usage: Used by radiative transfer methods.\n"
1849 "\n"
1850 "Unit: For passive observations, as selected by *iy_unit*.\n"
1851 " For transmission calculations, same as for transmitted\n"
1852 " signal.\n"
1853 "\n"
1854 "Dimensions: [ f_grid, stokes_dim ]\n"),
1855 GROUP("Matrix")));
1856
1857 wsv_data.push_back(WsvRecord(
1858 NAME("iyb"),
1860 "Monochromatic pencil beam data for one measurement block.\n"
1861 "\n"
1862 "The data for all *iy* of a measurement block appended to a vector,\n"
1863 "following the sorting order used for *y*.\n"
1864 "\n"
1865 "Usage: Used internally.\n"
1866 "\n"
1867 "Unit: W / (m^2 Hz sr) or transmittance.\n"
1868 "\n"
1869 "Dimensions: [ nlos * nf * stokes_dim ] where nlos is number of rows in\n"
1870 " mblock_dlos_grid, and nf is length of f_grid.\n"),
1871 GROUP("Vector")));
1872
1873 wsv_data.push_back(WsvRecord(
1874 NAME("iy_agenda_call1"),
1876 "Flag to handle recursive calls of *iy_main_agenda*\n"
1877 "\n"
1878 "The agenda *iy_main_agenda* can be used recursively and this flag\n"
1879 "is used to tell the methods inside the agenda which is the primary\n"
1880 " call. This is handled automatically for methods using\n"
1881 "*iy_main_agenda*, such as *yCalc*, but the user must set this\n"
1882 "variable to 1 if the agenda is called directly inside the control\n"
1883 "file (which should be a rare case).\n"),
1884 GROUP("Index")));
1885
1886 wsv_data.push_back(WsvRecord(
1887 NAME("iy_aux"),
1889 "Data auxiliary to *iy*.\n"
1890 "\n"
1891 "Different data beside the direct result of the radiative transfer\n"
1892 "calculations (*iy*) can be obtained by this variable. These auxilary\n"
1893 "data are selected by *iy_aux_vars*.\n"
1894 "\n"
1895 "Usage: Provided by some radiative transfer methods.\n"
1896 "\n"
1897 "Dimensions: [quantity][ f_grid, stokes_dim ]\n"),
1898 GROUP("ArrayOfMatrix")));
1899
1900 wsv_data.push_back(WsvRecord(
1901 NAME("iy_aux_vars"),
1903 "Selection of quantities for *iy_aux* and when applicable also *y_aux*.\n"
1904 "\n"
1905 "Each element of this string array determines the quantity for the\n"
1906 "corresponding element in *iy_aux* and *y_aux* (i.e. the quantities\n"
1907 "are stored in the order given in *iy_aux_vars*).\n"
1908 "\n"
1909 "The possible choices vary between the methods. See the WSM you select\n"
1910 "for *iy_main_agenda* for the complete set of choices. Please not that\n"
1911 "if the calculations are done through *yCalc*, you can not select\n"
1912 "along-the-path variables.\n"),
1913 GROUP("ArrayOfString")));
1914
1915 wsv_data.push_back(WsvRecord(
1916 NAME("iy_cloudbox_agenda"),
1918 "Agenda deriving the intensity at boundary or interior of the cloudbox.\n"),
1919 GROUP("Agenda")));
1920
1921 wsv_data.push_back(WsvRecord(
1922 NAME("iy_independent_beam_approx_agenda"),
1923 DESCRIPTION("Agenda dedicated to *iyIndependentBeamApproximation*."),
1924 GROUP("Agenda")));
1925
1926 wsv_data.push_back(WsvRecord(
1927 NAME("iy_id"),
1929 "Identification number of *iy*.\n"
1930 "\n"
1931 "This variable is intended to be an identification number for individual\n"
1932 "calculations of *iy*. This id-number can e.g. be used as input to \n"
1933 "*WriteXMLIndexed*, to link filenames to the different calculations.\n"
1934 "\n"
1935 "Some methods sets and updates *iy_id*. The general numbering scheme is:\n"
1936 " xxxyyycba\n"
1937 "where xxx identifies the row in sensorPos/los (i.e. the mblock_index),\n"
1938 "yyy identifies pencil beam direction inside measurement block (should\n"
1939 "in general match a row in mblock_dlos_grid), and cba identies later legs\n"
1940 "of total propagation paths, where a, b and c identifies secondary, tertiary\n"
1941 "and quaternary part, respectively. 1-based numbering is used. That is,\n"
1942 "the primary path of the first pencil beam of the first measurement block\n"
1943 "has iy_id = 001001000.\n"
1944 "\n"
1945 "Accordingly, the primary propagation path has cba = 000. If the primary path\n"
1946 "intersects with the surface, and the downwelling radiation is calculated\n"
1947 "for three directions, these secondary paths get cba = 001, 002 and 003.\n"
1948 "If tertiary paths appear, they have numbers such as 011. \n"
1949 "\n"
1950 "As the numbering scheme has nine positions, it is suitable to store\n"
1951 "files as: WriteXMLIndexed(output_file_format,iy_id,in,filename,9)\n"
1952 "\n"
1953 "Setting of *iy_id* is not yet supported together with scattering\n"
1954 "calculations. The value of iy_id then differs, it is either set to 0\n"
1955 "or keeps its value set by *yCalc*.\n"),
1956 GROUP("Index")));
1957
1958 wsv_data.push_back(
1959 WsvRecord(NAME("iy_loop_freqs_agenda"),
1960 DESCRIPTION("Agenda dedicated to *iyLoopFrequencies*."),
1961 GROUP("Agenda")));
1962
1963 wsv_data.push_back(WsvRecord(
1964 NAME("iy_main_agenda"),
1966 "Agenda calculating the single monochromatic pencil beam spectrum.\n"),
1967 GROUP("Agenda")));
1968
1969 wsv_data.push_back(WsvRecord(
1970 NAME("iy_radar_agenda"),
1972 "Agenda calculating pointwise backscattering.\n"),
1973 GROUP("Agenda")));
1974
1975 wsv_data.push_back(WsvRecord(
1976 NAME("iy_space_agenda"),
1978 "Agenda providing the downwelling radiation at the top of the atmosphere.\n"),
1979 GROUP("Agenda")));
1980
1981 wsv_data.push_back(WsvRecord(
1982 NAME("iy_surface_agenda"),
1984 "Agenda providing the upwelling radiation from the surface.\n"),
1985 GROUP("Agenda")));
1986
1987 wsv_data.push_back(WsvRecord(
1988 NAME("iy_surface_agenda_array"),
1990 // FIXMEDOC
1991 "Upwelling radiation from the surface, divided into surface types.\n"),
1992 GROUP("ArrayOfAgenda")));
1993
1994 wsv_data.push_back(WsvRecord(
1995 NAME("iy_transmittance"),
1997 "Transmittance to be included in *iy*.\n"
1998 "\n"
1999 "The calculation of *iy* can be performed over several propation path\n"
2000 "branches, and there can be recursive calls of *iy_main_agenda*.\n"
2001 "This variable gives the transmittance from the end point of the present\n"
2002 "branch and the sensor for such recursive cases.\n"
2003 "\n"
2004 "This variable is used purely internally. The exact usage can vary\n"
2005 "between different RT integration schemes.\n"
2006 "\n"
2007 "Usage: Internally inside iy_main_agenda.\n"
2008 "\n"
2009 "Unit: 1\n"
2010 "\n"
2011 "Dimensions: [ f_grid, stokes_dim, stokes_dim ]\n"),
2012 GROUP("Tensor3")));
2013
2014 wsv_data.push_back(
2015 WsvRecord(NAME("iy_transmitter_agenda"),
2016 DESCRIPTION("Agenda providing a transmitter signal.\n"),
2017 GROUP("Agenda")));
2018
2019 wsv_data.push_back(WsvRecord(
2020 NAME("iy_unit"),
2022 "Selection of output unit for radiative transfer methods.\n"
2023 "\n"
2024 "This variable allows that the unit of the output radiance/intensity\n"
2025 "is changed. The possible choices differ between the radiative\n"
2026 "methods, including not considering the variable at all.\n"
2027 "Accordingly, for details see the radiative method you have selected\n"
2028 "(e.g., *iyEmissionStandard*, *iyMC* and the like).\n"),
2029 GROUP("String")));
2030
2031 wsv_data.push_back(WsvRecord(
2032 NAME("iy_unit_radar"),
2034 "Unit for radar simulations.\n"
2035 "\n"
2036 "See the radar methods for allowed options.\n"),
2037 GROUP("String")));
2038
2039 wsv_data.push_back(WsvRecord(
2040 NAME("jacobian"),
2042 "The Jacobian matrix.\n"
2043 "\n"
2044 "The matrix holding the Jacobians of the retrieval quantities. The\n"
2045 "matrix has to be initialised before the retrieval quantities can be\n"
2046 "defined. Initialisation is done by*jacobianInit*. Retrieval quantities\n"
2047 "are then added with *jacobianAdd...* or *retrievalAdd..* methods.\n"
2048 "\n"
2049 "The order between rows and columns follows how data are stored in *y*\n"
2050 "and *x*, respectively.\n"
2051 "\n"
2052 "Units: See the different retrieval quantities.\n"
2053 "\n"
2054 "Dimension: [ y, number of retrieval quantities and grids ]\n"),
2055 GROUP("Matrix")));
2056
2057 wsv_data.push_back(
2058 WsvRecord(NAME("jacobian_agenda"),
2059 DESCRIPTION("Pure numerical Jacobian calculation agenda.\n"),
2060 GROUP("Agenda")));
2061
2062 wsv_data.push_back(WsvRecord(
2063 NAME("jacobian_do"),
2065 "Flag to activate (clear-sky) Jacobian calculations.\n"
2066 "\n"
2067 "If this variable is set to 0, no Jacobian calculations will be done,\n"
2068 "even if such calculations have been set-up (through the\n"
2069 "jacobianAddXxx methods).\n"
2070 "\n"
2071 "Needs to be 0 if cloudy-sky (Doit) Jacobians shall be calculated.\n"),
2072 GROUP("Index")));
2073
2074 wsv_data.push_back(WsvRecord(
2075 NAME("jacobian_quantities"),
2077 "The retrieval quantities in the Jacobian matrix.\n"
2078 "\n"
2079 "An array of retrieval quantities for which the Jacobians are\n"
2080 "calculated.\n"
2081 "\n"
2082 "Usage: Quantities are added by the jacobianAdd WSMs.\n"),
2083 GROUP("ArrayOfRetrievalQuantity")));
2084
2085 wsv_data.push_back(WsvRecord(
2086 NAME("jacobian_targets"),
2088 "The partial derivatives that are computed for the Jacobian matrix.\n"
2089 "\n"
2090 "An array of jacobian targets for which the Jacobians are\n"
2091 "calculated.\n"
2092 "\n"
2093 "Usage: Input to absorption agendas.\n"),
2094 GROUP("ArrayOfJacobianTarget")));
2095
2096 wsv_data.push_back(WsvRecord(NAME("lat"),
2097 DESCRIPTION("A latitude.\n"
2098 "\n"
2099 "Unit: degrees\n"),
2100 GROUP("Numeric")));
2101
2102 wsv_data.push_back(WsvRecord(
2103 NAME("lat_grid"),
2105 "The latitude grid.\n"
2106 "\n"
2107 "The latitudes for which the atmospheric fields are defined. The\n"
2108 "atmosphere is undefined outside the range covered by the grid.\n"
2109 "The grid must be sorted in increasing order, with no repetitions.\n"
2110 "\n"
2111 "Geocentric latitudes are used.\n"
2112 "\n"
2113 "For 1D calculations this vector shall be set to be empty.\n"
2114 "\n"
2115 "For 2D cases the latitudes shall be interpreted as the angular\n"
2116 "distance inside the orbit plane from the equator (values\n"
2117 "outside +-90 deg are allowed).\n"
2118 "\n"
2119 "For 3D, the valid latitude range is [-90,90].\n"
2120 "\n"
2121 "See further the ARTS user guide (AUG). Use the index to find where\n"
2122 "this variable is discussed. The variable is listed as a subentry to\n"
2123 "\"workspace variables\".\n"
2124 "\n"
2125 "Usage: Set by the user.\n"
2126 "\n"
2127 "Unit: degrees\n"),
2128 GROUP("Vector")));
2129
2130 wsv_data.push_back(WsvRecord(
2131 NAME("lat_true"),
2133 "Latitudinal geolocation for 1D and 2D data.\n"
2134 "\n"
2135 "The variables *lat_grid* and *lon_grid* contain true positions only\n"
2136 "for 3D. For 1D and 2D, the geographical position is given by\n"
2137 "*lat_true* and *lon_true*. Can be left empty when not used.\n"
2138 "Otherwise:\n"
2139 "\n"
2140 " 1D: *lat_true* shall have length 1\n"
2141 "\n"
2142 " 2D: Both *lat_true* and *lon_true* shall have a length matching\n"
2143 " *lat_grid*. That is, *lat_true* and *lon_true* shall not be\n"
2144 " seen as grids, they are vectors giving the actual lat or lon\n"
2145 " for each point corresponding to *lat_grid*.\n"
2146 "\n"
2147 "Usage: Set by the user.\n"
2148 "\n"
2149 "Unit: degrees\n"),
2150 GROUP("Vector")));
2151
2152 wsv_data.push_back(WsvRecord(
2153 NAME("lbl_checked"),
2154 DESCRIPTION("Flag to check if the line-by-line calculations will work\n"
2155 "\n"
2156 "Usage: Set manually on own risk, or use *lbl_checkedCalc*.\n"
2157 "\n"
2158 "Unit: Boolean\n"),
2159 GROUP("Index")));
2160
2161 wsv_data.push_back(
2162 WsvRecord(NAME("line_irradiance"),
2163 DESCRIPTION("Irradiance as seen by a single absorption line.\n"
2164 "\n"
2165 "Used internally for, e.g., NLTE effects\n"),
2166 GROUP("Matrix")));
2167
2168 wsv_data.push_back(WsvRecord(
2169 NAME("line_transmission"),
2170 DESCRIPTION("Transmission as seen by a single absorption line.\n"
2171 "\n"
2172 "Used internally for, e.g., NLTE effects\n"),
2173 GROUP("Tensor3")));
2174
2175 wsv_data.push_back(WsvRecord(
2176 NAME("lo"),
2178 "The local oscillator frequency.\n"
2179 "\n"
2180 "A local oscillator frequency is used in a heterodyne system when\n"
2181 "the mixer folds the spectra from from radio frequencies (RF) to\n"
2182 "intermediate frequencies (IF).\n"
2183 "\n"
2184 "Unit: Hz\n"
2185 "\n"
2186 "Usage: Set by the user.\n"),
2187 GROUP("Numeric")));
2188
2189 wsv_data.push_back(WsvRecord(
2190 NAME("lo_multi"),
2192 "Local oscillator frequencies.\n"
2193 "\n"
2194 "As *lo* but describes an instrument with multiple mixers. A vector\n"
2195 "element for each LO. The size of this variable and\n"
2196 "*sideband_response_multi* shall match, and probably also\n"
2197 "*sideband_mode_multi*.\n"
2198 "\n"
2199 "Unit: Hz\n"
2200 "\n"
2201 "Usage: Set by the user.\n"),
2202 GROUP("Vector")));
2203
2204 wsv_data.push_back(WsvRecord(NAME("lon"),
2205 DESCRIPTION("A longitude.\n"
2206 "\n"
2207 "Unit: degrees\n"),
2208 GROUP("Numeric")));
2209
2210 wsv_data.push_back(WsvRecord(
2211 NAME("lon_grid"),
2213 "The longitude grid.\n"
2214 "\n"
2215 "The longitudes for which the atmospheric fields are defined. The\n"
2216 "atmosphere is undefined outside the range covered by the grid.\n"
2217 "The grid must be sorted in increasing order, with no repetitions.\n"
2218 "\n"
2219 "For 1D and 2D, this WSV shall be set to be empty.\n"
2220 "\n"
2221 "Allowed values for longitudes is the range [-360,360]. The difference\n"
2222 "between last and first value can not exceed 360 degrees. A difference\n"
2223 "of exactly 360 deg. means that the complete globe is covered and no\n"
2224 "propagation paths will reach a longitude edge.\n"
2225 "\n"
2226 "See further the ARTS user guide (AUG). Use the index to find where\n"
2227 "this variable is discussed. The variable is listed as a subentry to\n"
2228 "\"workspace variables\".\n"
2229 "\n"
2230 "Usage: Set by the user.\n"
2231 "\n"
2232 "Unit: degrees\n"),
2233 GROUP("Vector")));
2234
2235 wsv_data.push_back(WsvRecord(
2236 NAME("lon_true"),
2238 "Longitudinal geolocation for 1D and 2D data.\n"
2239 "\n"
2240 "The variables *lat_grid* and *lon_grid* contain true positions only\n"
2241 "for 3D. For 1D and 2D, the geographical position is given by\n"
2242 "*lat_true* and *lon_true*. Can be left empty when not used.\n"
2243 "Otherwise:\n"
2244 "\n"
2245 " 1D: *lon_true* shall have length 1\n"
2246 "\n"
2247 " 2D: Both *lat_true* and *lon_true* shall have a length matching\n"
2248 " *lat_grid*. That is, *lat_true* and *lon_true* shall not be\n"
2249 " seen as grids, they are vectors giving the actual lat or lon\n"
2250 " for each point corresponding to *lat_grid*.\n"
2251 "\n"
2252 "Usage: Set by the user.\n"
2253 "\n"
2254 "Unit: degrees\n"),
2255 GROUP("Vector")));
2256
2257 wsv_data.push_back(WsvRecord(
2258 NAME("mag_u_field"),
2260 "Zonal component of the magnetic field.\n"
2261 "\n"
2262 "The East-West magnetic field component. Positive values, when\n"
2263 "pointing eastward.\n"
2264 "\n"
2265 "Can be set to be empty, which is interpreted as zero field strength\n"
2266 "everywhere.\n"
2267 "\n"
2268 "Unit: T\n"
2269 "\n"
2270 "Dimensions: [ p_grid, lat_grid, lon_grid ] or [ 0 0 0 ].\n"),
2271 GROUP("Tensor3")));
2272
2273 wsv_data.push_back(WsvRecord(
2274 NAME("mag_u_field_raw"),
2276 "Raw zonal component of the magnetic field.\n"
2277 "\n"
2278 "The East-West magnetic field component. Positive values, when\n"
2279 "pointing eastward.\n"
2280 "\n"
2281 "Can be set to be empty, which is interpreted as zero field strength\n"
2282 "everywhere.\n"
2283 "\n"
2284 "Unit: T\n"
2285 "\n"
2286 "Dimensions: [ p_grid, lat_grid, lon_grid ].\n"),
2287 GROUP("GriddedField3")));
2288
2289 wsv_data.push_back(WsvRecord(
2290 NAME("mag_v_field"),
2292 "Meridional component of the magnetic field.\n"
2293 "\n"
2294 "The North-South magnetic field component. Positive values, when\n"
2295 "pointing northward.\n"
2296 "\n"
2297 "Can be set to be empty, which is interpreted as zero field strength\n"
2298 "everywhere.\n"
2299 "\n"
2300 "Unit: T\n"
2301 "\n"
2302 "Dimensions: [ p_grid, lat_grid, lon_grid ] or [ 0 0 0 ].\n"),
2303 GROUP("Tensor3")));
2304
2305 wsv_data.push_back(WsvRecord(
2306 NAME("mag_v_field_raw"),
2308 "Raw meridional component of the magnetic field.\n"
2309 "\n"
2310 "The North-South magnetic field component. Positive values, when\n"
2311 "pointing northward.\n"
2312 "\n"
2313 "Can be set to be empty, which is interpreted as zero field strength\n"
2314 "everywhere.\n"
2315 "\n"
2316 "Unit: T\n"
2317 "\n"
2318 "Dimensions: [ p_grid, lat_grid, lon_grid ].\n"),
2319 GROUP("GriddedField3")));
2320
2321 wsv_data.push_back(WsvRecord(
2322 NAME("mag_w_field"),
2324 "Vertical component of the magnetic field.\n"
2325 "\n"
2326 "Positive values, when pointing upward.\n"
2327 "\n"
2328 "Can be set to be empty, which is interpreted as zero field strength\n"
2329 "everywhere.\n"
2330 "\n"
2331 "Unit: T\n"
2332 "\n"
2333 "Dimensions: [ p_grid, lat_grid, lon_grid ] or [ 0 0 0 ].\n"),
2334 GROUP("Tensor3")));
2335
2336 wsv_data.push_back(WsvRecord(
2337 NAME("mag_w_field_raw"),
2339 "Raw vertical component of the magnetic field.\n"
2340 "\n"
2341 "Positive values, when pointing upward.\n"
2342 "\n"
2343 "Can be set to be empty, which is interpreted as zero field strength\n"
2344 "everywhere.\n"
2345 "\n"
2346 "Unit: T\n"
2347 "\n"
2348 "Dimensions: [ p_grid, lat_grid, lon_grid ].\n"),
2349 GROUP("GriddedField3")));
2350
2351 wsv_data.push_back(WsvRecord(
2352 NAME("main_agenda"),
2353 DESCRIPTION("Agenda corresponding to the entire controlfile.\n"),
2354 GROUP("Agenda")));
2355
2356 wsv_data.push_back(WsvRecord(
2357 NAME("mblock_dlos_grid"),
2359 "The set of angular pencil beam directions for each measurement block.\n"
2360 "\n"
2361 "The relative angles in this variable are angular off-sets with\n"
2362 "respect to the angles in *sensor_los*.\n"
2363 "\n"
2364 "The first column holds the relative zenith angle. This column is\n"
2365 "mandatory for all atmospheric dimensionalities. For 3D, there can\n"
2366 "also be a second column, giving relative azimuth angles. If this\n"
2367 "column is not present (for 3D) zero azimuth off-sets are assumed.\n"
2368 "\n"
2369 "This rule applies to all WSVs of dlos-type, while for WSVs holding\n"
2370 "absolute angles (los-type, such as *sensor_los*), the second column\n"
2371 "is mandatory for 3D.\n"
2372 "\n"
2373 "See further the ARTS user guide (AUG). Use the index to find where\n"
2374 "this variable is discussed. The variable is listed as a subentry to\n"
2375 "\"workspace variables\".\n"
2376 "\n"
2377 "Usage: Set by the user or output of antenna WSMs.\n"
2378 "\n"
2379 "Unit: degrees\n"),
2380 GROUP("Matrix")));
2381
2382 wsv_data.push_back(WsvRecord(
2383 NAME("mblock_index"),
2385 "Measurement block index. \n"
2386 "\n"
2387 "Used to tell agendas the index of present measurement block.\n"
2388 "\n"
2389 "Usage: Used internally.\n"),
2390 GROUP("Index")));
2391
2392 wsv_data.push_back(WsvRecord(
2393 NAME("mc_antenna"),
2395 "Antenna pattern description for dedicated MC calculaions.\n"
2396 "\n"
2397 "Usage: Input to MCGeneral. Set by *mc_antennaSetGaussian* and similar\n"
2398 " methods.\n"),
2399 GROUP("MCAntenna")));
2400
2401 wsv_data.push_back(WsvRecord(
2402 NAME("mc_error"),
2403 DESCRIPTION("Error in simulated *y* when using a Monte Carlo approach.\n"
2404 "\n"
2405 "Usage: Output from Monte Carlo functions. \n"
2406 "\n"
2407 "Units: Depends on *iy_unit*.\n"
2408 "\n"
2409 "Size: [ stokes_dim ]\n"),
2410 GROUP("Vector")));
2411
2412 wsv_data.push_back(WsvRecord(
2413 NAME("mc_iteration_count"),
2415 "Counts the number of iterations (or photons) used in the MC\n"
2416 "scattering algorithm.\n"
2417 "\n"
2418 "Usage: Set by MCGeneral and other MC methods.\n"),
2419 GROUP("Index")));
2420
2421 wsv_data.push_back(WsvRecord(
2422 NAME("mc_max_iter"),
2423 DESCRIPTION("The maximum number of iterations allowed for Monte Carlo\n"
2424 "calculations.\n"
2425 "\n"
2426 "Usage: Set by the user.\n"),
2427 GROUP("Index")));
2428
2429 wsv_data.push_back(WsvRecord(
2430 NAME("mc_max_scatorder"),
2431 DESCRIPTION("The maximum scattering order allowed for Monte Carlo\n"
2432 "radar calculations.\n"
2433 "\n"
2434 "Usage: Set by the user.\n"),
2435 GROUP("Index")));
2436
2437 wsv_data.push_back(WsvRecord(
2438 NAME("mc_max_time"),
2439 DESCRIPTION("The maximum time allowed for Monte Carlo calculations.\n"
2440 "\n"
2441 "Usage: Set by the user.\n"
2442 "\n"
2443 "Unit: s\n"),
2444 GROUP("Index")));
2445
2446 wsv_data.push_back(WsvRecord(
2447 NAME("mc_min_iter"),
2448 DESCRIPTION("The minimum number of iterations allowed for Monte Carlo\n"
2449 "calculations.\n"
2450 "\n"
2451 "Usage: Set by the user.\n"),
2452 GROUP("Index")));
2453
2454 wsv_data.push_back(
2455 WsvRecord(NAME("mc_points"),
2457 //FIXMEDOC
2458 "Source to emission, position.\n"
2459 "\n"
2460 "Counts the number of MC endpoints in each grid cell.\n"
2461 "\n"
2462 "Usage: Set by MCGeneral and other MC methods.\n"),
2463 GROUP("Tensor3")));
2464
2465 wsv_data.push_back(WsvRecord(
2466 NAME("mc_scat_order"),
2468 "Number of atmospheric scattering events between emission point and sensor.\n"
2469 "\n"
2470 "The first element gives the number of cases with zero scattering events,\n"
2471 "the second the number of single scattering cases etc.\n"
2472 "\n"
2473 "Scattering orders above what the variable can hold are not stored at all.\n"
2474 "The number of such cases can be determined by comparing\n"
2475 "*mc_iteration_count* with the sum of the elements in this array.\n"
2476 "\n"
2477 "Usage: Set by MCGeneral and other MC methods.\n"),
2478 GROUP("ArrayOfIndex")));
2479
2480 wsv_data.push_back(WsvRecord(
2481 NAME("mc_source_domain"),
2483 "Rough classification of source to emission.\n"
2484 "\n"
2485 "This is an array of length 4, where the elements in order represent\n"
2486 "space, the surface, atmospheric gas and atmospheric particle.\n"
2487 "The distinction between the two last elements is if the emission\n"
2488 "is associated with *vmr_field* or *pnd_field*.\n"
2489 "\n"
2490 "The values of the array give the number of cases where the emission\n"
2491 "source was found to be inside each \"domain\".\n"
2492 "\n"
2493 "Usage: Set by MCGeneral and other MC methods.\n"),
2494 GROUP("ArrayOfIndex")));
2495
2496 wsv_data.push_back(WsvRecord(
2497 NAME("mc_seed"),
2498 DESCRIPTION("The integer seed for the random number generator used by\n"
2499 "Monte Carlo methods.\n"
2500 "\n"
2501 "Usage: Set by MCSetSeed.\n"),
2502 GROUP("Index")));
2503
2504 wsv_data.push_back(WsvRecord(
2505 NAME("mc_std_err"),
2507 "Target precision (1 std. dev.) for Monte Carlo calculations.\n"
2508 "\n"
2509 "Usage: Set by the user.\n"),
2510 GROUP("Numeric")));
2511
2512 wsv_data.push_back(WsvRecord(
2513 NAME("mc_y_tx"),
2514 DESCRIPTION("Normalized Stokes vector for transmittance (e.g., radar).\n"
2515 "\n"
2516 "The first element (intensity) should have a value of 1."
2517 "\n"
2518 "Usage: Set by user. \n"
2519 "\n"
2520 "Units: Unitless.\n"
2521 "\n"
2522 "Size: [ stokes_dim ]\n"),
2523 GROUP("Vector")));
2524
2525 wsv_data.push_back(WsvRecord(
2526 NAME("mc_taustep_limit"),
2528 "Defines an upper step length in terms of optical thickness for Monte "
2529 "Carlo calculations.\n"
2530 "\n"
2531 "Usage: Set by the user.\n"),
2532 GROUP("Numeric")));
2533
2534 wsv_data.push_back(WsvRecord(
2535 NAME("met_amsu_data"),
2537 "The AMSU data set.\n"
2538 "\n"
2539 "This is intended as input for the method ybatchMetProfiles. It holds the\n"
2540 "latitude, longitude, satellite zenith angle and amsu-b corrected and \n"
2541 "uncorrected brightness temperatures. It also has information about \n"
2542 "the particular pixel corresponds to a land or sea point. This will be \n"
2543 "read in the method ybatchMetProfiles and the profiles corresponding to \n"
2544 "each latitude and longitude will be read in.\n"
2545 "\n"
2546 "See documentation of WSM *ybatchMetProfiles* for more information.\n"),
2547 GROUP("Matrix")));
2548
2549 wsv_data.push_back(WsvRecord(
2550 NAME("met_mm_antenna"),
2552 "The antenna beam width for meteorological millimeter instruments.\n"
2553 "\n"
2554 "This Vector must match the number and order of channels in\n"
2555 "*met_mm_backend*.\n"
2556 "\n"
2557 "Usage: Set by the user.\n"
2558 "\n"
2559 "Unit: [ Hz ]\n"
2560 "\n"
2561 "Size: [ number of channels ]\n"),
2562 GROUP("Vector")));
2563
2564 wsv_data.push_back(WsvRecord(
2565 NAME("met_mm_backend"),
2567 "Backend description for meteorological millimeter sensors with passbands.\n"
2568 "\n"
2569 "This is a compact description of a passband-type sensor, e.g. AMSU-A. The matrix\n"
2570 "contains one row for each instrument channel. Each row contains four elements:\n\n"
2571 " LO position [Hz]\n"
2572 " first offset from the LO [Hz]\n"
2573 " second offset from the LO+offset1 [Hz]\n"
2574 " channel width [Hz]\n"
2575 "\n"
2576 " LO\n"
2577 " |\n"
2578 " offset1 | offset1\n"
2579 " ----------------+----------------\n"
2580 " | |\n"
2581 " | |\n"
2582 " offset2 | offset2 offset2 | offset2\n"
2583 " ---------+--------- ---------+---------\n"
2584 " | | | |\n"
2585 " | | | |\n"
2586 "##### ##### ##### #####\n"
2587 "width width width width\n"
2588 "\n"
2589 "For a sensor with 1 passband, offset1 and offset2 are zero.\n"
2590 "For a sensor with 2 passbands, only offset2 is zero.\n"
2591 "\n"
2592 "Usage: Set by the user.\n"
2593 "\n"
2594 "Unit: All entries in Hz.\n"
2595 "\n"
2596 "Size: [number of channels, 4]\n"),
2597 GROUP("Matrix")));
2598
2599 wsv_data.push_back(WsvRecord(
2600 NAME("met_mm_polarisation"),
2602 "The polarisation for meteorological millimeter instruments.\n"
2603 "\n"
2604 "This array must match the number and order of channels in\n"
2605 "*met_mm_backend*.\n"
2606 "\n"
2607 "Possible values:\n"
2608 "V: Vertical polarisation\n"
2609 "H: Horizontal polarisation\n"
2610 "LHC: Left-hand circular polarisation\n"
2611 "RHC: Right-hand circular polarisation\n"
2612 "AMSU-V: Vertical polarisation dependening on AMSU zenith angle\n"
2613 "AMSU-H: Horizontal polarisation dependening on AMSU zenith angle\n"
2614 "ISMAR-V: Vertical polarisation dependening on ISMAR zenith angle\n"
2615 "ISMAR-H: Horizontal polarisation dependening on AMSU zenith angle\n"
2616 "\n"
2617 "Usage: Set by the user.\n"
2618 "\n"
2619 "Unit: [ String ]\n"
2620 "\n"
2621 "Size: [ number of channels ]\n"),
2622 GROUP("ArrayOfString")));
2623
2624 wsv_data.push_back(
2625 WsvRecord(NAME("met_profile_calc_agenda"),
2626 DESCRIPTION("Agenda for metoffice profile calculations.\n"),
2627 GROUP("Agenda")));
2628
2629 wsv_data.push_back(WsvRecord(
2630 NAME("level0_data"),
2631 DESCRIPTION("List of L0 data. Can be of any type.\n"
2632 "It is method-dependent how this is used to calibrated to L1\n"),
2633 GROUP("ArrayOfVector")));
2634
2635 wsv_data.push_back(WsvRecord(
2636 NAME("level0_time"),
2637 DESCRIPTION("List of L0 times. Should be in UTC.\n"
2638 "It is method-dependent how this is used to calibrated to L1\n"),
2639 GROUP("ArrayOfTime")));
2640
2641 wsv_data.push_back(WsvRecord(
2642 NAME("lm_ga_history"),
2644 "The series of gamma values for a Marquardt-levenberg inversion.\n"
2645 "\n"
2646 "The values are stored following iteration order, i.e. the first\n"
2647 "is the gamma factor for the first iteration etc.\n"),
2648 GROUP("Vector")));
2649
2650 wsv_data.push_back(WsvRecord(
2651 NAME("molarmass_dry_air"),
2653 "The average molar mass of dry air.\n"
2654 "\n"
2655 "This could also be referred to as the average molecular weight for\n"
2656 "dry air. The definition of \"dry air\" can differ between planets and\n"
2657 "methods using the WSV. For Earth, this should be a value around\n"
2658 "28.97.\n"),
2659 GROUP("Numeric")));
2660
2661 wsv_data.push_back(WsvRecord(
2662 NAME("nlte_level_identifiers"),
2663 DESCRIPTION("An array of non-lte quantum identifiers for levels matching\n"
2664 "*nlte_field_raw* and on request *nlte_vibrational_energies*.\n"),
2665 GROUP("ArrayOfQuantumIdentifier")));
2666
2667 wsv_data.push_back(WsvRecord(
2668 NAME("nlte_vibrational_energies"),
2669 DESCRIPTION("An list of vibrational energies matching\n"
2670 "*nlte_level_identifiers* and *nlte_field_raw* or being 0.\n"),
2671 GROUP("Vector")));
2672
2673 wsv_data.push_back(WsvRecord(
2674 NAME("collision_line_identifiers"),
2676 //FIXMEDOC
2677 "An array of quantum identifiers for finding collisional rates\n"
2678 "in *collision_coefficients*\n"),
2679 GROUP("ArrayOfQuantumIdentifier")));
2680
2681 wsv_data.push_back(
2682 WsvRecord(NAME("collision_coefficients"),
2684 //FIXMEDOC
2685 "An array of coefficients for effective collisions\n"),
2686 GROUP("ArrayOfArrayOfGriddedField1")));
2687
2688 wsv_data.push_back(
2689 WsvRecord(NAME("nelem"),
2690 DESCRIPTION("Number of elements of a Vector or Array.\n"),
2691 GROUP("Index")));
2692
2693 wsv_data.push_back(WsvRecord(
2694 NAME("ncols"),
2696 "Number of columns (elements in lowest dimension) of a Matrix or Tensor.\n"),
2697 GROUP("Index")));
2698
2699 wsv_data.push_back(WsvRecord(
2700 NAME("nrows"),
2702 "Number of rows (elements in 2nd lowest dimension) of a Matrix or Tensor.\n"),
2703 GROUP("Index")));
2704
2705 wsv_data.push_back(WsvRecord(
2706 NAME("npages"),
2707 DESCRIPTION("Number of elements in 3rd lowest dimension of a Tensor.\n"),
2708 GROUP("Index")));
2709
2710 wsv_data.push_back(WsvRecord(
2711 NAME("nbooks"),
2712 DESCRIPTION("Number of elements in 4th lowest dimension of a Tensor.\n"),
2713 GROUP("Index")));
2714
2715 wsv_data.push_back(WsvRecord(
2716 NAME("nshelves"),
2717 DESCRIPTION("Number of elements in 5th lowest dimension of a Tensor.\n"),
2718 GROUP("Index")));
2719
2720 wsv_data.push_back(WsvRecord(
2721 NAME("nvitrines"),
2722 DESCRIPTION("Number of elements in 6th lowest dimension of a Tensor.\n"),
2723 GROUP("Index")));
2724
2725 wsv_data.push_back(WsvRecord(
2726 NAME("nlibraries"),
2727 DESCRIPTION("Number of elements in 7th lowest dimension of a Tensor.\n"),
2728 GROUP("Index")));
2729
2730 wsv_data.push_back(
2731 WsvRecord(NAME("nlte_do"),
2732 DESCRIPTION("Flag to perform Non-LTE calculations.\n"),
2733 GROUP("Index")));
2734
2735 wsv_data.push_back(WsvRecord(
2736 NAME("nlte_source"),
2738 "Variable to contain the additional source function due to NLTE effects.\n"
2739 "\n"
2740 "Dimensions: [nza, naa, nf, stokes_dim]\n"),
2741 GROUP("StokesVector")));
2742
2743 wsv_data.push_back(WsvRecord(
2744 NAME("oem_diagnostics"),
2746 "Basic diagnostics of an OEM type inversion.\n"
2747 "\n"
2748 "This is a vector of length 5, having the elements (0-based index):\n"
2749 " 0: Convergence status, with coding\n"
2750 " 0 = converged\n"
2751 " 1 = max iterations reached\n"
2752 " 2 = max gamma of LM reached\n"
2753 " 9 = some error when calling *inversion_iterate_agenda*\n"
2754 " 99 = too high start cost.\n"
2755 " 1: Start value of cost function.\n"
2756 " 2: End value of cost function.\n"
2757 " 3: End value of y-part of cost function.\n"
2758 " 4: Number of iterations used.\n"
2759 "\n"
2760 "See WSM *OEM* for a definition of \"cost\". Values not calculated\n"
2761 "are set to NaN.\n"),
2762 GROUP("Vector")));
2763 wsv_data.push_back(
2764 WsvRecord(NAME("oem_errors"),
2765 DESCRIPTION("Errors encountered during OEM execution.\n"),
2766 GROUP("ArrayOfString")));
2767
2768 wsv_data.push_back(WsvRecord(
2769 NAME("output_file_format"),
2771 "Output file format.\n"
2772 "\n"
2773 "This variable sets the format for output files. It could be set to\n"
2774 "\"ascii\" for plain xml files, \"zascii\" for zipped xml files, or\n"
2775 "\"binary\".\n"
2776 "\n"
2777 "To change the value of this variable use the workspace methods\n"
2778 "*output_file_formatSetAscii*, *output_file_formatSetZippedAscii*, and\n"
2779 "*output_file_formatSetBinary*\n"),
2780 GROUP("String")));
2781
2782 wsv_data.push_back(WsvRecord(
2783 NAME("particle_bulkprop_field"),
2785 "Container for various data that describes scattering bulk properties.\n"
2786 "\n"
2787 "The number and order of bulk properties is free, as long as the data are\n"
2788 "consistent with the content of *particle_bulkprop_names*. \n"
2789 "\n"
2790 "The data shall be given on the standard atmospheric grids. When actually\n"
2791 "used, this variable must have zeros at all positions outside and at the\n"
2792 "border of the cloudbox.\n"
2793 "\n"
2794 "Dimensions: [ particle_bulkprop_names, p_grid, lat_grid, lon_grid ]\n"),
2795 GROUP("Tensor4")));
2796
2797 wsv_data.push_back(WsvRecord(
2798 NAME("particle_bulkprop_names"),
2800 "Identification of the data in *particle_bulkprop_field*.\n"
2801 "\n"
2802 "This variable assigns a name to each field in *particle_bulkprop_field*.\n"
2803 "The naming is totally free. If two fields are given the same name, the\n"
2804 "first one will be selected.\n"
2805 "\n"
2806 "Dimensions: length should match book-dimension of *particle_bulkprop_field*\n"),
2807 GROUP("ArrayOfString")));
2808
2809 wsv_data.push_back(WsvRecord(
2810 NAME("particle_masses"),
2812 "The mass of individual particles (or bulks).\n"
2813 "\n"
2814 "Each row corresponds to a scattering element (i.e. an element in\n"
2815 "*scat_data*). The user is free to define different mass\n"
2816 "categories and assign a mass for each category. Each column\n"
2817 "of *particle_masses* corresponds to such a mass category. A scattering\n"
2818 "element can have a non-zero mass for more than one category.\n"
2819 "\n"
2820 "For example, if you work with clouds, your mass categories could\n"
2821 "be ice and liquid, corresponding to IWC and LWC, respectively.\n"
2822 "The mass of particles inside the melting layer, having a mixed\n"
2823 "phase, could be divided between the two columns of the matrix.\n"
2824 "\n"
2825 "Shall either be empty, or have a row size consistent with the\n"
2826 "scattering variables (*scat_data*, *pnd_field*).\n"
2827 "\n"
2828 "Usage: Set by the user.\n"
2829 "\n"
2830 "Unit: kg\n"
2831 "\n"
2832 "Dimensions: [number of scattering elements, number of mass categories]\n"),
2833 GROUP("Matrix")));
2834
2835 wsv_data.push_back(WsvRecord(
2836 NAME("pha_mat"),
2838 "Ensemble averaged phase matrix.\n"
2839 "\n"
2840 "This workspace variable represents the actual physical phase\n"
2841 "matrix (averaged over all scattering elements) for given propagation\n"
2842 "directions. It is calculated in the method *pha_matCalc*.\n"
2843 "\n"
2844 "See ARTS user guide (AUG) for further information. Use the index to find\n"
2845 "where this variable is discussed. The variable is listed as a subentry\n"
2846 "to \"workspace variables\".\n"
2847 "\n"
2848 "Usage: Output of the method *pha_matCalc*\n"
2849 "\n"
2850 "Unit: m^2\n" //FIXME: really m2? not 1/m?
2851 "\n"
2852 "Dimensions: [za_grid, aa_grid, stokes_dim, stokes_dim]\n"),
2853 GROUP("Tensor4")));
2854
2855 wsv_data.push_back(WsvRecord(
2856 NAME("pha_mat_doit"),
2858 "Ensemble averaged phase matrix for DOIT calculation.\n"
2859 "\n"
2860 "This workspace variable represents the actual physical phase\n"
2861 "matrix (averaged over all scattering elements) for given incident and \n"
2862 "propagation directions. It is calculated in the method *DoitScatteringDataPrepare*.\n"
2863 "\n"
2864 "See ARTS user guide (AUG) for further information."
2865 "\n"
2866 "Usage: Output of the method *pha_matCalc*\n"
2867 "\n"
2868 "Unit: m^2\n" //FIXME: really m2? not 1/m?
2869 "\n"
2870 "Dimensions: [T,za_grid, aa_grid, za_grid, aa_grid, \n"
2871 " stokes_dim, stokes_dim]\n"),
2872 GROUP("Tensor7")));
2873
2874 wsv_data.push_back(WsvRecord(
2875 NAME("pha_mat_spt"),
2877 "Phase matrix for all individual scattering elements.\n"
2878 "\n"
2879 "This variable contains the elements of phase matrix for all individual\n"
2880 "scattering elements for given propagation directions. It is the\n"
2881 "calculated in the agenda *pha_mat_spt_agenda*. The elements of the phase\n"
2882 "matrix are calculated from the single scattering data.\n"
2883 "\n"
2884 "See ARTS user guide (AUG) for further information.\n"
2885 "\n"
2886 "Usage: Input and Output of the pha_mat_sptFrom* methods\n"
2887 "\n"
2888 "Unit: m^2\n" //FIXME: really m2? not 1/m?
2889 "\n"
2890 "Dimensions: [number of scattering elements, za_grid, aa_grid,\n"
2891 " stokes_dim, stokes_dim]\n"),
2892 GROUP("Tensor5")));
2893
2894 wsv_data.push_back(WsvRecord(
2895 NAME("pha_mat_spt_agenda"),
2897 "Agenda calculates the phase matrix for individual scattering elements.\n"),
2898 GROUP("Agenda")));
2899
2900 wsv_data.push_back(WsvRecord(
2901 NAME("pha_mat_sptDOITOpt"),
2903 "Interpolated phase matrix.\n"
2904 "\n"
2905 "This variable contains the data of the phase matrix in the \n"
2906 "scattering frame interpolated on the actual frequency (the variable\n"
2907 "is used inside *doit_mono_agenda*) and also interpolated on all \n"
2908 "possible scattering angles following from all combinations of \n"
2909 "*za_grid* and *aa_grid*. \n"
2910 "\n"
2911 "Usage: Input of the method *pha_mat_sptFromDataDOITOpt*\n"
2912 "\n"
2913 "Unit: m^2\n" //FIXME: really m2? not 1/m?
2914 "\n"
2915 "Dimensions: \n"
2916 "[number of scattering elements]\n"
2917 "[T, za_grid, aa_grid, za_grid, aa_grid,\n"
2918 " stokes_dim, stokes_dim]\n"),
2919 GROUP("ArrayOfTensor7")));
2920
2921 wsv_data.push_back(WsvRecord(
2922 NAME("planet_rotation_period"),
2924 "The sidereal rotation period of the planet.\n"
2925 "\n"
2926 "This is time that it takes for the planet to complete one revolution\n"
2927 "around its axis of rotation relative to the stars. For Earth, this\n"
2928 "is a value roughly 4 min less than 24 h.\n"
2929 "\n"
2930 "A negative value signifies a retrograde rotation, i.e. opposite to\n"
2931 "the rotation of Earth.\n"
2932 "Unit: s\n"),
2933 GROUP("Numeric")));
2934
2935 wsv_data.push_back(WsvRecord(
2936 NAME("pnd_agenda_array"),
2938 "Mapping of particle bulk properties to number density data.\n"
2939 "\n"
2940 "The length of this agenda array shall match the size of *scat_species*.\n"
2941 "That is there is a \"pnd-agenda\" associated with each scattering species.\n"
2942 "\n"
2943 "In short, each agenda takes some bulk property data as input, and returns\n"
2944 "particle number densities for all scattering elements of the species.\n"
2945 "See further *pnd_agenda_input* and associated variables.\n"),
2946 GROUP("ArrayOfAgenda")));
2947
2948 wsv_data.push_back(WsvRecord(
2949 NAME("pnd_agenda_input"),
2951 "The variable input to one element of *pnd_agenda_array*.\n"
2952 "\n"
2953 "The column dimension corresponds to the input to the underlying\n"
2954 "particle size distribution method. For example, the first column\n"
2955 "can hold ice water content values, and the second one temperature\n"
2956 "data.\n"
2957 "\n"
2958 "Temperatures are handled by *pnd_agenda_input_t* and shall not be\n"
2959 "included in this variable.\n"
2960 "\n"
2961 "Each row corresponds to a position. That is, the methods in the\n"
2962 "pnd-agendas are expected to process multiple points in one call.\n"
2963 "\n"
2964 "Dimensions: [ n_points, n_input_variables ]\n"),
2965 GROUP("Matrix")));
2966
2967 wsv_data.push_back(WsvRecord(
2968 NAME("pnd_agenda_input_t"),
2970 "Temperature input to one element of *pnd_agenda_array*.\n"
2971 "\n"
2972 "This WSV works as *pnd_agenda_input* but holds a specific quantity,\n"
2973 "temperature.\n"
2974 "\n"
2975 "Each element corresponds to a position. That is, the methods in the\n"
2976 "pnd-agendas are expected to process multiple points in one call.\n"
2977 "\n"
2978 "Dimensions: [ n_points ]\n"),
2979 GROUP("Vector")));
2980
2981 wsv_data.push_back(WsvRecord(
2982 NAME("pnd_agenda_array_input_names"),
2984 "Naming of all input expected by *pnd_agenda_array*.\n"
2985 "\n"
2986 "This variable contains *pnd_agenda_input_names* for each agenda\n"
2987 "element in *pnd_agenda_array*.\n"
2988 "\n"
2989 "Dimension: [ n_scattering_species ][ n_input_variables ]\n"),
2990 GROUP("ArrayOfArrayOfString")));
2991
2992 wsv_data.push_back(WsvRecord(
2993 NAME("pnd_agenda_input_names"),
2995 "Naming of (existing or expected) data in *pnd_agenda_input*.\n"
2996 "\n"
2997 "The strings of this variable refer to the corresponding column in\n"
2998 "*pnd_agenda_input*.\n"
2999 "\n"
3000 "Dimension: [ n_input_variables ]\n"),
3001 GROUP("ArrayOfString")));
3002
3003 wsv_data.push_back(WsvRecord(
3004 NAME("pnd_data"),
3006 "Particle number density values for a set of points.\n"
3007 "\n"
3008 "The variable contains particle number density data for one scattering\n"
3009 "species. The row dimension corresponds to different positions, in the\n"
3010 "same way as *pnd_agenda_input* is defined.\n"
3011 "\n"
3012 "Dimensions: [ n_points, n_scattering_elements ]\n"),
3013 GROUP("Matrix")));
3014
3015 wsv_data.push_back(WsvRecord(
3016 NAME("pnd_field"),
3018 "Particle number density field.\n"
3019 "\n"
3020 "This variable holds the particle number density fields for all\n"
3021 "scattering elements being read in the WSMs\n"
3022 "*ScatElementsPndAndScatAdd* or *ScatSpeciesPndAndScatAdd* and\n"
3023 "interpolated to the calculation grids *p_grid*, *lat_grid*, and\n"
3024 "*lon_grid* inside the cloudbox. An alternative method to create\n"
3025 "*pnd_field* is *pnd_fieldCalcFromParticleBulkProps*.\n"
3026 "\n"
3027 "Total number and order of scattering elements in *pnd_field* and (the\n"
3028 "flattened) *scat_data* has to be identical.\n"
3029 "\n"
3030 "Note: To ensure that no particles exist outside the cloudbox,\n"
3031 "*pnd_field* is required to be 0 at its outer limits (corresponding\n"
3032 "to the *cloudbox_limits*).\n"
3033 "\n"
3034 "Usage: Set by user or output of *pnd_fieldCalcFromParticleBulkProps*\n"
3035 "\n"
3036 "Unit: m^-3\n"
3037 "\n"
3038 "Size: [number of scattering elements, \n"
3039 " (*cloudbox_limits*[1] - *cloudbox_limits*[0]) +1, \n"
3040 " (*cloudbox_limits*[3] - *cloudbox_limits*[2]) +1, \n"
3041 " (*cloudbox_limits*[5] - *cloudbox_limits*[4]) +1 ] \n"),
3042 GROUP("Tensor4")));
3043
3044 wsv_data.push_back(WsvRecord(
3045 NAME("pnd_size_grid"),
3047 "The particle sizes associated with *pnd_data*.\n"
3048 "\n"
3049 "This variable holds the size of each scattering element considered.\n"
3050 "Size can be defined differently, depending on particle size distribution\n"
3051 "used. Most common choices should by equivalent diameter, maximum diameter\n"
3052 "and mass.\n"
3053 "\n"
3054 "Dimension: [ n_sizes ]\n"),
3055 GROUP("Vector")));
3056
3057 wsv_data.push_back(WsvRecord(
3058 NAME("pnd_field_raw"),
3060 "The particle number density field raw data.\n"
3061 "\n"
3062 "This variable contains the particle number density data for all\n"
3063 "considered scattering elements. *pnd_field_raw* is an Array of\n"
3064 "GriddedField3. It includes one GriddedField3 for each scattering\n"
3065 "element, which contains both the data and the corresponding grids.\n"
3066 "\n"
3067 "Usage: Set by the user. Input to methods *ScatElementsPndAndScatAdd* and \n"
3068 " *ScatSpeciesPndAndScatAdd*\n"
3069 "\n"
3070 "Unit: m^-3\n"
3071 "\n"
3072 "Size: Array[number of scattering elementst]\n"
3073 " GriddedField3 \n "
3074 " [number of pressure levels] \n"
3075 " [number of latitudes] \n"
3076 " [number of longitudes] \n"
3077 " [number of pressure levels, number of latitudes, number of longitudes]\n"),
3078 GROUP("ArrayOfGriddedField3")));
3079
3080 wsv_data.push_back(WsvRecord(
3081 NAME("ppath"),
3083 "The propagation path for one line-of-sight.\n"
3084 "\n"
3085 "This variable describes the total (pencil beam) propagation path for\n"
3086 "a given combination of starting point and line-of-sight. The path is\n"
3087 "described by a data structure of type Ppath. This structure contains\n"
3088 "also additional fields to faciliate the calculation of spectra and\n"
3089 "interpolation of the atmospheric fields.\n"
3090 "\n"
3091 "The data struture is too extensive to be described here, but it is\n"
3092 "described carefully in the ARTS user guide (AUG). Use the index to\n"
3093 "find where the data structure, Ppath, for propagation paths is \n"
3094 "discussed. It is listed as a subentry to \"data structures\".\n"
3095 "\n"
3096 "Usage: Output from *ppath_agenda*.\n"),
3097 GROUP("Ppath")));
3098
3099 wsv_data.push_back(
3100 WsvRecord(NAME("ppath_agenda"),
3101 DESCRIPTION("Agenda calculating complete propagation paths.\n"),
3102 GROUP("Agenda")));
3103
3104 wsv_data.push_back(WsvRecord(
3105 NAME("ppath_field"),
3107 "An array meant to build up the necessary geometries for radiative\n"
3108 "field calculations.\n"
3109 "\n"
3110 "Can be ordered or not\n"
3111 "\n"
3112 "Size: user-defined\n"),
3113 GROUP("ArrayOfPpath")));
3114
3115 wsv_data.push_back(WsvRecord(
3116 NAME("ppath_inside_cloudbox_do"),
3118 "Flag to perform ray tracing inside the cloudbox.\n"
3119 "\n"
3120 "Standard propagation path calculations stop at the boundary of the\n"
3121 "cloudbox, or stop directly if started inside the cloudbox. This WSV\n"
3122 "allows scattering methods to obtain propagation paths inside the\n"
3123 "cloudbox. Hence, this variable is for internal usage primarily.\n"
3124 "\n"
3125 "Usage: For communication between modules of arts.\n"),
3126 GROUP("Index")));
3127
3128 wsv_data.push_back(WsvRecord(
3129 NAME("ppath_lmax"),
3131 "Maximum length between points describing propagation paths.\n"
3132 "\n"
3133 "See *ppath_stepGeometric* for a description of this variable.\n"
3134 "\n"
3135 "Usage: Ppath methods such as *ppath_stepGeometric*.\n"),
3136 GROUP("Numeric")));
3137
3138 wsv_data.push_back(WsvRecord(
3139 NAME("ppath_lraytrace"),
3141 "Maximum length of ray tracing steps when determining propagation\n"
3142 "paths.\n"
3143 "\n"
3144 "See *ppath_stepRefractionBasic* for a description of this variable.\n"
3145 "\n"
3146 "Usage: Refraction ppath methods such as *ppath_stepRefractionBasic*.\n"),
3147 GROUP("Numeric")));
3148
3149 wsv_data.push_back(WsvRecord(
3150 NAME("ppath_step"),
3152 "A propagation path step.\n"
3153 "\n"
3154 "The main intention of this variable is communication with the agenda\n"
3155 "*ppath_step_agenda*.\n"
3156 "\n"
3157 "See *ppath_step_agenda* for more information on this variable and\n"
3158 "the calculation of propagation paths. Or read the chapter on\n"
3159 "propagation paths in the ARTS user guide.\n"
3160 "\n"
3161 "Usage: In/output to/from *ppath_step_agenda*.\n"
3162 "\n"
3163 "Members: See AUG.\n"),
3164 GROUP("Ppath")));
3165
3166 wsv_data.push_back(
3167 WsvRecord(NAME("ppath_step_agenda"),
3168 DESCRIPTION("Agenda calculating a propagation path step.\n"),
3169 GROUP("Agenda")));
3170
3171 wsv_data.push_back(WsvRecord(
3172 NAME("ppvar_f"),
3174 "Doppler adjusted frequencies along the propagation path.\n"
3175 "\n"
3176 "See *ppvar_p* for a general description of WSVs of ppvar-type.\n"
3177 "\n"
3178 "Dimension: [ number of frequencies, ppath.np ]\n"
3179 "\n"
3180 "Usage: Output of radiative transfer methods.\n"),
3181 GROUP("Matrix")));
3182
3183 wsv_data.push_back(WsvRecord(
3184 NAME("ppvar_iy"),
3186 "iy-values along the propagation path.\n"
3187 "\n"
3188 "See *ppvar_p* for a general description of WSVs of ppvar-type.\n"
3189 "\n"
3190 "Dimension: [ number of frequencies, stokes_dim, ppath.np ]\n"
3191 "\n"
3192 "Usage: Output of radiative transfer methods.\n"),
3193 GROUP("Tensor3")));
3194
3195 wsv_data.push_back(WsvRecord(
3196 NAME("ppvar_mag"),
3198 "Magnetic field along the propagation path.\n"
3199 "\n"
3200 "See *ppvar_p* for a general description of WSVs of ppvar-type.\n"
3201 "\n"
3202 "Dimension: [ 3, ppath.np ]\n"
3203 "\n"
3204 "Usage: Output of radiative transfer methods.\n"),
3205 GROUP("Matrix")));
3206
3207 wsv_data.push_back(WsvRecord(
3208 NAME("ppvar_nlte"),
3210 "Non-LTE temperatures/ratios along the propagation path.\n"
3211 "\n"
3212 "See *ppvar_p* for a general description of WSVs of ppvar-type.\n"
3213 "\n"
3214 "Dimension: [ number of non-lte temperatures, 1, 1, ppath.np ]\n"
3215 "\n"
3216 "Usage: Output of radiative transfer methods.\n"),
3217 GROUP("EnergyLevelMap")));
3218
3219 wsv_data.push_back(WsvRecord(
3220 NAME("ppvar_p"),
3222 "Pressure along the propagation path.\n"
3223 "\n"
3224 "ppvar stands for propagation path variable. The variables named in is\n"
3225 "way describe the atmosphere and its properties at each point of the\n"
3226 "propagation path\n"
3227 "\n"
3228 "Dimension: [ ppath.np ]\n"
3229 "\n"
3230 "Usage: Output of radiative transfer methods.\n"),
3231 GROUP("Vector")));
3232
3233 wsv_data.push_back(WsvRecord(
3234 NAME("ppvar_pnd"),
3236 "PND values along the propagation path.\n"
3237 "\n"
3238 "See *ppvar_p* for a general description of WSVs of ppvar-type.\n"
3239 "\n"
3240 "Dimension: [ number of scattering elements, ppath.np ]\n"
3241 "\n"
3242 "Usage: Output of radiative transfer methods.\n"),
3243 GROUP("Matrix")));
3244
3245 wsv_data.push_back(WsvRecord(
3246 NAME("ppvar_optical_depth"),
3248 "The optical depth between the sensor and each point of the propagation path.\n"
3249 "\n"
3250 "Returned as the one-way optical depth even in the case of radar\n"
3251 "simulations. Just a scalar value, i.e. no polarisation information is\n"
3252 "provided.\n"
3253 "\n"
3254 "See *ppvar_p* for a general description of WSVs of ppvar-type.\n"
3255 "\n"
3256 "Dimension: [ ppath.np, f_grid]\n"
3257 "\n"
3258 "Usage: Output of radiative transfer methods.\n"),
3259 GROUP("Matrix")));
3260
3261 wsv_data.push_back(WsvRecord(
3262 NAME("ppvar_t"),
3264 "Temperature along the propagation path.\n"
3265 "\n"
3266 "See *ppvar_p* for a general description of WSVs of ppvar-type.\n"
3267 "\n"
3268 "Dimension: [ ppath.np ]\n"
3269 "\n"
3270 "Usage: Output of radiative transfer methods.\n"),
3271 GROUP("Vector")));
3272
3273 wsv_data.push_back(WsvRecord(
3274 NAME("ppvar_trans_cumulat"),
3276 "The transmittance between the sensor and each point of the propagation path.\n"
3277 "\n"
3278 "See *ppvar_p* for a general description of WSVs of ppvar-type.\n"
3279 "\n"
3280 "Dimension: [ ppath.np, f_grid, stokes_dim, stokes_dim ]\n"
3281 "\n"
3282 "Usage: Output of radiative transfer methods.\n"),
3283 GROUP("Tensor4")));
3284
3285 wsv_data.push_back(WsvRecord(
3286 NAME("ppvar_trans_partial"),
3288 "The transmittance between the points along the propagation path.\n"
3289 "\n"
3290 "To maintain consistency in size also this variable stores np transmissivities,\n"
3291 "while there are only np-1 distances between the points of the ppath. The\n"
3292 "extra values placed at index 0 and can be seen as the transmissivities\n"
3293 "between the sensor and the start of the ppath. These transmissivities\n"
3294 "are always unity. That is, the transmissivities between ppath point i and i+1\n"
3295 "are found at index i+1 in *ppvar_trans_partial*.\n"
3296 "\n"
3297 "See *ppvar_p* for a general description of WSVs of ppvar-type.\n"
3298 "\n"
3299 "Dimension: [ ppath.np, f_grid, stokes_dim, stokes_dim ]\n"
3300 "\n"
3301 "Usage: Output of radiative transfer methods.\n"),
3302 GROUP("Tensor4")));
3303
3304 wsv_data.push_back(WsvRecord(
3305 NAME("ppvar_vmr"),
3307 "VMR values along the propagation path.\n"
3308 "\n"
3309 "See *ppvar_p* for a general description of WSVs of ppvar-type.\n"
3310 "\n"
3311 "Dimension: [ number of abs. species, ppath.np ]\n"
3312 "\n"
3313 "Usage: Output of radiative transfer methods.\n"),
3314 GROUP("Matrix")));
3315
3316 wsv_data.push_back(WsvRecord(
3317 NAME("ppvar_wind"),
3319 "Winds along the propagation path.\n"
3320 "\n"
3321 "See *ppvar_p* for a general description of WSVs of ppvar-type.\n"
3322 "\n"
3323 "Dimension: [ 3, ppath.np ]\n"
3324 "\n"
3325 "Usage: Output of radiative transfer methods.\n"),
3326 GROUP("Matrix")));
3327
3328 wsv_data.push_back(WsvRecord(
3329 NAME("propmat_clearsky"),
3331 "This contains the absorption coefficients for one point in the\n"
3332 "atmosphere (one set of pressure, temperature, magnetic field, and\n"
3333 "VMR values).\n"
3334 "\n"
3335 "Dimensions: [naa, nza, nf, f(stokes_dim)]\n"
3336 "\n"
3337 "Unit: 1/m\n"),
3338 GROUP("PropagationMatrix")));
3339
3340 wsv_data.push_back(
3341 WsvRecord(NAME("propmat_clearsky_agenda_checked"),
3342 DESCRIPTION("OK-flag for *propmat_clearsky_agenda*.\n"
3343 "\n"
3344 "Set by *propmat_clearsky_agenda_checkedCalc*.\n"),
3345 GROUP("Index")));
3346
3347 wsv_data.push_back(WsvRecord(
3348 NAME("propmat_clearsky_agenda"),
3349 DESCRIPTION("Agenda calculating the absorption coefficient matrices.\n"),
3350 GROUP("Agenda")));
3351
3352 wsv_data.push_back(WsvRecord(
3353 NAME("propmat_clearsky_field"),
3355 "Gas absorption field.\n"
3356 "\n"
3357 "Contains the (polarized) gas absorption coefficients for all species\n"
3358 "as a function of *f_grid*, *p_grid*, *lat_grid*, and *lon_grid*. \n"
3359 "\n"
3360 "This is mainly for testing and plotting gas absorption. For RT\n"
3361 "calculations, gas absorption is calculated or extracted locally,\n"
3362 "therefore there is no need to store a global field. But this variable\n"
3363 "is handy for easy plotting of absorption vs. pressure, for example.\n"
3364 "\n"
3365 "Unit: 1/m\n"
3366 "\n"
3367 "Dimensions: [species, f_grid, *stokes_dim*, stokes_dim, p_grid, lat_grid, lon_grid]\n"),
3368 GROUP("Tensor7")));
3369
3370 wsv_data.push_back(WsvRecord(
3371 NAME("psd_data"),
3373 "Particle size distribution values for a set of points.\n"
3374 "\n"
3375 "The variable contains particle size distribution data for one scattering\n"
3376 "species. The row dimension corresponds to different positions, in the\n"
3377 "same way as *pnd_agenda_input* is defined.\n"
3378 "\n"
3379 "Dimensions: [ n_points, n_scattering_elements ]\n"),
3380 GROUP("Matrix")));
3381
3382 wsv_data.push_back(WsvRecord(
3383 NAME("psd_size_grid"),
3385 "The particle sizes associated with *psd_data*.\n"
3386 "\n"
3387 "This variable holds the size of each scattering element considered.\n"
3388 "Size can be defined differently, depending on particle size distribution\n"
3389 "used. Most common choices should by equivalent diameter, maximum diameter\n"
3390 "and mass.\n"
3391 "\n"
3392 "Dimension: [ n_sizes ]\n"),
3393 GROUP("Vector")));
3394
3395 wsv_data.push_back(WsvRecord(
3396 NAME("p_grid"),
3398 "The pressure grid.\n"
3399 "\n"
3400 "The pressure levels on which the atmospheric fields are defined.\n"
3401 "This variable must always be defined. The grid must be sorted in\n"
3402 "decreasing order, with no repetitions.\n"
3403 "\n"
3404 "No gap between the lowermost pressure level and the surface is \n"
3405 "allowed. The uppermost pressure level defines the practical upper\n"
3406 "limit of the atmosphere as vacuum is assumed above.\n"
3407 "\n"
3408 "See further the ARTS user guide (AUG). Use the index to find where\n"
3409 "this variable is discussed. The variable is listed as a subentry to\n"
3410 "\"workspace variables\".\n"
3411 "\n"
3412 "Usage: Set by the user.\n"
3413 "\n"
3414 "Unit: Pa\n"),
3415 GROUP("Vector")));
3416
3417 wsv_data.push_back(WsvRecord(
3418 NAME("p_grid_orig"),
3420 "The original pressure grid before optimization.\n"
3421 "\n"
3422 "This variable is used to interpolate *cloudbox_field* back to its original\n"
3423 "size after the calculation with *OptimizeDoitPressureGrid*.\n"
3424 " The variable is listed as a subentry to\n"
3425 "\"workspace variables\".\n"
3426 "\n"
3427 "Usage: Set by the user.\n"
3428 "\n"
3429 "Unit: Pa\n"),
3430 GROUP("Vector")));
3431
3432 wsv_data.push_back(WsvRecord(
3433 NAME("p_hse"),
3435 "Reference pressure calculation of hydrostatic equilibrium.\n"
3436 "\n"
3437 "The altitude specified by this pressure is used as the reference\n"
3438 "when calculating hydrostatic equilibrium. That is, the geometrical\n"
3439 "altitude at this pressure is not changed.\n"
3440 "\n"
3441 "Usage: Set by the user.\n"
3442 "\n"
3443 "Unit: Pa\n"),
3444 GROUP("Numeric")));
3445 wsv_data.push_back(WsvRecord(
3446 NAME("radiance_field"),
3448 "Radiance field.\n"
3449 "\n"
3450 "Radiant flux received by a surface per unit solid angle and per unit\n"
3451 "area for each hemisphere. The last dimension denotes the hemispheres.\n"
3452 "The first component is the downward radiance and the second component\n"
3453 "is the upward radiance.\n"
3454 "\n"
3455 "Units: W / (m^2 sr)\n"
3456 "\n"
3457 "Size: [p_grid, \n"
3458 " lat_grid, \n"
3459 " lon_grid, \n"
3460 " N_za, N_aa\n"),
3461 GROUP("Tensor5")));
3462
3463 wsv_data.push_back(WsvRecord(
3464 NAME("range_bins"),
3466 "The range bins of an active instrument.\n"
3467 "\n"
3468 "The bins are assumed to cover a range without gaps, and the bins are\n"
3469 "defined by their edges. That is, the length of this vector is the\n"
3470 "number of bins + 1.\n"
3471 "\n"
3472 "The bins can potentially be defined in two ways, by altitude or time.\n"
3473 "See the method you are using, if this variable shall hold time or\n"
3474 "altitude (or maybe both options are treated).\n"
3475 "\n"
3476 "Unit: m or s\n"),
3477 GROUP("Vector")));
3478
3479 wsv_data.push_back(WsvRecord(
3480 NAME("refr_index_air"),
3482 "Real part of the refractive index of air.\n"
3483 "\n"
3484 "The variable contains the refractive index summed over all relevant\n"
3485 "constituents, at one position in the atmosphere. This refractive\n"
3486 "is related to the phase velocity. See also *refr_index_air_group*.\n"
3487 "\n"
3488 "Unit: 1\n"),
3489 GROUP("Numeric")));
3490
3491 wsv_data.push_back(WsvRecord(
3492 NAME("refr_index_air_agenda"),
3493 DESCRIPTION("Agenda calculating the refractive index of air.\n"),
3494 GROUP("Agenda")));
3495
3496 wsv_data.push_back(WsvRecord(
3497 NAME("refr_index_air_group"),
3499 "Group index of refractivity.\n"
3500 "\n"
3501 "This variable is defined as the ratio between group velocity and the\n"
3502 "speed of ligh in vacuum. That is, it is defined as the \"standard\"\n"
3503 "refractive index, but refers to the group velocity instead of the\n"
3504 "phase velocity. See also *refr_index_air*.\n"
3505 "\n"
3506 "Unit: 1\n"),
3507 GROUP("Numeric")));
3508
3509 wsv_data.push_back(WsvRecord(
3510 NAME("refellipsoid"),
3512 "Reference ellipsoid.\n"
3513 "\n"
3514 "This vector specifies the shape of the reference ellipsoid. The\n"
3515 "vector must have length 2, where the two elements are:\n"
3516 " 1: Equatorial radius.\n"
3517 " 2: The eccentricity.\n"
3518 "The eccentricity is sqrt(1-b*b/a*a) where a and b are equatorial and\n"
3519 "polar radius, respectively. If the eccentricity is set to 0, an\n"
3520 "average radius should be used instead of the equatorial one.\n"
3521 "\n"
3522 "The eccentricity must be 0 for 1D calculations, as a spherical Earth\n"
3523 "is implied by setting *atmosphere_dim* to 1. For 2D, the selected\n"
3524 "ellipsoid parameters should be selected according to cross-section\n"
3525 "between the real ellipsoid and the 2D plane considered. That is\n"
3526 "the applied ellipsoid shall have een converted to match the internal\n"
3527 "treatment of 2D cases. For 3D, models can be used, such as WGS84.\n"
3528 "\n"
3529 "Usage: Set by the user.\n"
3530 "\n"
3531 "Size: [ 2 ]\n"),
3532 GROUP("Vector")));
3533
3534 wsv_data.push_back(
3535 WsvRecord(NAME("relmat_per_band"),
3536 DESCRIPTION("Relaxation matrix per band per pressure level.\n"
3537 "\n"
3538 "Dimensions: [pressures][band][n_linex, nlines]\n"
3539 "Units: Hz/Pa in HWHM\n"),
3540 GROUP("ArrayOfArrayOfMatrix")));
3541
3542 wsv_data.push_back(WsvRecord(
3543 NAME("relmat_type_per_band"),
3544 DESCRIPTION("Used to set the type of line mixing relaxation matrix\n"
3545 "that will be calculated.\n"
3546 "\n"
3547 "Supported types by index:\n"
3548 " 0: Hartmann-Tran type relaxation matrix.\n"
3549 " 1: Linear type relaxation matrix.\n"
3550 "\n"
3551 "Dimensions: [number of bands]\n"),
3552 GROUP("ArrayOfIndex")));
3553
3554 wsv_data.push_back(WsvRecord(
3555 NAME("retrieval_checked"),
3557 "Flag indicating completeness and consistency of retrieval setup.\n"
3558 "\n"
3559 "Unit: Boolean\n"),
3560 GROUP("Index")));
3561
3562 wsv_data.push_back(WsvRecord(
3563 NAME("retrieval_eo"),
3565 "The estimated error in the retrieval due to uncertainty in the observations.\n"
3566 "\n"
3567 "The vector contains the square roots of the diagonal elements of the\n"
3568 "covariance matrix of the error due to measurement noise, S_m in Rodgers'\n"
3569 " book.\n"),
3570 GROUP("Vector")));
3571
3572 wsv_data.push_back(WsvRecord(
3573 NAME("retrieval_ss"),
3575 "The estimated error in the retrieval due to limited resolution of the\n"
3576 "observation system.\n"
3577 "\n"
3578 "The vector contains the square roots of the diagonal\n"
3579 "elements of the covariance matrix of the smoothing error, S_s in Rodgers'\n"
3580 "book.\n"),
3581 GROUP("Vector")));
3582
3583 wsv_data.push_back(WsvRecord(
3584 NAME("rte_alonglos_v"),
3586 "Velocity along the line-of-sight to consider for a RT calculation.\n"
3587 "\n"
3588 "This variable gives the velocity of the imaginary detector in\n"
3589 "monochromatic pencil beam calculations. The relevant velocity is\n"
3590 "the projection along the line-of-sight (ie. total velocity shall not\n"
3591 "be given). A positive value means a movement of the detector in the\n"
3592 "same direction as the line-of-sight.\n"
3593 "\n"
3594 "This variable is required to include Doppler effects due to\n"
3595 "velocities of the observer, relative the centre of the coordinate\n"
3596 "system used that is fixed to the planets centre point.\n"
3597 "\n"
3598 "Unit: [ m/s ]\n"),
3599 GROUP("Numeric")));
3600
3601 wsv_data.push_back(WsvRecord(
3602 NAME("rte_los"),
3604 "A line-of-sight for (complete) radiative transfer calculations.\n"
3605 "\n"
3606 "This variable gives the observation direction for monochromatic\n"
3607 "pencil beam calculations. Hence, it is the line-of-sight at the end\n"
3608 "point of the propagation path.\n"
3609 "\n"
3610 "For 1D and 2D cases, *rte_los* is a vector of length 1 holding the \n"
3611 "zenith angle. For 3D, the length of the vector is 2, where the\n"
3612 "additional element is the azimuthal angle. These angles are defined\n"
3613 "in the ARTS user guide (AUG). Look in the index for \"zenith angle\"\n"
3614 "and \"azimuthal angle\".\n"
3615 "\n"
3616 "Usage: See above.\n"
3617 "\n"
3618 "Units: [ degree, degree ]\n"
3619 "\n"
3620 "Size: [ 1 or 2 ]\n"),
3621 GROUP("Vector")));
3622
3623 wsv_data.push_back(WsvRecord(
3624 NAME("rte_pos"),
3626 "A geographical position for starting radiative transfer calculations.\n"
3627 "\n"
3628 "This variable gives the observation position for monochromatic\n"
3629 "pencil beam calculations. Hence, it is the end point of the\n"
3630 "propagation path.\n"
3631 "\n"
3632 "This variable is a vector with a length equalling the atmospheric\n"
3633 "dimensionality. The first element is the geometrical altitude.\n"
3634 "Element 2 is the latitude and element 3 is the longitude.\n"
3635 "\n"
3636 "Usage: See above. \n"
3637 "\n"
3638 "Units: [ m, degree, degree ]\n"
3639 "\n"
3640 "Size: [ atmosphere_dim ]\n"),
3641 GROUP("Vector")));
3642
3643 wsv_data.push_back(WsvRecord(
3644 NAME("rte_pos2"),
3646 "A second geographical position to define the geometry for\n"
3647 "radiative transfer calculations.\n"
3648 "\n"
3649 "This variable is used when the propagation path is defined by two\n"
3650 "positions, instead of a position (*rte_pos*) and a line-of-sight\n"
3651 "(*rte_los*). That is, this variable basically replaces *rte_los*\n"
3652 "for the cases of consideration. In practice, *rte_los* is determined\n"
3653 "by finding the propagation path between *rte_pos* and *rte_pos2*.\n"
3654 "\n"
3655 "As *rte_pos* with the exception that a \"latitude\" must also be\n"
3656 "specified for 1D. This is the angular distance to *rte_pos*, where\n"
3657 "this distance is defined as the 2D-\"latitude\".\n"
3658 "\n"
3659 "Usage: See above. \n"
3660 "\n"
3661 "Units: [ m, degree, degree ]\n"
3662 "\n"
3663 "Size: [ atmosphere_dim ]\n"),
3664 GROUP("Vector")));
3665
3666 wsv_data.push_back(WsvRecord(
3667 NAME("rtp_mag"),
3669 "Magnetic field at a radiative transfer point.\n"
3670 "\n"
3671 "See *mag_u_field* etc. for a definition of the different components.\n"
3672 "For this variable the components are put together and thus defines\n"
3673 "magnetic field vector. Hence, this is a vector of length three, even\n"
3674 "if any of the input fields is set to be empty.\n"
3675 "\n"
3676 "The WSV is used as input to methods and agendas calculating radiative\n"
3677 "properties for a given conditions.\n"
3678 "\n"
3679 "Usage: Communication variable.\n"
3680 "\n"
3681 "Units: T\n"
3682 "\n"
3683 "Size: [ u-component, v-component, w-component ]\n"),
3684 GROUP("Vector")));
3685
3686 wsv_data.push_back(WsvRecord(
3687 NAME("rtp_los"),
3689 "Line-of-sight at a radiative transfer point.\n"
3690 "\n"
3691 "This variable holds a local line-of-sight. The angles of this\n"
3692 "vector are defined as for *rte_los*.\n"
3693 "\n"
3694 "The WSV is used as input to methods and agendas calculating radiative\n"
3695 "properties for a given conditions.\n"
3696 "\n"
3697 "Usage: Communication variable.\n"
3698 "\n"
3699 "Units: [ degree, degree ]\n"
3700 "\n"
3701 "Size: [ 1 or 2 ]\n"),
3702 GROUP("Vector")));
3703
3704 wsv_data.push_back(WsvRecord(
3705 NAME("rtp_pos"),
3707 "Position of a radiative transfer point.\n"
3708 "\n"
3709 "This vector is defined as *rte_pos*, but holds a position along\n"
3710 "the propgation path, or the start point for new paths, in contrast\n"
3711 "to *rte_pos* that is position of the (imaginary) detector.\n"
3712 "\n"
3713 "The WSV is used as input to methods and agendas calculating radiative\n"
3714 "properties for a given conditions.\n"
3715 "\n"
3716 "Usage: Communication variable.\n"
3717 "\n"
3718 "Units: [ m, degree, degree ]\n"
3719 "\n"
3720 "Size: [ atmosphere_dim ]\n"),
3721 GROUP("Vector")));
3722
3723 wsv_data.push_back(WsvRecord(
3724 NAME("rtp_pressure"),
3726 "Pressure at a radiative transfer point.\n"
3727 "\n"
3728 "This scalar variable holds the local pressure.\n"
3729 "\n"
3730 "The WSV is used as input to methods and agendas calculating radiative\n"
3731 "properties for a given conditions.\n"
3732 "\n"
3733 "Usage: Communication variable.\n"
3734 "\n"
3735 "Units: [ Pa ]\n"),
3736 GROUP("Numeric")));
3737
3738 wsv_data.push_back(WsvRecord(
3739 NAME("rtp_temperature"),
3741 "Temperature at a radiative transfer point.\n"
3742 "\n"
3743 "This scalar variable can hold the local temperature. It is intended\n"
3744 "mainly for communication with various methods and agendas, such as\n"
3745 "methods and agendas calculating absorption coefficients.\n"
3746 "The WSV is used as input to methods and agendas calculating radiative\n"
3747 "properties for a given conditions.\n"
3748 "\n"
3749 "Usage: Communication variable.\n"
3750 "\n"
3751 "Units: [ K ]\n"),
3752 GROUP("Numeric")));
3753
3754 wsv_data.push_back(WsvRecord(
3755 NAME("rt_integration_option"),
3757 "Switch between integration approaches for radiative transfer steps.\n"
3758 "\n"
3759 "See each WSM using this varaible as input for available options.\n"),
3760 GROUP("String")));
3761
3762 wsv_data.push_back(WsvRecord(
3763 NAME("rtp_nlte"),
3765 "NLTE temperature/ratio at a radiative transfer point.\n"
3766 "\n"
3767 "This vector variable can hold the NLTE temperature/ratio. It is intended\n"
3768 "mainly for communication with various methods and agendas, such as\n"
3769 "methods and agendas calculating absorption coefficients.\n"
3770 "The WSV is used as input to methods and agendas calculating radiative\n"
3771 "properties for a given conditions.\n"
3772 "\n"
3773 "Usage: Communication variable.\n"
3774 "\n"
3775 "Units: [ K/# ]\n"
3776 "Size: [ NLTE levels, 1, 1, 1 ] or [ 0, 0, 0, 0 ]\n"),
3777 GROUP("EnergyLevelMap")));
3778
3779 wsv_data.push_back(WsvRecord(
3780 NAME("rtp_vmr"),
3782 "Absorption species abundances for radiative transfer calculations.\n"
3783 "\n"
3784 "This vector variable holds the local abundance of the constituents\n"
3785 "included in *abs_species*.\n"
3786 "\n"
3787 "The WSV is used as input to methods and agendas calculating radiative\n"
3788 "properties for a given conditions.\n"
3789 "\n"
3790 "Usage: Communication variable.\n"
3791 "\n"
3792 "Units: [ Differ between the elements, can be VMR, kg/m3 or #/m3. ]\n"
3793 "\n"
3794 "Size: Should match abs_species.nelem()\n"),
3795 GROUP("Vector")));
3796
3797 wsv_data.push_back(WsvRecord(
3798 NAME("scat_data"),
3800 "Array of single scattering data.\n"
3801 "\n"
3802 "As *scat_data_raw*, but with frequency grids and dimensions reduced\n"
3803 "to the RT's *f_grid* or a single frequency entry. Also, temperature\n"
3804 "grid or dimensions can be reduced to a single entry, meaning no\n"
3805 "temperature interpolation is done for the respective data.\n"
3806 "\n"
3807 "Standard approach to derive scat_data is to use *scat_dataCalc* to\n"
3808 "derive it from *scat_data_raw*."),
3809 GROUP("ArrayOfArrayOfSingleScatteringData")));
3810
3811 wsv_data.push_back(WsvRecord(
3812 NAME("scat_data_checked"),
3814 "OK-flag for *scat_data*.\n"
3815 "\n"
3816 "Relevant checks are performed by *scat_data_checkedCalc. Only the\n"
3817 "value 1 is taken as OK.\n"),
3818 GROUP("Index")));
3819
3820 wsv_data.push_back(WsvRecord(
3821 NAME("scat_data_raw"),
3823 "Array of raw single scattering data.\n"
3824 "\n"
3825 "This variable holds the single scattering properties for all \n"
3826 "scattering elements, organized according to their assignment to a\n"
3827 "scattering species. *scat_data_raw* entries can be derived from\n"
3828 "precalculated data files using the methods *ScatElementsPndAndScatAdd*,\n"
3829 "*ScatSpeciesPndAndScatAdd*, or *ScatSpeciesScatAndMetaRead* or\n"
3830 "can be calculated using *scat_data_singleTmatrix*.\n"
3831 "\n"
3832 "This may be used in combination with *scat_meta*\n"
3833 "\n"
3834 "Usage: Method ouput.\n"
3835 "\n"
3836 "Members: SingleScatteringData:\n"
3837 " Enum[ptype attribute]\n"
3838 " String[description] \n"
3839 " Vector[f_grid]\n"
3840 " Vector[T_grid]\n"
3841 " Vector[za_grid]\n"
3842 " Vector[aa_grid]\n"
3843 " Tensor7[pha_mat_data]\n"
3844 " [f_grid, T_grid, za_grid, aa_grid, za_grid, aa_grid, matrix_element]\n"
3845 " ^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^\n"
3846 " scattered incoming\n"
3847 " Tensor5[ext_mat_data]\n"
3848 " [f_grid, T_grid, za_grid, aa_grid, matrix_element]\n"
3849 " Tensor5[abs_vec_data]\n"
3850 " [f_grid, T_grid, za_grid, aa_grid, matrix_element]\n"
3851 "\n"
3852 "Dimensions: [number of scattering species][number of scattering elements] \n"),
3853 GROUP("ArrayOfArrayOfSingleScatteringData")));
3854
3855 wsv_data.push_back(WsvRecord(
3856 NAME("scat_data_mono"),
3858 "Monochromatic single scattering data.\n"
3859 "\n"
3860 "This variable holds the single scattering properties for all\n"
3861 "scattering species and scattering elements for a specified frequency.\n"
3862 "It can be calculated from *scat_data* using *scat_data_monoCalc*,\n"
3863 "which interpolates *scat_data* to the required frequency.\n"),
3864 GROUP("ArrayOfArrayOfSingleScatteringData")));
3865
3866 wsv_data.push_back(WsvRecord(
3867 NAME("scat_data_single"),
3869 "Structure for the single scattering data.\n"
3870 "\n"
3871 "Comprises the single scattering data of a single scattering element.\n"
3872 "See ARTS user guide for further information.\n"
3873 "\n"
3874 "Usage: Set by the user.\n"
3875 "\n"
3876 "Dimensions: SingleScatteringData \n"
3877 " Enum[ptype attribute]\n"
3878 " String[description] \n"
3879 " Vector[f_grid]\n"
3880 " Vector[T_grid]\n"
3881 " Vector[za_grid]\n"
3882 " Vector[aa_grid]\n"
3883 " Tensor7[pha_mat_data]\n"
3884 " [f_grid, T_grid, za_grid, aa_grid, za_grid, aa_grid, matrix_element]\n"
3885 " ^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^\n"
3886 " scattered incoming\n"
3887 " Tensor5[ext_mat_data]\n"
3888 " [f_grid, T_grid, za_grid, aa_grid, matrix_element]\n"
3889 " Tensor5[abs_vec_data]\n"
3890 " [f_grid, T_grid, za_grid, aa_grid, matrix_element]\n"),
3891 GROUP("SingleScatteringData")));
3892
3893 wsv_data.push_back(WsvRecord(
3894 NAME("scat_lat_index"),
3896 "Latitude index for scattering calculations.\n"
3897 "\n"
3898 "This variable is used in methods used for computing scattering\n"
3899 "properties of scattering elements like *opt_prop_sptFromData* and\n"
3900 "*pha_matCalc*. It holds the information about the position for which the\n"
3901 "scattering calculations are done.\n"
3902 "\n"
3903 "Usage: Input to the methods *spt_calc_agenda*,\n"
3904 " *pha_mat_spt_agenda*\n"),
3905 GROUP("Index")));
3906
3907 wsv_data.push_back(WsvRecord(
3908 NAME("scat_lon_index"),
3910 "Longitude index for scattering calculations.\n"
3911 "\n"
3912 "This variable is used in methods used for computing scattering\n"
3913 "properties of scattering elements like *opt_prop_sptFromData* and\n"
3914 "*pha_matCalc*. It holds the information about the position for which the\n"
3915 "scattering calculations are done.\n"
3916 "\n"
3917 "Usage: Input to the methods *spt_calc_agenda*,\n"
3918 " *pha_mat_spt_agenda*\n"),
3919 GROUP("Index")));
3920
3921 wsv_data.push_back(WsvRecord(
3922 NAME("scat_meta_single"),
3924 "Structure for the scattering meta data.\n"
3925 "\n"
3926 "This variable holds the scattering meta data for a single scattering\n"
3927 "element (see AUG for definition). Scattering meta data comprises\n"
3928 "the microphysical description of the scattering element as necessary\n"
3929 "to relate single scattering properties with mass density or flux\n"
3930 "fields. That is, e.g., in order to handle the scattering element in\n"
3931 "particle size (and shape) distribution calculations.\n"
3932 "\n"
3933 "For a definition of the structure members see below.\n"
3934 "\n"
3935 "Members of Numeric type can be flagged as unknown by setting them to\n"
3936 "NAN. This will cause a runtime error in case the parameter is needed in\n"
3937 "the calculation, but will be ignored otherwise.\n"
3938 "\n"
3939 "Usage: Set by the user.\n"
3940 "\n"
3941 "Members:\n"
3942 " description [*String*]\n"
3943 " Description: Free-form description of the scattering element,\n"
3944 " holding information deemed of interest by the user but not covered\n"
3945 " by other structure members (and not used within ARTS).\n"
3946 " source [*String*]\n"
3947 " Description: Free-form description of the source of the data,\n"
3948 " e.g., Mie, T-Matrix, or DDA calculation or a database or a\n"
3949 " literature source.\n"
3950 " refr_index [*String*]\n"
3951 " Description: Free-form description of the underlying complex\n"
3952 " refractive index data, e.g., a literature source.\n"
3953 " mass [*Numeric*]\n"
3954 " Unit: [kg]\n"
3955 " Description: The mass of the scattering element.\n"
3956 " diameter_max [*Numeric*]\n"
3957 " Unit: [m]\n"
3958 " Description: The maximum diameter (or dimension) of the scattering\n"
3959 " element, defined by the circumferential sphere diameter of the\n"
3960 " element. Note that this parameter is only used by some size\n"
3961 " distributions; it does not have a proper meaning if the scattering\n"
3962 " element represents an ensemble of differently sized particles.\n"
3963 " diameter_volume_equ [*Numeric*]\n"
3964 " Unit: [m]\n"
3965 " Description: The volume equivalent sphere diameter of the\n"
3966 " scattering element, i.e., the diameter of a sphere with the same\n"
3967 " volume. For nonspherical particles, volume refers to the volume\n"
3968 " of the particle-forming substance, not that of the circumferential\n"
3969 " sphere (which can be derived from diameter_max). If the particle\n"
3970 " consists of a mixture of materials, the substance\n"
3971 " encompasses the complete mixture. E.g., the substance of 'soft'\n"
3972 " ice particles includes both the ice and the air.\n"
3973 " diameter_area_equ_aerodynamical [*Numeric*]\n"
3974 " Unit: [m]\n"
3975 " Description: The area equivalent sphere diameter of the\n"
3976 " scattering element, i.e., the diameter of a sphere with the same\n"
3977 " cross-sectional area. Here, area refers to the aerodynamically\n"
3978 " relevant area, i.e., the cross-sectional area perpendicular to the\n"
3979 " direction of fall. Similarly to volume in the definition of\n"
3980 " diameter_volume_equ, for non-spherical and mixed-material\n"
3981 " particles, area refers to the area covered by the substance\n"
3982 " mixture of the particle.\n"),
3983 GROUP("ScatteringMetaData")));
3984
3985 wsv_data.push_back(WsvRecord(
3986 NAME("scat_meta"),
3988 "An Array of scattering meta data (*scat_meta_single*).\n"
3989 "\n"
3990 "The array holds the meta data for all scattering elements. For a\n"
3991 "description of the meta data contents refer to the documentation\n"
3992 "of *scat_data_single*.\n"
3993 "\n"
3994 "Corresponding to *scat_data*, it is organized in terms of scattering\n"
3995 "species (i.e., one sub-array per scattering species holding one\n"
3996 "*scat_meta_single* instance per scattering element assigned to this\n"
3997 "scattering species). It is primarily used for particle size and shape\n"
3998 "distribution calculations using *pnd_fieldCalcFromParticleBulkProps*.\n"
3999 "It is also applied for deducing microphysical characterizations of\n"
4000 "scattering species, e.g., by *particle_massesFromMetaData*.\n"
4001 "\n"
4002 "Note: This array must contain as many elements as *scat_data* (on\n"
4003 "both array levels).\n"
4004 "\n"
4005 "Usage: Set by the user.\n"
4006 "\n"
4007 "Dimensions: [scattering species][scattering elements]"
4008 "\n"
4009 "For more details, see also *scat_meta_single*.\n"),
4010 GROUP("ArrayOfArrayOfScatteringMetaData")));
4011
4012 wsv_data.push_back(WsvRecord(
4013 NAME("scat_p_index"),
4015 "Pressure index for scattering calculations.\n"
4016 "\n"
4017 "This variable is used in methods used for computing scattering\n"
4018 "properties of scattering elements like *opt_prop_sptFromData* and\n"
4019 "*pha_matCalc*. It holds the information about the location for which the\n"
4020 "scattering calculations are done.\n"
4021 "\n"
4022 "Usage: Input to the methods *spt_calc_agenda*,\n"
4023 " *pha_mat_spt_agenda*\n"),
4024 GROUP("Index")));
4025
4026 wsv_data.push_back(WsvRecord(
4027 NAME("scat_species"),
4029 "Array of Strings defining the scattering species to consider.\n"
4030 "\n"
4031 "Each String contains the information to connect scattering species\n"
4032 "(e.g., hydrometeor) atmospheric fields with the microphysical\n"
4033 "information like size and shape distributions. The strings follow\n"
4034 "the following structure with individual elements separated by dashes:\n"
4035 "\n"
4036 "- scattering species name [*String*]\n"
4037 " the name of the scattering species' atmospheric field. Free form,\n"
4038 " but is matched to *atm_fields_compact* fields by their names.\n"
4039 " Common are, e.g., IWC (ice water content), LWC (liquid water\n"
4040 " content), RR (rain rate), and SR (snow rate).\n"
4041 "- particle size distribution [*String*]:\n"
4042 " the size distribution function/parametrization to apply. For\n"
4043 " currently possible PSDs see *pnd_fieldCalcFromParticleBulkProps*.\n"
4044 "\n"
4045 "Example: [''IWC-MH97'', ''LWC-H98_STCO'', ...]\n"),
4046 GROUP("ArrayOfString")));
4047
4048 wsv_data.push_back(WsvRecord(
4049 NAME("scat_species_a"),
4051 "Mass-size relationship parameter, for one scattering species.\n"
4052 "\n"
4053 "Some methods require a relationship between mass and particle size,\n"
4054 "valid for the complete scattering species. A common model for this\n"
4055 "relationship is:\n"
4056 " mass(x) = a * x^b,\n"
4057 "where x is size (that could be Dveq, Dmax or mass) and a/b are parameters.\n"
4058 "\n"
4059 "This WSV is a in the expression above.\n"
4060 "The WSV matching b is *scat_species_b*.\n"
4061 "The WSV matching x is *scat_species_x*.\n"),
4062 GROUP("Numeric")));
4063
4064 wsv_data.push_back(WsvRecord(
4065 NAME("scat_species_b"),
4067 "Mass-size relationship parameter, for one scattering species.\n"
4068 "\n"
4069 "See *scat_species_a* for details.\n"),
4070 GROUP("Numeric")));
4071
4072 wsv_data.push_back(WsvRecord(
4073 NAME("scat_species_x"),
4075 "The size grid of one scattering species.\n"
4076 "\n"
4077 "The variable holds the sizes associated with one scattering species.\n"
4078 "The typical application of these data are as the size grid when\n"
4079 "calculating particle size distributions.\n"
4080 "\n"
4081 "The user must set this WSV as several quantities can be used as size,\n"
4082 "such as mass and maximum diamater.\n"
4083 "\n"
4084 "See also *scat_species_a*, for example usage of this WSV.\n"
4085 "\n"
4086 "Dimension: [number of scattering elements]\n"),
4087 GROUP("Vector")));
4088
4089 wsv_data.push_back(WsvRecord(
4090 NAME("sensor_checked"),
4092 "OK-flag for sensor related variables.\n"
4093 "\n"
4094 "This variable flags that sensor variables are defined in a formally\n"
4095 "and practically correct way. For example, it checks for correct\n"
4096 "dimensions of *sensor_pos* and *sensor_los*.\n"
4097 "\n"
4098 "Shall be set by *sensor_checkedCalc*. See that WSM for treated WSVs.\n"
4099 "Only the value 1 is taken as OK.\n"),
4100 GROUP("Index")));
4101
4102 wsv_data.push_back(WsvRecord(
4103 NAME("sensor_description_amsu"),
4105 "Sensor description for simple AMSU setup.\n"
4106 "\n"
4107 "This is a compact description of an AMSU-type sensor. The matrix\n"
4108 "contains one row for each instrument channel. Each row contains three\n"
4109 "elements: LO position [Hz], offset of the channel center from the LO\n"
4110 "[Hz], and channel width [Hz].\n"
4111 "\n"
4112 "Usage: Set by the user.\n"
4113 "\n"
4114 "Unit: All entries in Hz.\n"
4115 "\n"
4116 "Size: [number of channels, 3]\n"),
4117 GROUP("Matrix")));
4118
4119 wsv_data.push_back(WsvRecord(
4120 NAME("sensor_los"),
4122 "The sensor line-of-sight (LOS) for each measurement block.\n"
4123 "\n"
4124 "Line-of-sights are specified by giving the zenith and azimuth angles.\n"
4125 "Column 1 holds the zenith angle. This angle is simply the angle \n"
4126 "between the zenith and LOS directions. For 1D and 3D the valid\n"
4127 "range is [0 180], while for 2D angles down to -180 degrees are\n"
4128 "allowed. Negative angles signifies for 2D observations towards\n"
4129 "lower latitudes, while positive angles means observations towards\n"
4130 "higher latitudes. Nadir corresponds throughout to 180 degrees.\n"
4131 "\n"
4132 "The azimuth angle is given with respect to the meridian plane. That\n"
4133 "is, the plane going through the north and south poles. The valid \n"
4134 "range is [-180,180] where angles are counted clockwise; 0 means\n"
4135 "that the viewing or propagation direction is north-wise and +90 means\n"
4136 "that the direction of concern goes eastward.\n"
4137 "\n"
4138 "No azimuth angle shall be specified for 1D and 2D. This angle is in\n"
4139 "general of no concern for these atmospheric dimensionalities, but\n"
4140 "matter in some cases, such as with respect to the Doppler shift due\n"
4141 "to winds. For 1D the azimuth angle is then assumed to be 0 deg, i.e.\n"
4142 "the sensor is treated to be directed towards North. For 2D, the \n"
4143 "implied azimuth is 0 or 180, depending of the zenith angle is positive\n"
4144 "or negative.\n"
4145 "\n"
4146 "See further the ARTS user guide (AUG). Use the index to find where\n"
4147 "this variable is discussed. The variable is listed as a subentry to\n"
4148 "\"workspace variables\".\n"
4149 "\n"
4150 "Usage: Set by the user.\n"
4151 "\n"
4152 "Unit: [ degrees, degrees ]\n"
4153 "\n"
4154 "Size: [ number of measurement blocks, 1 or 2 ]\n"),
4155 GROUP("Matrix")));
4156
4157 wsv_data.push_back(WsvRecord(
4158 NAME("sensor_los_geodetic"),
4160 "As *sensor_los* but matching geodetic coordinates.\n"
4161 "\n"
4162 "For this version zenith is defined as the normal of the reference\n"
4163 "ellipsoid, in contrast to *sensor_los* zenith is along the direction\n"
4164 "towards the planets centre.\n"
4165 "\n"
4166 "Probably only useful for 3D.\n"
4167 "\n"
4168 "Usage: Set by the user.\n"
4169 "\n"
4170 "Unit: [ degrees, degrees ]\n"
4171 "\n"
4172 "Size: [ number of measurement blocks, 2 ]\n"),
4173 GROUP("Matrix")));
4174
4175 wsv_data.push_back(WsvRecord(
4176 NAME("sensor_los_ecef"),
4178 "As *sensor_los* but matching ECEF coordinates.\n"
4179 "\n"
4180 "For this version of sensor_los, each row shall hold [dx,dy,dz],\n"
4181 "where dx, dy and dz are the x, y and z components if the line-of-sight\n"
4182 "directions in ECEF coordinates. [dx,dy,dz] must form a unit vector (i.e.\n"
4183 "its 2-norm shall be 1).\n"
4184 "\n"
4185 "Probably only useful for 3D.\n"
4186 "\n"
4187 "Usage: Set by the user.\n"
4188 "\n"
4189 "Unit: [ m, m, m ]\n"
4190 "\n"
4191 "Size: [ number of measurement blocks, 3 ]\n"),
4192 GROUP("Matrix")));
4193
4194 wsv_data.push_back(WsvRecord(
4195 NAME("sensor_norm"),
4197 "Flag if sensor response should be normalised or not (0 or 1).\n"
4198 "\n"
4199 "If the flag is set to 1 each sensor response is normalised (where\n"
4200 "applicable). If set to 0 the sensor responses are left as provided.\n"
4201 "\n"
4202 "See further the ARTS user guide (AUG). Use the index to find where\n"
4203 "this variable is discussed. The variable is listed as a sub-entry to\n"
4204 "\"workspace variables\".\n"
4205 "\n"
4206 "Usage: Set by the user.\n"),
4207 GROUP("Index")));
4208
4209 wsv_data.push_back(WsvRecord(
4210 NAME("sensor_pol"),
4212 "A set of polarisation response angles.\n"
4213 "\n"
4214 "The standard choice to consider the polarisation response of the\n"
4215 "reciever is by *instrument_pol*, and this response becomes then part\n"
4216 "of *sensor_response*. However, that choice is not possible when the\n"
4217 "polartisation response changes between measurement blocks, and this\n"
4218 "variable combined with the *yApplySensorPol* offers an alternative for\n"
4219 "such situations. This WSV also allows defintion of an arbitrary\n"
4220 "polarisation angle.\n"
4221 "\n"
4222 "When applying the polarisation response by *yApplySensorPol*, this\n"
4223 "variable complements *sensor_pos* and *sensor_los*. This WSV matrix\n"
4224 "is also a matrix, that shall have the same number of rows as the other\n"
4225 "two matrices. \n"
4226 "\n"
4227 "The columns of *sensor_pol* corresponds to the channels/frequencies\n"
4228 "of the receiver. Each element gives the polarisation angle. A pure\n"
4229 "vertical response has the angle 0 deg, and pure horisontal 90 deg.\n"
4230 "If all U values (Stokes element 3) are zero, the sign of the angle does,\n"
4231 "not matter, and 0 and 180 degrees give the same result. With non-zero\n"
4232 "U, the result of e.g. -45 and +45 degrees differ.\n"
4233 "\n"
4234 "Note that a receiver with a linear response is assumed. Circular\n"
4235 "polarisation is not affected by any rotation.\n"
4236 "\n"
4237 "Usage: Set by the user.\n"
4238 "\n"
4239 "Unit: [ degrees ]\n"
4240 "\n"
4241 "Size: [ number of measurement blocks, number of channels/frequencies ]\n"),
4242 GROUP("Matrix")));
4243
4244 wsv_data.push_back(WsvRecord(
4245 NAME("sensor_pos"),
4247 "The sensor position for each measurement block.\n"
4248 "\n"
4249 "The sensor positions are specified as a matrix, where the number of\n"
4250 "columns shall be equal to *atmosphere_dim*. Column 1 shall contain\n"
4251 "the altitude of the sensor platform, column 2 the latitude and the \n"
4252 "last column the longitude. The number of rows corresponds to the\n"
4253 "number of measurement blocks.\n"
4254 "\n"
4255 "Valid range for latitudes in 3D is [-90,90], while for 2D any value\n"
4256 "is accepted. Accepted range for longitudes are [-360,360].\n"
4257 "\n"
4258 "See further the ARTS user guide (AUG). Use the index to find where\n"
4259 "this variable is discussed. The variable is listed as a subentry to\n"
4260 "\"workspace variables\".\n"
4261 "\n"
4262 "Usage: Set by the user.\n"
4263 "\n"
4264 "Unit: [ m, degrees, degrees ]\n"
4265 "\n"
4266 "Size: [ number of measurement blocks, atmosphere_dim ]\n"),
4267 GROUP("Matrix")));
4268
4269 wsv_data.push_back(WsvRecord(
4270 NAME("sensor_pos_geodetic"),
4272 "As *sensor_pos* but using geodetic coordinates.\n"
4273 "\n"
4274 "For this version the second column shall hold geodetic latitudes,\n"
4275 "in contrast to *sensor_pos* where the geocentric system us used.\n"
4276 "Please note that also the altitude (column 1) differs between\n"
4277 "the two versions of the variables. Here the altitude is with\n"
4278 "taken along the local nadir, while for *sensor_pos* it is taken\n"
4279 "along the direction towards the planets centre.\n"
4280 "\n"
4281 "Probably only useful for 3D.\n"
4282 "\n"
4283 "Usage: Set by the user.\n"
4284 "\n"
4285 "Unit: [ m, degrees, degrees ]\n"
4286 "\n"
4287 "Size: [ number of measurement blocks, atmosphere_dim ]\n"),
4288 GROUP("Matrix")));
4289
4290 wsv_data.push_back(WsvRecord(
4291 NAME("sensor_pos_ecef"),
4293 "As *sensor_pos* but using ECEF coordinates.\n"
4294 "\n"
4295 "The sensor position is here specified as earth-centered, earth-fixed\n"
4296 "(ECEF) coordinates (using standard definition of ECEF).\n"
4297 "\n"
4298 "Probably only useful for 3D.\n"
4299 "\n"
4300 "Column 1, 2 and 3 shall hold x, y and z coordinate, respectively.\n"
4301 "\n"
4302 "Usage: Set by the user.\n"
4303 "\n"
4304 "Unit: [ m, m, m ]\n"
4305 "\n"
4306 "Size: [ number of measurement blocks, atmosphere_dim ]\n"),
4307 GROUP("Matrix")));
4308
4309 wsv_data.push_back(WsvRecord(
4310 NAME("sensor_response"),
4312 "The matrix modelling the total sensor response.\n"
4313 "\n"
4314 "This matrix describes the sensor respons for one measurement block\n"
4315 "The response is assumed to be identical for each such block.\n"
4316 "\n"
4317 "The matrix is the product of all the individual sensor response\n"
4318 "matrices. Therefore its dimensions are depending on the total sensor\n"
4319 "configuration. The *sensor_response* has to initialised by the \n"
4320 "*sensor_responseInit* method.\n"
4321 "\n"
4322 "Usage: Output/input to the *sensor_response...* methods.\n"
4323 "\n"
4324 "Units: -\n"
4325 "\n"
4326 "Dimension: See the individual *sensor_response...* method. \n"),
4327 GROUP("Sparse")));
4328
4329 wsv_data.push_back(WsvRecord(
4330 NAME("sensor_response_aa"),
4332 "The relative azimuth angles associated with the output of\n"
4333 "*sensor_response*.\n"
4334 "\n"
4335 "The variable shall not be set manually, it will be set together with\n"
4336 "*sensor_response* by sensor response WSMs.\n"
4337 "\n"
4338 "Usage: Set by sensor response methods.\n"
4339 "\n"
4340 "Unit: [ degrees ]\n"),
4341 GROUP("Vector")));
4342
4343 wsv_data.push_back(WsvRecord(
4344 NAME("sensor_response_agenda"),
4346 "Agenda providing the sensor response data for a measurement block.\n"),
4347 GROUP("Agenda")));
4348
4349 wsv_data.push_back(WsvRecord(
4350 NAME("sensor_response_dlos"),
4352 "The relative zenith and azimuth angles associated with the output of\n"
4353 "*sensor_response*.\n"
4354 "\n"
4355 "Definition of angles match *mblock_dlos_grid*. Works otherwise as\n"
4356 "*sensor_response_f*.\n"
4357 "\n"
4358 "The variable shall not be set manually, it will be set together with\n"
4359 "*sensor_response* by sensor response WSMs.\n"
4360 "\n"
4361 "Usage: Set by sensor response methods.\n"
4362 "\n"
4363 "Unit: [ degrees ]\n"),
4364 GROUP("Matrix")));
4365
4366 wsv_data.push_back(WsvRecord(
4367 NAME("sensor_response_dlos_grid"),
4369 "The zenith and azimuth angles associated with *sensor_response*.\n"
4370 "\n"
4371 "A variable for communication between sensor response WSMs. Matches\n"
4372 "initially *mblock_dlos_grid*, but is later adjusted according to the\n"
4373 "sensor specifications. Only defined when a common grid exists. Values\n"
4374 "are here not repeated as in *sensor_response_dlos*\n"
4375 "\n"
4376 "Usage: Set by sensor response methods.\n"
4377 "\n"
4378 "Unit: [ degrees ]\n"),
4379 GROUP("Matrix")));
4380
4381 wsv_data.push_back(WsvRecord(
4382 NAME("sensor_response_f"),
4384 "The frequencies associated with the output of *sensor_response*.\n"
4385 "\n"
4386 "This vector gives the frequency for each element of the measurement\n"
4387 "vector produced inside one measurement block. The frequencies of\n"
4388 "the total measurement vector, *y*, are obtained by repeating these\n"
4389 "frequencies n times, where n is the number of measurement blocks\n"
4390 "(e.g. the number of rows in *sensor_pos*).\n"
4391 "\n"
4392 "The variable shall not be set manually, it will be set together with\n"
4393 "*sensor_response* by sensor response WSMs.\n"
4394 "\n"
4395 "Usage: Set by sensor response methods.\n"
4396 "\n"
4397 "Unit: [ Hz ]\n"),
4398 GROUP("Vector")));
4399
4400 wsv_data.push_back(WsvRecord(
4401 NAME("sensor_response_f_grid"),
4403 "The frequency grid associated with *sensor_response*.\n"
4404 "\n"
4405 "A variable for communication between sensor response WSMs. Matches\n"
4406 "initially *f_grid*, but is later adjusted according to the sensor\n"
4407 "specifications. Only defined when a common grid exists. Values are\n"
4408 "here not repeated as in *sensor_response_f*\n"
4409 "\n"
4410 "Usage: Set by sensor response methods.\n"
4411 "\n"
4412 "Unit: [ Hz ]\n"),
4413 GROUP("Vector")));
4414
4415 wsv_data.push_back(WsvRecord(
4416 NAME("sensor_response_pol"),
4418 "The polarisation states associated with the output of\n"
4419 "*sensor_response*.\n"
4420 "\n"
4421 "Works basically as *sensor_response_f*.\n"
4422 "\n"
4423 "See *instrument_pol* for coding of polarisation states.\n"
4424 "\n"
4425 "The variable shall not be set manually, it will be set together with\n"
4426 "*sensor_response* by sensor response WSMs.\n"
4427 "\n"
4428 "Usage: Set by sensor response methods.\n"
4429 "\n"
4430 "Unit: [ - ]\n"),
4431 GROUP("ArrayOfIndex")));
4432
4433 wsv_data.push_back(WsvRecord(
4434 NAME("sensor_response_pol_grid"),
4436 "The \"polarisation grid\" associated with *sensor_response*.\n"
4437 "\n"
4438 "A variable for communication between sensor response WSMs. It is\n"
4439 "initially 1:stokes_dim, but can later adjusted according to the \n"
4440 "sensor specifications. Only defined when a common grid exists. \n"
4441 "\n"
4442 "See *instrument_pol* for coding of polarisation states.\n"
4443 "\n"
4444 "Usage: Set by sensor response methods.\n"
4445 "\n"
4446 "Unit: [ - ]\n"),
4447 GROUP("ArrayOfIndex")));
4448
4449 wsv_data.push_back(WsvRecord(
4450 NAME("sensor_time"),
4452 "The time for each measurement block.\n"
4453 "\n"
4454 "This WSV is used when a time must be assigned to the measurements.\n"
4455 "\n"
4456 "Usage: Set by the user.\n"
4457 "\n"
4458 "Unit: [ UTC date and time ]\n"
4459 "\n"
4460 "Size: [ number of measurement blocks ]\n"),
4461 GROUP("ArrayOfTime")));
4462
4463 wsv_data.push_back(WsvRecord(
4464 NAME("sideband_mode"),
4466 "Description of target sideband.\n"
4467 "\n"
4468 "A text string describing which of the two sidebands (of a heterodyne\n"
4469 "instrument) that can be seen as \"main\" band. Possible choices are:\n"
4470 " \"lower\" : Low frequency sideband shall be considered as target.\n"
4471 " \"upper\" : High frequency sideband shall be considered as target.\n"
4472 "\n"
4473 "Usage: Set by the user.\n"),
4474 GROUP("String")));
4475
4476 wsv_data.push_back(WsvRecord(
4477 NAME("sideband_mode_multi"),
4479 "Description of target sideband for a multiple LO receiver.\n"
4480 "\n"
4481 "As *sideband_mode* but handles an instrument with several LO chains.\n"
4482 "See further *lo_multi* and *sideband_response_multi*. This length of\n"
4483 "this array must match the size of those WSVs.\n"
4484 "\n"
4485 "Usage: Set by the user.\n"),
4486 GROUP("ArrayOfString")));
4487
4488 wsv_data.push_back(WsvRecord(
4489 NAME("sideband_response"),
4491 "Description of (mixer) sideband response.\n"
4492 "\n"
4493 "This variable describes the response of each sideband of a heterodyne\n"
4494 "receiver. The response is given as a GriddedField1, with frequency as the\n"
4495 "grid. The actual data describe the sideband filter function at each\n"
4496 "frequency grid point. An interpolation is applied to obtain the\n"
4497 "response for other frequencies.\n"
4498 "\n"
4499 "The frequency grid should be given in terms of IF, with end points\n"
4500 "symmetrically placed around zero. That is, the grid must contain\n"
4501 "both negative and positive values. The sideband response (after \n"
4502 "summation with *lo*) is not allowed to extend outside the range\n"
4503 "for which spectral data exist (normally determined by *f_grid*).\n"
4504 "\n"
4505 "Usage: Set by the user.\n"
4506 "\n"
4507 "Dimensions: \n"
4508 " GriddedField1:\n"
4509 " Vector f_grid[N_f]\n"
4510 " Vector data[N_f]\n"),
4511 GROUP("GriddedField1")));
4512
4513 wsv_data.push_back(WsvRecord(
4514 NAME("sideband_response_multi"),
4516 "Description of multiple (mixer) sideband responses.\n"
4517 "\n"
4518 "As *sideband_response* but describes an instrument with multiple\n"
4519 "mixers. An array element for each LO. The size of this variable and\n"
4520 "*lo_multi* shall match.\n"
4521 "\n"
4522 "Unit: Hz\n"
4523 "\n"
4524 "Usage: Set by the user.\n"),
4525 GROUP("ArrayOfGriddedField1")));
4526
4527 wsv_data.push_back(WsvRecord(
4528 NAME("spectral_irradiance_field"),
4530 "Spectral irradiance field.\n"
4531 "\n"
4532 "Spectral irradiance is the radiative power per unit area\n"
4533 "and unit frequency. The last dimension denotes the hemispheres.\n"
4534 "The first component denotes the downward direction and the second\n"
4535 "component denotes the upward direction.\n"
4536 "\n"
4537 "Units: W m^-2 Hz^-1\n"
4538 "\n"
4539 " Size: [ Nf,\n"
4540 " p_grid, \n"
4541 " lat_grid, \n"
4542 " lon_grid, \n"
4543 " 2 ]\n"),
4544 GROUP("Tensor5")));
4545
4546 wsv_data.push_back(WsvRecord(
4547 NAME("spectral_radiance_field"),
4549 "Spectral radiance field.\n"
4550 "\n"
4551 "This variable holds a calculation of the radiance field through\n"
4552 "the atmosphere, for the directions matching *za_grid* and *aa_grid*.\n"
4553 "\n"
4554 "Don't confuse this variable with *cloudbox_field*. That varinale also\n"
4555 "holds a field of spectral radiances, but is restricted to the cloud box.\n"
4556 "\n"
4557 "Units: W / (m^2 Hz sr)\n"
4558 "\n"
4559 " Size: [f_grid,\n"
4560 " p_grid, \n"
4561 " lat_grid, \n"
4562 " lon_grid, \n"
4563 " za_grid,\n"
4564 " aa_grid,\n"
4565 " stokes_dim ]\n"
4566 "\n"
4567 "Note: For 1D, the size of the latitude, longitude and azimuth\n"
4568 "dimension (N_aa) are all 1.\n"),
4569 GROUP("Tensor7")));
4570
4571 wsv_data.push_back(WsvRecord(
4572 NAME("specific_heat_capacity"),
4573 DESCRIPTION("Specific heat capacity.\n"
4574 "\n"
4575 "It is the heat capacity per unit \n"
4576 "mass of a material.\n"
4577 "\n"
4578 "Units: K J^-1 kg^-1\n"
4579 "\n"
4580 "Size: [ p_grid, \n"
4581 " lat_grid, \n"
4582 " lon_grid] \n"),
4583 GROUP("Tensor3")));
4584
4585 wsv_data.push_back(WsvRecord(
4586 NAME("specular_los"),
4588 "The specular direction (for reflection by a flat surface).\n"
4589 "\n"
4590 "The specular direction as a standard line-of-sight vector, consisting\n"
4591 "of a zenith and azimuth angle (the later only for 3D).\n"
4592 "\n"
4593 "Units: degrees\n"
4594 "\n"
4595 "Size: [ 1 or 2 ]\n"),
4596 GROUP("Vector")));
4597
4598 wsv_data.push_back(WsvRecord(
4599 NAME("spt_calc_agenda"),
4601 "Agenda calculating single scattering properties from the amplitude matrix.\n"),
4602 GROUP("Agenda")));
4603
4604 wsv_data.push_back(
4605 WsvRecord(NAME("stokes_dim"),
4606 DESCRIPTION("The dimensionality of the Stokes vector (1-4).\n"
4607 "\n"
4608 "Usage: Set by the user.\n"),
4609 GROUP("Index")));
4610
4611 wsv_data.push_back(WsvRecord(
4612 NAME("stokes_rotation"),
4614 "Rotation of the Stokes H and V directions.\n"
4615 "\n"
4616 "This variable allows to introduce a rotation of the Stokes coordinate\n"
4617 "system. Such a rotation could be needed to handle the scanning\n"
4618 "procedure of some instruments, such as AMSU-A. The variable is\n"
4619 "applied by the *sensor_responseStokesRotation* WSM.\n"
4620 "\n"
4621 "The rotation is given as an angle for each direction. In general, the\n"
4622 "number of rotations to be specified follows *sensor_response_dlos_grid*.\n"
4623 "In more detail, if no antenna is included or a 1D antenna is used, and\n"
4624 "the rotation is applied before the antenna is included in \n"
4625 "*sensor_response*, there should be one angle for each row of\n"
4626 "*mblock_dlos_grid*. After inclusion of an antenna response, the relevant\n"
4627 "number of angles is determined by the rows of *antenna_dlos*.\n"
4628 "\n"
4629 "It is assumed that the rotation is common for all frequency elements.\n"
4630 "\n"
4631 "Units: degrees\n"
4632 "\n"
4633 "Size: [ number of directions ]\n"
4634 "\n"
4635 "Usage: Set by the user.\n"),
4636 GROUP("Vector")));
4637
4638 wsv_data.push_back(WsvRecord(
4639 NAME("surface_complex_refr_index"),
4641 "Complex refractive index of the surface, at a single point.\n"
4642 "\n"
4643 "See *complex_refr_index* for the expected format and how the data\n"
4644 "are treated.\n"),
4645 GROUP("GriddedField3")));
4646
4647 wsv_data.push_back(WsvRecord(
4648 NAME("surface_emission"),
4650 "The emission from the surface.\n"
4651 "\n"
4652 "See specific methods generating *surface_emission* and the user\n"
4653 "guide for more information.\n"
4654 "\n"
4655 "Dimensions: [ f_grid, stokes_dim ]\n"),
4656 GROUP("Matrix")));
4657
4658 wsv_data.push_back(WsvRecord(
4659 NAME("surface_los"),
4661 "Downwelling radiation directions to consider in surface reflection.\n"
4662 "\n"
4663 "The directions are given as a zenith and azimuth angle (the later\n"
4664 "only for 3D), following the definition of line-of-sights.\n"
4665 "\n"
4666 "Units: degrees\n"
4667 "\n"
4668 "Size: [ any number, 1 or 2 ]\n"),
4669 GROUP("Matrix")));
4670
4671 wsv_data.push_back(WsvRecord(
4672 NAME("surface_normal"),
4674 "The normal vector for a point at the surface.\n"
4675 "\n"
4676 "The vector is given as a zenith and azimuth (the later only for 3D)\n"
4677 "angle, following the definition of line-of-sights. For example,\n"
4678 "this vector is always [0] for 1D, as there is no surface topography\n"
4679 "for this atmospheric dimensionality.\n"
4680 "\n"
4681 "Units: degrees\n"
4682 "\n"
4683 "Size: [ 1 or 2 ]\n"),
4684 GROUP("Vector")));
4685
4686 wsv_data.push_back(WsvRecord(
4687 NAME("surface_props_data"),
4689 "Various surface properties.\n"
4690 "\n"
4691 "A general container for passing data to surface methods. Each surface\n"
4692 "property shall be specified on the grid set by *lat_grid* and *lon_grid*.\n"
4693 "\n"
4694 "The properties are identified by the accompanying variable\n"
4695 "*surface_props_names*.\n"
4696 "\n"
4697 "Size: [ number of props., lat_grid, lon_grid ]\n"),
4698 GROUP("Tensor3")));
4699
4700 wsv_data.push_back(WsvRecord(
4701 NAME("surface_props_names"),
4703 "Name on surface properties found in *surface_props_data*.\n"
4704 "\n"
4705 "Each string names a property in *surface_props_data*. The user is free\n"
4706 "to include data with any name, but the surface methods making use of\n"
4707 "*surface_props_data* expect data to be named in a specific way. See\n"
4708 "the documentation of each method for recognised choices.\n"
4709 "\n"
4710 "Size: [ number of props. ]\n"),
4711 GROUP("ArrayOfString")));
4712
4713 wsv_data.push_back(WsvRecord(
4714 NAME("surface_rmatrix"),
4716 "The reflection coefficients for the directions given by\n"
4717 "*surface_los* to the direction of interest.\n"
4718 "\n"
4719 "The rows and columns of this tensor holds the reflection\n"
4720 "coefficient matrix for one frequency and one LOS. The reflection\n"
4721 "coefficients shall take into accound the angular weighting of the\n"
4722 "downwelling radiation.\n"
4723 "\n"
4724 "See specific methods generating *surface_rmatrix* and the user guide\n"
4725 "for more information.\n"
4726 "\n"
4727 "Usage: Input to methods for *surface_rtprop_agenda*.\n"
4728 "\n"
4729 "Units: -\n"
4730 "\n"
4731 "Dimensions: [ surface_los, f_grid, stokes_dim, stokes_dim ]\n"),
4732 GROUP("Tensor4")));
4733
4734 wsv_data.push_back(WsvRecord(
4735 NAME("surface_rtprop_agenda"),
4736 DESCRIPTION("Agenda providing radiative properties of the surface.\n"),
4737 GROUP("Agenda")));
4738
4739 wsv_data.push_back(WsvRecord(
4740 NAME("surface_rtprop_agenda_array"),
4742 "Description of surface radiative properties, divided into surface types.\n"),
4743 GROUP("ArrayOfAgenda")));
4744
4745 wsv_data.push_back(
4746 WsvRecord(NAME("surface_rtprop_sub_agenda"),
4747 DESCRIPTION("Sub-agenda to *surface_rtprop_agenda*.\n"),
4748 GROUP("Agenda")));
4749
4750 wsv_data.push_back(WsvRecord(
4751 NAME("surface_skin_t"),
4753 "Surface skin temperature.\n"
4754 "\n"
4755 "This temperature shall be selected considering the radiative\n"
4756 "properties of the surface, and can differ from the \"bulk\"\n"
4757 "temperature.\n"
4758 "\n"
4759 "Usage: Input to methods for *surface_rtprop_agenda*.\n"),
4760 GROUP("Numeric")));
4761
4762 wsv_data.push_back(WsvRecord(
4763 NAME("surface_reflectivity"),
4765 "Surface reflectivity, for a given position and angle.\n"
4766 "\n"
4767 "This variable describes the surface reflectivity at one position\n"
4768 "and one incidence angle. It works as *surface_scalar_reflectivity*\n"
4769 "but is also defined for vector radiative transfer.\n"
4770 "\n"
4771 "The first dimension of the variable shall either match *f_grid* or\n"
4772 "be 1. The later case is interpreted as the reflectivity is the same\n"
4773 "for all frequencies.\n"
4774 "\n"
4775 "Usage: Input to some surface properties methods.\n"
4776 "\n"
4777 "Dimensions: [ f_grid or 1, stokes_dim, stokes_dim]\n"),
4778 GROUP("Tensor3")));
4779
4780 wsv_data.push_back(WsvRecord(
4781 NAME("surface_rv_rh"),
4783 "Surface reflectivity, described by rv and rh (power) reflectivities.\n"
4784 "\n"
4785 "This variable describes the surface reflectivity at one position\n"
4786 "and one incidence angle. For this position and angle, one or multiple\n"
4787 "combinations of rv and rh are specified, where rv and rh are the\n"
4788 "reflectivity for vertical and horizontal polarisation, respectively.\n"
4789 "\n"
4790 "This matrix shall always have two columns, where the first column\n"
4791 "holds rv values, and the second column rh. It is up to the user to\n"
4792 "make sure that data are put into the correct column, this can not\n"
4793 "be checked bu the methods using this WSV.\n"
4794 "\n"
4795 "The number of rows shall either match *f_grid* or be 1. The later case\n"
4796 "is interpreted as the reflectivities are the same for all frequencies.\n"
4797 "\n"
4798 "Usage: Input to some surface properties methods.\n"
4799 "\n"
4800 "Dimensions: [ f_grid or 1, 2]\n"),
4801 GROUP("Matrix")));
4802
4803 wsv_data.push_back(WsvRecord(
4804 NAME("surface_scalar_reflectivity"),
4806 "Surface reflectivity, assuming it can be described as a scalar value.\n"
4807 "\n"
4808 "This variable describes the surface reflectivity at one position\n"
4809 "and one incidence angle. For this position and angle, one or multiple\n"
4810 "scalar reflectivities are specified.\n"
4811 "\n"
4812 "The length of the vector shall either match *f_grid* or be 1. The \n"
4813 "later case is interpreted as the reflectivity is the same for all\n"
4814 "frequencies (ie. matches a constant vector).\n"
4815 "\n"
4816 "Usage: Input to some surface properties methods.\n"
4817 "\n"
4818 "Dimensions: [ f_grid or 1]\n"),
4819 GROUP("Vector")));
4820
4821 wsv_data.push_back(
4822 WsvRecord(NAME("surface_type"),
4823 DESCRIPTION("Local, single surface type value.\n"
4824 "\n"
4825 "See *surface_type_mask* for details.\n"),
4826 GROUP("Index")));
4827
4828 wsv_data.push_back(
4829 WsvRecord(NAME("surface_type_aux"),
4830 DESCRIPTION("Auxiliary variable to *surface_type*.\n"
4831 "\n"
4832 "See *surface_type_mask* for details.\n"),
4833 GROUP("Numeric")));
4834
4835 wsv_data.push_back(WsvRecord(
4836 NAME("surface_type_mask"),
4838 "Classification of the surface using a type coding.\n"
4839 "\n"
4840 "This variable gives a description of the surface using a type class\n"
4841 "coding. A common term for such a variable is \"surface mask\".\n"
4842 "\n"
4843 "The mask is a latitude and longtide field. The mask values are\n"
4844 "floating numbers, where the integer part is the type and the remainder\n"
4845 "can be used to provide auxilary information. In terms of the local\n"
4846 "variables, the mask values equal *surface_type* + *surface_type_aux*.\n"
4847 "\n"
4848 "There is no fixed type coding, it is up to the user to set up\n"
4849 "a consistent system. The critical point is in the agendas\n"
4850 "matching each surface type, that are denoted as iy_surface_sub_agendaX\n"
4851 "where X is the *surface_type* index.\n"
4852 "\n"
4853 "The surface type can be any integer (>=0) for which a corresponding\n"
4854 "agenda exists.\n"
4855 "\n"
4856 "Dimensions: \n"
4857 " GriddedField2:\n"
4858 " Vector Latitude [N_lat]\n"
4859 " Vector Longitude [N_lon]\n"
4860 " Matrix data [N_lat][N_lon]\n"),
4861 GROUP("GriddedField2")));
4862
4863 wsv_data.push_back(
4864 WsvRecord(NAME("surface_types"),
4866 "This and associated WSVs describe a mixture of surface types.\n"
4867 "\n"
4868 "Holds a number of *surface_type*.\n"),
4869 GROUP("ArrayOfIndex")));
4870
4871 wsv_data.push_back(
4872 WsvRecord(NAME("surface_types_aux"),
4874 "Auxiliary variable to *surface_types*.\n"
4875 "\n"
4876 "Holds a number of *surface_type_aux*..\n"),
4877 GROUP("Vector")));
4878
4879 wsv_data.push_back(
4880 WsvRecord(NAME("surface_types_weights"),
4881 DESCRIPTION("Auxiliary variable to *surface_type*.\n"
4882 "\n"
4883 "Holds the relative weight of each surface type.\n"),
4884 GROUP("Vector")));
4885
4886 wsv_data.push_back(WsvRecord(
4887 NAME("telsem_atlases"),
4889 "TELSEM 2 emissivity atlases.\n"
4890 "\n"
4891 "Array should be filled with 12\n"
4892 "atlases, one for each month. Index 0 is January, index 11 December.\n"
4893 ""),
4894 GROUP("ArrayOfTelsemAtlas")));
4895
4896 wsv_data.push_back(WsvRecord(
4897 NAME("tessem_neth"),
4899 //FIXMEDOC Add more documentation?
4900 "TESSEM2 neural network parameters for horizontal polarization.\n"),
4901 GROUP("TessemNN")));
4902
4903 wsv_data.push_back(WsvRecord(
4904 NAME("tessem_netv"),
4906 //FIXMEDOC Add more documentation?
4907 "TESSEM2 neural network parameters for vertical polarization.\n"),
4908 GROUP("TessemNN")));
4909
4910 wsv_data.push_back(
4911 WsvRecord(NAME("test_agenda"),
4912 DESCRIPTION("A dummy agenda for testing purposes.\n"
4913 "\n"
4914 "Only used for testing by developers.\n"),
4915 GROUP("Agenda")));
4916
4917 wsv_data.push_back(
4918 WsvRecord(NAME("test_agenda_array"),
4919 DESCRIPTION("Array of agenda for TestArrayOfAgenda case.\n"
4920 "\n"
4921 "Only used for testing by developers.\n"),
4922 GROUP("ArrayOfAgenda")));
4923
4924 wsv_data.push_back(WsvRecord(
4925 NAME("time"),
4926 DESCRIPTION("A UTC time point.\n"),
4927 GROUP("Time")));
4928
4929 wsv_data.push_back(WsvRecord(
4930 NAME("timer"),
4931 DESCRIPTION("Stores the starting time for time measurements.\n"),
4932 GROUP("Timer")));
4933
4934 wsv_data.push_back(WsvRecord(
4935 NAME("time_grid"),
4936 DESCRIPTION("A grid of times. Should be increasing\n"),
4937 GROUP("ArrayOfTime")));
4938
4939 wsv_data.push_back(WsvRecord(
4940 NAME("time_stamps"),
4941 DESCRIPTION("A set of times. Can be in random order\n"),
4942 GROUP("ArrayOfTime")));
4943
4944 wsv_data.push_back(WsvRecord(
4945 NAME("transmitter_pos"),
4947 "Transmitter positions.\n"
4948 "\n"
4949 "Used for radio link calculations and gives then the position of the\n"
4950 "transmitting device. The corresponding positions of the receiver are\n"
4951 "given by *sensor_pos*. The number of rows in *transmitter_pos* and\n"
4952 "*sensor_pos* must be equal.\n"
4953 "\n"
4954 "This WSV is also defined as *sensor_pos* regarding the content of the\n"
4955 "columns, accepted range for latitudes etc. With one exception, this\n"
4956 "WSV is demanded to have two columns also for 1D. The additional\n"
4957 "second value is the angular distance between the transmitter and the\n"
4958 "reciver. This angle is defined as \"latitude\" for 2D, with the\n"
4959 "sensor fixed at the angle of 0 degree.\n"
4960 "\n"
4961 "Each row this matrix defines *rte_pos2* for the measurement block,\n"
4962 "exactly as *sensor_pos* is translated to *rte_pos*.\n"
4963 "\n"
4964 "If no transmitter is involved in the calculations, the variable can\n"
4965 "be set to be empty.\n"
4966 "\n"
4967 "Usage: Set by the user.\n"
4968 "\n"
4969 "Unit: [ m, degrees, degrees ]\n"),
4970 GROUP("Matrix")));
4971
4972 wsv_data.push_back(WsvRecord(
4973 NAME("t_field"),
4975 "The field of atmospheric temperatures.\n"
4976 "\n"
4977 "This variable gives the atmospheric temperature at each crossing of\n"
4978 "the pressure, latitude and longitude grids.\n"
4979 "\n"
4980 "The temperature for a point between the grid crossings is obtained \n"
4981 "by (multi-)linear interpolation of the *t_field*.\n"
4982 "\n"
4983 "See further the ARTS user guide (AUG). Use the index to find where\n"
4984 "this variable is discussed. The variable is listed as a subentry to\n"
4985 "\"workspace variables\".\n"
4986 "\n"
4987 "Usage: Output of *AtmFieldsCalc*.\n"
4988 "\n"
4989 "Unit: K\n"
4990 "\n"
4991 "Dimensions: [ p_grid, lat_grid, lon_grid ]\n"),
4992 GROUP("Tensor3")));
4993
4994 wsv_data.push_back(WsvRecord(
4995 NAME("nlte_field"),
4997 "The field of NLTE temperatures and/or ratios.\n"
4998 "\n"
4999 "This variable gives the NLTE temperature/ratio at each crossing of\n"
5000 "the pressure, latitude and longitude grids. The size of the\n"
5001 "array is the number of NLTE levels in all molecules.\n"
5002 "\n"
5003 "The temperature/ratio for a point between the grid crossings is obtained \n"
5004 "by (multi-)linear interpolation of the *nlte_field*.\n"
5005 "\n"
5006 "There are two types of NLTE computations available in ARTS. One from\n"
5007 "giving excitiation temperatures that makes the absorption/emission diverge\n"
5008 "from LTE. The other is to use the absolute ratios of upper-to-lower states at\n"
5009 "the levels of interest.\n"
5010 ""
5011 "\n"
5012 "Units: [ K or \% ]]\n"
5013 "\n"
5014 "Dimensions: [ NLTE levels, p_grid, lat_grid, lon_grid ] or [ 0, 0, 0, 0 ]\n"),
5015 GROUP("EnergyLevelMap")));
5016
5017 wsv_data.push_back(WsvRecord(
5018 NAME("t_field_raw"),
5020 "Raw data for atmospheric temperatures.\n"
5021 "\n"
5022 "This variable gives the atmospheric temperature as stored in the \n"
5023 "database for the atmospheric scenarios.\n"
5024 "\n"
5025 "See further the ARTS user guide (AUG). Use the index to find where\n"
5026 "this variable is discussed. The variable is listed as a subentry to\n"
5027 "\"workspace variables\".\n"
5028 "\n"
5029 "Usage: Set by the user by choosing a climatology.\n"
5030 "\n"
5031 "Unit: K\n"
5032 "\n"
5033 "Size GriddedField3 \n "
5034 " [N_p] \n"
5035 " [N_lat] \n"
5036 " [N_lon] \n"
5037 " [N_p, N_lat, N_lon] \n"),
5038 GROUP("GriddedField3")));
5039
5040 wsv_data.push_back(WsvRecord(
5041 NAME("nlte_field_raw"),
5042 ("Raw data for NLTE temperatures and/or ratios.\n"
5043 "\n"
5044 "This variable gives the NLTE temperature/ratio as stored in the \n"
5045 "database for the atmospheric scenarios.\n"
5046 "\n"
5047 "See further the ARTS user guide (AUG). Use the index to find where\n"
5048 "this variable is discussed. The variable is listed as a subentry to\n"
5049 "\"workspace variables\".\n"
5050 "\n"
5051 "Usage: Set by the user by choosing a climatology.\n"
5052 "\n"
5053 "Unit: K\n"
5054 "\n"
5055 "Size ArrayOfGriddedField3 \n "
5056 "array:\n"
5057 " [NLTE levels] or [ 0 ]\n"
5058 "fields:\n"
5059 " [N_p] \n"
5060 " [N_lat] \n"
5061 " [N_lon] \n"
5062 " [N_p, N_lat, N_lon] \n"),
5063 GROUP("ArrayOfGriddedField3")));
5064
5065 wsv_data.push_back(WsvRecord(
5066 NAME("t_surface"),
5068 "The surface temperature.\n"
5069 "\n"
5070 "This variable holds the temperature of the surface at each latitude\n"
5071 "and longitude grid crossing. The normal case should be that this \n"
5072 "temperature field is interpolated to obtain *surface_skin_t*.\n"
5073 "Accordingly, for 1D cases it could be a better idea to specify\n"
5074 "*surface_skin_t* directly.\n"
5075 "\n"
5076 "These temperature shall be selected considering the radiative\n"
5077 "properties of the surface, and can differ from the \"bulk\"\n"
5078 "temperatures.\n"
5079 "\n"
5080 "Usage: Set by user.\n"
5081 "\n"
5082 "Unit: K\n"
5083 "\n"
5084 "Dimensions: [ lat_grid, lon_grid ]\n"),
5085 GROUP("Matrix")));
5086
5087 wsv_data.push_back(WsvRecord(
5088 NAME("verbosity"),
5090 "ARTS verbosity.\n"
5091 "\n"
5092 "The verbosity variable is implicitly passed to all workspace methods.\n"
5093 "It can be used to dynamically control the reporting level during\n"
5094 "runtime.\n"
5095 "\n"
5096 "Usage: Set by user.\n"
5097 "\n"
5098 "See also: *verbosityInit*\n"
5099 " *verbositySet*\n"
5100 " *verbositySetAgenda*\n"
5101 " *verbositySetScreen*\n"
5102 " *verbositySetFile*\n"),
5103 GROUP("Verbosity")));
5104
5105 wsv_data.push_back(WsvRecord(
5106 NAME("vmr_field"),
5108 "VMR field.\n"
5109 "\n"
5110 "This variable gives the volume mixing ratio of the chosen gaseous \n"
5111 "species as a function of p_grid, lat_grid, lon_grid. \n"
5112 "\n"
5113 "See further the ARTS user guide (AUG). Use the index to find where\n"
5114 "this variable is discussed. The variable is listed as a subentry to\n"
5115 "\"workspace variables\".\n"
5116 "\n"
5117 "Units: [ Differ between the elements, can be VMR, kg/m3 or #/m3. ]\n"
5118 "\n"
5119 "Dimensions: [species, p_grid, lat_grid, lon_grid]\n"),
5120 GROUP("Tensor4")));
5121
5122 wsv_data.push_back(WsvRecord(
5123 NAME("vmr_field_raw"),
5125 "VMR data for the chosen gaseous species.\n"
5126 "\n"
5127 "This variable contains the volume mixing ratios (VMR) for all \n"
5128 "chosen gaseous species. It includes the grids corresponding to the \n"
5129 "grids in the database. \n"
5130 "*vmr_field_raw* is an Array of Array of Tensor3. It contains one \n"
5131 "gridded field for each species which contains the data and \n"
5132 "also the grids.\n"
5133 "For the calculation the data is \n"
5134 "interpolated on *p_grid*, *lat_grid* and *lon_grid*\n"
5135 "\n"
5136 "Usage: Output of *AtmRawRead*\n"
5137 " Input to *AtmFieldsCalc*.\n"
5138 "\n"
5139 "Unit: absolute number\n"
5140 "\n"
5141 "Size: Array[number of absorption species]\n"
5142 " GriddedField3 \n "
5143 " [N_p] \n"
5144 " [N_lat] \n"
5145 " [N_lon] \n"
5146 " [N_p, N_lat, N_lon] \n"),
5147 GROUP("ArrayOfGriddedField3")));
5148
5149 wsv_data.push_back(WsvRecord(
5150 NAME("water_p_eq_agenda"),
5151 DESCRIPTION("Agenda to calculate the saturation pressure of water.\n"),
5152 GROUP("Agenda")));
5153
5154 wsv_data.push_back(WsvRecord(
5155 NAME("water_p_eq_field"),
5157 "The field of water saturation pressure.\n"
5158 "\n"
5159 "This variable holds the saturation pressure of water at each crossing of\n"
5160 "the pressure, latitude and longitude grids.\n"
5161 "\n"
5162 "Unit: Pa\n"
5163 "\n"
5164 "Dimensions: [ p_grid, lat_grid, lon_grid ]\n"),
5165 GROUP("Tensor3")));
5166
5167 wsv_data.push_back(WsvRecord(
5168 NAME("wigner_initialized"),
5170 "Indicates if the wigner tables are initialized.\n"
5171 "If they are not, computations will be aborted.\n"
5172 "\n"
5173 "Will hold the value of provided maximum factorial value\n"
5174 "\n"
5175 "The developer should always test this variable in functions\n"
5176 "that might require computing wigner symbols because the error\n"
5177 "handling is otherwise offloaded to third party software...\n"),
5178 GROUP("Index")));
5179
5180 wsv_data.push_back(WsvRecord(
5181 NAME("wind_u_field"),
5183 "Zonal component of the wind field.\n"
5184 "\n"
5185 "The East-West wind component. Air moving towards higher\n"
5186 "longitudes is a positive wind. This wind causes no Doppler shift\n"
5187 "for 1D and 2D simulations.\n"
5188 "\n"
5189 "Can be set to be empty, which is interpreted as zero wind speed\n"
5190 "everywhere.\n"
5191 "\n"
5192 "Unit: m/s\n"
5193 "\n"
5194 "Dimensions: [ p_grid, lat_grid, lon_grid ] or [ 0 0 0 ].\n"),
5195 GROUP("Tensor3")));
5196
5197 wsv_data.push_back(WsvRecord(
5198 NAME("wind_u_field_raw"),
5200 "Raw zonal component of the wind field.\n"
5201 "\n"
5202 "The East-West wind component. Air moving towards higher\n"
5203 "longitudes is a positive wind. This wind causes no Doppler shift\n"
5204 "for 1D and 2D simulations.\n"
5205 "\n"
5206 "Can be set to be empty, which is interpreted as zero wind speed\n"
5207 "everywhere.\n"
5208 "\n"
5209 "Unit: m/s\n"
5210 "\n"
5211 "Dimensions: [ p_grid, lat_grid, lon_grid ].\n"),
5212 GROUP("GriddedField3")));
5213
5214 wsv_data.push_back(WsvRecord(
5215 NAME("wind_v_field"),
5217 "Meridional component of the magnetic field.\n"
5218 "\n"
5219 "The North-South wind component. Air moving towards higher\n"
5220 "latitudes is a positive wind.\n"
5221 "\n"
5222 "Can be set to be empty, which is interpreted as zero wind speed\n"
5223 "everywhere.\n"
5224 "\n"
5225 "Unit: m/s\n"
5226 "\n"
5227 "Dimensions: [ p_grid, lat_grid, lon_grid ] or [ 0 0 0 ]\n"),
5228 GROUP("Tensor3")));
5229
5230 wsv_data.push_back(WsvRecord(
5231 NAME("wind_v_field_raw"),
5233 "Raw meridional component of the magnetic field.\n"
5234 "\n"
5235 "The North-South wind component. Air moving towards higher\n"
5236 "latitudes is a positive wind.\n"
5237 "\n"
5238 "Can be set to be empty, which is interpreted as zero wind speed\n"
5239 "everywhere.\n"
5240 "\n"
5241 "Unit: m/s\n"
5242 "\n"
5243 "Dimensions: [ p_grid, lat_grid, lon_grid ]\n"),
5244 GROUP("GriddedField3")));
5245
5246 wsv_data.push_back(WsvRecord(
5247 NAME("wind_w_field"),
5249 "Vertical wind component field.\n"
5250 "\n"
5251 "Upward moving air corresponds to a positive wind speed.\n"
5252 "\n"
5253 "Can be set to be empty, which is interpreted as zero wind speed\n"
5254 "everywhere.\n"
5255 "\n"
5256 "Unit: m/s\n"
5257 "\n"
5258 "Dimensions: [ p_grid, lat_grid, lon_grid ] or [ 0 0 0 ]\n"),
5259 GROUP("Tensor3")));
5260
5261 wsv_data.push_back(WsvRecord(
5262 NAME("wind_w_field_raw"),
5264 "Raw vertical wind component field.\n"
5265 "\n"
5266 "Upward moving air corresponds to a positive wind speed.\n"
5267 "\n"
5268 "Can be set to be empty, which is interpreted as zero wind speed\n"
5269 "everywhere.\n"
5270 "\n"
5271 "Unit: m/s\n"
5272 "\n"
5273 "Dimensions: [ p_grid, lat_grid, lon_grid ]\n"),
5274 GROUP("GriddedField3")));
5275
5276 wsv_data.push_back(WsvRecord(
5277 NAME("wmrf_channels"),
5279 "Channel selection for WMRF fast calculation.\n"
5280 "\n"
5281 "This variable can be used to select one or several instrument channels\n"
5282 "from the list of all possible channels. Zero-based indexing is used, so\n"
5283 "Channel 0 is the first instrument channel!\n"),
5284 GROUP("ArrayOfIndex")));
5285
5286 wsv_data.push_back(WsvRecord(
5287 NAME("wmrf_weights"),
5289 "The weights for a WMRF fast calculation.\n"
5290 "\n"
5291 "Weights are stored in a sparse matrix. This can be used as a\n"
5292 "sensor_response matrix.\n"
5293 "\n"
5294 "The dimension of the matrix is (nchan, nfreq), where nchan\n"
5295 "is the number of instrument channels and nfreq is the number\n"
5296 "of monochromatic frequencies.\n"),
5297 GROUP("Sparse")));
5298
5299 wsv_data.push_back(WsvRecord(
5300 NAME("xml_output_type"),
5302 "Flag to determine whether XML output shall be binary or ascii.\n"
5303 "\n"
5304 "This flag has to be set using the workspace method\n"
5305 "*output_file_formatSetAscii* or *output_file_formatSetBinary*.\n"
5306 "One of these methods MUST be called before writing the first\n"
5307 "output file.\n"
5308 "\n"
5309 "Usage: Set by user.\n"),
5310 GROUP("Index")));
5311
5312 wsv_data.push_back(WsvRecord(
5313 NAME("x"),
5315 "The state vector.\n"
5316 "\n"
5317 "This WSV matches directly the x-vector in the formalism by C.D. Rodgers.\n"
5318 "\n"
5319 "Inside *x*, the elements matching one retrieval quantity, such as\n"
5320 "atmospheric temperatures, are kept together. That is, each retrieval\n"
5321 "quantity covers a continuous range inside *x*. The start and index of\n"
5322 "these ranges can be deduced by *jacobian_quantities* (see function(s)\n"
5323 "inside jacobian.cc for details).\n"
5324 "\n"
5325 "The order of elements inside each retrieval quantity should be clarified\n"
5326 "by corresponding \"adding\" method, i.e. *jacobianAddTemperature* for\n"
5327 "atmospheric temperatures. The general rule is that data are sorted from\n"
5328 "left to right with respect to the order in the corresponding WSV. For\n"
5329 "example, inside *x* atmospheric data are stored with pressure as inner-\n"
5330 "most loop, followed by latitude and longitude as outermost loo