RHESSysCalibrator  2.1.0
Public Member Functions | Public Attributes | List of all members
rhessyscalibrator.calibration_parameters.CalibrationParametersProto Class Reference

Represents whether particular calibration parameters have been specified using boolean values. More...

Inheritance diagram for rhessyscalibrator.calibration_parameters.CalibrationParametersProto:
rhessyscalibrator.calibration_parameters.CalibrationParameters rhessyscalibrator.calibration_parameters.CalibrationParameters rhessyscalibrator.calibration_parameters.CalibrationParameters

Public Member Functions

def __init__
 
def parseParameterString (self, param_string)
 Parse parameter string for presence and range of all possible calibration parameters. More...
 
def setPresenceAndRangeForParameter (self, param_name, param_string)
 Parses param_string for presence and optionally range of parameter param_name. More...
 
def generateParameterValues (self)
 Generate random values for parameters specified as True. More...
 
def __init__
 
def parseParameterString (self, param_string)
 Parse parameter string for presence and range of all possible calibration parameters. More...
 
def setPresenceAndRangeForParameter (self, param_name, param_string)
 Parses param_string for presence and optionally range of parameter param_name. More...
 
def generateParameterValues (self)
 Generate random values for parameters specified as True. More...
 
def __init__
 
def parseParameterString (self, param_string)
 Parse parameter string for presence and range of all possible calibration parameters. More...
 
def setPresenceAndRangeForParameter (self, param_name, param_string)
 Parses param_string for presence and optionally range of parameter param_name. More...
 
def generateParameterValues (self)
 Generate random values for parameters specified as True. More...
 

Public Attributes

 s_for_sv
 
 s1
 
 s2
 
 s3
 
 sv1
 
 sv2
 
 gw1
 
 gw2
 
 vgsen1
 
 vgsen2
 
 vgsen3
 
 svalt1
 
 svalt2
 
 parameterRanges
 

Detailed Description

Represents whether particular calibration parameters have been specified using boolean values.

Constructor & Destructor Documentation

def rhessyscalibrator.calibration_parameters.CalibrationParametersProto.__init__ (   self,
  s_for_sv = False 
)
def rhessyscalibrator.calibration_parameters.CalibrationParametersProto.__init__ (   self,
  s_for_sv = False 
)
def rhessyscalibrator.calibration_parameters.CalibrationParametersProto.__init__ (   self,
  s_for_sv = False 
)

Member Function Documentation

def rhessyscalibrator.calibration_parameters.CalibrationParametersProto.generateParameterValues (   self)

Generate random values for parameters specified as True.

Note: Current implementation only supports the following parameters: s1, s2, s3, sv1, sv2, gw1, gw2, vgsen1, vgsen2, vgsen3, svalt1, svalt2

Returns
CalibrationParameters object containing random values for each enabled parameter.
def rhessyscalibrator.calibration_parameters.CalibrationParametersProto.generateParameterValues (   self)

Generate random values for parameters specified as True.

Note: Current implementation only supports the following parameters: s1, s2, s3, sv1, sv2, gw1, gw2, vgsen1, vgsen2, vgsen3, svalt1, svalt2

Returns
CalibrationParameters object containing random values for each enabled parameter.
def rhessyscalibrator.calibration_parameters.CalibrationParametersProto.generateParameterValues (   self)

Generate random values for parameters specified as True.

Note: Current implementation only supports the following parameters: s1, s2, s3, sv1, sv2, gw1, gw2, vgsen1, vgsen2, vgsen3, svalt1, svalt2

Returns
CalibrationParameters object containing random values for each enabled parameter.
def rhessyscalibrator.calibration_parameters.CalibrationParametersProto.parseParameterString (   self,
  param_string 
)

Parse parameter string for presence and range of all possible calibration parameters.

Parameters
param_stringString representing the list of parameters, and optionally ranges.
def rhessyscalibrator.calibration_parameters.CalibrationParametersProto.parseParameterString (   self,
  param_string 
)

Parse parameter string for presence and range of all possible calibration parameters.

Parameters
param_stringString representing the list of parameters, and optionally ranges.
def rhessyscalibrator.calibration_parameters.CalibrationParametersProto.parseParameterString (   self,
  param_string 
)

Parse parameter string for presence and range of all possible calibration parameters.

Parameters
param_stringString representing the list of parameters, and optionally ranges.
def rhessyscalibrator.calibration_parameters.CalibrationParametersProto.setPresenceAndRangeForParameter (   self,
  param_name,
  param_string 
)

Parses param_string for presence and optionally range of parameter param_name.

Parameters
param_nameString representing parameter name (e.g. 's1', 'gw1', etc.)
param_stringString representing the list of parameters, and optionally ranges.

Exception if param_name is not recognized Exception if ceiling of parameter range is not greater than the floor.

def rhessyscalibrator.calibration_parameters.CalibrationParametersProto.setPresenceAndRangeForParameter (   self,
  param_name,
  param_string 
)

Parses param_string for presence and optionally range of parameter param_name.

Parameters
param_nameString representing parameter name (e.g. 's1', 'gw1', etc.)
param_stringString representing the list of parameters, and optionally ranges.

Exception if param_name is not recognized Exception if ceiling of parameter range is not greater than the floor.

def rhessyscalibrator.calibration_parameters.CalibrationParametersProto.setPresenceAndRangeForParameter (   self,
  param_name,
  param_string 
)

Parses param_string for presence and optionally range of parameter param_name.

Parameters
param_nameString representing parameter name (e.g. 's1', 'gw1', etc.)
param_stringString representing the list of parameters, and optionally ranges.

Exception if param_name is not recognized Exception if ceiling of parameter range is not greater than the floor.

Member Data Documentation

rhessyscalibrator.calibration_parameters.CalibrationParametersProto.gw1
rhessyscalibrator.calibration_parameters.CalibrationParametersProto.gw2
rhessyscalibrator.calibration_parameters.CalibrationParametersProto.parameterRanges
rhessyscalibrator.calibration_parameters.CalibrationParametersProto.s1
rhessyscalibrator.calibration_parameters.CalibrationParametersProto.s2
rhessyscalibrator.calibration_parameters.CalibrationParametersProto.s3
rhessyscalibrator.calibration_parameters.CalibrationParametersProto.s_for_sv
rhessyscalibrator.calibration_parameters.CalibrationParametersProto.sv1
rhessyscalibrator.calibration_parameters.CalibrationParametersProto.sv2
rhessyscalibrator.calibration_parameters.CalibrationParametersProto.svalt1
rhessyscalibrator.calibration_parameters.CalibrationParametersProto.svalt2
rhessyscalibrator.calibration_parameters.CalibrationParametersProto.vgsen1
rhessyscalibrator.calibration_parameters.CalibrationParametersProto.vgsen2
rhessyscalibrator.calibration_parameters.CalibrationParametersProto.vgsen3

The documentation for this class was generated from the following file: