refs #6667 Minor changes to export parameter type

and substitution dictionary in DirectEnergyConversion

Code/Mantid/Framework/Geometry/inc/MantidGeometry/Instrument/Component.h

@@ -176,7 +176,7 @@ namespace Mantid
       }
 
       /**
-      * Get a parameter's type -- this is HACK untill Python can export property regardless of type properly
+      * Get a parameter's type -- this is HACK untill Python can export property regardless of the property type 
       * @param pname :: The name of the parameter
       * @param recursive :: If true the search will walk up through the parent components
       * @returns std::string describing parameter type or empty string if the type is not found

Code/Mantid/Framework/Geometry/test/ComponentTest.h

@@ -168,7 +168,7 @@ class ComponentTest : public CxxTest::TestSuite
     TS_ASSERT_EQUALS(ancs[0]->getName(), parent.getName());
     TS_ASSERT(ancs[0]->isParametrized());
 
-    std::string type=ancs[0]->getParameterType("Child");
+   // std::string type=ancs[0]->getParameterType("Child");
   }
 
   void testGetFullName()

Code/Mantid/instrument/MAPS_Parameters.xml

@@ -21,6 +21,7 @@
 </parameter>
 
 
+
 <!-- RunNumber to use for diag instead of the input run number if none - use input run -->
 <parameter name="mask_run" type="string">
    <value val="None"/>
@@ -235,11 +236,16 @@
    <value val=".spe"/>
 </parameter>
 
-
+<!-- If one wants to sum runs   -->  
 <parameter name="sum_runs"  type="bool">
    <value val="False"/>
 </parameter>
 
+<!-- # Run Detector Efficiency Correction -->
+<parameter name="apply_detector_eff"   type="bool">
+   <value val="True"/>
+</parameter>
+
 <!-- List of the words which can be used as a command line arguments to define reducer keywords
      the form is reducer_keword1=synonim1=synonim2=synonim3;reducer_keword1=synonim1a
      each synonims met in command line are converted into appropriate reducer keyword

Code/Mantid/scripts/Inelastic/DirectEnergyConversion.py

@@ -722,24 +722,24 @@ def setup_mtd_instrument(self, workspace = None):
             except:
                 self.instrument = None
                 raise RuntimeError('Cannot load instrument for prefix "%s"' % self.instr_name)
-            self.help();
-            #instr_pattern = os.path.join(idf_dir,self.instr_name + '*_Definition.xml')
-            #idf_files = glob.glob(instr_pattern)
-            #if len(idf_files) > 0:
-            #    tmp_ws_name = '__empty_' + self.instr_name
-            #    if not mtd.doesExist(tmp_ws_name):
-            #        LoadEmptyInstrument(Filename=idf_files[0],OutputWorkspace=tmp_ws_name)
-            #    self.instrument = mtd[tmp_ws_name].getInstrument()
-            #else:
-            #    self.instrument = None
-            #    raise RuntimeError('Cannot load instrument for prefix "%s"' % self.instr_name)
+
+       # set up default parameters values from instrName_Parameters.xml file   
+        par_names = self.instrument.getParameterNames()
+        for name in par_names:
+           setattr(self, name, self.get_default_parameter(name))
+
+        # build the dictionary of necessary allowed substitution names and substitute parameters with their values
+        self.build_subst_dictionary()
+
         # Initialise IDF parameters
         self.init_idf_params()
 
 
     def init_params(self):
         """
         Attach analysis arguments that are particular to the ElasticConversion 
+
+        specify some parameters which are not in IDF Parameters file
         """
         self.save_formats = ['.spe','.nxs','.nxspe']
         self.fix_ei=False
@@ -753,7 +753,7 @@ def init_params(self):
             self.normalise_method  = 'current'
         else:
             self.facility = str(config.getFacility())
-        
+
         # The Ei requested
         self.ei_requested = None
         self.monitor_workspace = None
@@ -779,14 +779,46 @@ def init_params(self):
 
         # Ki/Kf factor correction
         self.apply_kikf_correction = True
-    	
-    	# Detector calibration file
-    	self.det_cal_file = None
+
+        # Detector calibration file
+        self.det_cal_file = None
         # the workspace which contains already loaded detector calibration file and used to save time on multiple det_cal_file loadings
         self.det_cal_file_ws = None
         # Option to move detector positions based on the information
         self.relocate_dets = False
+
+        #The rmm of Vanadium is a constant, should not be instrument parameter. Atom not exposed to python :(
+        self.van_rmm = 50.9415#self.get_default_parameter("vanadium-rmm") 
+
 
+    def build_subst_dictionary(self) :
+        """Method to process the field "synonims" in the parameters string 
+
+           it takes string of synonyms in the form key1=subs1=subst2=subts3;key2=subst4 and returns the dictionary 
+           in the form dict[subs1]=key1 ; dict[subst2] = key1 ... dict[subst4]=key2
+        """
+        if not hasattr(self,'synonims') :  # nothing to do
+            return
+        if self.synonims == None : # nothing to do 
+            return
+        if type(self.synonims) == dict : # all done
+            return
+        if type(self.synonims) != str : 
+            raise AttributeError("The synonims fielf of Reducer object has to be special format string or the dictionary")
+        # we are in the right place and going to transform string into dictionary
+
+        subst_lines = self.synonims.split(";")
+        rez  = dict()
+        for lin in subst_lines :
+            lin=lin.strip()
+            keys = lin.split("=")
+            if len(keys)<2 :
+                raise AttributeError("The pairs in the synonims fields have to have form key1=key2=key3 with at least two values present")
+            for i in xrange(1,len(keys)) :
+                rez[keys[i]]=keys[0]
+
+        self.synonims = rez
+
     def init_idf_params(self):
         """
         Initialise the parameters from the IDF file if necessary
@@ -795,77 +827,44 @@ def init_idf_params(self):
             return
 
         self.ei_mon_spectra = [int(self.get_default_parameter("ei-mon1-spec")), int(self.get_default_parameter("ei-mon2-spec"))]
-        self.scale_factor = self.get_default_parameter("scale-factor")
-        self.wb_scale_factor = self.get_default_parameter("wb-scale-factor")
         self.wb_integr_range = [self.get_default_parameter("wb-integr-min"), self.get_default_parameter("wb-integr-max")]
-        self.mon1_norm_spec = int(self.get_default_parameter("norm-mon1-spec"))
         self.mon1_norm_range = [self.get_default_parameter("norm-mon1-min"), self.get_default_parameter("norm-mon1-max")]
         self.background_range = [self.get_default_parameter("bkgd-range-min"), self.get_default_parameter("bkgd-range-max")]
         self.monovan_integr_range = [self.get_default_parameter("monovan-integr-min"), self.get_default_parameter("monovan-integr-max")]
-        self.van_mass = self.get_default_parameter("vanadium-mass")
-        #The rmm of Vanadium is a constant, should not be instrument parameter. Atom not exposed to python :(
-        self.van_rmm = 50.9415#self.get_default_parameter("vanadium-rmm") 
-
-        # Diag 
-        self.diag_params = ['diag_tiny', 'diag_huge', 'diag_samp_zero', 'diag_samp_lo', 'diag_samp_hi','diag_samp_sig',\
-                            'diag_van_out_lo', 'diag_van_out_hi', 'diag_van_lo', 'diag_van_hi', 'diag_van_sig', 'diag_variation']
-        # Add an attribute for each of them
-        for par in self.diag_params:
-            setattr(self, par, self.get_default_parameter(par))
-
-        # Bleed options
-        try:
-            self.diag_bleed_test = self.get_default_parameter('diag_bleed_test')
-            self.diag_bleed_maxrate = self.get_default_parameter('diag_bleed_maxrate')
-            self.diag_bleed_pixels = int(self.get_default_parameter('diag_bleed_pixels'))
-            self.diag_params.extend(['diag_bleed_maxrate','diag_bleed_pixels'])
-        except ValueError:
-            self.diag_bleed_test = False
-        self.diag_params.append('diag_bleed_test')
-
+
+
         # Do we have specified spectra to diag over
         try:
             self.diag_spectra = self.instrument.getStringParameter("diag_spectra")[0]
         except Exception:
             self.diag_spectra = None
 
-        #par_names = self.instrument.getParameterNames()
-        #for name in par_names :
-        #    val,type = self.get_default_parameter_and_type(name)
-        #    if type != type(str) :
-        #        if not hasattr(self,name) :
-        #            setattr(self,name,val)
-
 
         # Mark IDF files as read
         self._idf_values_read = True
 
     def get_default_parameter(self, name):
-        if self.instrument is None:
+        instr = self.instrument;
+        if instr is None:
             raise ValueError("Cannot init default parameter, instrument has not been loaded.")
-        try :
-            values = self.instrument.getParameter(name)
-        except :
-            pass
-        if len(values) != 1:
-            raise ValueError('Instrument parameter file does not contain a definition for "%s". Cannot continue' % name)
-        return values[0]
-
-    def get_default_parameter_and_type(self,name):
-        """Returns tupe with default parameter value and default parameter type. Default parameters can be strings or values
-        """
-        if self.instrument is None:
-            raise ValueError("Cannot init default parameter, instrument has not been loaded.")
-
-        values = self.instrument.getParameter(name)
-        if len(values) != 1 :
-            values = self.instrument.getStringParameter(name)
-            if len(values) != 1 :
-                raise ValueError('Instrument parameter file does not contain a definition for "%s". Cannot continue' % name)
 
-        return (values,type(values))
-
-
+        type_name = instr.getParameterType(name)
+        if type_name == "bool":
+            val = instr.getBoolParameter(name)
+            return val[0]
+        elif type_name == "double":
+            val = instr.getNumberParameter(name)
+            return val[0]
+        elif type_name == "string":
+            val = instr.getStringParameter(name)
+            if val == "None" : 
+                return None
+            else :
+                return val[0]
+        else :
+            raise KeyError(" Can not find property with name "+name)
+
+
 
 
     def log(self, msg):
@@ -888,11 +887,11 @@ def help(self,keyword=None) :
             par_names = self.instrument.getParameterNames()
             print "****: ***************************************************************************** "
             print "****: There are ", len(par_names), " reduction parameters availible to change, namely: "
-            for i in xrange(0,len(par_names),1):
-                #print "****: {0}\t {1}\t {2}\t {3}\n".format(par_names[i],par_names[i+1],par_names[i+2],par_names[i+3]),
-                print par_names[i],
-                print  type(self.instrument.getParameterType(par_names[i])),
-                print  self.instrument.getParameterType(par_names[i])
+            for i in xrange(0,len(par_names),4):
+                print "****: {0}\t {1}\t {2}\t {3}\n".format(par_names[i],par_names[i+1],par_names[i+2],par_names[i+3]),
+                #print par_names[i],
+                #print  type(self.instrument.getParameterType(par_names[i])),
+                #print  self.instrument.getParameterType(par_names[i])
             print "****:" 
             print "****: type help(parameter_name) to get help on a parameter with  specified  name"
             print "****: ***************************************************************************** ";

Code/Mantid/scripts/Inelastic/dgreduce.py

@@ -3,6 +3,7 @@
 import time as time
 import numpy
 from mantid.simpleapi import *
+from mantid.kernel import funcreturns
 
 # the class which is responsible for data reduction
 global Reducer
@@ -121,7 +122,7 @@ def arb_units(wb_run,sample_run,ei_guess,rebin,map_file=None,**kwargs):
     # Deal with mandatory parameters
     print 'DGreduce run for ',inst_name,'run number ',sample_run
     try:
-        n,r=lhs('both')
+        n,r=funcreturns.lhs_info('both')
         wksp_out=r[0]
     except:
         if sample_run == 0:
@@ -140,7 +141,7 @@ def arb_units(wb_run,sample_run,ei_guess,rebin,map_file=None,**kwargs):
     # set rebinning range
     reducer.energy_bins = rebin
     if float(str.split(rebin,',')[2])>=float(ei_guess):
-        print 'error rebin range exceeds ei'
+        print 'Error: rebin max range {0} exceeds incident energy {1}'.format(str.split(rebin,',')[2],ei_guess)
         return
 
 
@@ -256,7 +257,6 @@ def get_failed_spectra_list(diag_workspace):
     masked in the given workspace
 
     Input:
-
      diag_workspace  -  A workspace containing masking
     """
     if type(diag_workspace) == str: