CalculateEfficiency.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 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
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
#include "MantidAPI/MatrixWorkspace_fwd.h"
#include "MantidAlgorithms/DllConfig.h"
 
namespace Mantid {
namespace Algorithms {
class MANTID_ALGORITHMS_DLL CalculateEfficiency final : public API::Algorithm {
public:
  const std::string name() const override { return "CalculateEfficiency"; }
  const std::string summary() const override { return "Calculates the detector efficiency for a SANS instrument."; }
 
  int version() const override { return (1); }
  const std::string category() const override { return "SANS;CorrectionFunctions\\EfficiencyCorrections"; }
 
private:
  // Overridden Algorithm methods
  void init() override;
  void exec() override;
 
  void sumUnmaskedDetectors(const API::MatrixWorkspace_sptr &rebinnedWS, double &sum, double &error, int &nPixels);
 
  void normalizeDetectors(const API::MatrixWorkspace_sptr &rebinnedWS, const API::MatrixWorkspace_sptr &outputWS,
                          double sum, double error, int nPixels, double min_eff, double max_eff);
 
  void maskComponent(API::MatrixWorkspace &ws, const std::string &componentName);
  void maskEdges(const API::MatrixWorkspace_sptr &ws, int left, int right, int high, int low,
                 const std::string &componentName);
};
 
} // namespace Algorithms
} // namespace Mantid