IQTransform.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2011 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 "MantidAlgorithms/DllConfig.h"
#include "MantidKernel/cow_ptr.h"
 
namespace Mantid {
namespace Kernel {
namespace Units {
class Label;
}
} // namespace Kernel
 
namespace Algorithms {
class MANTID_ALGORITHMS_DLL IQTransform final : public API::Algorithm {
public:
  IQTransform();
  const std::string name() const override { return "IQTransform"; }
  const std::string summary() const override {
    return "This algorithm provides various functions that are sometimes used "
           "to linearise the output of a 'SANS' data reduction prior to "
           "fitting it.";
  }
 
  int version() const override { return (1); }
  const std::string category() const override { return "SANS"; }
 
private:
  void init() override;
  void exec() override;
 
  inline API::MatrixWorkspace_sptr subtractBackgroundWS(const API::MatrixWorkspace_sptr &ws,
                                                        const API::MatrixWorkspace_sptr &background);
 
  using TransformFunc = void (IQTransform::*)(const API::MatrixWorkspace_sptr &);
  using TransformMap = std::map<std::string, TransformFunc>;
  TransformMap m_transforms; 
 
  std::shared_ptr<Kernel::Units::Label> m_label;
 
  // A function for each transformation
  void guinierSpheres(const API::MatrixWorkspace_sptr &ws);
  void guinierRods(const API::MatrixWorkspace_sptr &ws);
  void guinierSheets(const API::MatrixWorkspace_sptr &ws);
  void zimm(const API::MatrixWorkspace_sptr &ws);
  void debyeBueche(const API::MatrixWorkspace_sptr &ws);
  void kratky(const API::MatrixWorkspace_sptr &ws);
  void porod(const API::MatrixWorkspace_sptr &ws);
  void holtzer(const API::MatrixWorkspace_sptr &ws);
  void logLog(const API::MatrixWorkspace_sptr &ws);
  void general(const API::MatrixWorkspace_sptr &ws);
};
 
} // namespace Algorithms
} // namespace Mantid