CalculateTransmission.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 Algorithms {
class MANTID_ALGORITHMS_DLL CalculateTransmission : public API::ParallelAlgorithm {
public:
  const std::string name() const override { return "CalculateTransmission"; }
  const std::string summary() const override {
    return "Calculates the transmission correction, as a function of "
           "wavelength, for a SANS instrument.";
  }
 
  int version() const override { return (1); }
  const std::vector<std::string> seeAlso() const override {
    return {"CalculateTransmissionBeamSpreader", "ApplyTransmissionCorrection"};
  }
  const std::string category() const override { return "SANS;CorrectionFunctions\\TransmissionCorrections"; }
 
private:
  mutable double m_done{0.0};
 
  void init() override;
  void exec() override;
 
  API::MatrixWorkspace_sptr extractSpectra(const API::MatrixWorkspace_sptr &ws, const std::vector<size_t> &indices);
  API::MatrixWorkspace_sptr fit(const API::MatrixWorkspace_sptr &raw, const std::vector<double> &rebinParams,
                                const std::string &fitMethod);
  API::MatrixWorkspace_sptr fitData(const API::MatrixWorkspace_sptr &WS, double &grad, double &offset);
  API::MatrixWorkspace_sptr fitPolynomial(const API::MatrixWorkspace_sptr &WS, int order,
                                          std::vector<double> &coeficients);
  API::MatrixWorkspace_sptr rebin(const std::vector<double> &binParams, const API::MatrixWorkspace_sptr &ws);
  void logIfNotMonitor(const API::MatrixWorkspace_sptr &sampleWS, const API::MatrixWorkspace_sptr &directWS,
                       size_t index);
};
 
} // namespace Algorithms
} // namespace Mantid