ARTS  1.0.222
workspace.cc
Go to the documentation of this file.
1 /* Copyright (C) 2000, 2001 Stefan Buehler <sbuehler@uni-bremen.de>
2  Patrick Eriksson <patrick@rss.chalmers.se>
3 
4  This program is free software; you can redistribute it and/or modify it
5  under the terms of the GNU General Public License as published by the
6  Free Software Foundation; either version 2, or (at your option) any
7  later version.
8 
9  This program is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  GNU General Public License for more details.
13 
14  You should have received a copy of the GNU General Public License
15  along with this program; if not, write to the Free Software
16  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
17  USA. */
18 
35 #include "arts.h"
36 #include "matpackI.h"
37 #include "array.h"
38 #include "auto_wsv_groups.h"
39 #include "wsv_aux.h"
40 
43 
45 {
46 
47  //--------------------< Build the wsv data >--------------------
48  // Initialize to empty, just in case.
49  wsv_data.resize(0);
50 
51 
52  //--------------------< Spectroscopy Stuff >--------------------
53  // --------------------
54  wsv_data.push_back
55  (WsvRecord
56  ("lines",
57  "A list of spectral line data.",
59 
60  wsv_data.push_back
61  (WsvRecord
62  ("lines_per_tg",
63  "A list of spectral line data for each tag.\n"
64  "Dimensions: (tag_groups.nelem()) (# of lines for this tag)",
66 
67  wsv_data.push_back
68  (WsvRecord
69  ("tgs",
70  "This is an array of arrays of OneTag tag definitions.\n"
71  "It defines the available tag groups for the calculation\n"
72  "of absorption coefficients and weighting functions.\n"
73  "Contrary to the original Bredbeck definition, tags within a\n"
74  "group must belong to the same species, because one VMR profile\n"
75  "is associated with each tag group.",
76  TagGroups_));
77 
78  wsv_data.push_back
79  (WsvRecord
80  ("wfs_tgs",
81  "This is an array of arrays of tag group definitions.\n"
82  "It defines the tag groups for the calculation of weighting\n"
83  "functions. The selected tag groups must be a subgroup of the\n"
84  "tag groups defined for the absorption coefficient calculation.",
85  TagGroups_));
86 
87  wsv_data.push_back
88  (WsvRecord
89  ("wfss_tgs",
90  "This is an array of arrays of tag group definitions.\n"
91  "It defines the tag groups for the calculation of weighting\n"
92  "functions. The selected tag groups must be a subgroup of the\n"
93  "tag groups defined for the absorption coefficient calculation.",
94  TagGroups_));
95 
96  wsv_data.push_back
97  (WsvRecord
98  ("lineshape",
99  "Lineshape specification: function, norm, cutoff. There is one entry for\n"
100  "each abs_tag, not for each species. This means if you have several\n"
101  "abs_tags for different isotopes or transitions of a species, you\n"
102  "may use different lineshapes.",
104 
105 
106  //--------------------< Continuum Stuff >--------------------
107  // -----------------
108  wsv_data.push_back
109  (WsvRecord
110  ("cont_description_names",
111  "Continuum / full model absorption tag names. This variable should\n"
112  "contain a list of tag names of continuum and full models, respectively.\n"
113  "Associated with this WSV is the WSV\n"
114  "`cont_description_models' which contains the specific model version of\n"
115  "each continuum / full model absorption tag and the WSV\n"
116  "`cont_description_parameters' which should contain the continuum / full model\n"
117  "user defined parameters. The user defined parameters are only used when\n"
118  "the specified model is 'user'. See also the online documentation in\n"
119  "arts/doc/doxygen/html/continua_cc.html.\n"
120  "\n"
121  "The following full water vapor models are implemented:\n"
122  "'H2O-MPM87': absorption model (line and continuum) according to \n"
123  " H. J. Liebe,\n"
124  " A contribution to modeling atmospheric millimeter-wave properties,\n"
125  " Frequenz, 41, 1987, 31-36\n"
126  " and\n"
127  " H. J. Liebe and D. H. Layton,\n"
128  " Millimeter-wave properties of the atmosphere:\n"
129  " Laboratory studies and propagation modeling,\n"
130  " U.S. Dept. of Commerce, National Telecommunications and Information\n"
131  " Administration, Institute for Communication Sciences,\n"
132  " 325 Broadway, Boulder, CO 80303-3328, report 87224.\n"
133  "'H2O-MPM89': absorption model (line and continuum) according to \n"
134  " H. J. Liebe,\n Int. J. Infrared and Millimeter Waves, 10(6), 1989, 631\n"
135  "'H2O-MPM93': absorption model (line and continuum) according to \n"
136  " H. J. Liebe and G. A. Hufford and M. G. Cotton,\n"
137  " Propagation modeling of moist air and suspended water/ice\n"
138  " particles at frequencies below 1000 GHz,\n"
139  " AGARD 52nd Specialists Meeting of the Electromagnetic Wave\n"
140  " Propagation Panel,\n Palma de Mallorca, Spain, 1993, May 17-21 \n"
141  " (ftp.its.bldrdoc.gov/pub/mpm93/)\n"
142  "'H2O-CP98': absorption model (line and continuum) according to \n"
143  " S. L. Cruz-Pol et al.,\n Radio Science, 33(5), 1319, 1998"
144  " (ece.uprm.edu/~pol/Atmosphere.html)\n"
145  "'H2O-PWR98': absorption model (line and continuum) according to \n"
146  " P. W. Rosenkranz,\n "
147  " Radio Science, 33(4), 919, 1998, Radio Science, 34(4), 1025, 1999\n"
148  " (ftp: mesa.mit.edu/phil/lbl_rt).\n"
149  "\n"
150  "The following full oxygen models are implemented:\n"
151  "'O2-MPM93': absorption model (line and continuum) according to\n"
152  " H. J. Liebe and G. A. Hufford and M. G. Cotton,\n"
153  " Propagation modeling of moist air and suspended water/ice\n"
154  " particles at frequencies below 1000 GHz,\n"
155  " AGARD 52nd Specialists Meeting of the Electromagnetic Wave\n"
156  " Propagation Panel,\n Palma de Mallorca, Spain, 1993, May 17-21\n"
157  " (ftp.its.bldrdoc.gov/pub/mpm93/)\n"
158  "'O2-PWR93': absorption model (line and continuum) according to \n"
159  " P. W. Rosenkranz,\n Chapter 2, in M. A. Janssen, \n"
160  " Atmospheric Remote Sensing by Microwave Radiometry\n"
161  " John Wiley & Sons, Inc., 1993 (mesa.mit.edu/phil/lbl_rt)\n"
162  "\n"
163  "The following continuum parameterizations are implemented:\n"
164  "H2O-H2O ('H2O-SelfContStandardType'):\n"
165  " P. W. Rosenkranz, \n"
166  " Radio Science, Vol. 33, No 4, Pages 919-928, 1998 and \n"
167  " Radio Science, Vol. 34, No 4, Page 1025, 1999 (mesa.mit.edu/phil/lbl_rt)\n"
168  "H2O-air ('H2O-ForeignContStandardType'): \n"
169  " P. W. Rosenkranz, \n"
170  " Radio Science, Vol. 33, No 4, Pages 919-928, 1998 and \n"
171  " Radio Science, Vol. 34, No 4, Page 1025, 1999 (mesa.mit.edu/phil/lbl_rt)\n"
172  "H2O-air ('H2O-ContMPM93'): \n"
173  " H. J. Liebe and G. A. Hufford and M. G. Cotton,\n"
174  " Propagation modeling of moist air and suspended water/ice\n"
175  " particles at frequencies below 1000 GHz,\n"
176  " AGARD 52nd Specialists Meeting of the Electromagnetic Wave\n"
177  " Propagation Panel,\n Palma de Mallorca, Spain, 1993, May 17-21\n"
178  " (ftp.its.bldrdoc.gov/pub/mpm93/)\n"
179  "O2-air ('O2-SelfContStandardType'):\n"
180  " P. W. Rosenkranz,\n"
181  " Chapter 2, in M. A. Janssen,\n"
182  " Atmospheric Remote Sensing by Microwave Radiometry,\n"
183  " John Wiley & Sons, Inc., 1993\n"
184  " (mesa.mit.edu/phil/lbl_rt)\n"
185  " and also described in \n"
186  " H. J. Liebe and G. A. Hufford and M. G. Cotton,\n"
187  " Propagation modeling of moist air and suspended water/ice\n"
188  " particles at frequencies below 1000 GHz,\n"
189  " AGARD 52nd Specialists Meeting of the Electromagnetic Wave\n"
190  " Propagation Panel,\n Palma de Mallorca, Spain, 1993, May 17-21\n"
191  " (ftp.its.bldrdoc.gov/pub/mpm93/)\n"
192  "N2-N2 ('N2-SelfContStandardType'):\n"
193  " The functional form of Rosenkranz but with more input parameters.\n"
194  " P. W. Rosenkranz,\n"
195  " Chapter 2, in M. A. Janssen,\n"
196  " Atmospheric Remote Sensing by Microwave Radiometry,\n"
197  " John Wiley & Sons, Inc., 1993 (mesa.mit.edu/phil/lbl_rt)\n"
198  "N2-N2 ('N2-SelfContMPM93'):\n"
199  " H. J. Liebe and G. A. Hufford and M. G. Cotton,\n"
200  " Propagation modeling of moist air and suspended water/ice\n"
201  " particles at frequencies below 1000 GHz,\n"
202  " AGARD 52nd Specialists Meeting of the Electromagnetic Wave\n"
203  " Propagation Panel, Palma de Mallorca, Spain, 1993, May 17-21 \n"
204  " (ftp.its.bldrdoc.gov/pub/mpm93/)\n"
205  "CO2-CO2 ('CO2-SelfContPWR93'):\n"
206  " P. W. Rosenkranz,\n"
207  " Chapter 2, in M. A. Janssen,\n"
208  " Atmospheric Remote Sensing by Microwave Radiometry,\n"
209  " John Wiley & Sons, Inc., 1993 (mesa.mit.edu/phil/lbl_rt)\n"
210  "CO2-N2 ('CO2-ForeignContPWR93'):\n"
211  " P. W. Rosenkranz,\n"
212  " Chapter 2, in M. A. Janssen,\n"
213  " Atmospheric Remote Sensing by Microwave Radiometry,\n"
214  " John Wiley & Sons, Inc., 1993 (mesa.mit.edu/phil/lbl_rt)\n"
215  "\n"
216  "The following cloud absorption models are implemented:\n"
217  "Suspended water droplet ('liquidcloud-MPM93') \n"
218  " absorption parameterization from the MPM93 model:\n"
219  " H. J. Liebe and G. A. Hufford and M. G. Cotton,\n"
220  " Propagation modeling of moist air and suspended water/ice\n"
221  " particles at frequencies below 1000 GHz,\n"
222  " AGARD 52nd Specialists Meeting of the Electromagnetic Wave\n"
223  " Propagation Panel,\n Palma de Mallorca, Spain, 1993, May 17-21\n"
224  " (ftp.its.bldrdoc.gov/pub/mpm93/)\n"
225  "Ice water droplet absorption ('icecloud-MPM93') \n"
226  " parameterization from MPM93 model:\n"
227  " H. J. Liebe and G. A. Hufford and M. G. Cotton,\n"
228  " Propagation modeling of moist air and suspended water/ice\n"
229  " particles at frequencies below 1000 GHz,\n"
230  " AGARD 52nd Specialists Meeting of the Electromagnetic Wave\n"
231  " Propagation Panel,\n Palma de Mallorca, Spain, 1993, May 17-21\n"
232  " (ftp.its.bldrdoc.gov/pub/mpm93/)\n"
233  "\n"
234  "The following rain extinction model is implemented:\n"
235  "Rain extinction parameterization ('rain-MPM93') from the\n"
236  " MPM93 model, described in:\n"
237  " H. J. Liebe,\n"
238  " MPM - An Atmospheric Millimeter-Wave Propagation Model,\n"
239  " Int. J. Infrared and Millimeter Waves, vol. 10(6),\n"
240  " pp. 631-650, 1989;\n"
241  " and based on:\n"
242  " Olsen, R.L., D.V. Rogers, and D. B. Hodge,\n"
243  " The aR^b relation in the calculation of rain attenuation,\n"
244  " IEEE Trans. Antennas Propagat., vol. AP-26, pp. 318-329, 1978.\n"
245  " IMPORTANT NOTE: rain-MPM93 parameterizes the EXTINCTION by rain,\n"
246  " not just the absorption. Therefore it is not suitable for \n"
247  " calculating thermal emission by rain!\n"
248  " Please use rain-MPM93 only for calculation of attenuation.\n"
249  "\n",
250  ArrayOfString_));
251 
252  wsv_data.push_back
253  (WsvRecord
254  ("cont_description_models",
255  "Continuum / full model absorption model description parameter.\n"
256  "See the WSV `cont_description_names' for a detailed description\n"
257  "of the allowed continuum models. There should be one string here\n"
258  "for each entry in `cont_description_names'.See also the online"
259  "documentation in arts/doc/doxygen/html/continua_cc.html.\n",
260  ArrayOfString_));
261 
262  wsv_data.push_back
263  (WsvRecord
264  ("cont_description_parameters",
265  "Continuum model parameters. See the WSV `cont_description_names'\n"
266  "for a detailed description of the allowed continuum models. There\n"
267  "should be one parameter vector here for each entry in\n"
268  "`cont_description_names'. See also the online documentation in\n"
269  "arts/doc/doxygen/html/continua_cc.html.\n",
270  ArrayOfVector_));
271 
272 
273  //--------------------< 1D Input Atmosphere Stuff >--------------------
274  // ---------------------------
275  wsv_data.push_back
276  (WsvRecord
277  ("raw_ptz",
278  "Matrix has rows:\n"
279  "1. Pressure in Pa\n"
280  "2. Temperature in K\n"
281  "3. Altitude in m",
282  Matrix_));
283 
284  wsv_data.push_back
285  (WsvRecord
286  ("raw_vmrs",
287  "The individual VMR profiles. Each species VMR profile comes with a\n"
288  "pressure profile. The different species can hence be on different\n"
289  "grids.\n"
290  "The matrix has rows:\n"
291  "1. Pressure in Pa\n"
292  "2. VMR profile (absolute number)\n"
293  "The array dimension is determined by the number of tag groups.",
294  ArrayOfMatrix_));
295 
296 
297  //--------------------< General Absorption Stuff >--------------------
298  // --------------------------
299  wsv_data.push_back
300  (WsvRecord
301  ("p_abs",
302  "The pressure grid for the absorption coefficients [Pa]. This\n"
303  "is the basic independent grid for the absorption calculation, both\n"
304  "in the 1D and 2D case. Therefore it remains a vector, even in 2D.\n"
305  "The \"raw\" atmospheric data shall be interpolated to p_abs before\n"
306  "the absorption calculations starts.",
307  Vector_));
308 
309  wsv_data.push_back
310  (WsvRecord
311  ("f_mono",
312  "The monochromatic frequency grid [Hz]. ",
313  Vector_));
314 
315 
316  //--------------------< 1D Absorption Stuff >--------------------
317  // ---------------------
318  wsv_data.push_back
319  (WsvRecord
320  ("t_abs",
321  "Temperature associated with the pressures in p_abs [K]",
322  Vector_));
323 
324  wsv_data.push_back
325  (WsvRecord
326  ("z_abs",
327  "Vertical altitudes associated with the pressures in p_abs [m]",
328  Vector_));
329 
330  wsv_data.push_back
331  (WsvRecord
332  ("h2o_abs",
333  "The total water profile associated with the pressures in p_abs [-]",
334  Vector_));
335 
336  wsv_data.push_back
337  (WsvRecord
338  ("n2_abs",
339  "The total nitrogen profile associated with the pressures in p_abs [-]",
340  Vector_));
341 
342  wsv_data.push_back
343  (WsvRecord
344  ("vmrs",
345  "The VMRs (unit: absolute number) on the p_abs grid.\n"
346  "Dimensions: [tag_groups.nelem(), p_abs.nelem()]",
347  Matrix_));
348 
349  wsv_data.push_back
350  (WsvRecord
351  ("abs",
352  "The matrix of absorption coefficients (in units of [1/m]).\n"
353  "Dimensions: [f_mono.nelem(), p_abs.nelem()]",
354  Matrix_));
355 
356  wsv_data.push_back
357  (WsvRecord
358  ("abs0",
359  "A second absoprtion matrix. This matrix can be used, for example,\n"
360  "to store absorption read from a file that shall be added to *abs*.",
361  Matrix_));
362 
363  wsv_data.push_back
364  (WsvRecord
365  ("abs_per_tg",
366  "These are the absorption coefficients individually for each\n"
367  "tag group. The Array contains one matrix for each tag group,\n"
368  "the matrix format is the same as that of abs",
369  ArrayOfMatrix_));
370 
371  wsv_data.push_back
372  (WsvRecord
373  ("xsec_per_tg",
374  "These are the cross sections individually for each tag\n"
375  "group. The Array contains one matrix for each tag group,\n"
376  "the matrix format is the same as that of abs",
377  ArrayOfMatrix_));
378 
379 
380  //--------------------< Hydrostatic equilibrium >--------------------
381  // -------------------------
382  wsv_data.push_back
383  (WsvRecord
384  ("hse",
385  "This vector holds the parameters for calculating hydrostatic \n"
386  "equilibrium (HSE). The length of the vector is either 1 or 5, where\n"
387  "the values are: \n "
388  " 1: On/off flag. 0 = ignore HSE, 1 = consider HSE.\n "
389  " 2: The pressure of the reference point [Pa]. \n "
390  " 3: The altitude of the reference point [m]. \n "
391  " 4: Gravitational acceleration at the geoid surface [m/s2]. \n "
392  " 5: Number of iterations of the calculations.\n"
393  "If the on/off flag is set to 1, the length of the vector must be 5,\n"
394  "while if the flag is 0 a length of 1 is OK.\n"
395  "See the function hseCalc for some more details.",
396  Vector_));
397 
398 
399  //--------------------< RT Stuff >--------------------
400  // ----------
401 
402  wsv_data.push_back
403  (WsvRecord
404  ("emission",
405  "Boolean to include emssion in the calculation of spectra.\n"
406  "If this variable is set to 0 (zero) pure transmission calculations \n"
407  "will be simulated and, for example, yCalc will give optical \n"
408  "thicknesses instead of radiation intensities.",
409  Index_));
410 
411  wsv_data.push_back
412  (WsvRecord
413  ("za_pencil",
414  "Pencil beam zenith angle grid [deg]. \n"
415  "The observation direction is specified by the angle between zenith \n"
416  "and the LOS.",
417  Vector_));
418 
419  wsv_data.push_back
420  (WsvRecord
421  ("z_tan",
422  "Tangent altitude for each spectrum [m].\n"
423  "These tangent altitudes include the effect of refraction (if set). \n"
424  "In the case of a ground intersection, a geometrical prolongation \n"
425  "below the ground is applied to determine the tangent altitude. \n"
426  "For upward observations where there are no tangent altitudes, \n"
427  "*z_tan* is set to 999 km. \n"
428  "It should be noted that the LOS calculations take *za_pencil* as \n"
429  "input, not *z_tan*. However, *za_pencil* can be calculated from \n"
430  "*z_tan* by the function *zaFromZtan*. ",
431  Vector_));
432 
433  wsv_data.push_back
434  (WsvRecord
435  ("z_plat",
436  "Vertical altitude, above the geoid, of the observation platform [m].",
437  Numeric_));
438 
439  wsv_data.push_back
440  (WsvRecord
441  ("l_step",
442  "The maximum length, along the LOS, between the points of LOS [m].\n"
443  "The final step length will in most cases equal the selected length.\n"
444  "There are two rare exceptions:\n"
445  " 1. Downward observations from within the atmosphere, where the step\n"
446  " length is adjusted downwards to get an integer number of steps\n"
447  " between the sensor and the tangent or ground point.\n"
448  " 2. Limb sounding and the distance from the tangent point to the\n"
449  " atmospheric limit (the highest absorption altitude) is smaller\n"
450  " than the selected length. The length is then adjusted to this\n"
451  " distance",
452  Numeric_));
453 
454  wsv_data.push_back
455  (WsvRecord
456  ("refr",
457  "Boolean for inclusion of refraction (0=no refraction, 1=refraction).",
458  Index_));
459 
460  wsv_data.push_back
461  (WsvRecord
462  ("refr_lfac",
463  "This factor determines the step length used during the ray tracing \n"
464  "performed when considering refraction. \n"
465  "The step length applied is *l_step* divided by *refr_lfac*. \n"
466  "Accordingly, this factor gives how many ray tracing steps that are \n"
467  "performed for each step of the LOS.",
468  Index_));
469 
470  wsv_data.push_back
471  (WsvRecord
472  ("refr_model",
473  "A string giving what parameterization to use for the calculation of \n"
474  "refractive index. See *refrCalc* for existing choices.",
475  String_));
476 
477  wsv_data.push_back
478  (WsvRecord
479  ("refr_index",
480  "The refractive index at the pressure levels in p_abs [-].\n",
481  Vector_));
482 
483  wsv_data.push_back
484  (WsvRecord
485  ("r_geoid",
486  "The local curvature radius of the geoid along the LOS [m].",
487  Numeric_));
488 
489  wsv_data.push_back
490  (WsvRecord
491  ("z_ground",
492  "The vertical altitude above the geoid of the ground [m].",
493  Numeric_));
494 
495  wsv_data.push_back
496  (WsvRecord
497  ("t_ground",
498  "The physical temperature of the ground [K].",
499  Numeric_));
500 
501  wsv_data.push_back
502  (WsvRecord
503  ("e_ground",
504  "The ground emission factor for the frequencies in f_mono [0-1].",
505  Vector_));
506 
507  wsv_data.push_back
508  (WsvRecord
509  ("los",
510  "Structure to define the line of sight (LOS). See los.h for \n"
511  "definition of the structure.",
512  Los_));
513 
514  wsv_data.push_back
515  (WsvRecord
516  ("source",
517  "Mean source function between the points of the LOS.",
518  ArrayOfMatrix_));
519 
520  wsv_data.push_back
521  (WsvRecord
522  ("trans",
523  "The transmissions between the points of the LOS [-].",
524  ArrayOfMatrix_));
525 
526  wsv_data.push_back
527  (WsvRecord
528  ("y_space",
529  "Radiation entering the atmosphere at the top of the atmosphere, \n"
530  "typically cosmic background radiation. This variable is most easily \n"
531  "set by the function *y_spaceStd*.",
532  Vector_));
533 
534  wsv_data.push_back
535  (WsvRecord
536  ("y",
537  "The working set of spectra. \n"
538  "The spectra from the different zenith angles are appended to form *y*.",
539  Vector_));
540 
541  wsv_data.push_back
542  (WsvRecord
543  ("y0",
544  "A reference spectrum. This variable can be used e.g. to save a copy\n"
545  "of *y* or to compare the spectra before and after some operation(s).",
546  Vector_));
547 
548  wsv_data.push_back
549  (WsvRecord
550  ("h",
551  "The H matrix.\n"
552  "\n"
553  "Can be used to apply the sensor model to monochromatic pencil beam\n"
554  "spectra and weighting functions. \n",
555  Matrix_));
556 
557 
558  //--------------------< WF Stuff >--------------------
559  // ----------
560  wsv_data.push_back
561  (WsvRecord
562  ("absloswfs",
563  "Line of sight weighting functions. \n"
564  "See AUG for definition of this quantity. ",
565  ArrayOfMatrix_));
566 
567  wsv_data.push_back
568  (WsvRecord
569  ("k_grid",
570  "Retrieval grid to be used in calculation of weighting functions (WFs)\n"
571  "For example, *k_grid* is the pressure altitude grid for species WFs. \n"
572  "Not all WFs need 'k_grid* as input.",
573  Vector_));
574 
575  wsv_data.push_back
576  (WsvRecord
577  ("k",
578  "The weighting functions (WFs) for a single retrieval/error group.",
579  Matrix_));
580 
581  wsv_data.push_back
582  (WsvRecord
583  ("k_names",
584  "Names of the retrieval identies in *k*.",
585  ArrayOfString_));
586 
587  wsv_data.push_back
588  (WsvRecord
589  ("k_aux",
590  "Auxiliary data for *k*. The number of rows of this matrix equals the\n"
591  "length of the state vector for the retrieval group (the number of\n"
592  "columns of k).\n"
593  "The columns hold different quantities:\n"
594  " Col 1: retrieval grid (or correspondingly)\n"
595  " Col 2: a priori values",
596  Matrix_));
597 
598  wsv_data.push_back
599  (WsvRecord
600  ("kx",
601  "The state weighting function matrix.",
602  Matrix_));
603 
604  wsv_data.push_back
605  (WsvRecord
606  ("kx_names",
607  "Names of the retrieval identities in *kx*.",
608  ArrayOfString_));
609 
610  wsv_data.push_back
611  (WsvRecord
612  ("kx_lengths",
613  "The length of the state vector for each retrieval identity in *kx*.",
614  ArrayOfIndex_));
615 
616  wsv_data.push_back
617  (WsvRecord
618  ("kx_aux",
619  "Auxiliary data for *kx*. As *k_aux* but with the data of the \n"
620  "different retrieval groups appended vertically.",
621  Matrix_));
622 
623  wsv_data.push_back
624  (WsvRecord
625  ("kb",
626  "The model parameters weighting function matrix.",
627  Matrix_));
628 
629  wsv_data.push_back
630  (WsvRecord
631  ("kb_names",
632  "Names of the model parameter identities in *kb*.",
633  ArrayOfString_));
634 
635  wsv_data.push_back
636  (WsvRecord
637  ("kb_lengths",
638  "The length of the model vector for each retrieval identity in *kb*.",
639  ArrayOfIndex_));
640 
641  wsv_data.push_back
642  (WsvRecord
643  ("kb_aux",
644  "Auxiliary data for *kb*. As *k_aux* but with the data of the \n"
645  "different forward model groups appended vertically.",
646  Matrix_));
647 
648  wsv_data.push_back
649  (WsvRecord
650  ("S_S",
651  "Stores the accuracy of the spectroscopic parameters read from catalog\n"
652  "This are necessary for the the spectroscopic error analysis\n"
653  "number columns = 2; first keeps the absolute error, second the error in percents\n"
654  "number lines equal of spectroscopic parameters investigated (the number of\n"
655  "columns of k).",
656  Matrix_));
657 
658  // wsv_data.push_back
659 // (WsvRecord
660 // ("Mcorr",
661 // "Stores the correlation matrix\n"
662 // "This are necessary for the the spectroscopic error analysis\n"
663 // "number columns = number lines equal of spectroscopic parameters \n"
664 // "investigated (the number of columns of k).",
665 // Matrix_));
666 
667  //-------------------< Batch calculation stuff >-----------------------
668  // -----------------------
669 
670  wsv_data.push_back
671  (WsvRecord
672  ("batchname",
673  "Default basename for batch data.",
674  String_));
675 
676  wsv_data.push_back
677  (WsvRecord
678  ("ybatch",
679  "A batch of spectra.\n"
680  "The spectra are stored as columns in a matrix",
681  Matrix_));
682 
683  wsv_data.push_back
684  (WsvRecord
685  ("absbatch",
686  "A batch of absorption coefficients.\n"
687  "FIXME",
688  ArrayOfMatrix_));
689 
690  wsv_data.push_back
691  (WsvRecord
692  ("jacbatch",
693  "A batch of jacobian matrices.\n"
694  "FIXME",
695  ArrayOfMatrix_));
696 
697 
698  wsv_data.push_back
699  (WsvRecord
700  ("radiosonde_data",
701  "An array of Matrix holding data for many radiosonde launches. The\n"
702  "dimension of the Array is the number of radiosonde launches. Each\n"
703  "Matrix within the Array has dimension nx4, where n is the number of\n"
704  "pressure levels. The columns of the Matrix are:\n"
705  "\n"
706  "pressure [Pa] temperature [K] altitude [m] VMR [1]",
707  ArrayOfMatrix_));
708 
709  //-------------------< Cooling rates stuff >-----------------------
710  // -------------------
711 
712  wsv_data.push_back
713  (WsvRecord
714  ("coolrate",
715  "Cooling rate matrix, in unit of K/s/Hz."
716  "Dimensions: [f_mono.nelem(), z_crates.nelem()]",
717  Matrix_));
718 
719  wsv_data.push_back
720  (WsvRecord
721  ("p_coolrate",
722  "Pressures for which to calculate cooling rates.",
723  Vector_));
724 
725  //-------------------< Methods as variables >-----------------------
726  // --------------------
727 
728  wsv_data.push_back
729  (WsvRecord
730  ("method_list",
731  "A list of methods. See \"arts -d MethodListDefine\"\n"
732  "for an explanation what a method list is.",
733  ArrayOfIndex_));
734 
735 }
ArrayOfMatrix_
@ ArrayOfMatrix_
Definition: auto_wsv_groups.h:35
ArrayOfString_
@ ArrayOfString_
Definition: auto_wsv_groups.h:33
TagGroups_
@ TagGroups_
Definition: auto_wsv_groups.h:39
auto_wsv_groups.h
Defines the enum type that acts as a handle for workspace variables groups.
define_wsv_data
void define_wsv_data()
Define the lookup data for the workspace variables.
Definition: workspace.cc:44
Los_
@ Los_
Definition: auto_wsv_groups.h:40
wsv_data
Array< WsvRecord > wsv_data
Definition: workspace.cc:42
array.h
This file contains the definition of Array.
ArrayOfLineRecord_
@ ArrayOfLineRecord_
Definition: auto_wsv_groups.h:36
matpackI.h
Array
This can be used to make arrays out of anything.
Definition: array.h:48
String_
@ String_
Definition: auto_wsv_groups.h:29
Index_
@ Index_
Definition: auto_wsv_groups.h:27
ArrayOfVector_
@ ArrayOfVector_
Definition: auto_wsv_groups.h:34
ArrayOfIndex_
@ ArrayOfIndex_
Definition: auto_wsv_groups.h:32
Matrix_
@ Matrix_
Definition: auto_wsv_groups.h:31
Numeric_
@ Numeric_
Definition: auto_wsv_groups.h:28
WsvRecord
This class contains all static information for one workspace variable.
Definition: wsv_aux.h:60
ArrayOfLineshapeSpec_
@ ArrayOfLineshapeSpec_
Definition: auto_wsv_groups.h:38
Vector_
@ Vector_
Definition: auto_wsv_groups.h:30
ArrayOfArrayOfLineRecord_
@ ArrayOfArrayOfLineRecord_
Definition: auto_wsv_groups.h:37
wsv_aux.h
Auxiliary header stuff related to workspace variable groups.
arts.h
The global header file for ARTS.