NormaliseByDetector.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2012 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 "MantidAlgorithms/DllConfig.h"
#include "MantidGeometry/Instrument/Detector.h"
#include "MantidGeometry/Instrument/FitParameter.h"
#include <memory>
 
namespace Mantid {
 
namespace API {
class MatrixWorkspace;
class Progress;
} // namespace API
namespace Algorithms {
class MANTID_ALGORITHMS_DLL NormaliseByDetector final : public API::Algorithm {
public:
  NormaliseByDetector(bool parallelExecution = true);
 
  const std::string name() const override;
  const std::string summary() const override { return "Normalise the input workspace by the detector efficiency."; }
 
  int version() const override;
  const std::vector<std::string> seeAlso() const override { return {"Divide"}; }
  const std::string category() const override;
 
private:
  const bool m_parallelExecution;
  const Mantid::Geometry::FitParameter tryParseFunctionParameter(const Mantid::Geometry::Parameter_sptr &parameter,
                                                                 const Geometry::IDetector &det);
  std::shared_ptr<Mantid::API::MatrixWorkspace>
  processHistograms(const std::shared_ptr<Mantid::API::MatrixWorkspace> &inWS);
  void processHistogram(size_t wsIndex, const std::shared_ptr<const Mantid::API::MatrixWorkspace> &inWS,
                        const std::shared_ptr<Mantid::API::MatrixWorkspace> &denominatorWS,
                        Mantid::API::Progress &prog);
 
  void init() override;
  void exec() override;
};
 
} // namespace Algorithms
} // namespace Mantid