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