Add ability to copy-paste DRF eff. fact coefficients into DRF select tool.

Author: wcjohns

InterSpec/DetectorPeakResponse.h

@@ -63,80 +63,15 @@ namespace rapidxml
   template<class Ch> class xml_document;
 }//namespace rapidxml
 
-//Three expression evaluators have been tried; all have benefits and drawbacks.
-//  CLHEP/Evaluator: only added 21 kb to final binary size, but slowest option
-//  exprtk.hpp: added 5.3 Mb to final binary size, but 30x faster than CLHEP
-//  muparserx: adds 430 kb to binary size, and about 10x faster than CLHEP
-//
-// Since muparserx is what TerminalWidget uses, it was decided on 20180408 to
-// only use muparserx.
-
-//100000 evaluations of:
-//  exp(-343.6330974237 + 269.1023287277*log(x) + -83.8077567526*log(x)^2
-//  + 12.9980559362*log(x)^3 + -1.0068649823*log(x)^4 + 0.0311640084*log(x)^5)
-//  muparser x took:  cpu=0.143294s, wall=0.14341s  (1.4 us/eval)
-//  evaluator x took: cpu=1.10172s, wall=1.10209s   (11 us/eval)
+/** TODO:
+ - Add a "fixed" geometry option - then distances in like shielding/source display are not shown/used
+ - Add a "setback" option
+ */
+
 
 //Forward declarations
-namespace mup
-{
-  class Value;
-  class ParserX;
-}
+struct FormulaWrapper;
 
-struct FormulaWrapper
-{
-  /** Constructor that takes an equation as a string, and creates a callable
-   object to evaluate that equation.
-   
-   \param fcnstr The function to use.  Ex: "exp(-1.2 + 3*lox(x) + ...)"
-   \param isMeV Only used to determine which energy value to use to test if the
-   function is valid or not;  If isMeV is true, uses 0.1, else 100.
-   */
-  FormulaWrapper( const std::string &fcnstr, const bool isMev );
-  ~FormulaWrapper();
-  
-  float efficiency( const float x );
-  double operator()( const float x );
-  
-  /** Finds the variable the user most likely intended to be the energy variable
-   for detector response functions, by looking for arguments inside
-   paranthesis.
-   Returned answer is always lower case.  Spaces, tabs, and newlines are all
-   removed from input string before searching.
-   Returns "x" if it doesnt find any other candidates.
-   
-   e.x., assert(find_variable_name("exp(2.0*log(x) - 1.1*log(x)^2)") == "x");
-   assert(find_variable_name("exp(2.0*log(E) - 1.1*log(E)^2)") == "e");
-   assert(find_variable_name("3.2*exp(energy)") == "energy");
-   assert(find_variable_name("") == "x");
-   assert(find_variable_name("1-energy") == "x"); //no (...), so defaults to "x"
-   */
-  static std::string find_variable_name( std::string eqn );
-  
-  std::mutex m_mutex;
-  std::string m_fcnstr;
-  std::string m_var_name;
-  
-  std::unique_ptr<mup::ParserX> m_parser;
-  std::unique_ptr<mup::Value> m_value;
-};//struct FormulaWrapper
-
-
-/*
- //ToDo: Add table to database to track which DRF to use for a given detector
- //      model, or serial number,
- struct DrfToUsePreference
- {
- Wt::Dbo::ptr<InterSpecUser> user;
- long int / <DetectorPeakResponse>  //Dbo::weak_ptr<DetectorPeakResponse>
- enum MatchType{ MatchByDetectorModel, MatchBySerialNumber };
- MatchType match_type;
- string detector_dentifier;
- 
- //could add info such as detector name, or whatever
- }
- */
 
 class DetectorPeakResponse
 {
@@ -163,8 +98,6 @@ class DetectorPeakResponse
    std::cout << det.intrinsicEfficiency(700.0f) << std::endl;    //0.219004
    std::cout << det.intrinsicEfficiency(800.0f) << std::endl;    //0.197117
   */
-
-  
 
 public:
   enum ResolutionFnctForm
@@ -317,6 +250,16 @@ class DetectorPeakResponse
                                       const float lowerEnergy,
                                       const float upperEnergy );
 
+  /** Makes a callable funtion from the provided mathematical formula
+   
+   @param fcn Mathematical formula to evaluate.  Example: "exp( 1.2 + 3.2*ln(x) + -2.1*ln(x)^2 )"
+   @param isMeV Whether units are in MeV, or keV
+   
+   Throws exception if formula is invalid.
+   */
+  static std::function<float(float)> makeEfficiencyFunctionFromFormula( const std::string &formula,
+                                                                       const bool isMeV );
+  
   //fromGadrasDefinition(...): accepts the Efficiency.csv and Detector.dat
   //  files from GADRAS to define the detector.
   //Note that just the Detector.dat file contains enough info to define the
@@ -819,10 +762,11 @@ class DetectorPeakResponse
     if( (a.setsValue() || a.isSchema()) && m_efficiencyFormula.size() )
     {
       const bool isMeV = (m_efficiencyEnergyUnits > 10.0f);
+      
       try
       {
-        std::shared_ptr<FormulaWrapper> expression = std::make_shared<FormulaWrapper>(m_efficiencyFormula,isMeV);
-        m_efficiencyFcn = [expression](float a) -> float { return expression->efficiency(a); };
+        m_efficiencyFcn
+            = DetectorPeakResponse::makeEfficiencyFunctionFromFormula( m_efficiencyFormula, isMeV);
       }catch( std::exception & )
       {
         //In principle this shouldnt happen - in practice it might

InterSpec_resources/static_text/detector_edit_help.xml

@@ -271,7 +271,27 @@ everywhere else.
                         An example input formula could be:
                         <div style="color:grey;margin-left:10px;">exp(-343.63 + 269.10*log(x) -83.80*ln(x)^2 + 13.00*pow(log(x),3) -1.01*log(x)^4)</div>
                      </div>
-                     <div style="margin-top:10px;">
+
+                     <div style="margin-top:20px;">
+                        As a shortcut, for efficiencies of the form
+                          <div style="color:grey;margin-left:10px;">exp(C<sub>0</sub> + C<sub>1</sub>*log(x) + C<sub>2</sub>*log(x)^2 + ... )</div>
+                        you can enter just the coefficients, and when you click the <b>Set</b> button, the equation will be tranformed for you.  This is useful when copy-pasting the coefficients from a spreadsheet.  The numbers can be seperated by commas, spaces, tabs, newlines, or semi-colons.  For example, if you enter
+<code>
+<pre>
+    -9.811E+00
+    -7.99E-01
+    4.618E-02
+    2.81E-03
+    -1.9432E-02
+    0.000E+00
+    0.000E+00
+</pre>
+</code>
+Then once you click the <b>Set</b> button, the text will be transformed into:
+<div style="color:grey;margin-left:10px;">exp( -9.811E+00 + -7.99E-01*log(x) + 4.618E-02*log(x)^2 + 2.81E-03*log(x)^3 + -1.9432E-02*log(x)^4 )</div>
+                     </div>
+
+                     <div style="margin-top:20px;">
                         After a formula is entered you may <u>click</u> the <b>Set</b> button to display the
 function on the chart to ensure the function is reasonable; the y-axis
 of this chart will always be set to display form 0 to 1.

src/DetectorPeakResponse.cpp

@@ -244,6 +244,60 @@ namespace
 }//namespace
 
 
+/** Struct that a string formated equation for evaluation of efficiency.
+ 
+Three expression evaluators have been tried; all have benefits and drawbacks.
+  CLHEP/Evaluator: only added 21 kb to final binary size, but slowest option
+  exprtk.hpp: added 5.3 Mb to final binary size, but 30x faster than CLHEP
+  muparserx: adds 430 kb to binary size, and about 10x faster than CLHEP
+
+ Since muparserx is what TerminalWidget uses, it was decided on 20180408 to
+ only use muparserx.
+
+100000 evaluations of:
+  exp(-343.6330974237 + 269.1023287277*log(x) + -83.8077567526*log(x)^2
+  + 12.9980559362*log(x)^3 + -1.0068649823*log(x)^4 + 0.0311640084*log(x)^5)
+  muparser x took:  cpu=0.143294s, wall=0.14341s  (1.4 us/eval)
+  evaluator x took: cpu=1.10172s, wall=1.10209s   (11 us/eval)
+*/
+struct FormulaWrapper
+{
+  /** Constructor that takes an equation as a string, and creates a callable
+   object to evaluate that equation.
+   
+   \param fcnstr The function to use.  Ex: "exp(-1.2 + 3*lox(x) + ...)"
+   \param isMeV Only used to determine which energy value to use to test if the
+   function is valid or not;  If isMeV is true, uses 0.1, else 100.
+   */
+  FormulaWrapper( const std::string &fcnstr, const bool isMev );
+  ~FormulaWrapper();
+  
+  float efficiency( const float x );
+  double operator()( const float x );
+  
+  /** Finds the variable the user most likely intended to be the energy variable
+   for detector response functions, by looking for arguments inside
+   paranthesis.
+   Returned answer is always lower case.  Spaces, tabs, and newlines are all
+   removed from input string before searching.
+   Returns "x" if it doesnt find any other candidates.
+   
+   e.x., assert(find_variable_name("exp(2.0*log(x) - 1.1*log(x)^2)") == "x");
+   assert(find_variable_name("exp(2.0*log(E) - 1.1*log(E)^2)") == "e");
+   assert(find_variable_name("3.2*exp(energy)") == "energy");
+   assert(find_variable_name("") == "x");
+   assert(find_variable_name("1-energy") == "x"); //no (...), so defaults to "x"
+   */
+  static std::string find_variable_name( std::string eqn );
+  
+  std::mutex m_mutex;
+  std::string m_fcnstr;
+  std::string m_var_name;
+  
+  std::unique_ptr<mup::ParserX> m_parser;
+  std::unique_ptr<mup::Value> m_value;
+};//struct FormulaWrapper
+
 
 FormulaWrapper::FormulaWrapper( const std::string &fcnstr, const bool isMev )
   : m_fcnstr( fcnstr ), m_var_name( "x" )
@@ -821,6 +875,14 @@ void DetectorPeakResponse::setIntrinsicEfficiencyFormula( const string &fcnstr,
 }//void setIntrinsicEfficiencyFormula( const std::string &fcn )
 
 
+function<float(float)> DetectorPeakResponse::makeEfficiencyFunctionFromFormula(
+                                                                     const std::string &formula,
+                                                                     const bool isMeV )
+{
+  shared_ptr<FormulaWrapper> expression = make_shared<FormulaWrapper>( formula, isMeV );
+  return [expression](float a) -> float { return expression->efficiency(a); };
+}
+
 
 void DetectorPeakResponse::fromGadrasDefinition( std::istream &csvFile,
                                                  std::istream &detDatFile )

src/DrfSelect.cpp

@@ -3532,6 +3532,57 @@ void DrfSelect::setDefineDetector()
 //  }//if(...)
 
   string fcn = m_detectorManualFunctionText->text().narrow();
+  
+  // Check if someone is copy-pasting in coefficiecnts from a spreadsheet
+  //  We will allow space tab, comma, semicolon, newline seperators, but each entry
+  //  must be
+  vector<string> potential_coefs;
+  SpecUtils::split( potential_coefs, fcn, ",\t; \n\r" );
+  vector<double> potential_coef_values;
+  size_t last_non_zero_coef = 0;
+  try
+  {
+    for( size_t i = 0; i < potential_coefs.size(); ++i )
+    {
+      const string &txt = potential_coefs[i];
+      size_t idx = 0;
+      const double val = stod( txt, &idx ); //throws exception if invalid float
+      
+      // Dont accept inf, NaN, or allow trailing characters
+      if( IsInf(val) || IsNan(val) || (idx != txt.size()) )
+        throw exception();
+      potential_coef_values.push_back( val );
+      if( val != 0.0 )
+        last_non_zero_coef = i;
+    }//
+  }catch( std::exception & )
+  {
+    // If we're here, its an invalid double, or there where characters after the number
+    potential_coef_values.clear();
+  }//try catch to parse entered text as exactly a list of coefficecnts
+  
+  if( (potential_coef_values.size() > 1) && (last_non_zero_coef > 1) )
+  {
+    assert( potential_coefs.size() == potential_coef_values.size() );
+    assert( !potential_coefs.empty() && (last_non_zero_coef < potential_coefs.size()) );
+    
+    fcn = "";
+    
+    for( size_t i = 0; i < potential_coefs.size(); ++i )
+    {
+      if( potential_coef_values[i] == 0.0 )
+        continue;
+      
+      const string mfunc = (i > 0) ? "*log(x)" : "";
+      const string power = (i > 1) ? ("^" + to_string(i)) : string();
+      fcn += (fcn.empty() ? "exp( " : " + ") + potential_coefs[i] + mfunc + power;
+    }
+    fcn += fcn.empty() ? "" : " )";
+    
+    m_detectorManualFunctionText->setText( WString::fromUTF8(fcn) );
+  }//if( is_all_coeffs )
+  
+  
   const string name = m_detectorManualFunctionName->text().toUTF8();
   string descr = m_detectorManualDescription->text().toUTF8();
   if( descr.empty() )