Table of Contents

Module: getParameters getParameters.py

getParameters.py is a script run to return a text output of parameter information for a given file.

It is presently used by the madmatlab methods getParameters, and via the cgi script getParametersService.py the madmatlab method getParametersWeb. It has the following input argument:

--filename=<full path to data file>

Returns backslash-delimited data, one for each parameter either measured or derivable, with the following fields:

  1. parameter.mnemonic (string) Example dti

  2. parameter.description (string) Example: "F10.7 Multiday average observed (Ott)"

  3. parameter.isError (int) 1 if error parameter, 0 if not

  4. parameter.units (string) Example "W/m2/Hz"

  5. parameter.isMeasured (int) 1 if measured, 0 if derivable

  6. parameter.category (string) Example: "Time Related Parameter"

  7. parameter.isSure (int) - 1 if parameter can be found for every record, 0 if can only be found for some

  8. parameter.isAddIncrement - 1 if additional increment, 0 if normal (Added in Madrigal 2.5)

Returns empty string if filename not found, and returns status -1.

Uses backslash-delimited since some strings contain commas.

This script, and the corresponding cgi script getParametersService.py are available to any scripting language that wants to access Madrigal parameter info.


Table of Contents

This document was automatically generated on Mon Aug 9 13:30:39 2010 by HappyDoc version r1_5