GetDetectorOffsets.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/Algorithm.h"
#include "MantidAPI/IFunction.h"
#include "MantidAlgorithms/DllConfig.h"
#include "MantidDataObjects/OffsetsWorkspace.h"
 
namespace Mantid {
namespace Algorithms {
class MANTID_ALGORITHMS_DLL GetDetectorOffsets final : public API::Algorithm {
 
  enum class offset_mode : int { signed_offset, relative_offset, absolute_offset };
 
public:
  const std::string name() const override { return "GetDetectorOffsets"; }
  const std::string summary() const override {
    return "Creates an OffsetsWorkspace containing offsets for each detector. "
           "You can then save these to a .cal file using SaveCalFile.";
  }
 
  int version() const override { return 1; }
  const std::vector<std::string> seeAlso() const override { return {"AlignComponents"}; }
  const std::string category() const override { return "Diffraction\\Calibration"; }
 
private:
  // Overridden Algorithm methods
  void init() override;
  std::map<std::string, std::string> validateInputs() override;
  void exec() override;
  double fitSpectra(const int64_t s);
  API::IFunction_sptr createFunction(const double peakHeight, const double peakLoc);
  void retrieveProperties();
 
  API::MatrixWorkspace_sptr inputW;           
  DataObjects::OffsetsWorkspace_sptr outputW; 
  double m_Xmin = DBL_MAX;                    
  double m_Xmax = -DBL_MIN;                   
  double m_maxOffset = 0.0;                   
  double m_dreference = 0.0;                  
  offset_mode mode;
  double m_dideal = 0.0; 
  double m_step = 0.0;        
  bool m_estimateFWHM = true; 
};
} // namespace Algorithms
} // namespace Mantid