CalculateFlatBackground.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2009 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/ParallelAlgorithm.h"
#include "MantidAlgorithms/DllConfig.h"
 
namespace Mantid {
namespace HistogramData {
class Histogram;
}
namespace Algorithms {
class MANTID_ALGORITHMS_DLL CalculateFlatBackground : public API::ParallelAlgorithm {
public:
  const std::string name() const override { return "CalculateFlatBackground"; }
  const std::string summary() const override { return "Finds a constant background value of each desired histogram."; }
 
  int version() const override { return (1); }
  const std::string category() const override { return "SANS;CorrectionFunctions\\BackgroundCorrections"; }
 
private:
  void init() override;
  void exec() override;
 
  void convertToDistribution(API::MatrixWorkspace_sptr workspace);
  void restoreDistributionState(API::MatrixWorkspace_sptr workspace);
  void checkRange(double &startX, double &endX);
  void Mean(const HistogramData::Histogram &histogram, double &background, double &variance, const double startX,
            const double endX) const;
  void LinearFit(const HistogramData::Histogram &histogram, double &background, double &variance, const double startX,
                 const double endX);
  void MovingAverage(const HistogramData::Histogram &histogram, double &background, double &variance,
                     const size_t windowWidth) const;
 
  std::unique_ptr<API::Progress> m_progress = nullptr;
};
 
} // namespace Algorithms
} // namespace Mantid