LoadHFIRSANS.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 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/IFileLoader.h"
#include "MantidDataHandling/XmlHandler.h"
#include "MantidDataObjects/Workspace2D.h"
#include "MantidKernel/DateAndTime.h"
#include "MantidKernel/FileDescriptor.h"
 
#include <map>
#include <string>
#include <utility>
#include <vector>
 
namespace Poco {
namespace XML {
class Element;
}
} // namespace Poco
 
namespace Mantid {
namespace DataHandling {
class MANTID_DATAHANDLING_DLL LoadHFIRSANS : public API::IFileLoader<Kernel::FileDescriptor> {
 
public:
  LoadHFIRSANS();
  const std::string name() const override { return "LoadHFIRSANS"; }
  const std::string summary() const override {
    return "Loads a SANS data file produce by the HFIR instruments at ORNL. "
           "The instrument geometry is also loaded. The center of the detector "
           "is placed at (0,0,D), where D is the sample-to-detector distance.";
  }
 
  int version() const override { return 1; }
  const std::vector<std::string> seeAlso() const override { return {"LoadSpiceAscii", "LoadSpiceXML2DDet"}; }
  const std::string category() const override { return "DataHandling\\Text;SANS\\DataHandling"; }
 
  int confidence(Kernel::FileDescriptor &descriptor) const override;
 
  int getNumberOfMonitors() const { return m_nMonitors; }
 
private:
  void init() override;
  void exec() override;
 
  void setInputFileAsHandler();
  void setSansSpiceXmlFormatVersion();
  void setTimes();
  void setWavelength();
 
  std::pair<int, int> parseDetectorDimensions(const std::string &dims_str);
  std::vector<int> readData(const std::string &dataXpath = "//Data");
  void permuteTubes(std::vector<int> &data);
 
  void storeValue(int specID, double value, double error, double wavelength, double dwavelength);
  void createWorkspace();
  template <class T> void addRunProperty(const std::string &name, const T &value, const std::string &units = "");
  template <class T> void addRunTimeSeriesProperty(const std::string &name, const T &value);
  void setBeamTrapRunProperty();
  void storeMetaDataIntoWS();
  void runLoadInstrument();
  void rotateDetector();
  void setDetectorDistance();
  void moveDetector();
  std::string getInstrumentStringParameter(const std::string &parameter);
  double getInstrumentDoubleParameter(const std::string &parameter);
  double getSourceToSampleDistance();
  void setBeamDiameter();
 
  /* constants */
  static const int m_nMonitors = 2;
  // when parsing the metadata ignore those tags
  const std::vector<std::string> m_tags_to_ignore{"Detector", "DetectorWing"};
 
  Mantid::DataHandling::XmlHandler m_xmlHandler;
  DataObjects::Workspace2D_sptr m_workspace;
  std::map<std::string, std::string> m_metadata;
 
  double m_sansSpiceXmlFormatVersion;
  double m_wavelength;
  double m_dwavelength;
  double m_sampleDetectorDistance;
  Mantid::Types::Core::DateAndTime m_startTime;
  Mantid::Types::Core::DateAndTime m_endTime;
};
} // namespace DataHandling
} // namespace Mantid