DetectorEfficiencyCorUser.h

#ifndef MANTID_ALGORITHMS_DETECTOREFFICIENCYCORUSER_H_
#define MANTID_ALGORITHMS_DETECTOREFFICIENCYCORUSER_H_

#include "MantidAPI/Algorithm.h"
#include "MantidKernel/cow_ptr.h"

namespace Mantid {

namespace HistogramData {
class Histogram;
class Points;
}

namespace Algorithms {

/** DetectorEfficiencyCorUser :

 This algorithm will calculate the detector efficiency according to the ILL INX
 program for time-of-flight
 data reduction.

 Formula_eff must be defined in the instrument parameters file.


 Copyright © 2013 ISIS Rutherford Appleton Laboratory, NScD Oak Ridge
 National Laboratory & European Spallation Source

 This file is part of Mantid.

 Mantid is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation; either version 3 of the License, or
 (at your option) any later version.

 Mantid is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.

 File change history is stored at: <https://github.com/mantidproject/mantid>
 Code Documentation is available at: <http://doxygen.mantidproject.org>
 */
class DLLExport DetectorEfficiencyCorUser : public API::Algorithm {
public:
  const std::string name() const override;
  /// Summary of algorithms purpose
  const std::string summary() const override {
    return "Corrects for detector efficiency. The correction factor is "
           "calculated using an instrument specific formula as a function "
           "of the final neutron energy E_f=E_i-E. Note that the formula "
           "is implemented only for a limited number of TOF instruments.";
  }

  int version() const override;
  const std::string category() const override;

private:
  void init() override;
  void exec() override;
  void retrieveProperties();
  double calculateFormulaValue(const std::string &formula, double energy);
  MantidVec calculateEfficiency(double eff0, const std::string &formula,
                                const HistogramData::Points &xIn);

  std::string getValFromInstrumentDef(const std::string &parameterName);

  HistogramData::Histogram
  applyDetEfficiency(const size_t nChans, const Mantid::MantidVec &effVec,
                     const HistogramData::Histogram &histogram);

  /// The user selected (input) workspace
  API::MatrixWorkspace_const_sptr m_inputWS;
  /// The output workspace, maybe the same as the input one
  API::MatrixWorkspace_sptr m_outputWS;
  /// stores the user selected value for incidient energy of the neutrons
  double m_Ei = 0.0;
};

} // namespace Algorithms
} // namespace Mantid

#endif /* MANTID_ALGORITHMS_DETECTOREFFICIENCYCORUSER_H_ */