AddAbsorptionWeightedPathLengths.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2020 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 "MantidAlgorithms/SampleCorrections/IBeamProfile.h"
 
namespace Mantid {
namespace API {
class Sample;
}
namespace Geometry {
class Instrument;
}
namespace Algorithms {
 
class MANTID_ALGORITHMS_DLL AddAbsorptionWeightedPathLengths final : public API::Algorithm {
public:
  const std::string name() const override { return "AddAbsorptionWeightedPathLengths"; };
  const std::string summary() const override {
    return "Add absorption weighted path lengths to each peak in a peaks "
           "workspace.";
  }
 
  int version() const override { return 1; };
  const std::vector<std::string> seeAlso() const override {
    return {"MonteCarloAbsorption", "SetSample", "SaveReflections"};
  }
  const std::string category() const override { return "Crystal\\Peaks"; }
 
private:
  void init() override;
  void exec() override;
  std::map<std::string, std::string> validateInputs() override;
  std::unique_ptr<IBeamProfile> createBeamProfile(const Geometry::Instrument &instrument,
                                                  const API::Sample &sample) const;
};
 
} // namespace Algorithms
} // namespace Mantid