__init__ ( self,  madDB=None )

__init__ initializes MadrigalParameters by getting some basic information from MadrigalDB.

Inputs: Existing MadrigalDB object, by default = None.

Returns: void

Affects: Initializes self.__binDir.

Exceptions: None.

__reorder (
        self,
        validList,
        sortedParmList,
        parmList,
        )

Private function that returns a new valid list sorted in the same parameter order as parmList.

__sortList ( self,  parmList )

Private function that returns a new list of parameters sorted as isprint sorts parameters.

getCategoryDict ( self,  parmList )

getCategoryDict returns a python dict with key = category index, item = category name and ordered parameters Inputs: parmList - the list of parameters (integers or mnemonics)

Returns: a python dict, with key = category index. Each item is a list of two items. The first item is the category name (string). The second item is a list of parameter mnemonics from parmList belonging in that category. Ordering is alphabetical, except that an error parameter immediately follows its non-error parameter.

Affects: None

Exceptions: none

getIsprintHeader ( self,  mnemonicList )

getIsprintHeader returns a string with mnemonics as it would appear at the top of isprint.

Inputs: mnemonic: a list of Madrigal mnemonics (string or integer)

Returns: a string with mnemonics as it would appear at the top of isprint

Affects: none

Exceptions: If any mnemonic not found.

getMadCategoryIndex ( self,  category )

getMadCategoryIndex returns the index (order) of a given category.

Inputs: a Madrigal category (string)

Returns: an integer representing the index (order). Returns -32767 if not found.

Affects: none

Exceptions: none

getMnemonicListFromExpression ( self,  expressionStr )

getMnemonicListFromExpression returns a list of unique cedar mnemonics in a python logical expression.

Inputs: expressionStr - a string containing a valid python logical expression with cedar mnemonics as variables. Expression can contain any python logical operator (and, or, not, ==, <, >, <=, >=, !=), any operator, any number, and valid python math function, and any variable that is a valid cedar mnemonic. A substring is assumed to be a cedar mnemonic if it begins with a letter, contains only alphanumerics, period, plus, or underscore, and is not immediately followed by a open parenthesis. Each potential cedar mnemonic is verified, and an exception is thrown if it is not valid. The validity of the entire expression is then verified by replacing all the valid cedar mnemonics by "1.0" and executing the resulting expression. If any exception besides divide by zero or value error occurs, an exception is thrown. Otherwise, the list of cedar mnemonics found is returned.

Returns: a list of unique cedar mnemonics (upper case).

Affects: None

Exceptions: Error thrown if any non-valid mnemonic found, or if expression throws an exception when run (except divide by zero or value error).

getParametersForInstruments (
        self,
        instrumentList,
        parmListName='Comprehensive',
        )

getParametersForInstruments returns a list of unique Madrigal mnemonics associated with a list of instruments.

This method's purpose is to return a list of parameters appropriate for a user to select from given that a certain list of instruments is under consideration. This method will return a list of all measured parameters found in data files associated with those instruments, and also all parameters in the parmNameList that can be derived from those measured parameters. The passed in parmNameList must be a valid name of a parameter list found in the madrigal.ui.web.MadrigalWebFormat class, and defaults to the "Comprehensive" list of parameters used in the madDataBrowse web page.

Inputs: instrumentList - a python list on instruments as integers (kinst values).

parmListName - a name (string) of a list of parameters in the MadrigalWebFormat class. Defaults to "Comprehensive"

Returns: an ordered list of unique Madrigal mnemonics.

Affects: None

Exceptions: None.

getParmCategory ( self,  parm )

getParmCategory returns a category (String) given a cedar parameter (integer or mnemonic string).

Inputs: a cedar code (integer)

Returns: a category string

Affects: none

Exceptions: none

getParmCodeFromMnemonic ( self,  mnemonic )

getParmCodeFromMnemonic converts a string to the cedar code (integer).

Inputs: mnemonic: the cedar mnemonic (string or integer in string form)

Returns: integer (cedar code)

Affects: none

Exceptions: MadrigalError thrown if code not found.

getParmDescription ( self,  parm )

getParmDescription returns a description including units and possible links (String) given a parameter (integer or mnemonic).

Inputs: a parameter (integer or mnemonic)

Returns: a description string including units and possible links

Affects: none

Exceptions: none

getParmDescriptionList ( self,  parmList )

getParmDescriptionList returns a list of descriptions (String) given a list of parameters (integer or mnemonic).

Inputs: a list of parameters (integer or mnemonic)

Returns: a list of descriptions (String) given a list of parameters (integer or mnemonic).

Affects: none

Exceptions: none

getParmFormat ( self,  mnemonic )

getParmFormat returns format string from parcods.tab of given mnemonic.

Inputs: mnemonic: the cedar mnemonic (string or integer)

Returns: format string from parcods.tab of given mnemonic

Affects: none

Exceptions: If mnemonic not found.

getParmMnemonic ( self,  code )

getParmMnemonic returns a mnemonic (String) given a parameter (integer or mnemonic).

Inputs: a parameter: integer, an integer in string form, or a mnemonic string

Returns: a mnemonic string. If integer not found, returns integer in string form.

Affects: none

Exceptions: none

getParmMnemonicList ( self,  codeList )

getParmMnemonicList returns a list of upper case mnemonics (String) given a list of cedar codes (integer, integer as string, or mnemonic string).

Inputs: a list of cedar codes (integer, integer as string, or mnemonic string)

Returns: a list of upper case mnemonics (String) given a list of cedar codes (integer). If illegal value, returns str(code) for that item

Affects: none

Exceptions: none

getParmScaleFactor ( self,  mnemonic )

getParmScaleFactor returns scale factor as double of given mnemonic.

Inputs: mnemonic: the cedar mnemonic (string or integer)

Returns: scale factor as double of given mnemonic

Affects: none

Exceptions: If mnemonic not found.

getParmType ( self,  mnemonic )

getParmType returns 1 if mnemonic is a standard parameter, 0 if an error parameter, or -1 if not found.

Inputs: mnemonic: the cedar mnemonic (string or integer in string form)

Returns: 1 if mnemonic is a standard parameter, 0 if an error parameter, or -1 if not found

Affects: none

Exceptions: If non-string passed in.

getParmUnits ( self,  parm )

getParmUnits returns units (String) given a parameter (integer or mnemonic).

Inputs: a parameter (integer or mnemonic)

Returns: units (String)

Affects: none

Exceptions: none

getSimpleParmDescription ( self,  parm )

getSimpleParmDescription returns a description without units or links (String) given a parameter (integer or mnemonic).

Inputs: a parameter (integer or mnemonic)

Returns: a description string without units or links

Affects: none

Exceptions: none

getStdExpression ( self,  expressionStr )

getStdExpression returns an expression in standard form (upper case mnemonic, all else lower case).

Inputs: expressionStr - a string containing a valid python logical expression with cedar mnemonics as variables. Expression can contain any python logical operator (and, or, not, ==, <, >, <=, >=, !=), any operator, any number, and valid python math function, and any variable that is a valid cedar mnemonic. A substring is assumed to be a cedar mnemonic if it begins with a letter, contains only alphanumerics, period, plus, or underscore, and is not immediately followed by a open parenthesis. Each potential cedar mnemonic is verified, and an exception is thrown if it is not valid.

Returns: an expression (string) in standard form (upper case mnemonic, all else lower case).

Affects: None

Exceptions: Error thrown if any non-valid mnemonic found.

hasAddIncrement ( self,  parm )

hasAddIncrement returns True if parm has additional increment parameter, False otherwise

Inputs: a parameter (integer or mnemonic)

Returns: True if parm has additional increment parameter, False otherwise

Affects: none

Exceptions: none

hasHtmlDesc ( self,  parm )

hasHtmlDesc returns 1 if that parameter has a html description in parmDesc.html.

Inputs: a Madrigal mnemonic (string) or parameter

Returns: 1 if that parameter has a html description in parmDesc.html, 0 if not

Affects: none

Exceptions: none

isAddIncrement ( self,  parm )

isAddIncrement returns True if parm is an additional increment parameter, False otherwise

Inputs: a parameter (integer or mnemonic)

Returns: True if parm is an additional increment parameter, False otherwise

Affects: none

Exceptions: none

isError ( self,  parm )

isError returns True if parm is an error parameter, False otherwise

Inputs: a parameter (integer or mnemonic)

Returns: True if parm is an error parameter, False otherwise

Affects: none

Exceptions: none

normalizeParmList ( self,  parmList )

normalizeParmList returns an ordered list of parameters with all mnemonics changed to integers.

Inputs: parmList - the list of parameters (integers or mnemonics) to convert

Returns: a new parmList that is ordered (negitive values are placed directly after the same positive values) and all parameters are converted to integers

Affects: None

Exceptions: none

orderParms ( self,  parmList )

orderParms sorts mnemonic parameters based on order in parcods.tab file.

Error parameters directly follow standard parameter.