NormaliseByPeakArea.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2013 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
#include "MantidAPI/Algorithm.h"
#include "MantidCurveFitting/DllConfig.h"
#include "MantidKernel/System.h"
#include "MantidKernel/cow_ptr.h"
 
namespace Mantid {
 
namespace HistogramData {
class HistogramY;
class HistogramE;
} // namespace HistogramData
 
namespace CurveFitting {
namespace Algorithms {
 
class MANTID_CURVEFITTING_DLL NormaliseByPeakArea final : public API::Algorithm {
public:
  NormaliseByPeakArea();
 
  const std::string name() const override;
  const std::string summary() const override {
    return "Normalises the input data by the area of of peak defined by the "
           "input mass value.";
  }
 
  const std::vector<std::string> seeAlso() const override { return {"MonitorEfficiencyCorUser", "Divide"}; }
 
  int version() const override;
  const std::string category() const override;
 
private:
  void init() override;
  void exec() override;
 
  void retrieveInputs();
  void createOutputWorkspaces(const API::MatrixWorkspace_sptr &yspaceIn);
  void setUnitsToMomentum(const API::MatrixWorkspace_sptr &workspace);
 
  API::MatrixWorkspace_sptr convertInputToY();
  double fitToMassPeak(const API::MatrixWorkspace_sptr &yspace, const size_t index);
  void normaliseTOFData(const double area, const size_t index);
  void saveToOutput(const API::MatrixWorkspace_sptr &accumWS, const Kernel::cow_ptr<HistogramData::HistogramY> &yValues,
                    const Kernel::cow_ptr<HistogramData::HistogramE> &eValues, const size_t index);
  void symmetriseYSpace();
 
  API::MatrixWorkspace_sptr m_inputWS;
  double m_mass;
  bool m_sumResults;
  API::MatrixWorkspace_sptr m_normalisedWS;
  API::MatrixWorkspace_sptr m_yspaceWS;
  API::MatrixWorkspace_sptr m_fittedWS;
  API::MatrixWorkspace_sptr m_symmetrisedWS;
 
  std::unique_ptr<API::Progress> m_progress;
};
 
} // namespace Algorithms
} // namespace CurveFitting
} // namespace Mantid