FLEXPART Testing Environment CTBTO WO8
 All Classes Namespaces Files Functions Variables Pages
Public Member Functions | Private Attributes | Static Private Attributes | List of all members
flextest.OutputCompare.OutputCompare Class Reference
Inheritance diagram for flextest.OutputCompare.OutputCompare:
Inheritance graph
[legend]
Collaboration diagram for flextest.OutputCompare.OutputCompare:
Collaboration graph
[legend]

Public Member Functions

def __init__
 
def query_test_types
 
def calculate_test_minus_control
 

Private Attributes

 _output_dir
 
 _control_output_dir
 

Static Private Attributes

list _VALID_TESTS
 

Detailed Description

Definition at line 19 of file OutputCompare.py.

Constructor & Destructor Documentation

def flextest.OutputCompare.OutputCompare.__init__ (   self,
  output_dir = None,
  control_output_dir = None 
)

Definition at line 31 of file OutputCompare.py.

31 
32  def __init__(self, output_dir=None, control_output_dir=None):
33 
34  if output_dir:
35  if os.path.isdir(output_dir):
36  self._output_dir = output_dir
37  else:
38  raise Exception('Unable to find output_dir: ' + output_dir)
39  else:
40  raise Exception('No output_dir defined')
41 
42  if control_output_dir:
43  if os.path.isdir(control_output_dir):
44  self._control_output_dir = control_output_dir
45  else:
46  raise Exception('Unable to find control_output_dir: ' + control_output_dir)
47  else:
48  raise Exception('No control_output_dir defined')
49 
50 
51 

Member Function Documentation

def flextest.OutputCompare.OutputCompare.calculate_test_minus_control (   self,
  test_type = None 
)

Definition at line 58 of file OutputCompare.py.

58 
59  def calculate_test_minus_control(self, test_type=None):
60 
61 
62  if test_type not in self._VALID_TESTS:
63  raise Exception('Invalid test_type: ' + str(test_type))
64 
65  else:
66 
67  if test_type in ['nest_all_vars_rmse', 'nest_all_vars_maxabserr']:
68  nest = True
69  else:
70  nest = False
71 
72 
73  # Create FlexpartOutput objects
74  control_output = FlexpartOutput.FlexpartOutput(
75  output_dir=self._control_output_dir,
76  nest=nest)
77  test_output = FlexpartOutput.FlexpartOutput(
78  output_dir=self._output_dir,
79  nest=nest)
80  # Create FlexpartError object
81  error_object = FlexpartErrors.FlexpartErrors(control=control_output,
82  test=test_output)
83 
84 
85  # Select and perform the test, returning the error
86 
87  if test_type in ['mother_all_vars_rmse', 'nest_all_vars_rmse']:
88  err_val = error_object.rmse()
89  elif test_type in ['mother_all_vars_maxabserr', 'nest_all_vars_maxabserr']:
90  err_val = error_object.max_absolute_error()
91  else:
92  err_val = None
93 
94  return err_val
def flextest.OutputCompare.OutputCompare.query_test_types (   self) 
Return list of the valid test types

Definition at line 52 of file OutputCompare.py.

52 
53  def query_test_types(self):
54 
55  """ Return list of the valid test types """
56  return self._VALID_TESTS
57 

Member Data Documentation

flextest.OutputCompare.OutputCompare._control_output_dir
private

Definition at line 43 of file OutputCompare.py.

flextest.OutputCompare.OutputCompare._output_dir
private

Definition at line 35 of file OutputCompare.py.

list flextest.OutputCompare.OutputCompare._VALID_TESTS
staticprivate
Initial value:
1 = [
2  'mother_all_vars_rmse',
3  'nest_all_vars_rmse',
4  'mother_all_vars_maxabserr',
5  'nest_all_vars_maxabserr'
6  ]

Definition at line 23 of file OutputCompare.py.

The documentation for this class was generated from the following file:
Generated on Sun Mar 27 2016 01:16:02 for FLEXPART Testing Environment CTBTO WO8 by   doxygen 1.8.6