00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00034 #include "arts.h"
00035 #include "matpackI.h"
00036 #include "matpackII.h"
00037 #include "matpackIII.h"
00038 #include "matpackVI.h"
00039 #include "array.h"
00040 #include "wsv_aux.h"
00041 #include "ppath.h"
00042 #include "workspace_ng.h"
00043
00044
00045 #define NAME(x) x
00046 #define DESCRIPTION(x) x
00047 #define GROUP(x) x
00048
00049
00050 void Workspace::define_wsv_data()
00051 {
00052
00053
00054
00055 wsv_data.resize(0);
00056
00057
00058
00059
00060
00061
00062
00063
00064
00065
00066
00067
00068
00069
00070
00071
00072
00073
00074
00075
00076
00077
00078
00079
00080
00081
00082
00083
00084
00085
00086
00087
00088
00089
00090
00091
00092
00093
00094
00095
00096
00097
00098
00099
00100
00101
00102
00103
00104
00105
00106
00107
00108
00109
00110
00111
00112
00113
00114 wsv_data.push_back
00115 (WsvRecord
00116 ( NAME( "abs_coef" ),
00117 DESCRIPTION
00118 (
00119 "The matrix of total absorption coefficients.\n"
00120 "\n"
00121 "FIXME: Is this used much?\n"
00122 "\n"
00123 "Dimensions: [f_grid, abs_p]\n"
00124 "\n"
00125 "Unit: 1/m\n"
00126 ),
00127 GROUP( "Matrix" )));
00128
00129 wsv_data.push_back
00130 (WsvRecord
00131 (NAME( "abs_coef_per_species" ),
00132 DESCRIPTION
00133 (
00134 "These are the absorption coefficients individually for each\n"
00135 "tag group. The Array contains one matrix for each tag group,\n"
00136 "the matrix format is the same as that of abs_coef\n"
00137 ),
00138 GROUP( "ArrayOfMatrix" )));
00139
00140
00141
00142
00143
00144
00145
00146
00147
00148
00149 wsv_data.push_back
00150 (WsvRecord
00151 (NAME( "abs_cont_models" ),
00152 DESCRIPTION
00153 (
00154 "Continuum / full model absorption model description parameter.\n"
00155 "See the WSV `abs_cont_names' for a detailed description\n"
00156 "of the allowed continuum models. There should be one string here\n"
00157 "for each entry in `abs_cont_names'.See also the online\n"
00158 "documentation in arts/doc/doxygen/html/continua_cc.html.\n"
00159 ),
00160 GROUP( "ArrayOfString" )));
00161
00162 wsv_data.push_back
00163 (WsvRecord
00164 (NAME( "abs_cont_names" ),
00165 DESCRIPTION
00166 (
00167 "Continuum / full model absorption tag names. This variable should\n"
00168 "contain a list of tag names of continuum and full models, respectively.\n"
00169 "Associated with this WSV is the WSV\n"
00170 "`abs_cont_models' which contains the specific model version of\n"
00171 "each continuum / full model absorption tag and the WSV\n"
00172 "`abs_cont_parameters' which should contain the continuum / full model\n"
00173 "user defined parameters. The user defined parameters are only used when\n"
00174 "the specified model is 'user'. See also the online documentation in\n"
00175 "arts/doc/doxygen/html/continua_cc.html.\n"
00176 "\n"
00177 "The following full water vapor models are implemented:\n"
00178 "'H2O-MPM87': absorption model (line and continuum) according to \n"
00179 " H. J. Liebe,\n"
00180 " A contribution to modeling atmospheric millimeter-wave properties,\n"
00181 " Frequenz, 41, 1987, 31-36\n"
00182 " and\n"
00183 " H. J. Liebe and D. H. Layton,\n"
00184 " Millimeter-wave properties of the atmosphere:\n"
00185 " Laboratory studies and propagation modeling,\n"
00186 " U.S. Dept. of Commerce, National Telecommunications and Information\n"
00187 " Administration, Institute for Communication Sciences,\n"
00188 " 325 Broadway, Boulder, CO 80303-3328, report 87224.\n"
00189 "'H2O-MPM89': absorption model (line and continuum) according to \n"
00190 " H. J. Liebe,\n Int. J. Infrared and Millimeter Waves, 10(6), 1989, 631\n"
00191 "'H2O-MPM93': absorption model (line and continuum) according to \n"
00192 " H. J. Liebe and G. A. Hufford and M. G. Cotton,\n"
00193 " Propagation modeling of moist air and suspended water/ice\n"
00194 " particles at frequencies below 1000 GHz,\n"
00195 " AGARD 52nd Specialists Meeting of the Electromagnetic Wave\n"
00196 " Propagation Panel,\n Palma de Mallorca, Spain, 1993, May 17-21 \n"
00197 " (ftp.its.bldrdoc.gov/pub/mpm93/)\n"
00198 "'H2O-CP98': absorption model (line and continuum) according to \n"
00199 " S. L. Cruz-Pol et al.,\n Radio Science, 33(5), 1319, 1998"
00200 " (ece.uprm.edu/~pol/Atmosphere.html)\n"
00201 "'H2O-PWR98': absorption model (line and continuum) according to \n"
00202 " P. W. Rosenkranz,\n "
00203 " Radio Science, 33(4), 919, 1998, Radio Science, 34(4), 1025, 1999\n"
00204 " (ftp: mesa.mit.edu/phil/lbl_rt).\n"
00205 "\n"
00206 "The following full oxygen models are implemented:\n"
00207 "'O2-MPM93': absorption model (line and continuum) according to\n"
00208 " H. J. Liebe and G. A. Hufford and M. G. Cotton,\n"
00209 " Propagation modeling of moist air and suspended water/ice\n"
00210 " particles at frequencies below 1000 GHz,\n"
00211 " AGARD 52nd Specialists Meeting of the Electromagnetic Wave\n"
00212 " Propagation Panel,\n Palma de Mallorca, Spain, 1993, May 17-21\n"
00213 " (ftp.its.bldrdoc.gov/pub/mpm93/)\n"
00214 "'O2-PWR93': absorption model (line and continuum) according to \n"
00215 " P. W. Rosenkranz,\n Chapter 2, in M. A. Janssen, \n"
00216 " Atmospheric Remote Sensing by Microwave Radiometry\n"
00217 " John Wiley & Sons, Inc., 1993 (mesa.mit.edu/phil/lbl_rt)\n"
00218 "\n"
00219 "The following continuum parameterizations are implemented:\n"
00220 "H2O-H2O ('H2O-SelfContStandardType'):\n"
00221 " P. W. Rosenkranz, \n"
00222 " Radio Science, Vol. 33, No 4, Pages 919-928, 1998 and \n"
00223 " Radio Science, Vol. 34, No 4, Page 1025, 1999 (mesa.mit.edu/phil/lbl_rt)\n"
00224 "H2O-air ('H2O-ForeignContStandardType'): \n"
00225 " P. W. Rosenkranz, \n"
00226 " Radio Science, Vol. 33, No 4, Pages 919-928, 1998 and \n"
00227 " Radio Science, Vol. 34, No 4, Page 1025, 1999 (mesa.mit.edu/phil/lbl_rt)\n"
00228 "H2O-air ('H2O-ContMPM93'): \n"
00229 " H. J. Liebe and G. A. Hufford and M. G. Cotton,\n"
00230 " Propagation modeling of moist air and suspended water/ice\n"
00231 " particles at frequencies below 1000 GHz,\n"
00232 " AGARD 52nd Specialists Meeting of the Electromagnetic Wave\n"
00233 " Propagation Panel,\n Palma de Mallorca, Spain, 1993, May 17-21\n"
00234 " (ftp.its.bldrdoc.gov/pub/mpm93/)\n"
00235 "O2-air ('O2-SelfContStandardType'):\n"
00236 " P. W. Rosenkranz,\n"
00237 " Chapter 2, in M. A. Janssen,\n"
00238 " Atmospheric Remote Sensing by Microwave Radiometry,\n"
00239 " John Wiley & Sons, Inc., 1993\n"
00240 " (mesa.mit.edu/phil/lbl_rt)\n"
00241 " and also described in \n"
00242 " H. J. Liebe and G. A. Hufford and M. G. Cotton,\n"
00243 " Propagation modeling of moist air and suspended water/ice\n"
00244 " particles at frequencies below 1000 GHz,\n"
00245 " AGARD 52nd Specialists Meeting of the Electromagnetic Wave\n"
00246 " Propagation Panel,\n Palma de Mallorca, Spain, 1993, May 17-21\n"
00247 " (ftp.its.bldrdoc.gov/pub/mpm93/)\n"
00248 "N2-N2 ('N2-SelfContStandardType'):\n"
00249 " The functional form of Rosenkranz but with more input parameters.\n"
00250 " P. W. Rosenkranz,\n"
00251 " Chapter 2, in M. A. Janssen,\n"
00252 " Atmospheric Remote Sensing by Microwave Radiometry,\n"
00253 " John Wiley & Sons, Inc., 1993 (mesa.mit.edu/phil/lbl_rt)\n"
00254 "N2-N2 ('N2-SelfContMPM93'):\n"
00255 " H. J. Liebe and G. A. Hufford and M. G. Cotton,\n"
00256 " Propagation modeling of moist air and suspended water/ice\n"
00257 " particles at frequencies below 1000 GHz,\n"
00258 " AGARD 52nd Specialists Meeting of the Electromagnetic Wave\n"
00259 " Propagation Panel, Palma de Mallorca, Spain, 1993, May 17-21 \n"
00260 " (ftp.its.bldrdoc.gov/pub/mpm93/)\n"
00261 "CO2-CO2 ('CO2-SelfContPWR93'):\n"
00262 " P. W. Rosenkranz,\n"
00263 " Chapter 2, in M. A. Janssen,\n"
00264 " Atmospheric Remote Sensing by Microwave Radiometry,\n"
00265 " John Wiley & Sons, Inc., 1993 (mesa.mit.edu/phil/lbl_rt)\n"
00266 "CO2-N2 ('CO2-ForeignContPWR93'):\n"
00267 " P. W. Rosenkranz,\n"
00268 " Chapter 2, in M. A. Janssen,\n"
00269 " Atmospheric Remote Sensing by Microwave Radiometry,\n"
00270 " John Wiley & Sons, Inc., 1993 (mesa.mit.edu/phil/lbl_rt)\n"
00271 "\n"
00272 "The following cloud absorption models are implemented:\n"
00273 "Suspended water droplet ('liquidcloud-MPM93') \n"
00274 " absorption parameterization from the MPM93 model:\n"
00275 " H. J. Liebe and G. A. Hufford and M. G. Cotton,\n"
00276 " Propagation modeling of moist air and suspended water/ice\n"
00277 " particles at frequencies below 1000 GHz,\n"
00278 " AGARD 52nd Specialists Meeting of the Electromagnetic Wave\n"
00279 " Propagation Panel,\n Palma de Mallorca, Spain, 1993, May 17-21\n"
00280 " (ftp.its.bldrdoc.gov/pub/mpm93/)\n"
00281 "Ice water droplet absorption ('icecloud-MPM93') \n"
00282 " parameterization from MPM93 model:\n"
00283 " H. J. Liebe and G. A. Hufford and M. G. Cotton,\n"
00284 " Propagation modeling of moist air and suspended water/ice\n"
00285 " particles at frequencies below 1000 GHz,\n"
00286 " AGARD 52nd Specialists Meeting of the Electromagnetic Wave\n"
00287 " Propagation Panel,\n Palma de Mallorca, Spain, 1993, May 17-21\n"
00288 " (ftp.its.bldrdoc.gov/pub/mpm93/)\n"
00289 "\n"
00290 "The following rain extinction model is implemented:\n"
00291 "Rain extinction parameterization ('rain-MPM93') from the\n"
00292 " MPM93 model, described in:\n"
00293 " H. J. Liebe,\n"
00294 " MPM - An Atmospheric Millimeter-Wave Propagation Model,\n"
00295 " Int. J. Infrared and Millimeter Waves, vol. 10(6),\n"
00296 " pp. 631-650, 1989;\n"
00297 " and based on:\n"
00298 " Olsen, R.L., D.V. Rogers, and D. B. Hodge,\n"
00299 " The aR^b relation in the calculation of rain attenuation,\n"
00300 " IEEE Trans. Antennas Propagat., vol. AP-26, pp. 318-329, 1978.\n"
00301 " IMPORTANT NOTE: rain-MPM93 parameterizes the EXTINCTION by rain,\n"
00302 " not just the absorption. Therefore it is not suitable for \n"
00303 " calculating thermal emission by rain!\n"
00304 " Please use rain-MPM93 only for calculation of attenuation.\n"
00305 ),
00306 GROUP( "ArrayOfString" )));
00307
00308 wsv_data.push_back
00309 (WsvRecord
00310 (NAME( "abs_cont_parameters" ),
00311 DESCRIPTION
00312 (
00313 "Continuum model parameters. See the WSV `abs_cont_names'\n"
00314 "for a detailed description of the allowed continuum models. There\n"
00315 "should be one parameter vector here for each entry in\n"
00316 "`abs_cont_names'. See also the online documentation in\n"
00317 "arts/doc/doxygen/html/continua_cc.html.\n"
00318 ),
00319 GROUP( "ArrayOfVector" )));
00320
00321 wsv_data.push_back
00322 (WsvRecord
00323 (NAME( "abs_h2o" ),
00324 DESCRIPTION
00325 (
00326 "The total water profile associated with the pressures in abs_p [-]\n"
00327 ),
00328 GROUP( "Vector" )));
00329
00330 wsv_data.push_back
00331 (WsvRecord
00332 ( NAME( "abs_lines" ),
00333 DESCRIPTION
00334 (
00335 "A list of spectral line data.\n"
00336 ),
00337 GROUP( "ArrayOfLineRecord" )));
00338
00339 wsv_data.push_back
00340 (WsvRecord
00341 ( NAME( "abs_lineshape" ),
00342 DESCRIPTION
00343 (
00344 "Lineshape specification: function, norm, cutoff. There is one entry for\n"
00345 "each abs_tag, not for each species. This means if you have several\n"
00346 "abs_tags for different isotopes or transitions of a species, you\n"
00347 "may use different lineshapes.\n"
00348 ),
00349 GROUP( "ArrayOfLineshapeSpec" )));
00350
00351 wsv_data.push_back
00352 (WsvRecord
00353 ( NAME( "abs_lines_per_species" ),
00354 DESCRIPTION
00355 (
00356 "A list of spectral line data for each tag.\n"
00357 "Dimensions: (tag_groups.nelem()) (# of lines for this tag)\n"
00358 ),
00359 GROUP( "ArrayOfArrayOfLineRecord" )));
00360
00361 wsv_data.push_back
00362 (WsvRecord
00363 ( NAME( "abs_lookup" ),
00364 DESCRIPTION
00365 (
00366 "An absorption lookup table.\n"
00367 "\n"
00368 "This holds an absorption lookup table, as well as all information that\n"
00369 "is necessary to use the table to extract absorption. Extraction\n"
00370 "routines are implemented as member functions. \n"
00371 "\n"
00372 "This has quite a complicated structure. See Doxygen documentation for\n"
00373 "class GasAbsLookup for details. FIXME: Add here a reference to AUG,\n"
00374 "once the chapter on the lookup table has been written.\n"
00375 ),
00376 GROUP( "GasAbsLookup" )));
00377
00378 wsv_data.push_back
00379 (WsvRecord
00380 ( NAME( "abs_nls" ),
00381 DESCRIPTION
00382 (
00383 "Nonlinear species for absorption lookup table generation.\n"
00384 "\n"
00385 "A list of absorption species that should be treated non-linearly.\n"
00386 "This means that the H2O VMR should be varied when calculating the\n"
00387 "lookup table for those species.\n"
00388 "\n"
00389 "A typical example is for this to containt the Rosenkranz full\n"
00390 "absorption model species for water vapor and oxygen \n"
00391 "([\"H2O-PWR98\", \"O2-PWR93\"]).\n"
00392 "\n"
00393 "It only makes sense to put a species here if is either a water vapor\n"
00394 "species, or some other species that uses *h2o_abs*, that is, for which\n"
00395 "the absorption coefficient depends directly on water vapor.\n"
00396 "\n"
00397 "See user guide and online documentation of *abs_pts* and *abs_lookupCreate*\n"
00398 "for more details and usage examples.\n"
00399 ),
00400 GROUP( "ArrayOfArrayOfSpeciesTag" )));
00401
00402 wsv_data.push_back
00403 (WsvRecord
00404 ( NAME( "abs_nls_pert" ),
00405 DESCRIPTION
00406 (
00407 "Fractional perturbations for the nonlinear species in the absorption\n"
00408 "lookup table.\n"
00409 "\n"
00410 "This is a vector of fractional perturbations that should contain 1\n"
00411 "(the unperturbed reference profile). A value of 0 may lead to error\n"
00412 "messages from some absorption routines, so a possible content for this\n"
00413 "variable is: [1e-24, 1, 2].\n"
00414 "(This is similar to *abs_t_pert*, but multiplicative, not additive.)\n"
00415 ),
00416 GROUP( "Vector" )));
00417
00418 wsv_data.push_back
00419 (WsvRecord
00420 ( NAME( "abs_nls_interp_order" ),
00421 DESCRIPTION
00422 (
00423 "The interpolation order to use when interpolating absorption between\n"
00424 "the H2O values given by *abs_nls_pert*. This is used by methods\n"
00425 "extracting absorption coefficients from the lookup table, and by\n"
00426 "methods setting up parameters for lookup table generation. Has a\n"
00427 "default value, which is set in general.arts.\n"
00428 "\n"
00429 "Note that the number of points used in the interpolation scheme is\n"
00430 "interpolation order + 1 (e.g., two for first order interpolation).\n"
00431 ),
00432 GROUP( "Index" )));
00433
00434 wsv_data.push_back
00435 (WsvRecord
00436 ( NAME( "abs_p_interp_order" ),
00437 DESCRIPTION
00438 (
00439 "The interpolation order to use when interpolating absorption\n"
00440 "between pressure levels. This is used by methods extracting\n"
00441 "absorption coefficients from the lookup table, and by methods\n"
00442 "setting up parameters for lookup table generation. Has a\n"
00443 "default value, which is set in general.arts.\n"
00444 "\n"
00445 "Note that the number of points used in the interpolation scheme is\n"
00446 "interpolation order + 1 (e.g., two for first order interpolation).\n"
00447 ),
00448 GROUP( "Index" )));
00449
00450 wsv_data.push_back
00451 (WsvRecord
00452 ( NAME( "abs_t_pert" ),
00453 DESCRIPTION
00454 (
00455 "Temperature perturbations for the absorption lookup table.\n"
00456 "\n"
00457 "This is a vector containing temperature perturbations (in Kelvin) that\n"
00458 "should be added to the reference temperature profile. (Similar to\n"
00459 "*abs_nls_pert*, but additive, not multiplicative.) Should normally\n"
00460 "contain 0, to include the reference profile itself. Example content:\n"
00461 "[-5, 0, 5].\n"
00462 ),
00463 GROUP( "Vector" )));
00464
00465 wsv_data.push_back
00466 (WsvRecord
00467 ( NAME( "abs_t_interp_order" ),
00468 DESCRIPTION
00469 (
00470 "The interpolation order to use when interpolating absorption between\n"
00471 "the temperature values given by *abs_t_pert*. This is used by methods\n"
00472 "extracting absorption coefficients from the lookup table, and by\n"
00473 "methods setting up parameters for lookup table generation. Has a\n"
00474 "default value, which is set in general.arts.\n"
00475 "\n"
00476 "Note that the number of points used in the interpolation scheme is\n"
00477 "interpolation order + 1 (e.g., two for first order interpolation).\n"
00478 ),
00479 GROUP( "Index" )));
00480
00481 wsv_data.push_back
00482 (WsvRecord
00483 ( NAME( "abs_lookup_is_adapted" ),
00484 DESCRIPTION
00485 (
00486 "Flag to indicate whether *abs_lookupAdapt* has already been\n"
00487 "called.\n"
00488 "\n"
00489 "Values: 0=false, 1=true.\n"
00490 ),
00491 GROUP( "Index" )));
00492
00493 wsv_data.push_back
00494 (WsvRecord
00495 (NAME( "abs_n2" ),
00496 DESCRIPTION
00497 (
00498 "The total nitrogen profile associated with the pressures in abs_p [-]\n"
00499 ),
00500 GROUP( "Vector" )));
00501
00502 wsv_data.push_back
00503 (WsvRecord
00504 ( NAME( "abs_p" ),
00505 DESCRIPTION
00506 (
00507 "List of pressures to be used for the calculation of absorption\n"
00508 "coefficients. \n"
00509 "\n"
00510 "This can be copied from the global p_grid, but could also be\n"
00511 "different. \n"
00512 "\n"
00513 "Any absorption method should check that the length of this vector\n"
00514 "is the same as that of abs_t\n"
00515 "\n"
00516 "Dimension: [number of pressures]\n"
00517 "\n"
00518 "Unit: Pa\n"
00519 ),
00520 GROUP( "Vector" )));
00521
00522 wsv_data.push_back
00523 (WsvRecord
00524 ( NAME( "abs_scalar_gas" ),
00525 DESCRIPTION
00526 (
00527 "Scalar gas absorption coefficients.\n"
00528 "\n"
00529 "This contains the absorption coefficients for one point in the\n"
00530 "atmosphere (one set of pressure, temperature, and VMR values). There\n"
00531 "are two distinct cases:\n"
00532 "\n"
00533 "Case a: For all frequencies and all species:\n"
00534 "Dimension: [ f_grid, abs_species ]\n"
00535 "\n"
00536 "Case b: For a single frequency for all species:\n"
00537 "Dimension: [ 1, abs_species ]\n"
00538 "\n"
00539 "Unit: 1/m\n"
00540 ),
00541 GROUP( "Matrix" )));
00542
00543 wsv_data.push_back
00544 (WsvRecord
00545 ( NAME( "abs_scalar_gas_agenda" ),
00546 DESCRIPTION
00547 (
00548 "See agendas.cc.\n"
00549 ),
00550 GROUP( "Agenda" )));
00551
00552 wsv_data.push_back
00553 (WsvRecord
00554 ( NAME( "abs_field" ),
00555 DESCRIPTION
00556 (
00557 "Scalar gas absorption field.\n"
00558 "\n"
00559 "Contains the scalar gas absorption for all species as a function of\n"
00560 "f_grid, p_grid, lat_grid, and lon_grid. \n"
00561 "\n"
00562 "This is mainly for testing and plotting gas absorption. For RT\n"
00563 "calculations, gas absorption is calculated or extracted locally,\n"
00564 "therefore there is no need to store a global field. But this variable\n"
00565 "is handy for easy plotting of absorption vs. pressure, for example.\n"
00566 "\n"
00567 "Unit: 1/m\n"
00568 "\n"
00569 "Dimensions: [species, f_grid, p_grid, lat_grid, lon_grid]\n"
00570 ),
00571 GROUP( "Tensor5" )));
00572
00573 wsv_data.push_back
00574 (WsvRecord
00575 ( NAME( "abs_species" ),
00576 DESCRIPTION
00577 (
00578 "Tag groups for scalar gas absorption.\n"
00579 "\n"
00580 "This is an array of arrays of SpeciesTag tag definitions. It defines the\n"
00581 "available tag groups for the calculation of scalar gas absorption\n"
00582 "coefficients. See online documentation of method *abs_speciesSet* for\n"
00583 "more detailed information how tag groups work and some examples.\n"
00584 ),
00585 GROUP( "ArrayOfArrayOfSpeciesTag" )));
00586
00587 wsv_data.push_back
00588 (WsvRecord
00589 ( NAME( "abs_t" ),
00590 DESCRIPTION
00591 (
00592 "List of temperatures to be used for the calculation of absorption\n"
00593 "coefficients.\n"
00594 "\n"
00595 "In contrast to the global t_field, this is just a vector. Any\n"
00596 "absorption method should check that the length of this vector is the\n"
00597 "same as that of abs_p\n"
00598 "\n"
00599 "Dimension: [number of pressures]\n"
00600 "\n"
00601 "Unit: K\n"
00602 ),
00603 GROUP( "Vector" )));
00604
00605 wsv_data.push_back
00606 (WsvRecord
00607 ( NAME( "abs_vec" ),
00608 DESCRIPTION
00609 (
00610 "Total absorption vector.\n"
00611 "\n"
00612 "This variable contains the absorption coefficient vector which \n"
00613 "is used in the RTE calculation. It is \n"
00614 "the physical absorption which includes particle absorption \n"
00615 "for all chosen particle types as well as gaseous absorption for\n"
00616 "all chosen gaseous species.\n"
00617 "The vector is calculated by the agendas *opt_prop_gas_agenda* \n"
00618 "and, if scattering calculations are performed, \n"
00619 "*opt_prop_part_agenda* \n"
00620 "The dimensision of the variable adapts to *stokes_dim*.\n"
00621 "\n"
00622 "See further the ARTS user guide (AUG). Use the index to find where\n"
00623 "this variable is discussed. The variable is listed as a subentry to\n"
00624 "\"workspace variables\".\n"
00625 "\n"
00626 "Usage: Output of the agendas *opt_prop_gas_agenda* \n"
00627 " and *opt_prop_part_agenda* \n"
00628 "\n"
00629 "Unit: [Hz, m^2]\n"
00630 "\n"
00631 "Dimensions: [f_grid, stokes_dim]\n"
00632 ),
00633 GROUP( "Matrix" )));
00634
00635 wsv_data.push_back
00636 (WsvRecord
00637 ( NAME("abs_vec_spt"),
00638 DESCRIPTION
00639 (
00640 "Absorption vector for a single particle type.\n"
00641 "\n"
00642 "This variable contains the elements of absorption vector of a \n"
00643 "single particle, given It is calculated in the agenda \n"
00644 "*spt_calc_agenda*.\n"
00645 "\n"
00646 "ARTS user guide (AUG) gives the formulas used for computing all \n"
00647 "the elements of absorption vector.\n"
00648 "\n"
00649 "Usage: Input and Output of the method abs_vec_sptCalc\n"
00650 "\n"
00651 "Unit: m^2\n"
00652 "\n"
00653 "Dimensions: [part_types,stokes_dim]\n"
00654 ),
00655 GROUP( "Matrix" ) ));
00656
00657 wsv_data.push_back
00658 (WsvRecord
00659 (NAME( "abs_vmrs" ),
00660 DESCRIPTION
00661 (
00662 "The VMRs (unit: absolute number) on the abs_p grid.\n"
00663 "Dimensions: [tag_groups.nelem(), abs_p.nelem()]\n"
00664 ),
00665 GROUP( "Matrix" )));
00666
00667 wsv_data.push_back
00668 (WsvRecord
00669 ( NAME( "abs_xsec_per_species" ),
00670 DESCRIPTION
00671 (
00672 "Absorption cross sections.\n"
00673 "\n"
00674 "This variable contains absorption cross section xsec individually for\n"
00675 "each tag group. The Array contains one matrix for each tag group, the\n"
00676 "matrix format is the same as that of abs_coef.\n"
00677 "\n"
00678 "Dimensions: [abs_species](f_grid, abs_p)\n"
00679 "\n"
00680 "Unit: m^2 (alpha = xsec * n * VMR),\n"
00681 " where n is total density.\n"
00682 ),
00683 GROUP( "ArrayOfMatrix" )));
00684
00685 wsv_data.push_back
00686 (WsvRecord
00687 ( NAME( "antenna_dim" ),
00688 DESCRIPTION
00689 (
00690 "The dimensionality of the antenna pattern (1-2).\n"
00691 "\n"
00692 "A dimensionality of 1 means that only the respons variation in the\n"
00693 "zenith direction is considered. The provided respons shall then be the\n"
00694 "integrated in the azimuth direction. For 2D, the respons of the\n"
00695 "antenna has both a zenith and azimuth variation.\n"
00696 "\n"
00697 "Usage: Set by the user.\n"
00698 "\n"
00699 "Unit: Integer value.\n"
00700 ),
00701 GROUP( "Index" )));
00702
00703 wsv_data.push_back
00704 (WsvRecord
00705 ( NAME( "antenna_los" ),
00706 DESCRIPTION
00707 (
00708 "The relative line-of-sight of each antenna pattern.\n"
00709 "\n"
00710 "This variable describes the line-of-sight of the individual antennae\n"
00711 "relative to *sensor_los*. If only one antenna is present the matrix\n"
00712 "should contain a row of zero(s). The number of columns corresponds to\n"
00713 "the *antenna_dim*, with the first column containing zenith angles\n"
00714 "and the second azimuth angles. If each measurement block corresponds\n"
00715 "to a single antenna pattern, the normal choice is to set the angle(s)\n"
00716 "of this variable to zero.\n"
00717 "\n"
00718 "See further the ARTS user guide (AUG). Use the index to find where\n"
00719 "this variable is discussed. The variable is listed as a subentry to\n"
00720 "\"workspace variables\".\n"
00721 "\n"
00722 "Usage: Set by the user.\n"
00723 "\n"
00724 "Unit: [ degrees, degrees ]\n"
00725 "\n"
00726 "Size: [ number of antennae, 1 or 2 ]\n"
00727 ),
00728 GROUP( "Matrix" )));
00729
00730 wsv_data.push_back
00731 (WsvRecord
00732 ( NAME( "antenna_response" ),
00733 DESCRIPTION
00734 (
00735 "The antenna pattern/response.\n"
00736 "\n"
00737 "This WSV describes the antenna response as a function of polarisation\n"
00738 "(pol), frequencue (f), zenith angle (za) and azimuth angle (aa).\n"
00739 "\n"
00740 "Polarisation dimension: If this dimension has size 1, the data are\n"
00741 "applied for all polarisations of concern. The data are otherwise used\n"
00742 "in sequential order. This signifies that, in general, the first\n"
00743 "polarisation \"layer\" corresponds to the first stokes dimension\n"
00744 "etc. An exception is if a polarisation rotation has been applied. In\n"
00745 "any case, it is up to the user to ensure that polarisations are\n"
00746 "consistently defined.\n"
00747 "\n"
00748 "Frequency dimension: If this dimension has size 1, the data are\n"
00749 "applied for all frequencies of concern. The given frequency must be\n"
00750 "inside the frequency range of concern. A linear interpolation is\n"
00751 "otherwise applied.\n"
00752 "\n"
00753 "Zenith angle dimension: This dimension must always have a size >= 2\n"
00754 "The response outside covered grid range is treated as zero. If\n"
00755 "*antenna_dim* equals 1, the data should correspond to the response\n"
00756 "integrated in the azimuthal direction.\n"
00757 "\n"
00758 "Azimuth angle dimension: If *antenna_dim* equals 1, this dimension\n"
00759 "must have size 1. A size >= 2 is otherwise required. The response\n"
00760 "outside covered grid range is treated as zero.\n"
00761 "\n"
00762 "Usage: Set by the user.\n"
00763 "\n"
00764 "Dimensions: \n"
00765 " GField4:\n"
00766 " ArrayOfString field_names[N_pol]\n"
00767 " Vector f_grid[N_f]\n"
00768 " Vector za_grid[N_za]\n"
00769 " Vector aa_grid[N_aa]\n"
00770 " Tensor4 data[N_pol][N_f][N_za][N_aa]\n"
00771 ),
00772 GROUP( "GField4" )));
00773
00774 wsv_data.push_back
00775 (WsvRecord
00776 ( NAME( "atmosphere_dim" ),
00777 DESCRIPTION
00778 (
00779 "The atmospheric dimensionality (1-3).\n"
00780 "\n"
00781 "This variable defines the complexity of the atmospheric structure.\n"
00782 "The dimensionality is given by an integer between 1 and 3, where 1\n"
00783 "means 1D etc. This is the master variable for the atmospheric\n"
00784 "dimensionality, variables which size changes with the dimensionality\n"
00785 "are checked to match this variable. \n"
00786 "\n"
00787 "Methods adapt automatically to this variable. That is, it should\n"
00788 "not be needed to change any methods if the dimensionality is\n"
00789 "changed. However, not all methods are working for higher dimensions.\n"
00790 "\n"
00791 "Usage: Set by the user.\n"
00792 "\n"
00793 "Unit: Integer value.\n"
00794 ),
00795 GROUP( "Index" )));
00796
00797 wsv_data.push_back
00798 (WsvRecord
00799 ( NAME( "atm_fields_compact" ),
00800 DESCRIPTION
00801 (
00802 "A compact combination of all atmospheric fields for a clear-sky\n"
00803 "calculation on a common set of grids.\n"
00804 "\n"
00805 "This concerns temperature, altitude, and gas VMRs.\n"
00806 "\n"
00807 "The data is stored in a GField4.\n"
00808 "\n"
00809 "The order of the fields must be:\n"
00810 "T[K] z[m] VMR_1[1] ... VMR[2]\n"
00811 "\n"
00812 "Usage: Used inside batch calculations, to hold successive atmospheric\n"
00813 " states from an ArrayOfGField4.\n"
00814 "\n"
00815 "Possible future extensions: Add a similar variable\n"
00816 "particle_fields_compact for hydrometeors?\n"
00817 "\n"
00818 "Dimensions: \n"
00819 " GField4:\n"
00820 " ArrayOfString field_names[N_fields]\n"
00821 " Vector p_grid[N_p]\n"
00822 " Vector lat_grid[N_lat]\n"
00823 " Vector lon_grid[N_lon]\n"
00824 " Tensor4 data[N_fields][N_p][N_lat][N_lon]\n"
00825 ),
00826 GROUP( "GField4" )));
00827
00828 wsv_data.push_back
00829 (WsvRecord
00830 ( NAME( "backend_channel_response" ),
00831 DESCRIPTION
00832 (
00833 "The response of each backend channel.\n"
00834 "\n"
00835 "The response is given as an ArrayOfGField1. The grid consists of\n"
00836 "relative frequencies. These relative frequencies are added to \n"
00837 "*f_backend* to obtain the absolute frequency for each response value.\n"
00838 "The actual data are the response at each frequency grid point.\n"
00839 "\n"
00840 "There are here two options. If the array has length 1, the same\n"
00841 "response is applied for all channels. Accordingly, this assumes that\n"
00842 "all channels have the same response function. The second option is to\n"
00843 "specify the response for each channel seperately. This signifies that\n"
00844 "the *backend_channel_response* array has either 1 or n elements, where\n"
00845 "n is the length of *f_backend*\n"
00846 "\n"
00847 "Usage: Set by the user.\n"
00848 "\n"
00849 "Size: Array[N_ch]\n"
00850 " GField1 \n "
00851 " [N_f] \n"
00852 " [N_f] \n"
00853 ),
00854 GROUP( "ArrayOfGField1" )));
00855
00856 wsv_data.push_back
00857 (WsvRecord
00858 ( NAME( "backend_channel_response_multi" ),
00859 DESCRIPTION
00860 (
00861 "As *backend_channel_response_multi* but describes an instrument with\n"
00862 "muliple mixer/reciever chains.\n"
00863 "\n"
00864 "See *f_backend_multi* for when to use this variable and size\n"
00865 "constraints.\n"
00866 "\n"
00867 "Usage: Set by the user.\n "
00868 ),
00869 GROUP( "ArrayOfArrayOfGField1" )));
00870
00871 wsv_data.push_back
00872 (WsvRecord
00873 ( NAME( "batch_atm_fields_compact" ),
00874 DESCRIPTION
00875 (
00876 "An array of compact atmospheric states.\n"
00877 "\n"
00878 "This is used to hold a set of *atm_fields_compact* for batch\n"
00879 "calculations. \n"
00880 ),
00881 GROUP( "ArrayOfGField4" )));
00882
00883 wsv_data.push_back
00884 (WsvRecord
00885 ( NAME( "batch_cloudbox_limits" ),
00886 DESCRIPTION
00887 (
00888 "An array of cloudbox_limits.\n"
00889 "\n"
00890 "This is used to hold a set of *cloudbox-limits* for batch\n"
00891 "calculations. \n"
00892 ),
00893 GROUP( "ArrayOfArrayOfIndex" )));
00894
00895 wsv_data.push_back
00896 (WsvRecord
00897 ( NAME( "batch_pnd_fields" ),
00898 DESCRIPTION
00899 (
00900 "An array of compact pnd states.\n"
00901 "\n"
00902 "This is used to hold a set of 1D *pnd_fields* for batch\n"
00903 "calculations. \n"
00904 ),
00905 GROUP( "ArrayOfTensor4" )));
00906
00907 wsv_data.push_back
00908 (WsvRecord
00909 ( NAME( "cloudbox_on" ),
00910 DESCRIPTION
00911 (
00912 "Flag to activate the cloud box.\n"
00913 "\n"
00914 "Scattering calculations are confined to a part of the atmosphere\n"
00915 "denoted as the cloud box. The extension of the cloud box is given by\n"
00916 "*cloudbox_limits*. This variable tells methods if a cloud box is\n"
00917 "activated or not. \n"
00918 "\n"
00919 "See further the ARTS user guide (AUG). Use the index to find where\n"
00920 "this variable is discussed. The variable is listed as a subentry to\n"
00921 "\"workspace variables\".\n"
00922 "\n"
00923 "Usage: Set by the user.\n"
00924 "\n"
00925 "Unit: Boolean.\n"
00926 ),
00927 GROUP( "Index" )));
00928
00929 wsv_data.push_back
00930 (WsvRecord
00931 ( NAME( "cloudbox_limits" ),
00932 DESCRIPTION
00933 (
00934 "The limits of the cloud box.\n"
00935 "\n"
00936 "This variable defines the extension of the cloud box. The cloud box \n"
00937 "is defined to be rectangular in the used coordinate system, with \n"
00938 "limits exactly at points of the involved grids. This means, for \n"
00939 "example, that the vertical limits of the cloud box are two pressure \n"
00940 "surfaces. For 2D, the angular extension of the cloud box is between \n"
00941 "two points of the latitude grid, and likewise for 3D but then also \n"
00942 "with a longitude extension between two grid points. The latitude and\n"
00943 "longitude limits for the cloud box cannot be placed at the end \n"
00944 "points of the corresponding grid as it must be possible to calculate\n"
00945 "the incoming intensity field.\n"
00946 "\n"
00947 "The variable *cloudbox_limits* is an array of index value with\n"
00948 "length twice *atmosphere_dim*. For each dimension there is a lower \n"
00949 "limit and an upper limit. The order of the dimensions is as usual \n"
00950 "pressure, latitude and longitude. The upper limit index must be \n"
00951 "greater then the lower limit index. For example, \n"
00952 "*cloudbox_limits* = [0 5 4 11 4 11] means that cloud box extends\n"
00953 "between pressure levels 0 and 5, and latitude and longitude points 4\n"
00954 "and 11.\n"
00955 "\n"
00956 "If *cloudbox_on* = 0, the content of this variable is neglected, but\n"
00957 "it must be initiated to some dummy values.\n"
00958 "\n"
00959 "See further the ARTS user guide (AUG). Use the index to find where\n"
00960 "this variable is discussed. The variable is listed as a subentry to\n"
00961 "\"workspace variables\".\n"
00962 "\n"
00963 "Usage: Set by the user, either directly or using a method\n"
00964 " checking the extension of scattering particles.\n"
00965 "\n"
00966 "Unit: Index values.\n"
00967 "\n"
00968 "Size: [ 2 * atmosphere_dim ]\n"
00969 ),
00970 GROUP( "ArrayOfIndex" )));
00971
00972 wsv_data.push_back
00973 (WsvRecord
00974 ( NAME("complex_n"),
00975 DESCRIPTION
00976 (
00977 "Complex refractive index (n).\n"
00978 "\n"
00979 "This matrix describes the dielectric properties of some medium. \n"
00980 "A typical usage of this variable is to describe the properties of the\n"
00981 "surface (if it is assumed to be flat).\n"
00982 "\n"
00983 "This is a two-column matrix. The first column holds the real part\n"
00984 "of n, and the second column the imaginary part. The number of rows\n"
00985 "should normally match *f_grid*."
00986 "\n"
00987 "Unit: -\n"
00988 "\n"
00989 "Dimensions: [f_grid,2]\n"
00990 ),
00991 GROUP( "Matrix" ) ));
00992
00993 wsv_data.push_back
00994 (WsvRecord
00995 ( NAME( "diy_dt" ),
00996 DESCRIPTION
00997 (
00998 "Derivative of *iy* with respect to temperature along the ppaths.\n"
00999 "\n"
01000 "This variable holds the derivative of monochromatic pencil beam\n"
01001 "radiances with respect to the temperature at each point along each \n"
01002 "propagation path part.\n"
01003 "\n"
01004 "The number of books is here always 1. This extra dimension is\n"
01005 "included in order to have the same data type for all diy-variables.\n"
01006 "\n"
01007 "Usage: Set by *iy_calc* and *rte_agenda*.\n"
01008 "\n"
01009 "Dimensions: [ppath_array][ 1 ppath.np, f_grid, stokes_dim ]\n"
01010 ),
01011 GROUP( "ArrayOfTensor4" )));
01012
01013 wsv_data.push_back
01014 (WsvRecord
01015 ( NAME( "diy_dvmr" ),
01016 DESCRIPTION
01017 (
01018 "Derivative of *iy* with respect to VMR along the propagation path.\n"
01019 "\n"
01020 "This variable holds the derivative of monochromatic pencil beam\n"
01021 "radiances with respect to the VMR of each species at each point\n"
01022 "along each propagation path part.\n"
01023 "\n"
01024 "Usage: Set by *iy_calc* and *rte_agenda*.\n"
01025 "\n"
01026 "Dimensions: \n"
01027 " [ppath_array][ rte_do_vmr_species, ppath.np, f_grid, stokes_dim ]\n"
01028 ),
01029 GROUP( "ArrayOfTensor4" )));
01030
01031 wsv_data.push_back
01032 (WsvRecord
01033 ( NAME( "doit_conv_flag" ),
01034 DESCRIPTION
01035 (
01036 "Flag for the convergence test.\n"
01037 "\n"
01038 "This variable is initialized with 0 inside the method \n"
01039 "*i_fieldIterate*.\n"
01040 "If after an iteration the convergence test is fulfilled, 1 is \n"
01041 "assigned which means that the iteration is completed. \n"
01042 "\n"
01043 "Usage: Method output. \n"
01044 ),
01045 GROUP( "Index" )));
01046
01047 wsv_data.push_back
01048 (WsvRecord
01049 ( NAME( "doit_conv_test_agenda" ),
01050 DESCRIPTION
01051 (
01052 "See agendas.cc.\n"
01053 ),
01054 GROUP( "Agenda" )));
01055
01056 wsv_data.push_back
01057 (WsvRecord
01058 ( NAME( "doit_i_field" ),
01059 DESCRIPTION
01060 (
01061 "Radiation field.\n"
01062 "\n"
01063 "This variable is used to store the monochromatic radiation field \n"
01064 "inside the cloudbox which is found by an iterative solution (DOIT).\n"
01065 "Refer to AUG for further information.\n"
01066 "\n"
01067 "Usage: Method output. \n"
01068 "\n"
01069 "Unit: W / (m^2 Hz sr) for each Stokes component.\n"
01070 "\n"
01071 "Size: [(cloudbox_limits[1] - cloudbox_limits[0]) +1, \n"
01072 " (cloudbox_limits[3] - cloudbox_limits[2]) +1, \n"
01073 " (cloudbox_limits[5] - cloudbox_limits[4]) +1, \n"
01074 " N_za, N_aa, N_i ]\n"
01075 ),
01076 GROUP( "Tensor6" )));
01077
01078 wsv_data.push_back
01079 (WsvRecord
01080 ( NAME( "doit_i_field1D_spectrum" ),
01081 DESCRIPTION
01082 (
01083 "Radiation field for the whole frequency spectrum. \n"
01084 "\n"
01085 "This variable holds the radiation field. In contrast to \n"
01086 "*doit_i_field* this variable has an additional freqeuncy \n"
01087 "dimension. This variable is only used for 1D DOIT \n"
01088 "calculations.\n"
01089 "\n"
01090 "Usage: Output of *CloudboxFieldPut*\n"
01091 "\n"
01092 "Unit: W / (m^2 Hz sr)\n"
01093 "\n"
01094 "Size: [N_f \n"
01095 " (cloudbox_limits[1] - cloudbox_limits[0]) +1, \n"
01096 " N_za, N_aa, N_i ]\n"
01097 ),
01098 GROUP( "Tensor4" )));
01099
01100 wsv_data.push_back
01101 (WsvRecord
01102 ( NAME( "doit_i_field_old" ),
01103 DESCRIPTION
01104 (
01105 "Intensity field inside the cloudbox.\n"
01106 "\n"
01107 "This variable is used to store the intensity field inside the\n"
01108 "cloudbox while performing the iteration. One has to store the\n"
01109 "intensity field of the previos iteration to be able to do the \n"
01110 "convergence test after each iteration.\n"
01111 "Refer to AUG for more information.\n"
01112 "\n"
01113 "Usage: Method output. \n"
01114 "\n"
01115 "Unit: W / (m^2 Hz sr) for each Stokes component.\n"
01116 "\n"
01117 "Size: [(cloudbox_limits[1] - cloudbox_limits[0]) +1, \n"
01118 " (cloudbox_limits[3] - cloudbox_limits[2]) +1, \n"
01119 " (cloudbox_limits[5] - cloudbox_limits[4]) +1, \n"
01120 " N_za, N_aa, N_i ]\n"
01121 ),
01122 GROUP( "Tensor6" )));
01123
01124 wsv_data.push_back
01125 (WsvRecord
01126 ( NAME( "doit_is_initialized" ),
01127 DESCRIPTION
01128 (
01129 "Flag to determine if *DoitInit* was called.\n"
01130 "\n"
01131 "This flag is checked by *ScatteringDoit* to make sure that\n"
01132 "*DoitInit* was called before.\n"
01133 ),
01134 GROUP( "Index" )));
01135
01136 wsv_data.push_back
01137 (WsvRecord
01138 ( NAME( "doit_iteration_counter" ),
01139 DESCRIPTION
01140 (
01141 "Counter for number of iterations.\n"
01142 "\n"
01143 "This variable holds the number of iterations \n"
01144 "while solving the VRTE using the DOIT method. \n"
01145 ),
01146 GROUP( "Index" )));
01147
01148 wsv_data.push_back
01149 (WsvRecord
01150 ( NAME( "doit_mono_agenda" ),
01151 DESCRIPTION
01152 (
01153 "See agendas.cc.\n"
01154 ),
01155 GROUP( "Agenda" )));
01156
01157 wsv_data.push_back
01158 (WsvRecord
01159 ( NAME( "doit_rte_agenda" ),
01160 DESCRIPTION
01161 (
01162 "See agendas.cc.\n"
01163 ),
01164 GROUP( "Agenda" )));
01165
01166 wsv_data.push_back
01167 (WsvRecord
01168 ( NAME( "doit_scat_field_agenda" ),
01169 DESCRIPTION
01170 (
01171 "See agendas.cc.\n"
01172 ),
01173 GROUP( "Agenda" )));
01174
01175 wsv_data.push_back
01176 (WsvRecord
01177 ( NAME( "doit_scat_field" ),
01178 DESCRIPTION
01179 (
01180 "Scattered field field inside the cloudbox.\n"
01181 "\n"
01182 "This variable holds the value of the scattering integral.\n"
01183 "for all points inside the cloudbox. \n"
01184 "For more information refer to AUG.\n"
01185 "\n"
01186 "Usage: Input to *doit_i_fieldUpdateXXX*. \n"
01187 "\n"
01188 "Unit: W / (m^2 Hz sr) for each Stokes component.\n"
01189 "\n"
01190 "Size: [(cloudbox_limits[1] - cloudbox_limits[0]) +1, \n"
01191 " (cloudbox_limits[3] - cloudbox_limits[2]) +1, \n"
01192 " (cloudbox_limits[5] - cloudbox_limits[4]) +1, \n"
01193 " N_za, N_aa, N_i ]\n"
01194 ),
01195 GROUP( "Tensor6" )));
01196
01197 wsv_data.push_back
01198 (WsvRecord
01199 ( NAME( "doit_za_grid_opt" ),
01200 DESCRIPTION
01201 (
01202 "Optimized zenith angle grid.\n"
01203 "\n"
01204 "Output of the method *DoitGridOptimization*. For limb simulations \n"
01205 "with scattering it is very \n"
01206 "important to use optimized grids for both, accuracy and speed of \n"
01207 "the calculations.\n"
01208 "\n"
01209 "Usage: Output of *DoitGridOptimization* \n"
01210 "\n"
01211 "Unit: degrees \n"
01212 ),
01213 GROUP( "Vector" )));
01214
01215 wsv_data.push_back
01216 (WsvRecord
01217 ( NAME( "doit_za_grid_size" ),
01218 DESCRIPTION
01219 (
01220 "This vector contains the discretisation of the zenith angle grid \n"
01221 "for the scattering integral calculation. \n"
01222 "\n"
01223 "The zenith angle grid is defined from 0 to 180.\n"
01224 "*doit_za_grid_size* is the number of points of the zenith angle grid.\n"
01225 "\n"
01226 "Usage: Output of *DoitAngularGridsSet*.\n"
01227 ),
01228 GROUP( "Index" )));
01229
01230 wsv_data.push_back
01231 (WsvRecord
01232 ( NAME( "doit_za_interp" ),
01233 DESCRIPTION
01234 (
01235 "Flag for interplation method in zenith angle dimension.\n"
01236 "\n"
01237 "0 - linear interpolation \n"
01238 "1 - cubic interpolation \n"
01239 "Default is linear interpolation. \n"
01240 "\n"
01241 "Usage: Set by user in *doit_za_interpSet*. \n"
01242 ),
01243 GROUP( "Index" )));
01244
01245 wsv_data.push_back
01246 (WsvRecord
01247 ( NAME( "emission" ),
01248 DESCRIPTION
01249 (
01250 "Thermal emission source term.\n"
01251 "\n"
01252 "This variable holds the emission at one position along the propagation\n"
01253 "path. This source term is used for calculations inside *rte_agenda*.\n"
01254 "Inside scattering methods, such as DOIT, the calculation of the source\n"
01255 "term can be hard coded.\n"
01256 "\n"
01257 "Usage: Set by *emission_agenda.\n"
01258 "\n"
01259 "Unit: W / (m^2 Hz sr) or optical thickness \n"
01260 "\n"
01261 "Dimensions: [ f_grid ]\n"
01262 ),
01263 GROUP( "Vector" )));
01264
01265 wsv_data.push_back
01266 (WsvRecord
01267 ( NAME( "emission_agenda" ),
01268 DESCRIPTION
01269 (
01270 "See agendas.cc.\n"
01271 ),
01272 GROUP( "Agenda" )));
01273
01274 wsv_data.push_back
01275 (WsvRecord
01276 ( NAME( "ext_mat" ),
01277 DESCRIPTION
01278 (
01279 "Total extinction matrix.\n"
01280 "\n"
01281 "This variable contains the extinction coefficient matrix which \n"
01282 "is used in the RT calculation in the cloudbox . It is \n"
01283 "the physical extinction matrix which includes particles extinction \n"
01284 "for all chosen particle types and gaseous extinction for all chosen \n"
01285 "gaseous species.\n"
01286 "The matrix is calculated by the agendas *opt_prop_gas_agenda* \n"
01287 "and, if scattering calculations are performed, \n"
01288 "*opt_prop_part_agenda* \n"
01289 "The dimensision of the variable adapts to *stokes_dim*.\n"
01290 "\n"
01291 "See further the ARTS user guide (AUG). Use the index to find where\n"
01292 "this variable is discussed. The variable is listed as a subentry to\n"
01293 "\"workspace variables\".\n"
01294 "\n"
01295 "Usage: Output of the agendas *opt_prop_gas_agenda* \n"
01296 " and *opt_prop_part_agenda* \n"
01297 "\n"
01298 "Unit: [Hz, m^2, m^2] "
01299 "\n"
01300 "Dimensions: [f_grid, stokes_dim, stokes_dim]\n"
01301 ),
01302 GROUP( "Tensor3" )));
01303
01304 wsv_data.push_back
01305 (WsvRecord
01306 ( NAME( "ext_mat_spt" ),
01307 DESCRIPTION
01308 (
01309 "Extinction matrix for a single particle type.\n"
01310 "\n"
01311 "This variable contains the elements for extinction matrix of a \n"
01312 "single particle for a given propagation direction. It is calculated\n"
01313 "input as well as the output of the agenda *spt_calc_agenda*. \n"
01314 "\n"
01315 "Usage: Output of *spt_calc_agenda* \n"
01316 "\n"
01317 "Unit: m^2 \n"
01318 "\n"
01319 "Dimensions: [part_types, stokes_dim, stokes_dim]\n"
01320 ),
01321 GROUP( "Tensor3" )));
01322
01323 wsv_data.push_back
01324 (WsvRecord
01325 ( NAME( "file_index" ),
01326 DESCRIPTION
01327 (
01328 "Index number for files.\n"
01329 "\n"
01330 "See *WriteXMLIndexed* for further information.\n"
01331 "\n"
01332 "Usage: Input to *WriteXMLIndexed* and *ReadXMLIndexed*. \n"
01333 ),
01334 GROUP( "Index" )));
01335
01336 wsv_data.push_back
01337 (WsvRecord
01338 ( NAME( "forloop_agenda" ),
01339 DESCRIPTION
01340 (
01341 "See agendas.cc.\n"
01342 ),
01343 GROUP( "Agenda" )));
01344
01345 wsv_data.push_back
01346 (WsvRecord
01347 ( NAME( "forloop_index" ),
01348 DESCRIPTION
01349 (
01350 "The index for for loops.\n"
01351 "\n"
01352 "This is the index that is used by method *ForLoop* to loop over\n"
01353 "*forloop_agenda*. \n"
01354 ),
01355 GROUP( "Index" )));
01356
01357 wsv_data.push_back
01358 (WsvRecord
01359 ( NAME( "f_backend" ),
01360 DESCRIPTION
01361 (
01362 "The frequency position of each backend (spectrometer) channel.\n"
01363 "\n"
01364 "Usage: Set by the user.\n "
01365 "\n"
01366 "Unit: Hz\n"
01367 ),
01368 GROUP( "Vector" )));
01369
01370 wsv_data.push_back
01371 (WsvRecord
01372 ( NAME( "f_backend_multi" ),
01373 DESCRIPTION
01374 (
01375 "As *f_backend* but describes an instrument with muliple\n"
01376 "mixer/reciever chains.\n"
01377 "\n"
01378 "This variable is needed when e.g. the reciever has several mixers\n"
01379 "or the the reciever measures several polarisation and the channels\n"
01380 "differ in position or response function. \n"
01381 "\n"
01382 "The array has one element for each \"reciever chain\". The array\n"
01383 "length must match *backend_channel_response_multi*, and possibly\n"
01384 "also *lo_multi*.\n"
01385 "\n"
01386 "Usage: Set by the user.\n "
01387 "\n"
01388 "Unit: Hz\n"
01389 ),
01390 GROUP( "ArrayOfVector" )));
01391
01392 wsv_data.push_back
01393 (WsvRecord
01394 ( NAME( "f_grid" ),
01395 DESCRIPTION
01396 (
01397 "The frequency grid for monochromatic pencil beam calculations.\n"
01398 "\n"
01399 "Usage: Set by the user.\n "
01400 "\n"
01401 "Unit: Hz\n"
01402 ),
01403 GROUP( "Vector" )));
01404
01405 wsv_data.push_back
01406 (WsvRecord
01407 (NAME( "f_index" ),
01408 DESCRIPTION
01409 (
01410 "Frequency index. \n"
01411 "\n"
01412 "Not all methods handle all monochromatic frequencies (of *f_grid*) in\n"
01413 "parellel and this variable is used for communication between methods,\n"
01414 "holding the index of the frequency treated presently.\n"
01415 "\n"
01416 "Usage: Method output.\n"
01417 ),
01418 GROUP( "Index" )));
01419
01420
01421
01422
01423
01424
01425
01426
01427
01428
01429
01430
01431
01432
01433
01434
01435
01436
01437
01438
01439
01440
01441
01442
01443
01444 wsv_data.push_back
01445 (WsvRecord
01446 ( NAME( "iy" ),
01447 DESCRIPTION
01448 (
01449 "Monochromatic pencil beam radiance spectrum.\n"
01450 "\n"
01451 "This variable holds a single spectrum, with values corresponding\n"
01452 "to infinite frequency and spatial resolution (compare to *y*).\n"
01453 "\n"
01454 "The variable is used to represent spectra at all positions of the\n"
01455 "propagation path and can e.g. temporarily hold radiation entering\n"
01456 "the atmpophere from space. The unit depends on if emission is \n"
01457 "considered or not.\n"
01458 "\n"
01459 "Usage: Used by radiative transfer methods.\n"
01460 "\n"
01461 "Unit: W / (m^2 Hz sr) or transmission.\n"
01462 "\n"
01463 "Dimensions: [ f_grid, stokes_dim ]\n"
01464 ),
01465 GROUP( "Matrix" )));
01466
01467 wsv_data.push_back
01468 (WsvRecord
01469 ( NAME( "iy_cloudbox_agenda" ),
01470 DESCRIPTION
01471 (
01472 "See agendas.cc.\n"
01473 ),
01474 GROUP( "Agenda" )));
01475
01476 wsv_data.push_back
01477 (WsvRecord
01478 ( NAME( "iy_space_agenda" ),
01479 DESCRIPTION
01480 (
01481 "See agendas.cc.\n"
01482 ),
01483 GROUP( "Agenda" )));
01484
01485 wsv_data.push_back
01486 (WsvRecord
01487 ( NAME( "i_space" ),
01488 DESCRIPTION
01489 (
01490 "Monochromatic intensities at the top of the atmosphere.\n"
01491 "\n"
01492 "The matrix holds the intensity entering the atmosphere from above\n"
01493 "along a propagation path. This should normally correspond to cosmic\n"
01494 "background radiation, but could also be radiation from the sun or \n"
01495 "a transmitting satellite.\n"
01496 "\n"
01497 "Usage: Output from *iy_space_agenda*.\n"
01498 "\n"
01499 "Unit: W / (m^2 Hz sr) \n"
01500 "\n"
01501 "Dimensions: [ f_grid, stokes_dim ]\n"
01502 ),
01503 GROUP( "Matrix" )));
01504
01505 wsv_data.push_back
01506 (WsvRecord
01507 ( NAME( "jacobian" ),
01508 DESCRIPTION
01509 (
01510 "The Jacobian matrix.\n"
01511 "\n"
01512 "The matrix holding the Jacobians of the retrieval quantities. Each\n"
01513 "quantity, and its subdivision into atmospheric grids, are stored as\n"
01514 "columns in the matrix. The matrix has to be initialised before the\n"
01515 "quantities can be defined. Initialisation WSM is *jacobianInit*.\n"
01516 "Retrieval quantities are then added with *jacobianAdd...* methods.\n"
01517 "See the online help. Pure numerical calculation is described by\n"
01518 "*jacobian_calc_agenda* and are performed by *jacobianCalc*.\n"
01519 "\n"
01520 "Units: See the different retrieval quantities.\n"
01521 "\n"
01522 "Dimension: [ y, number of retrieval quantities and grids ]\n"
01523 ),
01524 GROUP( "Matrix" )));
01525
01526 wsv_data.push_back
01527 (WsvRecord
01528 ( NAME( "jacobian_agenda" ),
01529 DESCRIPTION
01530 (
01531 "See agendas.cc.\n"
01532 ),
01533 GROUP( "Agenda" )));
01534
01535 wsv_data.push_back
01536 (WsvRecord
01537 ( NAME( "jacobian_indices" ),
01538 DESCRIPTION
01539 (
01540 "First and last column index in *jacobian* for each retrieval quantity."
01541 "\n"
01542 "This variable tells which part of *jacobian* that corresponds to \n"
01543 "each jacobian quantity.\n"
01544 "\n"
01545 "Usage: Set by *jacobianClose*.\n"
01546 ),
01547 GROUP( "ArrayOfArrayOfIndex" )));
01548
01549
01550
01551
01552
01553
01554
01555
01556
01557
01558
01559
01560 wsv_data.push_back
01561 (WsvRecord
01562 ( NAME( "jacobian_unit" ),
01563 DESCRIPTION
01564 (
01565 "Unit for jacobians calculated in an analytical manner.\n"
01566 "\n"
01567 "As *y_unit* but applies to analytical jacobians. The unit for\n"
01568 "jacobians calculated by perturbations is determined by *y_unit*.\n"
01569 "\n"
01570 "Units defined as for *y_unit* with two exceptions.\n"
01571 " 1. The choice \"PlanckBT\" is not allowed here. \n"
01572 " 2. One additional choice exists:\n"
01573 " \"-\": Use unit defined by *y_unit*.\n"
01574 "\n"
01575 "Usage: Set by the user.\n"
01576 ),
01577 GROUP( "String" )));
01578
01579 wsv_data.push_back
01580 (WsvRecord
01581 ( NAME( "jacobian_quantities" ),
01582 DESCRIPTION
01583 (
01584 "The retrieval quantities in the Jacobian matrix.\n"
01585 "\n"
01586 "An array of retrieval quantities for which the jacobians are\n"
01587 "calculated.\n"
01588 "\n"
01589 "Usage: Quantities are added by the jacobianAdd WSMs.\n"
01590 ),
01591 GROUP( "ArrayOfRetrievalQuantity" )));
01592
01593 wsv_data.push_back
01594 (WsvRecord
01595 ( NAME( "jacobian_y_agenda" ),
01596 DESCRIPTION
01597 (
01598 "See agendas.cc.\n"
01599 ),
01600 GROUP( "Agenda" )));
01601
01602 wsv_data.push_back
01603 (WsvRecord
01604 ( NAME( "lat_grid" ),
01605 DESCRIPTION
01606 (
01607 "The latitude grid.\n"
01608 "\n"
01609 "The latitudes for which the atmospheric fields are defined. The\n"
01610 "atmosphere is undefined outside the range covered by the grid.\n"
01611 "The grid must be sorted in increasing order, with no repetitions.\n"
01612 "\n"
01613 "Geocentric latitudes shall be used.\n"
01614 "\n"
01615 "For 1D calculations this vector shall be set to be empty. For 2D cases\n"
01616 "the latitudes shall be interpreted as the angular distance inside the\n"
01617 "orbit plane from an arbitrary zero point (values outside +-90 deg are\n"
01618 "allowed). For 3D, the valid latitude range is [-90,90].\n"
01619 "\n"
01620 "See further the ARTS user guide (AUG). Use the index to find where\n"
01621 "this variable is discussed. The variable is listed as a subentry to\n"
01622 "\"workspace variables\".\n"
01623 "\n"
01624 "Usage: Set by the user.\n"
01625 "\n"
01626 "Unit: degrees\n"
01627 ),
01628 GROUP( "Vector" )));
01629
01630 wsv_data.push_back
01631 (WsvRecord
01632 ( NAME( "lat_1d" ),
01633 DESCRIPTION
01634 (
01635 "The latitude for a 1D observation.\n"
01636 "\n"
01637 "This variable is used to assign a latitude valid for a 1D case. A\n"
01638 "special variable is needed for 1D as there exists no latitude grid \n"
01639 "for such cases. The variable can be used, for example, to set the \n"
01640 "geoid radius or select atmospheric profiles from a 2D/3D \n"
01641 "climatology. \n"
01642 "\n"
01643 "For limb sounding, the choosen latitude should normally be selected\n"
01644 "to be valid for the tangent points, rather than for the sensor.\n"
01645 "\n"
01646 "Values shall be inside the range [-90,90].\n"
01647 "\n"
01648 "Usage: Set by the user.\n"
01649 "\n"
01650 "Unit: degrees\n"
01651 ),
01652 GROUP( "Numeric" )));
01653
01654 wsv_data.push_back
01655 (WsvRecord
01656 ( NAME( "lo" ),
01657 DESCRIPTION
01658 (
01659 "The local oscillator frequency.\n"
01660 "\n"
01661 "A local oscillator frequency is used in a heterodyne system when\n"
01662 "the mixer folds the spectra from from radio frequencies (RF) to\n"
01663 "intermediate frequencies (IF).\n"
01664 "\n"
01665 "Unit: Hz\n"
01666 "\n"
01667 "Usage: Set by the user.\n"
01668 ),
01669 GROUP( "Numeric" )));
01670
01671 wsv_data.push_back
01672 (WsvRecord
01673 ( NAME( "lo_multi" ),
01674 DESCRIPTION
01675 (
01676 "Local oscillator frequencies.\n"
01677 "\n"
01678 "As *lo* but describes an instrument with multiple mixers. A vector\n"
01679 "element for each LO. The size of this variable and\n"
01680 "*sideband_response_multi* shall match, and probably also\n"
01681 "*sideband_mode_multi*.\n"
01682 "\n"
01683 "Unit: Hz\n"
01684 "\n"
01685 "Usage: Set by the user.\n"
01686 ),
01687 GROUP( "Vector" )));
01688
01689 wsv_data.push_back
01690 (WsvRecord
01691 ( NAME( "lon_grid" ),
01692 DESCRIPTION
01693 (
01694 "The longitude grid.\n"
01695 "\n"
01696 "The longitudes for which the atmospheric fields are defined. The\n"
01697 "atmosphere is undefined outside the range covered by the grid.\n"
01698 "The grid must be sorted in increasing order, with no repetitions.\n"
01699 "\n"
01700 "For 1D and 2D calculations this vector shall be set to be empty\n"
01701 "Allowed values for longidudes is the range [-360,360].\n"
01702 "\n"
01703 "See further the ARTS user guide (AUG). Use the index to find where\n"
01704 "this variable is discussed. The variable is listed as a subentry to\n"
01705 "\"workspace variables\".\n"
01706 "\n"
01707 "Usage: Set by the user.\n"
01708 "\n"
01709 "Unit: degrees\n"
01710 ),
01711 GROUP( "Vector" )));
01712
01713
01714
01715
01716
01717
01718
01719
01720
01721
01722
01723
01724
01725
01726
01727
01728
01729
01730 wsv_data.push_back
01731 (WsvRecord
01732 ( NAME( "main_agenda" ),
01733 DESCRIPTION
01734 (
01735 "See agendas.cc.\n"
01736 ),
01737 GROUP( "Agenda" )));
01738
01739 wsv_data.push_back
01740 (WsvRecord
01741 ( NAME( "mblock_aa_grid" ),
01742 DESCRIPTION
01743 (
01744 "The azimuthal angle grid for each measurement block.\n"
01745 "\n"
01746 "This variable should normally contain the azimuth grid of the\n"
01747 "antenna pattern. The grid is given as an angular off-set with\n"
01748 "respect to the angles in *sensor_los*.\n"
01749 "\n"
01750 "See further the ARTS user guide (AUG). Use the index to find where\n"
01751 "this variable is discussed. The variable is listed as a subentry to\n"
01752 "\"workspace variables\".\n"
01753 "\n"
01754 "Usage: Set by the user.\n"
01755 "\n"
01756 "Unit: degrees\n"
01757 ),
01758 GROUP( "Vector" )));
01759
01760 wsv_data.push_back
01761 (WsvRecord
01762 ( NAME( "mblock_za_grid" ),
01763 DESCRIPTION
01764 (
01765 "The zenith angle grid for each measurement block.\n"
01766 "\n"
01767 "This variable should normally contain the zenith grid of the\n"
01768 "antenna pattern. The grid is given as an angular off-set with\n"
01769 "respect to the angles in *sensor_los*.\n"
01770 "\n"
01771 "See further the ARTS user guide (AUG). Use the index to find where\n"
01772 "this variable is discussed. The variable is listed as a subentry to\n"
01773 "\"workspace variables\".\n"
01774 "\n"
01775 "Usage: Set by the user.\n"
01776 "\n"
01777 "Unit: degrees\n"
01778 ),
01779 GROUP( "Vector" )));
01780
01781 wsv_data.push_back
01782 (WsvRecord
01783 ( NAME( "mc_antenna" ),
01784 DESCRIPTION
01785 (
01786 "Antenna pattern description for dedicated MC calculaions.\n"
01787 "\n"
01788 "MCAntenna object used by MCGeneral to sample the field of view."
01789 "Possible antenna types are Pencil Beam and Gaussian (2D).\n"
01790 "\n"
01791 "Usage: Input to MCGeneral. Set by mc_antennaSetGaussian and similar\n"
01792 " methods.\n"
01793 ),
01794 GROUP( "MCAntenna" )));
01795
01796 wsv_data.push_back
01797 (WsvRecord
01798 ( NAME( "mc_cloud_opt_path" ),
01799 DESCRIPTION
01800 (
01801 "The cloud optical path integrated over the field of view.\n"
01802 "\n"
01803 "Usage: Output from mc_IWP_cloud_opt_pathCalc \n"
01804 ),
01805 GROUP( "Numeric" )));
01806
01807 wsv_data.push_back
01808 (WsvRecord
01809 ( NAME( "mc_cloud_opt_path_error" ),
01810 DESCRIPTION
01811 (
01812 "Standrad error in the cloud optical path integrated over the field\n"
01813 "of view.\n"
01814 "\n"
01815 "Usage: Output from mc_IWP_cloud_opt_pathCalc \n"
01816 ),
01817 GROUP( "Numeric" )));
01818
01819 wsv_data.push_back
01820 (WsvRecord
01821 ( NAME( "mc_error" ),
01822 DESCRIPTION
01823 (
01824 "Error in simulated *y* when using a Monte Carlo approach.\n"
01825 "\n"
01826 "Usage: Output from Monte Carlo functions. \n"
01827 "\n"
01828 "Units: Depends on *y_unit*.\n"
01829 "\n"
01830 "Size: [ stokes_dim ]\n"
01831 ),
01832 GROUP( "Vector" )));
01833
01834
01835
01836
01837
01838
01839
01840
01841
01842
01843
01844
01845
01846
01847
01848
01849
01850
01851 wsv_data.push_back
01852 (WsvRecord
01853 ( NAME( "mc_iteration_count" ),
01854 DESCRIPTION
01855 (
01856 "Counts the number of iterations (or photons) used in the MC\n "
01857 "scattering algorithm.\n"
01858 "\n"
01859 "Usage: Set by MCGeneral and other MC methods.\n"
01860 ),
01861 GROUP( "Index" )));
01862
01863 wsv_data.push_back
01864 (WsvRecord
01865 ( NAME( "mc_IWP" ),
01866 DESCRIPTION
01867 (
01868 "The ice water path integrated over the field of view\n"
01869 "\n"
01870 "Usage: Output from mc_IWP_cloud_opt_pathCalc \n"
01871 ),
01872 GROUP( "Numeric" )));
01873
01874 wsv_data.push_back
01875 (WsvRecord
01876 ( NAME( "mc_IWP_error" ),
01877 DESCRIPTION
01878 (
01879 "The standard error of ice water path integrated over the field of view\n"
01880 "\n"
01881 "Usage: Output from mc_IWP_cloud_opt_pathCalc \n"
01882 ),
01883 GROUP( "Numeric" )));
01884
01885 wsv_data.push_back
01886 (WsvRecord
01887 ( NAME( "mc_points" ),
01888 DESCRIPTION
01889 (
01890 "Counts the number of MC endpoints in each grid cell.\n"
01891 "\n"
01892 "Usage: Set by MCGeneral and other MC methods.\n"
01893 ),
01894 GROUP( "Tensor3" )));
01895
01896 wsv_data.push_back
01897 (WsvRecord
01898 ( NAME( "mc_seed" ),
01899 DESCRIPTION
01900 (
01901 "The integer seed for the random number generator used by\n"
01902 "Monte Carlos methods.\n"
01903 "\n"
01904 "Usage: Set by MCSetSeed.\n"
01905 ),
01906 GROUP( "Index" )));
01907
01908 wsv_data.push_back
01909 (WsvRecord
01910 ( NAME( "mc_std_err" ),
01911 DESCRIPTION
01912 (
01913 "Target precision (1 std. dev.) for Monte Carlo calculations.\n"
01914 "\n"
01915 "Usage: Set by the user.\n"
01916 ),
01917 GROUP( "Numeric" )));
01918
01919 wsv_data.push_back
01920 (WsvRecord
01921 ( NAME( "mc_max_time" ),
01922 DESCRIPTION
01923 (
01924 "The maximum time allowed for Monte Carlo calculations.\n"
01925 "\n"
01926 "Usage: Set by the user.\n"
01927 "\n"
01928 "Unit: s\n"
01929 ),
01930 GROUP( "Index" )));
01931
01932 wsv_data.push_back
01933 (WsvRecord
01934 ( NAME( "mc_max_iter" ),
01935 DESCRIPTION
01936 (
01937 "The maximum number of iterations allowed for Monte Carlo\n"
01938 "calculations.\n"
01939 "\n"
01940 "Usage: Set by the user.\n"
01941 ),
01942 GROUP( "Index" )));
01943
01944 wsv_data.push_back
01945 (WsvRecord
01946 ( NAME( "mc_z_field_is_1D" ),
01947 DESCRIPTION
01948 (
01949 "Flag for MCGeneral and associated methods.\n"
01950 "\n"
01951 "If fields outside the cloud box are 1D, this flag can be set to 1\n"
01952 "and the calculations will be more rapid.\n"
01953 "\n"
01954 "Usage: Set by the user.\n"
01955 ),
01956 GROUP( "Index" )));
01957
01958
01959
01960
01961
01962
01963
01964
01965
01966
01967
01968
01969
01970
01971
01972 wsv_data.push_back
01973 (WsvRecord
01974 ( NAME( "meridian_angle_1d" ),
01975 DESCRIPTION
01976 (
01977 "The meridian angle for a 1D observation.\n"
01978 "\n"
01979 "This variable is only used when calculating a curvature radius of \n"
01980 "the geoid for 1D cases. The given value shall be the angle between \n"
01981 "the observation and meridian plane where 0 degrees means an \n"
01982 "observation in the N-S direction.\n"
01983 "\n"
01984 "Values shall be in the range [-180,180].\n"
01985 "\n"
01986 "Usage: Set by the user.\n"
01987 "\n"
01988 "Unit: degrees\n"
01989 ),
01990 GROUP( "Numeric" )));
01991
01992 wsv_data.push_back
01993 (WsvRecord
01994 ( NAME( "met_amsu_data" ),
01995 DESCRIPTION
01996 (
01997 "The AMSU data set.\n"
01998 "\n"
01999 "This is intended as input for the method ybatchMetProfiles. It holds the\n"
02000 "latitude, longitude, satellite zenith angle and amsu-b corrected and \n"
02001 "uncorrected brightness temperatures. It also has information about \n"
02002 "the particular pixel corresponds to a land or sea point. This will be \n"
02003 "read in the method ybatchMetProfiles and the profiles corresponding to \n"
02004 "each latitude and longitude will be read in.\n"
02005 "\n"
02006 "See documentation of WSM *ybatchMetProfiles* for more information.\n"
02007 ),
02008 GROUP( "Matrix" )));
02009
02010 wsv_data.push_back
02011 (WsvRecord
02012 ( NAME( "nelem" ),
02013 DESCRIPTION
02014 (
02015 "This variable is used by the VectorSet workspace method.\n"
02016 ),
02017 GROUP( "Index" )));
02018
02019 wsv_data.push_back
02020 (WsvRecord
02021 ( NAME( "ncols" ),
02022 DESCRIPTION
02023 (
02024 "This variable is used by the MatrixSet, Tensor3Set, etc. \n"
02025 "workspace methods.\n"
02026 ),
02027 GROUP( "Index" )));
02028
02029 wsv_data.push_back
02030 (WsvRecord
02031 ( NAME( "nrows" ),
02032 DESCRIPTION
02033 (
02034 "See *ncols*.\n"
02035 ),
02036 GROUP( "Index" )));
02037
02038 wsv_data.push_back
02039 (WsvRecord
02040 ( NAME( "npages" ),
02041 DESCRIPTION
02042 (
02043 "See *ncols*.\n"
02044 ),
02045 GROUP( "Index" )));
02046
02047 wsv_data.push_back
02048 (WsvRecord
02049 ( NAME( "nbooks" ),
02050 DESCRIPTION
02051 (
02052 "See *ncols*.\n"
02053 ),
02054 GROUP( "Index" )));
02055
02056 wsv_data.push_back
02057 (WsvRecord
02058 ( NAME( "nshelves" ),
02059 DESCRIPTION
02060 (
02061 "See *ncols*.\n"
02062 ),
02063 GROUP( "Index" )));
02064
02065 wsv_data.push_back
02066 (WsvRecord
02067 ( NAME( "nvitrines" ),
02068 DESCRIPTION
02069 (
02070 "See *ncols*.\n"
02071 ),
02072 GROUP( "Index" )));
02073
02074 wsv_data.push_back
02075 (WsvRecord
02076 ( NAME( "nlibraries" ),
02077 DESCRIPTION
02078 (
02079 "See *ncols*.\n"
02080 ),
02081 GROUP( "Index" )));
02082
02083 wsv_data.push_back
02084 (WsvRecord
02085 ( NAME( "met_profile_calc_agenda" ),
02086 DESCRIPTION
02087 (
02088 "See agendas.cc.\n"
02089 ),
02090 GROUP( "Agenda" )));
02091
02092 wsv_data.push_back
02093 (WsvRecord
02094 ( NAME( "opt_prop_gas_agenda" ),
02095 DESCRIPTION
02096 (
02097 "See agendas.cc.\n"
02098 ),
02099 GROUP( "Agenda" )));
02100
02101 wsv_data.push_back
02102 (WsvRecord
02103 ( NAME( "opt_prop_part_agenda" ),
02104 DESCRIPTION
02105 (
02106 "See agendas.cc.\n"
02107 ),
02108 GROUP( "Agenda" )));
02109
02110 wsv_data.push_back
02111 (WsvRecord
02112 (NAME( "output_file_format" ),
02113 DESCRIPTION
02114 (
02115 "Output file format. \n"
02116 "\n"
02117 "This variable sets the format for output files. It could be set to\n"
02118 "\"ascii\" for plain xml files, \"zascii\" for zipped xml files, or\n"
02119 "\"binary\".\n"
02120 "\n"
02121 "To change the value of this variable use the workspace methods\n"
02122 "*output_file_formatSetAscii*, *output_file_formatSetZippedAscii*, and\n"
02123 "*output_file_formatSetBinary*\n"
02124 ),
02125 GROUP( "String" )));
02126
02127 wsv_data.push_back
02128 (WsvRecord
02129 (NAME( "particle_masses" ),
02130 DESCRIPTION
02131 (
02132 "The mass of each particle type stored in a vector \n"
02133 "\n"
02134 "Usage: Set by the user.\n"
02135 ),
02136 GROUP( "Vector" )));
02137
02138 wsv_data.push_back
02139 (WsvRecord
02140 ( NAME( "pha_mat" ),
02141 DESCRIPTION
02142 (
02143 "Ensemble averaged phase matrix.\n"
02144 "\n"
02145 "This workspace variable represents the actual physical phase\n"
02146 "matrix (averaged over all particle types) for given propagation\n"
02147 "directions. It is calculated in the method *pha_matCalc*\n"
02148 "\n"
02149 "ARTS user guide (AUG) gives the formula used for computing this\n"
02150 "variable. Use the index to find where this variable is discussed.\n"
02151 "The variable is listed as a subentry to \"workspace variables\".\n"
02152 "\n"
02153 "Usage: Output of the method *pha_matCalc*\n"
02154 "\n"
02155 "Unit: m^2\n"
02156 "\n"
02157 "Dimensions: [ scat_za_grid, scat_aa_grid, stokes_dim, stokes_dim ]\n"
02158 ),
02159 GROUP( "Tensor4" )));
02160
02161 wsv_data.push_back
02162 (WsvRecord
02163 ( NAME( "pha_mat_spt" ),
02164 DESCRIPTION
02165 (
02166 "Phase matrix for a single particle type.\n"
02167 "\n"
02168 "This variable contains the elements of phase matrix for a single \n"
02169 "particle for given propagation direction. \n"
02170 "It is the calculated in the agenda *pha_mat_spt_agenda* .\n"
02171 "The elements of the phase matrix are calculated from \n"
02172 "single_scattering_data*."
02173 "ARTS user guide (AUG) gives the formulas used for computing all \n"
02174 "elements of the phase matrix for a given particle type.\n"
02175 "\n"
02176 "Usage: Input and Output of the method pha_mat_sptCalc\n"
02177 "\n"
02178 "Unit: m^2\n"
02179 "\n"
02180 "Dimensions: [part_types, scat_za_grid, scat_aa_grid, stokes_dim, stokes_dim]\n"
02181 ),
02182 GROUP( "Tensor5" )));
02183
02184 wsv_data.push_back
02185 (WsvRecord
02186 ( NAME( "pha_mat_spt_agenda" ),
02187 DESCRIPTION
02188 (
02189 "See agendas.cc.\n"
02190 ),
02191 GROUP( "Agenda" )));
02192
02193 wsv_data.push_back
02194 (WsvRecord
02195 ( NAME( "pha_mat_sptDOITOpt" ),
02196 DESCRIPTION
02197 (
02198 "Interpolated phase matrix.\n"
02199 "\n"
02200 "This variable contains the data of the phase matrix in the \n"
02201 "scattering frame interpolated on the actual frequency (the variable\n"
02202 "is used inside *scat_mono_agenda*) and also interpolated on all \n"
02203 "possible scattering angles following from all combinations of \n"
02204 "*scat_za_grid* and *scat_aa_grid*. \n"
02205 "\n"
02206 "Usage: Input of the method *pha_mat_sptFromDataDOITOpt\n"
02207 "\n"
02208 "Unit: m^2\n"
02209 "\n"
02210 "Dimensions: \n"
02211 "[particle types]\n"
02212 "[T, scat_za_grid,scat_aa_grid, scat_za_grid, scat_aa_grid,\n"
02213 "stokes_dim, stokes_dim]\n"
02214 ),
02215 GROUP( "ArrayOfTensor7" )));
02216
02217 wsv_data.push_back
02218 (WsvRecord
02219 ( NAME( "pnd_field" ),
02220 DESCRIPTION
02221 (
02222 "Particle number density field.\n"
02223 "\n"
02224 "This veriable corresponds to the particle number density fields \n"
02225 "for all particle types being read in the WSMs *ParticleTypeAdd* \n"
02226 "or *ParticleTypeAddAll*. \n"
02227 "\n"
02228 "Usage: Calculated internally.\n"
02229 "\n"
02230 "Unit: m^-3\n"
02231 "\n"
02232 "Size: [N_part_types, \n"
02233 " (cloudbox_limits[1] - cloudbox_limits[0]) +1, \n"
02234 " (cloudbox_limits[3] - cloudbox_limits[2]) +1, \n"
02235 " (cloudbox_limits[5] - cloudbox_limits[4]) +1 ] \n"
02236 ),
02237 GROUP( "Tensor4" )));
02238
02239
02240
02241
02242
02243
02244
02245
02246
02247
02248
02249
02250
02251
02252
02253
02254
02255
02256
02257
02258
02259
02260
02261
02262
02263
02264
02265
02266 wsv_data.push_back
02267 (WsvRecord
02268 ( NAME( "pnd_field_raw" ),
02269 DESCRIPTION
02270 (
02271 "The particle number density field data.\n"
02272 "\n"
02273 "This variable contains the particle number density data for all \n"
02274 "chosen particle types. It includes the grids corresponding to the \n"
02275 "grids in the database. \n"
02276 "*pnd_field_raw* is an Array of GField3. It includes a\n"
02277 "GField3 for each particle type which contains the data and \n"
02278 "also the grids.\n"
02279 "\n"
02280 "Usage: Used in the methods *ParticleTypeAdd* and \n"
02281 " *ParticleTypeAddAll*\n"
02282 "\n"
02283 "Unit: m^-3\n"
02284 "\n"
02285 "Size: Array[N_pt]\n"
02286 " GField3 \n "
02287 " [N_p] \n"
02288 " [N_lat] \n"
02289 " [N_lon] \n"
02290 " [N_p, N_lat, N_lon] \n"
02291 ),
02292 GROUP( "ArrayOfGField3" )));
02293
02294 wsv_data.push_back
02295 (WsvRecord
02296 ( NAME( "ppath" ),
02297 DESCRIPTION
02298 (
02299 "The propagation path for one line-of-sight.\n"
02300 "\n"
02301 "This variable described the total (pencil beam) propagation path for\n"
02302 "a given combination of starting point and line-of-sight. The path is\n"
02303 "described by a data structure of type Ppath. This structure contains\n"
02304 "also additional fields to faciliate the calculation of spectra and\n"
02305 "interpolation of the atmospheric fields.\n"
02306 "\n"
02307 "The data struture is too extensive to be described here, but it is\n"
02308 "described carefully in the ARTS user guide (AUG). Use the index to\n"
02309 "find where the data structure, Ppath, for propagation paths is \n"
02310 "discussed. It is listed as a subentry to \"data structures\".\n"
02311 "\n"
02312 "Usage: Output from the method *ppathCalc*.\n"
02313 ),
02314 GROUP( "Ppath" )));
02315
02316 wsv_data.push_back
02317 (WsvRecord
02318 ( NAME( "ppath_array" ),
02319 DESCRIPTION
02320 (
02321 "The complete set of propagation paths.\n"
02322 "\n"
02323 "In the case of scattering (either inside the atmosphere or by the \n"
02324 "surface) the propagation path is divided into parts, with one part\n"
02325 "between each scattering event. This variable describes this complete\n"
02326 "set of propagation paths, in contrast to *ppath* that describes only\n"
02327 "one part.\n"
02328 "\n"
02329 "This variable is not always filled. It used as part of analytical \n"
02330 "jacobian calculations for gases and temperature.\n"
02331 "\n"
02332 "See the user guide for further details.\n"
02333 "\n"
02334 "Usage: See above.\n"
02335 ),
02336 GROUP( "ArrayOfPpath" )));
02337
02338 wsv_data.push_back
02339 (WsvRecord
02340 ( NAME( "ppath_array_index" ),
02341 DESCRIPTION
02342 (
02343 "Index in *ppath_array* of present propagation path part.\n"
02344 "\n"
02345 "This variable shall point to correct position in *ppath_array* when\n"
02346 "*iy_calc* is called. A negative value means that there is no\n"
02347 "previous path part. The variable is then modified by *iy_calc* as\n"
02348 "soon as a new propagation path is calculated.\n"
02349 "\n"
02350 "Usage: Communication with *iy_calc*.\n"
02351 ),
02352 GROUP( "Index" )));
02353
02354 wsv_data.push_back
02355 (WsvRecord
02356 ( NAME( "ppath_lmax" ),
02357 DESCRIPTION
02358 (
02359 "Maximum length between points describing propagation paths.\n"
02360 "\n"
02361 "See *ppath_stepGeometric* for a description of this variable.\n"
02362 "\n"
02363 "Usage: Ppath methods such as *ppath_stepGeometric*.\n"
02364 ),
02365 GROUP( "Numeric" )));
02366
02367 wsv_data.push_back
02368 (WsvRecord
02369 ( NAME( "ppath_lraytrace" ),
02370 DESCRIPTION
02371 (
02372 "Maximum length of ray tracing steps when determining propagation\n"
02373 "paths.\n"
02374 "\n"
02375 "See *ppath_stepRefractionEuler* for a description of this variable.\n"
02376 "\n"
02377 "Usage: Refraction ppath methods such as *ppath_stepRefractionEuler*.\n"
02378 ),
02379 GROUP( "Numeric" )));
02380
02381 wsv_data.push_back
02382 (WsvRecord
02383 ( NAME( "ppath_step" ),
02384 DESCRIPTION
02385 (
02386 "A propagation path step.\n"
02387 "\n"
02388 "The main intention of this variable is communication with the agenda\n"
02389 "*ppath_step_agenda*.\n"
02390 "\n"
02391 "Type \"arts -d ppath_step\" and \"arts -d ppathCalc\" for more\n"
02392 "information on this variable and the calculation of propagation\n"
02393 "paths. Or read the chapter on propgation paths in the ARTS user\n"
02394 "guide.\n"
02395 "\n"
02396 "Usage: In/output to/from *ppath_step_agenda*.\n"
02397 "\n"
02398 "Members: See AUG.\n"
02399 ),
02400 GROUP( "Ppath" )));
02401
02402 wsv_data.push_back
02403 (WsvRecord
02404 ( NAME( "ppath_step_agenda" ),
02405 DESCRIPTION
02406 (
02407 "See agendas.cc.\n"
02408 ),
02409 GROUP( "Agenda" )));
02410
02411 wsv_data.push_back
02412 (WsvRecord
02413 ( NAME( "ppath_transmissions" ),
02414 DESCRIPTION
02415 (
02416 "Transmissions along the propagation path (ppath).\n"
02417 "\n"
02418 "The variable stores the transmission between neighbouring points\n"
02419 "along the propagation path. The transmission is stored as a Muller\n"
02420 "matrix and the case of polarised extinction is handled.\n"
02421 "\n"
02422 "Usage: Used by raditaive transfer functions.\n"
02423 "\n"
02424 "Size: [ np-1, nf, stokes_dim, stokes_dim ] where np is the number of\n"
02425 " of points of the propagation path and nf is the number of\n"
02426 " frequencies.\n"
02427 ),
02428 GROUP( "Tensor4" )));
02429
02430 wsv_data.push_back
02431 (WsvRecord
02432 ( NAME( "p_grid" ),
02433 DESCRIPTION
02434 (
02435 "The pressure grid.\n"
02436 "\n"
02437 "The pressure surfaces on which the atmospheric fields are defined.\n"
02438 "This variable must always be defined. The grid must be sorted in\n"
02439 "decreasing order, with no repetitions.\n"
02440 "\n"
02441 "No gap between the lowermost pressure level and the surface is \n"
02442 "allowed. The uppermost pressure level defines the practical upper\n"
02443 "limit of the atmosphere as vacuum is assumed above.\n"
02444 "\n"
02445 "See further the ARTS user guide (AUG). Use the index to find where\n"
02446 "this variable is discussed. The variable is listed as a subentry to\n"
02447 "\"workspace variables\".\n"
02448 "\n"
02449 "Usage: Set by the user.\n"
02450 "\n"
02451 "Unit: Pa\n"
02452 ),
02453 GROUP( "Vector" )));
02454
02455 wsv_data.push_back
02456 (WsvRecord
02457 ( NAME( "refr_index" ),
02458 DESCRIPTION
02459 (
02460 "Refractive index of air (only real part).\n"
02461 "\n"
02462 "This variable contains the refractive index summed over all relevant\n"
02463 "constituents, at one position in the atmosphere. The standard set of\n"
02464 "functions assumes that all frequency components propagate along the\n"
02465 "same path. That is, dispersion is neglected and this variable has no\n"
02466 "frequency dimension.\n"
02467 "\n"
02468 "Unit: 1\n"
02469 ),
02470 GROUP( "Numeric" )));
02471
02472 wsv_data.push_back
02473 (WsvRecord
02474 ( NAME( "refr_index_agenda" ),
02475 DESCRIPTION
02476 (
02477 "See agendas.cc.\n"
02478 ),
02479 GROUP( "Agenda" )));
02480
02481 wsv_data.push_back
02482 (WsvRecord
02483 ( NAME( "rte_agenda" ),
02484 DESCRIPTION
02485 (
02486 "See agendas.cc.\n"
02487 ),
02488 GROUP( "Agenda" )));
02489
02490 wsv_data.push_back
02491 (WsvRecord
02492 ( NAME( "rte_do_vmr_jacs" ),
02493 DESCRIPTION
02494 (
02495 "Index of gas species for which *rte_agenda* shall calculate "
02496 "VMR jacobians (with respect to changes along the propagation path).\n"
02497 "\n"
02498 "These indexes refer to the position in *abs_species*.\n"
02499 "\n"
02500 "Usage: Set internally, by *RteCalc*.\n"
02501 ),
02502 GROUP( "ArrayOfIndex" )));
02503
02504 wsv_data.push_back
02505 (WsvRecord
02506 ( NAME( "rte_do_t_jacs" ),
02507 DESCRIPTION
02508 (
02509 "Flag to *rte_agenda* to calculate jacobians for temperature.\n"
02510 "\n"
02511 "Usage: Set internally, by *RteCalc*.\n"
02512 ),
02513 GROUP( "Index" )));
02514
02515 wsv_data.push_back
02516 (WsvRecord
02517 ( NAME( "rte_gp_p" ),
02518 DESCRIPTION
02519 (
02520 "The pressure grid position of *rte_pos*.\n"
02521 "\n"
02522 "This variable is used to give the grid position for an end point\n"
02523 "of the propagation path to some workspace method part of the\n"
02524 "radiative transfer calculations.\n"
02525 "\n"
02526 "Usage: Set internally.\n"
02527 ),
02528 GROUP( "GridPos" )));
02529
02530 wsv_data.push_back
02531 (WsvRecord
02532 ( NAME( "rte_gp_lat" ),
02533 DESCRIPTION
02534 (
02535 "The latitude grid position of *rte_pos*.\n"
02536 "\n"
02537 "This variable is used to give the grid position for an end point\n"
02538 "of the propagation path to some workspace method part of the\n"
02539 "radiative transfer calculations.\n"
02540 "\n"
02541 "Usage: Set internally.\n"
02542 ),
02543 GROUP( "GridPos" )));
02544
02545 wsv_data.push_back
02546 (WsvRecord
02547 ( NAME( "rte_gp_lon" ),
02548 DESCRIPTION
02549 (
02550 "The longitude grid position of *rte_pos*.\n"
02551 "\n"
02552 "This variable is used to give the grid position for an end point\n"
02553 "of the propagation path to some workspace method part of the\n"
02554 "radiative transfer calculations.\n"
02555 "\n"
02556 "Usage: Set internally.\n"
02557 ),
02558 GROUP( "GridPos" )));
02559
02560 wsv_data.push_back
02561 (WsvRecord
02562 ( NAME( "rte_los" ),
02563 DESCRIPTION
02564 (
02565 "A line-of-sight for radiative transfer calculations.\n"
02566 "\n"
02567 "The main purpose of this WSV and *rte_pos* is communication with \n"
02568 "different agendas involved in the RTE calculations. These variables \n"
02569 "can also be used to enable calling of *ppathCalc* (and maybe other \n"
02570 "methods) from the workspace. \n"
02571 "\n"
02572 "For 1D and 2D cases, *rte_los* is a vector of length 1 holding the \n"
02573 "zenith angle. For 3D, the length of the vector is 2, where the\n"
02574 "additional element is the azimuthal angle. These angles are defined\n"
02575 "in the ARTS user guide (AUG). Look in the index for \"zenith angle\"\n"
02576 "and \"azimuthal angle\".\n"
02577 "\n"
02578 "Usage: See above.\n"
02579 "\n"
02580 "Units: [ degree, degree ]\n"
02581 "\n"
02582 "Size: [ 1 or 2 ]\n"
02583 ),
02584 GROUP( "Vector" )));
02585
02586
02587
02588
02589
02590
02591
02592
02593
02594
02595
02596
02597
02598
02599
02600
02601
02602 wsv_data.push_back
02603 (WsvRecord
02604 ( NAME( "rte_pos" ),
02605 DESCRIPTION
02606 (
02607 "A geographical position for radiative transfer calculations.\n"
02608 "\n"
02609 "The main purpose of this WSV and *rte_los* is communication with \n"
02610 "different agendas involved in the RTE calculations. These variables \n"
02611 "can also be used to enable calling of *ppathCalc* (and maybe other \n"
02612 "methods) from the workspace. \n"
02613 "\n"
02614 "This variable is a vector with a length equalling the atmospheric\n"
02615 "dimensionality. The first element is the radius (from the coordinate\n"
02616 "system centre) of the position. Element 2 is the latitude and \n"
02617 "element 3 is the longitude. Please note that the vertical position \n"
02618 "is given as the radius, not the altitude above the geoid.\n"
02619 "\n"
02620 "Usage: See above. \n"
02621 "\n"
02622 "Units: [ m, degree, degree ]\n"
02623 "\n"
02624 "Size: [ atmosphere_dim ]\n"
02625 ),
02626 GROUP( "Vector" )));
02627
02628 wsv_data.push_back
02629 (WsvRecord
02630 ( NAME( "rte_pressure" ),
02631 DESCRIPTION
02632 (
02633 "A pressure for radiative transfer calculations.\n"
02634 "\n"
02635 "This scalar variable can hold the local pressure. It is intended\n"
02636 "mainly for communication with various methods and agendas, such as\n"
02637 "methods and agendas calculating absorption coefficients.\n"
02638 "\n"
02639 "Usage: Communication variable.\n"
02640 "\n"
02641 "Units: [ Pa ]\n"
02642 ),
02643 GROUP( "Numeric" )));
02644
02645 wsv_data.push_back
02646 (WsvRecord
02647 ( NAME( "rte_temperature" ),
02648 DESCRIPTION
02649 (
02650 "A temperature for radiative transfer calculations.\n"
02651 "\n"
02652 "This scalar variable can hold the local temperature. It is intended\n"
02653 "mainly for communication with various methods and agendas, such as\n"
02654 "methods and agendas calculating absorption coefficients.\n"
02655 "\n"
02656 "Usage: Communication variable.\n"
02657 "\n"
02658 "Units: [ K ]\n"
02659 ),
02660 GROUP( "Numeric" )));
02661
02662 wsv_data.push_back
02663 (WsvRecord
02664 ( NAME( "rte_vmr_list" ),
02665 DESCRIPTION
02666 (
02667 "A list of VMR values for radiative transfer calculations.\n"
02668 "\n"
02669 "This vector variable holds the local VMR value for all used species\n"
02670 "(as given by *abs_species*). It is intended mainly for communication\n"
02671 "with various methods and agendas, such as methods and agendas \n"
02672 "calculating absorption coefficients.\n"
02673 "\n"
02674 "Usage: Communication variable.\n"
02675 "\n"
02676 "Units: [ Absolute value ]\n"
02677 "\n"
02678 "Size: Should match abs_species.nelem()\n"
02679 ),
02680 GROUP( "Vector" )));
02681
02682 wsv_data.push_back
02683 (WsvRecord
02684 ( NAME( "r_geoid" ),
02685 DESCRIPTION
02686 (
02687 "Geoid radius.\n"
02688 "\n"
02689 "Geometrical altitudes are defined as the vertical distance above the\n"
02690 "geoid, and the geoid is the reference surface used when giving, for\n"
02691 "example, *z_surface* and *z_field*. \n"
02692 "\n"
02693 "The geoid is defined by giving the radius from the coordinate centre\n"
02694 "to the geoid surface for each crossing of the latitude and longitude\n"
02695 "grids. The geoid should normally be selected to be an ellipsoid but\n"
02696 "any shape is allowed. For 1D calculations, the geoid is by\n"
02697 "definition a sphere.\n"
02698 "\n"
02699 "The radius for a point between the grid crossings is obtained by\n"
02700 "linear (2D) or bi-linear (3D) interpolation of the *r_geoid*. For 1D\n"
02701 "cases the geoid radius is constant.\n"
02702 "\n"
02703 "See further the ARTS user guide (AUG). Use the index to find where\n"
02704 "this variable is discussed. The variable is listed as a subentry to\n"
02705 "\"workspace variables\".\n"
02706 "\n"
02707 "Usage: Set by using a method for a geodetic datum.\n"
02708 "\n"
02709 "Unit: m\n"
02710 "\n"
02711 "Dimensions: [ lat_grid, lon_grid ]\n"
02712 ),
02713 GROUP( "Matrix" )));
02714
02715 wsv_data.push_back
02716 (WsvRecord
02717 ( NAME( "scat_aa_grid" ),
02718 DESCRIPTION
02719 (
02720 "Azimuthal angle grid.\n"
02721 "\n"
02722 "The azimutal angle grid, on which the intensity field is stored. \n"
02723 "This grid is used for RT calculations inside the cloudbox, \n"
02724 "therefore one has to define it if the cloudbox is activated by \n"
02725 "the flag *cloudbox_on*.\n"
02726 "The grid must be sorted in increasing order, with no repetitions.\n"
02727 "\n"
02728 "Usage: Set by the user.\n"
02729 "\n"
02730 "Unit: degrees \n"
02731 ),
02732 GROUP( "Vector" )));
02733
02734 wsv_data.push_back
02735 (WsvRecord
02736 ( NAME( "scat_aa_index" ),
02737 DESCRIPTION
02738 (
02739 "Azimuth angle index for scattering calculations.\n"
02740 "\n"
02741 "This variable is used in methods used for computing scattering\n"
02742 "properties. \n"
02743 "It holds the information about the azimuth angles for which the \n"
02744 "scattering calculations are done. The angles used for computing \n"
02745 "scattering properties of particles can be different from that used \n"
02746 "for radiative transfer calculation. \n"
02747 "\n"
02748 "Usage: Method output.\n"
02749 ),
02750 GROUP( "Index" )));
02751
02752 wsv_data.push_back
02753 (WsvRecord
02754 ( NAME( "scat_data_mono" ),
02755 DESCRIPTION
02756 (
02757 "Monochromatic single scattering data.\n"
02758 "\n"
02759 "This variable holds the single scattering properties for all \n"
02760 "hydrometeor species. It is calculated from scat_data_raw by \n"
02761 "*scat_data_monoCalc*, which interpolates scat_data_raw for the \n"
02762 "required frequency.\n"
02763 ),
02764 GROUP( "ArrayOfSingleScatteringData" )));
02765
02766 wsv_data.push_back
02767 (WsvRecord
02768 ( NAME( "scat_data_raw" ),
02769 DESCRIPTION
02770 (
02771 "Raw data of single scattering data.\n"
02772 "\n"
02773 "This variable holds the single scattering properties for all \n"
02774 "hydrometeor species included in a calculation by using the \n"
02775 "methods *ParticleTypeAdd* or *ParticleTypeAddAll*. \n"
02776 "For more information refer to ArtsWiki.\n"
02777 "The unit of the single scattering properties is m^2.\n"
02778 "\n"
02779 "Usage: Method ouput.\n"
02780 "\n"
02781 "Dimensions: Array[particle types] \n"
02782 " SingleScatteringData \n"
02783 " Enum[particle type attribute]\n"
02784 " String[description] \n"
02785 " Vector[f_grid]\n"
02786 " Vector[T_grid]\n"
02787 " Vector[za_grid]\n"
02788 " Vector[aa_grid]\n"
02789 " Tensor6[pha_mat_data]\n"
02790 " [f_grid, za_grid, aa_grid, za_grid, aa_grid, matrix_element]\n"
02791 " Tensor4[ext_mat_data]\n"
02792 " [f_grid, za_grid, aa_grid, matrix_element]\n"
02793 " Tensor4[abs_vec_data]\n"
02794 " [f_grid, za_grid, aa_grid, matrix_element]\n"
02795 ),
02796 GROUP( "ArrayOfSingleScatteringData" )));
02797
02798 wsv_data.push_back
02799 (WsvRecord
02800 ( NAME( "scat_i_lat" ),
02801 DESCRIPTION
02802 (
02803 "Intensity field on cloudbox boundary (equal latitude surfaces).\n"
02804 "\n"
02805 "This variable gives the intensity field from all directions defined \n"
02806 "in *scat_aa_grid* and *scat_za_grid* on each grid point on the two \n"
02807 "equal \n"
02808 "latitude surfaces of the cloudbox boundary. It contains all four \n"
02809 "components of the Stokes vector.\n"
02810 "\n"
02811 "This variable is used as interface between the clear sky and the \n"
02812 "scattering calculations. \n"
02813 "\n"
02814 "See further the ARTS user guide (AUG). Use the index to find where\n"
02815 "this variable is discussed. The variable is listed as a subentry to\n"
02816 "\"workspace variables\".\n"
02817 "\n"
02818 "Usage: In/Output from/to *ScatteringMain* \n"
02819 "\n"
02820 "Unit: W / (m^2 Hz sr) \n"
02821 "\n"
02822 "Dimensions: [ f_grid, p_grid, latitude surface, lon_grid, \n"
02823 " scat_za_grid \n scat_aa_grid, stokes_dim ]\n"
02824 ),
02825 GROUP( "Tensor7" )));
02826
02827 wsv_data.push_back
02828 (WsvRecord
02829 ( NAME( "scat_i_lon" ),
02830 DESCRIPTION
02831 (
02832 "Intensity field on cloudbox boundary (equal longitude surfaces).\n"
02833 "\n"
02834 "This variable gives the intensity field from all directions defined \n"
02835 "in *scat_aa_grid* and *scat_za_grid* on each grid point on the equal\n"
02836 "latitude surfaces of the boundary of the cloudbox, which is defined \n"
02837 "by the workspace variable *cloudbox_limits*. It contains all four \n"
02838 "components of the Stokes vector.\n"
02839 "\n"
02840 "This variable is used as interface between the clear sky and the \n"
02841 "scattering calculations. \n"
02842 "\n"
02843 "See further the ARTS user guide (AUG). Use the index to find where\n"
02844 "this variable is discussed. The variable is listed as a subentry to\n"
02845 "\"workspace variables\".\n"
02846 "\n"
02847 "Usage: Output from *ScatteringMain* \n"
02848 "\n"
02849 "Unit: W / (m^2 Hz sr) \n"
02850 "\n"
02851 "Dimensions: [ f_grid, p_grid, lat_grid, latitude surface, \n"
02852 " scat_za_grid, scat_aa_grid, stokes_dim]\n"
02853 ),
02854 GROUP( "Tensor7" )));
02855
02856 wsv_data.push_back
02857 (WsvRecord
02858 ( NAME( "scat_i_p" ),
02859 DESCRIPTION
02860 (
02861 "Intensity field on cloudbox boundary (equal pressure surfaces).\n"
02862 "\n"
02863 "This variable gives the intensity field from all directions defined \n"
02864 "in *scat_aa_grid* and *scat_za_grid* on each grid point on the equal\n"
02865 "latitude surfaces of the cloudbox boundary. It contains all four \n"
02866 "components of the Stokes vector.\n"
02867 "\n"
02868 "This variable is used as interface between the clear sky and the \n"
02869 "scattering calculations. \n"
02870 "\n"
02871 "See further the ARTS user guide (AUG). Use the index to find where\n"
02872 "this variable is discussed. The variable is listed as a subentry to\n"
02873 "\"workspace variables\".\n"
02874 "\n"
02875 "Usage: In/Output from *ScatteringMain* \n"
02876 "\n"
02877 "Unit: W / (m^2 Hz sr) \n"
02878 "\n"
02879 "Dimensions: [ f_grid, pressure surfaces, lat_grid, lon_grid, \n"
02880 " scat_za_grid, scat_aa_grid, stokes_dim]\n"
02881 ),
02882 GROUP( "Tensor7" )));
02883
02884 wsv_data.push_back
02885 (WsvRecord
02886 ( NAME( "scat_lat_index" ),
02887 DESCRIPTION
02888 (
02889 "Latitude index for scattering calculations.\n"
02890 "\n"
02891 "This variable is used in methods used for computing scattering\n"
02892 "properties of particles like *ext_mat_partCalc* and *pha_matCalc*.\n"
02893 "It holds the information about the position for which the \n"
02894 "scattering calculations are done. \n"
02895 "\n"
02896 "Usage: Input to the methods *spt_calc_agenda*,\n"
02897 " *pha_mat_spt_agenda*\n"
02898 ),
02899 GROUP( "Index" )));
02900
02901 wsv_data.push_back
02902 (WsvRecord
02903 ( NAME( "scat_lon_index" ),
02904 DESCRIPTION
02905 (
02906 "Longitude index for scattering calculations.\n"
02907 "\n"
02908 "This variable is used in methods used for computing scattering\n"
02909 "properties of particles like *ext_mat_partCalc* and *pha_matCalc*.\n"
02910 "It holds the information about the position for which the \n"
02911 "scattering calculations are done. \n"
02912 "\n"
02913 "Usage: Input to the methods *spt_calc_agenda*,\n"
02914 " *pha_mat_spt_agenda*\n"
02915 ),
02916 GROUP( "Index" )));
02917
02918 wsv_data.push_back
02919 (WsvRecord
02920 ( NAME( "scat_p_index" ),
02921 DESCRIPTION
02922 (
02923 "Pressure index for scattering calculations.\n"
02924 "\n"
02925 "This variable is used in methods used for computing scattering\n"
02926 "properties of particles like *ext_mat_partCalc* and *pha_matCalc*.\n"
02927 "It holds the information about the location for which the \n"
02928 "scattering calculations are done.\n"
02929 "\n"
02930 "Usage: Input to the methods *spt_calc_agenda*,\n"
02931 " *pha_mat_spt_agenda*\n"
02932 ),
02933 GROUP( "Index" )));
02934
02935 wsv_data.push_back
02936 (WsvRecord
02937 ( NAME( "scat_za_grid" ),
02938 DESCRIPTION
02939 (
02940 "Zenith angle grid.\n"
02941 "\n"
02942 "The zenith angle grid, on which the intensity field is stored. \n"
02943 "This grid is used for RT calculations inside the cloudbox, therefore\n"
02944 "the grid has to be defined\n"
02945 "if the cloudbox is activated by the flag *cloudbox_on*.\n"
02946 "The grid must be sorted in increasing order, with no repetitions.\n"
02947 "\n"
02948 "Usage: Set by the user.\n"
02949 "\n"
02950 "Unit: degrees \n"
02951 ),
02952 GROUP( "Vector" )));
02953
02954 wsv_data.push_back
02955 (WsvRecord
02956 ( NAME( "scat_za_index" ),
02957 DESCRIPTION
02958 (
02959 "Zenith angle index for scattering calculations.\n"
02960 " \n"
02961 "This variable is used internally in WSMs for computing scattering \n"
02962 "properties. \n"
02963 "\n"
02964 "Usage: Input to the agendas *spt_calc_agenda*, \n "
02965 " *pha_mat_spt_agenda*.\n"
02966 ),
02967 GROUP( "Index" )));
02968
02969
02970
02971 wsv_data.push_back
02972 (WsvRecord
02973 ( NAME( "sensor_los" ),
02974 DESCRIPTION
02975 (
02976 "The sensor line-of-sight (LOS) for each measurement block.\n"
02977 "\n"
02978 "Line-of-sights are specified by giving the zenith and azimuth angles.\n"
02979 "Column 1 holds the zenith angle. This angle is simply the angle \n"
02980 "between the zenith and LOS directions. For 1D and 3D the valid\n"
02981 "range is [0 180], while for 2D angles down to -180 degrees are\n"
02982 "allowed. Negative angles signifies for 2D observations towards\n"
02983 "lower latitudes, while positive angles means observations towards\n"
02984 "higher latitudes. Nadir corresponds throughout to 180 degrees.\n"
02985 "\n"
02986 "The azimuth angle is given with respect to the meridian plane. That\n"
02987 "is, the plane going through the north and south poles. The valid \n"
02988 "range is [-180,180] where angles are counted clockwise; 0 means\n"
02989 "that the viewing or propagation direction is north-wise and +90 means\n"
02990 "that the direction of concern goes eastward.\n"
02991 "\n"
02992 "See further the ARTS user guide (AUG). Use the index to find where\n"
02993 "this variable is discussed. The variable is listed as a subentry to\n"
02994 "\"workspace variables\".\n"
02995 "\n"
02996 "Usage: Set by the user.\n"
02997 "\n"
02998 "Unit: [ degrees, degrees ]\n"
02999 "\n"
03000 "Size: [ number of measurement blocks, 1 or 2 ]\n"
03001 ),
03002 GROUP( "Matrix" )));
03003
03004 wsv_data.push_back
03005 (WsvRecord
03006 ( NAME( "sensor_norm" ),
03007 DESCRIPTION
03008 (
03009 "Flag if sensor response should be normalised or not (0 or 1).\n"
03010 "\n"
03011 "If the flag is set to 1 each sensor response is normalised (where\n"
03012 "applicable). If set to 0 the sensor responses are left as provided.\n"
03013 "\n"
03014 "See further the ARTS user guide (AUG). Use the index to find where\n"
03015 "this variable is discussed. The variable is listed as a sub-entry to\n"
03016 "\"workspace variables\".\n"
03017 "\n"
03018 "Usage: Set by the user.\n"
03019 ),
03020 GROUP( "Index" )));
03021
03022
03023
03024
03025
03026
03027
03028
03029
03030
03031
03032
03033
03034
03035
03036
03037
03038
03039
03040
03041
03042
03043
03044
03045
03046
03047
03048
03049
03050
03051
03052
03053
03054
03055
03056
03057
03058
03059
03060 wsv_data.push_back
03061 (WsvRecord
03062 ( NAME( "sensor_pos" ),
03063 DESCRIPTION
03064 (
03065 "The sensor position for each measurement block.\n"
03066 "\n"
03067 "The sensor positions are specified as a matrix, where the number of\n"
03068 "columns shall be equal to *atmosphere_dim*. Column 1 shall contain\n"
03069 "the radius of observation posotion, column 2 the latitude and the \n"
03070 "last column the longitude. The number of rows corresponds to the\n"
03071 "number of measurement blocks.\n"
03072 "\n"
03073 "Valid range for latitudes in 3D is [-90,90], while for 2D any value\n"
03074 "is accepted. Accepted range for longitudes are [-360,360].\n"
03075 "\n"
03076 "See further the ARTS user guide (AUG). Use the index to find where\n"
03077 "this variable is discussed. The variable is listed as a subentry to\n"
03078 "\"workspace variables\".\n"
03079 "\n"
03080 "Usage: Set by the user.\n"
03081 "\n"
03082 "Unit: [ m, degrees, degrees ]\n"
03083 "\n"
03084 "Size: [ number of measurement blocks, atmosphere_dim ]\n"
03085 ),
03086 GROUP( "Matrix" )));
03087
03088 wsv_data.push_back
03089 (WsvRecord
03090 ( NAME( "sensor_response" ),
03091 DESCRIPTION
03092 (
03093 "The matrix modelling the total sensor response.\n"
03094 "\n"
03095 "This matrix describes the sensor respons for one measurement block\n"
03096 "The response is assumed to be identical for each such block.\n"
03097 "\n"
03098 "The matrix is the product of all the individual sensor response\n"
03099 "matrices. Therefore its dimensions are depending on the total sensor\n"
03100 "configuration. The *sensor_response* has to initialised by the \n"
03101 "*sensor_responseInit* method.\n"
03102 "\n"
03103 "Usage: Output/input to the *sensor_response...* methods.\n"
03104 "\n"
03105 "Units: -\n"
03106 "\n"
03107 "Dimension: See the individual *sensor_response...* method. \n"
03108 ),
03109 GROUP( "Sparse" )));
03110
03111 wsv_data.push_back
03112 (WsvRecord
03113 ( NAME( "sensor_response_aa" ),
03114 DESCRIPTION
03115 (
03116 "The relative azimuth angles associated with the output of\n"
03117 "*sensor_response*.\n"
03118 "\n"
03119 "Definition of angle matches *mblock_aa_grid*. Works otherwise as\n"
03120 "*sensor_response_f*.\n"
03121 "\n"
03122 "The variable shall not be set manually, it will be set together with\n"
03123 "*sensor_response* by sensor response WSMs.\n"
03124 "\n"
03125 "Usage: Set by sensor response methods.\n"
03126 "\n"
03127 "Unit: [ degrees ]\n"
03128 ),
03129 GROUP( "Vector" )));
03130
03131 wsv_data.push_back
03132 (WsvRecord
03133 ( NAME( "sensor_response_aa_grid" ),
03134 DESCRIPTION
03135 (
03136 "The azimuth angle grid associated with *sensor_response*.\n"
03137 "\n"
03138 "A variable for communication between sensor response WSMs. Matches\n"
03139 "initially *mblock_aa_grid*, but is later adjusted according to the\n"
03140 "sensor specifications. Only defined when a common grid exists. Values\n"
03141 "are here not repeated as in *sensor_response_aa*\n"
03142 "\n"
03143 "The zenith and azimuth dimensions are joined into a single dimension\n"
03144 "after the antenna. The variables *sensor_response_za_grid* and \n"
03145 "*sensor_response_aa_grid* have then the same length after the antenna\n"
03146 "(if antenna_dim = 2), holding data taken from the columns of \n"
03147 "*antenna_los*.\n"
03148 "\n"
03149 "Usage: Set by sensor response methods.\n"
03150 "\n"
03151 "Unit: [ degrees ]\n"
03152 ),
03153 GROUP( "Vector" )));
03154
03155 wsv_data.push_back
03156 (WsvRecord
03157 ( NAME( "sensor_response_f" ),
03158 DESCRIPTION
03159 (
03160 "The frequencies associated with the output of *sensor_response*.\n"
03161 "\n"
03162 "This vector gives the frequency for each element of the measurement\n"
03163 "vector produced inside one measurement block. The frequencies of\n"
03164 "the total measurement vector, *y*, are obtained by repeating these\n"
03165 "frequencies n times, where n is the number of measurement blocks\n"
03166 "(e.g. the number of rows in *sensor_pos*).\n"
03167 "\n"
03168 "The variable shall not be set manually, it will be set together with\n"
03169 "*sensor_response* by sensor response WSMs.\n"
03170 "\n"
03171 "Usage: Set by sensor response methods.\n"
03172 "\n"
03173 "Unit: [ Hz ]\n"
03174 ),
03175 GROUP( "Vector" )));
03176
03177 wsv_data.push_back
03178 (WsvRecord
03179 ( NAME( "sensor_response_f_grid" ),
03180 DESCRIPTION
03181 (
03182 "The frequency grid associated with *sensor_response*.\n"
03183 "\n"
03184 "A variable for communication between sensor response WSMs. Matches\n"
03185 "initially *f_grid*, but is later adjusted according to the sensor\n"
03186 "specifications. Only defined when a common grid exists. Values are\n"
03187 "here not repeated as in *sensor_response_f*\n"
03188 "\n"
03189 "Usage: Set by sensor response methods.\n"
03190 "\n"
03191 "Unit: [ Hz ]\n"
03192 ),
03193 GROUP( "Vector" )));
03194
03195 wsv_data.push_back
03196 (WsvRecord
03197 ( NAME( "sensor_response_pol" ),
03198 DESCRIPTION
03199 (
03200 "The polarisation channel index associated with the output of\n"
03201 "*sensor_response*.\n"
03202 "\n"
03203 "The index is taken from *stokes_dim* and *sensor_pol*. Please note\n"
03204 "that only the index is provided (1-based). No information of the\n"
03205 "actual polarisation state is included. Works otherwise as\n"
03206 "*sensor_response_f*.\n"
03207 "\n"
03208 "The variable shall not be set manually, it will be set together with\n"
03209 "*sensor_response* by sensor response WSMs.\n"
03210 "\n"
03211 "Usage: Set by sensor response methods.\n"
03212 "\n"
03213 "Unit: [ - ]\n"
03214 ),
03215 GROUP( "ArrayOfIndex" )));
03216
03217 wsv_data.push_back
03218 (WsvRecord
03219 ( NAME( "sensor_response_pol_grid" ),
03220 DESCRIPTION
03221 (
03222 "The \"polarisation grid\" associated with *sensor_response*.\n"
03223 "\n"
03224 "A variable for communication between sensor response WSMs. Matches\n"
03225 "initially *stokes_dim*, but is later adjusted according to the \n"
03226 "sensor specifications. Only defined when a common grid exists. \n"
03227 "\n"
03228 "Usage: Set by sensor response methods.\n"
03229 "\n"
03230 "Unit: [ - ]\n"
03231 ),
03232 GROUP( "ArrayOfIndex" )));
03233
03234 wsv_data.push_back
03235 (WsvRecord
03236 ( NAME( "sensor_response_za" ),
03237 DESCRIPTION
03238 (
03239 "The relative zenith angles associated with the output of\n"
03240 "*sensor_response*.\n"
03241 "\n"
03242 "Definition of angle matches *mblock_za_grid*. Works otherwise as\n"
03243 "*sensor_response_f*.\n"
03244 "\n"
03245 "The variable shall not be set manually, it will be set together with\n"
03246 "*sensor_response* by sensor response WSMs.\n"
03247 "\n"
03248 "Usage: Set by sensor response methods.\n"
03249 "\n"
03250 "Unit: [ degrees ]\n"
03251 ),
03252 GROUP( "Vector" )));
03253
03254 wsv_data.push_back
03255 (WsvRecord
03256 ( NAME( "sensor_response_za_grid" ),
03257 DESCRIPTION
03258 (
03259 "The zenith angle grid associated with *sensor_response*.\n"
03260 "\n"
03261 "A variable for communication between sensor response WSMs. Matches\n"
03262 "initially *mblock_za_grid*, but is later adjusted according to the\n"
03263 "sensor specifications. Only defined when a common grid exists. Values\n"
03264 "are here not repeated as in *sensor_response_za*\n"
03265 "\n"
03266 "The zenith and azimuth dimensions are joined into a single dimension\n"
03267 "after the antenna. The variables *sensor_response_za_grid* and \n"
03268 "*sensor_response_aa_grid* have then the same length after the antenna\n"
03269 "(if antenna_dim = 2), holding data taken from the columns of \n"
03270 "*antenna_los*.\n"
03271 "\n"
03272 "Usage: Set by sensor response methods.\n"
03273 "\n"
03274 "Unit: [ degrees ]\n"
03275 ),
03276 GROUP( "Vector" )));
03277
03278
03279
03280
03281
03282
03283
03284
03285
03286
03287
03288
03289
03290
03291
03292
03293
03294
03295
03296
03297
03298
03299
03300
03301
03302
03303
03304
03305
03306
03307
03308
03309
03310
03311 wsv_data.push_back
03312 (WsvRecord
03313 ( NAME( "sensor_time" ),
03314 DESCRIPTION
03315 (
03316 "The time for each measurement block.\n"
03317 "\n"
03318 "This WSV is used when a time must be assigned to the measurements.\n"
03319 "No specific time format has (yet) been specified.\n"
03320 "\n"
03321 "Usage: Set by the user.\n"
03322 "\n"
03323 "Unit: [ arbitrary ]\n"
03324 "\n"
03325 "Size: [ number of measurement blocks ]\n"
03326 ),
03327 GROUP( "Vector" )));
03328
03329 wsv_data.push_back
03330 (WsvRecord
03331 ( NAME( "sideband_mode" ),
03332 DESCRIPTION
03333 (
03334 "Description of target sideband.\n"
03335 "\n"
03336 "A text string describing which of the two sidebands (of a heterodyne\n"
03337 "instrument) that can be seen as \"main\" band. Possible choices are:\n"
03338 " \"lower\" : Low frequency sideband shall be considered as target.\n"
03339 " \"upper\" : High frequency sideband shall be considered as target.\n"
03340 "\n"
03341 "Usage: Set by the user.\n"
03342 ),
03343 GROUP( "String" )));
03344
03345 wsv_data.push_back
03346 (WsvRecord
03347 ( NAME( "sideband_mode_multi" ),
03348 DESCRIPTION
03349 (
03350 "Description of target sideband for a multiple LO reciever.\n"
03351 "\n"
03352 "As *sideband_mode* but handles an instrument with several LO chains.\n"
03353 "See further *lo_multi* and *sideband_response_multi*. This length of\n"
03354 "this array must match the size of those WSVs.\n"
03355 "\n"
03356 "Usage: Set by the user.\n"
03357 ),
03358 GROUP( "ArrayOfString" )));
03359
03360
03361 wsv_data.push_back
03362 (WsvRecord
03363 ( NAME( "sideband_response" ),
03364 DESCRIPTION
03365 (
03366 "Description of (mixer) sideband response.\n"
03367 "\n"
03368 "This variable describes the response of each sideband of a heterodyne\n"
03369 "receiver. The response is given as a GField1, with frequency as the\n"
03370 "grid. The actual data describe the sideband filter function at each\n"
03371 "frequency grid point. An interpolation is applied to obtain the\n"
03372 "response for other frequencies.\n"
03373 "\n"
03374 "The frequency grid should be given in terms of IF, with end points\n"
03375 "symmetrically placed around zero. That is, the grid must contain\n"
03376 "both negative and positive values. The sideband response (after \n"
03377 "summation with *lo*) is not allowed to extend outside the range\n"
03378 "for which spectral data exist (normally determined by *f_grid*).\n"
03379 "\n"
03380 "Usage: Set by the user.\n"
03381 "\n"
03382 "Dimensions: \n"
03383 " GField1:\n"
03384 " Vector f_grid[N_f]\n"
03385 " Vector data[N_f]\n"
03386 ),
03387 GROUP( "GField1" )));
03388
03389 wsv_data.push_back
03390 (WsvRecord
03391 ( NAME( "sideband_response_multi" ),
03392 DESCRIPTION
03393 (
03394 "Description of multiple (mixer) sideband responses.\n"
03395 "\n"
03396 "As *sideband_response* but describes an instrument with multiple\n"
03397 "mixers. An array element for each LO. The size of this variable and\n"
03398 "*lo_multi* shall match.\n"
03399 "\n"
03400 "Unit: Hz\n"
03401 "\n"
03402 "Usage: Set by the user.\n"
03403 ),
03404 GROUP( "ArrayOfGField1" )));
03405
03406 wsv_data.push_back
03407 (WsvRecord
03408 ( NAME( "single_scattering_data" ),
03409 DESCRIPTION
03410 (
03411 "Structure for the single scattering data.\n"
03412 "\n"
03413 "See futher the ArtsWiki documentation were the SingleScatteringData\n"
03414 "structure is disussed.\n"
03415 "\n"
03416 "Usage: Set by the user.\n"
03417 "\n"
03418 "Dimensions: SingleScatteringData \n"
03419 " Enum[particle type attribute]\n"
03420 " String[description] \n"
03421 " Vector[f_grid]\n"
03422 " Vector[T_grid]\n"
03423 " Vector[za_grid]\n"
03424 " Vector[aa_grid]\n"
03425 " Tensor7[pha_mat_data]\n"
03426 " [f_grid, T_grid, za_grid, aa_grid, za_grid, aa_grid,"
03427 "matrix_element]\n"
03428 " Tensor5[ext_mat_data]\n"
03429 " [f_grid, T_grid, za_grid, aa_grid, matrix_element]\n"
03430 " Tensor5[abs_vec_data]\n"
03431 " [f_grid, T_grid, za_grid, aa_grid, matrix_element]\n"
03432 ),
03433 GROUP( "SingleScatteringData" )));
03434
03435
03436
03437
03438
03439
03440
03441
03442
03443
03444
03445
03446
03447
03448 wsv_data.push_back
03449 (WsvRecord
03450 ( NAME( "stokes_dim" ),
03451 DESCRIPTION
03452 (
03453 "The dimensionality of the Stokes vector (1-4).\n"
03454 "\n"
03455 "Usage: Set by the user.\n"
03456 ),
03457 GROUP( "Index" )));
03458
03459 wsv_data.push_back
03460 (WsvRecord
03461 ( NAME( "spt_calc_agenda" ),
03462 DESCRIPTION
03463 (
03464 "See agendas.cc.\n"
03465 ),
03466 GROUP( "Agenda" )));
03467
03468
03469
03470
03471
03472
03473
03474
03475
03476
03477
03478
03479
03480
03481
03482
03483 wsv_data.push_back
03484 (WsvRecord
03485 ( NAME( "surface_emission" ),
03486 DESCRIPTION
03487 ( "The emission from the surface.\n"
03488 "\n"
03489 "See further *surfaceCalc* and the user guide.\n"
03490 "\n"
03491 "Unit: W / (m^2 Hz sr)\n"
03492 "\n"
03493 "Dimensions: [ f_grid, stokes_dim ]\n"
03494 ),
03495 GROUP( "Matrix" )));
03496
03497 wsv_data.push_back
03498 (WsvRecord
03499 ( NAME( "surface_emissivity_DISORT" ),
03500 DESCRIPTION
03501 ( "The surface emissivity specified on lat_grid and lon_grid.\n"
03502 "\n"
03503 "Remnant from a first solution for surface emissivity fields.\n"
03504 "Should be replaced with more flexible solution allowing emissivity\n"
03505 "to vary with incidence angle.\n"
03506 "\n"
03507 "Dimensions: [ lat_grid, lon_grid ]\n"
03508 ),
03509 GROUP( "Matrix" )));
03510
03511 wsv_data.push_back
03512 (WsvRecord
03513 ( NAME( "surface_los" ),
03514 DESCRIPTION
03515 (
03516 "Directions for which to calculate downwelling radiation when \n"
03517 "considering a surface reflection.\n"
03518 "\n"
03519 "See further the user guide.\n"
03520 "\n"
03521 "Units: degrees\n"
03522 "\n"
03523 "Size: [ any number, 1 or 2 ]\n"
03524 ),
03525 GROUP( "Matrix" )));
03526
03527 wsv_data.push_back
03528 (WsvRecord
03529 ( NAME( "surface_prop_agenda" ),
03530 DESCRIPTION
03531 (
03532 "See agendas.cc.\n"
03533 ),
03534 GROUP( "Agenda" )));
03535
03536 wsv_data.push_back
03537 (WsvRecord
03538 ( NAME( "surface_rmatrix" ),
03539 DESCRIPTION
03540 (
03541 "The reflection coefficients for the directions given by\n"
03542 "*surface_los* to the direction of interest.\n"
03543 "\n"
03544 "The rows and columns of this tensor holds the reflection\n"
03545 "coefficient matrix for one frequency and one LOS. The reflection\n"
03546 "coefficients shall take into accound the angular weighting if the\n"
03547 "downwelling radiation.\n"
03548 "\n"
03549 "See further *surfaceCalc* and the user guide.\n"
03550 "\n"
03551 "Usage: Input to methods for *iy_surface_agenda*."
03552 "\n"
03553 "Units: -\n"
03554 "\n"
03555 "Dimensions: [ surface_los, f_grid, stokes_dim, stokes_dim ]\n"
03556 ),
03557 GROUP( "Tensor4" )));
03558
03559 wsv_data.push_back
03560 (WsvRecord
03561 ( NAME( "surface_skin_t" ),
03562 DESCRIPTION
03563 (
03564 "Surface skin temperature.\n"
03565 "\n"
03566 "This temperature shall be selected considering the radiative\n"
03567 "properties of the surface, and can differ from the \"bulk\"\n"
03568 "temperature.\n"
03569 "\n"
03570 "Usage: Input to methods for *iy_surface_agenda*.\n"
03571 ),
03572 GROUP( "Numeric" )));
03573
03574 wsv_data.push_back
03575 (WsvRecord
03576 ( NAME( "timer" ),
03577 DESCRIPTION
03578 (
03579 "Stores the starting time for time measurements.\n"
03580 ),
03581 GROUP( "Timer" )));
03582
03583 wsv_data.push_back
03584 (WsvRecord
03585 ( NAME( "t_field" ),
03586 DESCRIPTION
03587 (
03588 "The field of atmospheric temperatures.\n"
03589 "\n"
03590 "This variable gives the atmospheric temperature at each crossing of\n"
03591 "the pressure, latitude and longitude grids.\n"
03592 "\n"
03593 "The temperature for a point between the grid crossings is obtained \n"
03594 "by (multi-)linear interpolation of the *t_field*.\n"
03595 "\n"
03596 "See further the ARTS user guide (AUG). Use the index to find where\n"
03597 "this variable is discussed. The variable is listed as a subentry to\n"
03598 "\"workspace variables\".\n"
03599 "\n"
03600 "Usage: Output of *AtmFieldsCalc*.\n"
03601 "\n"
03602 "Unit: K\n"
03603 "\n"
03604 "Dimensions: [ p_grid, lat_grid, lon_grid ]\n"
03605 ),
03606 GROUP( "Tensor3" )));
03607
03608 wsv_data.push_back
03609 (WsvRecord
03610 ( NAME( "t_field_raw" ),
03611 DESCRIPTION
03612 (
03613 "Raw data for atmospheric temperatures.\n"
03614 "\n"
03615 "This variable gives the atmospheric temperature as stored in the \n"
03616 "database for the atmospheric scenarios.\n"
03617 "\n"
03618 "See further the ARTS user guide (AUG). Use the index to find where\n"
03619 "this variable is discussed. The variable is listed as a subentry to\n"
03620 "\"workspace variables\".\n"
03621 "\n"
03622 "Usage: Set by the user by choosing a climatology.\n"
03623 "\n"
03624 "Unit: K\n"
03625 "\n"
03626 "Size GField3 \n "
03627 " [N_p] \n"
03628 " [N_lat] \n"
03629 " [N_lon] \n"
03630 " [N_p, N_lat, N_lon] \n"
03631 ),
03632 GROUP( "GField3" )));
03633
03634 wsv_data.push_back
03635 (WsvRecord
03636 ( NAME( "t_surface" ),
03637 DESCRIPTION
03638 (
03639 "The surface temperature.\n"
03640 "\n"
03641 "This variable holds the temperature of the surface at each latitude\n"
03642 "and longitude grid crossing. The normal case should be that this \n"
03643 "temperature field is interpolated to obtain *surface_skin_t*.\n"
03644 "Accordingly, for 1D cases it could be a better idea to specify\n"
03645 "*surface_skin_t* directly.\n"
03646 "\n"
03647 "These temperature shall be selected considering the radiative\n"
03648 "properties of the surface, and can differ from the \"bulk\"\n"
03649 "temperatures.\n"
03650 "\n"
03651 "Usage: Set by user.\n"
03652 "\n"
03653 "Unit: K\n"
03654 "\n"
03655 "Dimensions: [ lat_grid, lon_grid ]\n"
03656 ),
03657 GROUP( "Matrix" )));
03658
03659 wsv_data.push_back
03660 (WsvRecord
03661 ( NAME( "vmr_field" ),
03662 DESCRIPTION
03663 (
03664 "VMR field.\n"
03665 "\n"
03666 "This variable gives the volume mixing ratio of the chosen gaseous \n"
03667 "species as a function of p_grid, lat_grid, lon_grid. \n"
03668 "\n"
03669 "See further the ARTS user guide (AUG). Use the index to find where\n"
03670 "this variable is discussed. The variable is listed as a subentry to\n"
03671 "\"workspace variables\".\n"
03672 "\n"
03673 "\n"
03674 "Usage: Calculated internally.\n"
03675 "\n"
03676 "Unit: absolute numbers \n"
03677 "\n"
03678 "Dimensions: [species, p_grid, lat_grid, lon_grid]\n"
03679 ),
03680 GROUP( "Tensor4" )));
03681
03682 wsv_data.push_back
03683 (WsvRecord
03684 ( NAME( "vmr_field_raw" ),
03685 DESCRIPTION
03686 (
03687 "VMR data for the chosen gaseous species.\n"
03688 "\n"
03689 "This variable contains the volume mixing ratios (VMR) for all \n"
03690 "chosen gaseous species. It includes the grids corresponding to the \n"
03691 "grids in the database. \n"
03692 "*vmr_field_raw* is an Array of Array of Tensor3. It contains one \n"
03693 "gridded field for each species which contains the data and \n"
03694 "also the grids.\n"
03695 "For the calculation the data is \n"
03696 "interpolated on *p_grid*, *lat_grid* and *lon_grid*\n"
03697 "\n"
03698 "Usage: Output of *AtmRawRead*\n"
03699 " Input to *AtmFieldsCalc*.\n"
03700 "\n"
03701 "Unit: absolute number\n"
03702 "\n"
03703 "Size: Array[N_pt]\n"
03704 " GField3 \n "
03705 " [N_p] \n"
03706 " [N_lat] \n"
03707 " [N_lon] \n"
03708 " [N_p, N_lat, N_lon] \n"
03709 ),
03710 GROUP( "ArrayOfGField3" )));
03711
03712
03713 wsv_data.push_back
03714 (WsvRecord
03715 ( NAME( "xml_output_type" ),
03716 DESCRIPTION
03717 (
03718 "Flag to determine whether XML output shall be binary or ascii.\n"
03719 "\n"
03720 "This flag has to be set using the workspace method\n"
03721 "*output_file_formatSetAscii* or *output_file_formatSetBinary*.\n"
03722 "One of these methods MUST be called before writing the first\n"
03723 "output file.\n"
03724 "\n"
03725 "Usage: Set by user.\n"
03726 ),
03727 GROUP( "Index" )));
03728
03729 wsv_data.push_back
03730 (WsvRecord
03731 ( NAME( "y" ),
03732 DESCRIPTION
03733 (
03734 "The measurement vector.\n"
03735 "\n"
03736 "This vector holds radiances averaged in frequency and spatially,\n"
03737 "and can contain many spectra appended. \n"
03738 "\n"
03739 "Usage: Output from radiative transfer calculations considering\n"
03740 " sensor response.\n"
03741 "\n"
03742 "Unit: Undefined. Possibilities include: K, W/(m^2 Hz sr) and\n "
03743 " optical thickness.\n"
03744 ),
03745 GROUP( "Vector" )));
03746
03747 wsv_data.push_back
03748 (WsvRecord
03749 ( NAME( "y_f" ),
03750 DESCRIPTION
03751 (
03752 "The frequencies associated with *y*.\n"
03753 "\n"
03754 "Works as *sensor_response_f*, but is valid for *y* and not only a\n"
03755 "single measurement block.\n"
03756 "\n"
03757 "Usage: Output from radiative transfer calculations considering\n"
03758 " sensor response.\n"
03759 "\n"
03760 "Unit: [ Hz ]\n"
03761 ),
03762 GROUP( "Vector" )));
03763
03764 wsv_data.push_back
03765 (WsvRecord
03766 ( NAME( "y_los" ),
03767 DESCRIPTION
03768 (
03769 "The line-of-sights associated with *y*.\n"
03770 "\n"
03771 "Definition of angles matches *sensor_los* (such as first column holds\n"
03772 "zenith angles), but gives actual observed LOS. That is, the values of\n"
03773 "both *sensor_los* and *antenna_los* are considered. Data are provided\n"
03774 "for each element of *y*, following y_f, and the number of rows equals\n"
03775 "the length of *y*.\n"
03776 "\n"
03777 "Usage: Output from radiative transfer calculations considering\n"
03778 " sensor response.\n"
03779 "\n"
03780 "Unit: [ degrees, degrees ]\n"
03781 ),
03782 GROUP( "Matrix" )));
03783
03784 wsv_data.push_back
03785 (WsvRecord
03786 ( NAME( "y_pol" ),
03787 DESCRIPTION
03788 (
03789 "The polarisation channel index associated *y*.\n"
03790 "\n"
03791 "Works as *sensor_response_pol*, but is valid for *y* and not only a\n"
03792 "single measurement block.\n"
03793 "\n"
03794 "Usage: Output from radiative transfer calculations considering\n"
03795 " sensor response.\n"
03796 "\n"
03797 "Unit: [ - ]\n"
03798 ),
03799 GROUP( "ArrayOfIndex" )));
03800
03801 wsv_data.push_back
03802 (WsvRecord
03803 ( NAME( "y_pos" ),
03804 DESCRIPTION
03805 (
03806 "The sensor positions associated with *y*.\n"
03807 "\n"
03808 "Definition of positions matches *sensor_pos* (such as first column\n"
03809 "holds the radius). Data are provided for each element of *y*,\n"
03810 "following y_f, and the number of rows equals the length of *y*.\n"
03811 "\n"
03812 "Usage: Output from radiative transfer calculations considering\n"
03813 " sensor response.\n"
03814 "\n"
03815 "Unit: [ degrees, degrees ]\n"
03816 ),
03817 GROUP( "Matrix" )));
03818
03819 wsv_data.push_back
03820 (WsvRecord
03821 ( NAME( "y_unit" ),
03822 DESCRIPTION
03823 (
03824 "Unit for spectral values returned by radiative transfer methods.\n"
03825 "\n"
03826 "The basic unit is determined by the definition of background\n"
03827 "radiation and atmospheric and surface source terms. The standard\n"
03828 "choices corresponds to the unit of radiances [W/m2/Hz/sr]. This\n"
03829 "variable allows conversion to other units.\n"
03830 "\n"
03831 "Possible choices are:\n"
03832 " \"1\" : No conversion.\n"
03833 " \"RJBT\" : Conversion to Rayliegh-Jean brightness temperature.\n"
03834 " \"PlanckBT\": Conversion to Planck brightness temperature.\n"
03835 "The conversion to brighness temperatures assumes that basic unit is\n"
03836 "[W/m2/Hz/sr]. Obtained unit is [K]. \n"
03837 "\n"
03838 "The conversion is applied on monochromatic pencil beam values. That\n"
03839 "is, before any sensor responses have been included.\n"
03840 "\n"
03841 "Usage: Set by the user.\n"
03842 ),
03843 GROUP( "String" )));
03844
03845
03846
03847
03848
03849 wsv_data.push_back
03850 (WsvRecord
03851 ( NAME( "ybatch" ),
03852 DESCRIPTION
03853 (
03854 "Batch of spectra.\n"
03855 "\n"
03856 "Each column of *ybatch* corresponds to a spectrum vector *y*. \n"
03857 "See further *ybatchCalc*.\n"
03858 "\n"
03859 "Usage: Most commonly produced by *ybatch*.\n"
03860 "\n"
03861 "Unit: Undefined. Possibilities include: K, W/(m^2 Hz sr) and\n "
03862 " optical thickness.\n"
03863 ),
03864 GROUP( "Matrix" )));
03865
03866 wsv_data.push_back
03867 (WsvRecord
03868 ( NAME( "ybatch_calc_agenda" ),
03869 DESCRIPTION
03870 (
03871 "See agendas.cc.\n"
03872 ),
03873 GROUP( "Agenda" )));
03874
03875 wsv_data.push_back
03876 (WsvRecord
03877 ( NAME( "ybatch_index" ),
03878 DESCRIPTION
03879 (
03880 "Index of batch case.\n"
03881 "\n"
03882 "See further *ybatchCalc*.\n"
03883 "\n"
03884 "Usage: Set by *ybatchCalc*, for communication with\n"
03885 " *bach_update_agenda*.\n"
03886 ),
03887 GROUP( "Index" )));
03888
03889 wsv_data.push_back
03890 (WsvRecord
03891 ( NAME( "ybatch_n" ),
03892 DESCRIPTION
03893 (
03894 "Number of batch cases defined.\n"
03895 "\n"
03896 "See further *ybatchCalc*.\n"
03897 "\n"
03898 "Usage: Output from *batch_pre_agenda*.\n"
03899 ),
03900 GROUP( "Index" )));
03901
03902 wsv_data.push_back
03903 (WsvRecord
03904 ( NAME( "z_field" ),
03905 DESCRIPTION
03906 (
03907 "The field of geometrical altitudes.\n"
03908 "\n"
03909 "This variable gives the geometrical altitude, above the geoid, of\n"
03910 "each crossing of the pressure, latitude and longitude grids. For 1D\n"
03911 "cases the altitudes give the geometrical position of the pressure\n"
03912 "surfaces.\n"
03913 "\n"
03914 "For each geographical position (lat,lon), the values must be sorted\n"
03915 "in increasing order, with no repetitions. Otherwise the altitudes\n"
03916 "can be set to arbitrary values. Hydrostatic equilibrium is not\n"
03917 "applied automatically. If hydrostatic equilibrium applies, *z_field*\n"
03918 "must be set by a method ensuring that this criterium is fulfilled.\n"
03919 "\n"
03920 "The radius (from the coordinate centre) for a point between the grid\n"
03921 "crossings is obtained by a (multi-)linear interpolation of the sum\n"
03922 "of *r_geoid* and *z_field*.\n"
03923 "\n"
03924 "See further the ARTS user guide (AUG). Use the index to find where\n"
03925 "this variable is discussed. The variable is listed as a subentry to\n"
03926 "\"workspace variables\".\n"
03927 "\n"
03928 "Usage: Output of *AtmFieldsCalc*\n"
03929 "\n"
03930 "Unit: m\n"
03931 "\n"
03932 "Dimensions: [ p_grid, lat_grid, lon_grid ]\n"
03933 ),
03934 GROUP( "Tensor3" )));
03935
03936
03937
03938
03939
03940
03941
03942
03943
03944
03945 wsv_data.push_back
03946 (WsvRecord
03947 ( NAME( "z_field_raw" ),
03948 DESCRIPTION
03949 (
03950 "Raw data for geometrical altitudes.\n"
03951 "\n"
03952 "This variable gives the geometrical altitudes as stored in the \n"
03953 "database for atmospheric scenarios.\n"
03954 "\n"
03955 "See further the ARTS user guide (AUG). Use the index to find where\n"
03956 "this variable is discussed. The variable is listed as a subentry to\n"
03957 "\"workspace variables\".\n"
03958 "\n"
03959 "Usage: Set by the user by choosing a climatology.\n"
03960 "\n"
03961 "Unit: K\n"
03962 "\n"
03963 "Size GField3 \n "
03964 " [N_p] \n"
03965 " [N_lat] \n"
03966 " [N_lon] \n"
03967 " [N_p, N_lat, N_lon] \n"
03968 ),
03969 GROUP( "GField3" )));
03970
03971 wsv_data.push_back
03972 (WsvRecord
03973 ( NAME( "z_surface" ),
03974 DESCRIPTION
03975 (
03976 "The surface altitude.\n"
03977 "\n"
03978 "This variable defines the shape of the surface, by giving the\n"
03979 "geometrical altitude above the geiod for each crossing of the \n"
03980 "latitude and longitude grids. Any shape of the surface is accepted.\n"
03981 "No gap between the surface and the lowermost pressure level is \n"
03982 "allowed.\n"
03983 "\n"
03984 "The radius (from the coordinate centre) for a point between the grid\n"
03985 "crossings is obtained by a linear (1D) or bi-linear (2D) \n"
03986 "interpolation of the sum of *r_geoid* and *z_surface*. With other \n"
03987 "words, the radius for the surface is assumed to vary linear along \n"
03988 "the latitudes and longitudes in *lat_grid* and *lon_grid*.\n"
03989 "\n"
03990 "See further the ARTS user guide (AUG). Use the index to find where\n"
03991 "this variable is discussed. The variable is listed as a subentry to\n"
03992 "\"workspace variables\".\n"
03993 "\n"
03994 "Usage: Set by user.\n"
03995 "\n"
03996 "Unit: m\n"
03997 "\n"
03998 "Dimensions: [ lat_grid, lon_grid ]\n"
03999 ),
04000 GROUP( "Matrix" )));
04001
04002
04003
04004
04005
04006
04007
04008
04009
04010
04011
04012
04013
04014
04015
04016
04017
04018
04019
04020
04021
04022
04023
04024
04025
04026
04027
04028
04029
04030
04031
04032
04033
04034
04035
04036
04037
04038
04039
04040
04041
04042
04043
04044
04045
04046
04047
04048
04049
04050
04051
04052
04053
04054
04055
04056
04057
04058
04059
04060
04061
04062
04063
04064
04065
04066
04067
04068
04069
04070
04071
04072
04073
04074
04075
04076
04077
04078
04079
04080
04081
04082
04083
04084
04085
04086
04087
04088
04089
04090
04091
04092
04093
04094
04095
04096
04097
04098
04099 }
04100
04101 Index get_wsv_id(const String& name)
04102 {
04103 map<String, Index>::const_iterator it = Workspace::WsvMap.find (name);
04104 if (it == Workspace::WsvMap.end())
04105 return -1;
04106 else
04107 return it->second;
04108 }
04109