UnwrapSNS.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2008 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/DeprecatedAlgorithm.h"
#include "MantidAlgorithms/DllConfig.h"
#include "MantidDataObjects/EventWorkspace.h"
 
namespace Mantid {
namespace Algorithms {
class MANTID_ALGORITHMS_DLL UnwrapSNS final : public API::Algorithm, public API::DeprecatedAlgorithm {
public:
  UnwrapSNS();
  ~UnwrapSNS() override = default;
  const std::string name() const override { return "UnwrapSNS"; }
  const std::string summary() const override {
    return "Takes an input workspace that contains 'raw' data, unwraps the "
           "data according to the reference flightpath provided and converts "
           "the units to wavelength. The output workspace will have common "
           "bins in the maximum theoretical wavelength range.";
  }
 
  int version() const override { return 1; }
 
  const std::string category() const override { return "CorrectionFunctions\\InstrumentCorrections"; }
 
private:
  void init() override;
  void exec() override;
  void execEvent();
  void runMaskDetectors();
 
  int unwrapX(const Mantid::HistogramData::HistogramX &, std::vector<double> &dataout, const double &Ld);
  void getTofRangeData(const bool);
  double m_conversionConstant; 
  API::MatrixWorkspace_const_sptr m_inputWS;          
  DataObjects::EventWorkspace_const_sptr m_inputEvWS; 
  double m_LRef;                                      
  double m_Tmin;                                      
  double m_Tmax;                                      
  double m_frameWidth;                                
  int m_numberOfSpectra;                              
  int m_XSize;                                        
  std::unique_ptr<API::Progress> m_progress;
};
 
} // namespace Algorithms
} // namespace Mantid