CalculateEfficiency2.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 "MantidAPI/WorkspaceGroup_fwd.h"
#include "MantidAlgorithms/DllConfig.h"
 
namespace {
struct SummedResults {
  double sum{0.0};
  double error{0.0};
  size_t nPixels{0};
};
} // namespace
 
namespace Mantid {
namespace Algorithms {
class MANTID_ALGORITHMS_DLL CalculateEfficiency2 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 (2); }
  const std::string category() const override { return "SANS;CorrectionFunctions\\EfficiencyCorrections"; }
 
private:
  // Overridden Algorithm methods
  void init() override;
  std::map<std::string, std::string> validateInputs() override;
  void exec() override;
  bool processGroups() override;
 
  API::MatrixWorkspace_sptr calculateEfficiency(const API::MatrixWorkspace_sptr &, double startProgress = 0.0,
                                                double stepProgress = 1.0);
 
  SummedResults sumUnmaskedAndDeadPixels(const API::MatrixWorkspace &workspace);
 
  void averageAndNormalizePixels(API::MatrixWorkspace &workspace, const SummedResults &results);
 
  API::MatrixWorkspace_sptr mergeGroup(API::WorkspaceGroup &);
  void validateGroupInput();
 
  double m_minThreshold{0.};
  double m_maxThreshold{2.};
};
 
} // namespace Algorithms
} // namespace Mantid