LoadSpice2D.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 LoadSpice2D : public API::IFileLoader<Kernel::FileDescriptor> {
public:
  const std::string name() const override { return "LoadSpice2D"; }
  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"; }
  static const int nMonitors = 2;
 
  int confidence(Kernel::FileDescriptor &descriptor) const override;
 
private:
  void init() override;
  void exec() override;
 
  void throwException(Poco::XML::Element const *elem, const std::string &name, const std::string &fileName);
  void runLoadInstrument(const std::string &inst_name, const DataObjects::Workspace2D_sptr &localWorkspace);
 
  void setInputPropertiesAsMemberProperties();
 
  void addMetadataAsRunProperties(const std::map<std::string, std::string> &);
  std::pair<int, int> parseDetectorDimensions(const std::string &);
  void createWorkspace();
  std::vector<int> getData(const std::string &);
  void createWorkspace(const std::vector<int> &data, const std::string &title, double monitor1_counts,
                       double monitor2_counts);
  void setWavelength(std::map<std::string, std::string> &metadata);
  template <class T>
  T addRunProperty(std::map<std::string, std::string> &metadata, const std::string &oldName, const std::string &newName,
                   const std::string &units = "");
  template <class T> void addRunProperty(const std::string &name, const T &value, const std::string &units = "");
  void setBeamTrapRunProperty(std::map<std::string, std::string> &metadata);
  void detectorDistance(std::map<std::string, std::string> &metadata);
  void detectorTranslation(std::map<std::string, std::string> &metadata);
  void setMetadataAsRunProperties(std::map<std::string, std::string> &metadata);
  void rotateDetector(const double &);
  void setTimes();
  void setSansSpiceXmlFormatVersion(std::map<std::string, std::string> &metadata);
 
  // Member variables:
  DataObjects::Workspace2D_sptr m_workspace;
  double m_wavelength_input{0.0};
  double m_wavelength_spread_input{0.0};
  Mantid::DataHandling::XmlHandler m_xmlHandler;
  double m_wavelength{0.0};
  double m_dwavelength{0.0};
  double m_sansSpiceXmlFormatVersion{0.0};
  Mantid::Types::Core::DateAndTime m_startTime;
  Mantid::Types::Core::DateAndTime m_endTime;
};
} // namespace DataHandling
} // namespace Mantid