LoadSpiceXML2DDet.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2015 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/ITableWorkspace_fwd.h"
#include "MantidAPI/MatrixWorkspace_fwd.h"
#include "MantidDataHandling/DllConfig.h"
 
namespace Mantid {
namespace DataHandling {
 
class SpiceXMLNode {
public:
  SpiceXMLNode(std::string nodename);
  void setParameters(const std::string &nodetype, const std::string &nodeunit, const std::string &nodedescription);
  void setValue(const std::string &strvalue);
 
  bool hasUnit() const;
  bool hasValue() const;
 
  bool isString() const;
  bool isInteger() const;
  bool isDouble() const;
 
  const std::string getName() const;
  const std::string getUnit() const;
  const std::string getDescription() const;
  const std::string getValue() const;
 
  std::string m_name;
  std::string m_value;
  std::string m_unit;
  char m_typechar;
  std::string m_typefullname;
  std::string m_description;
};
 
class MANTID_DATAHANDLING_DLL LoadSpiceXML2DDet final : public API::Algorithm {
public:
  LoadSpiceXML2DDet();
  ~LoadSpiceXML2DDet() override;
 
  const std::string name() const override;
 
  int version() const override;
  const std::vector<std::string> seeAlso() const override { return {"LoadSpice2D"}; }
 
  const std::string category() const override;
 
  const std::string summary() const override;
 
private:
  void init() override;
  void exec() override;
 
  void processInputs();
 
  API::MatrixWorkspace_sptr createMatrixWorkspace(const std::vector<unsigned int> &vec_counts);
  std::vector<unsigned int> binaryParseIntegers(std::string &binary_file_name);
 
  std::vector<SpiceXMLNode> xmlParseSpice(const std::string &xmlfilename);
 
  API::MatrixWorkspace_sptr xmlCreateMatrixWorkspaceKnownGeometry(const std::vector<SpiceXMLNode> &vecxmlnode,
                                                                  const size_t &numpixelx, const size_t &numpixely,
                                                                  const std::string &detnodename,
                                                                  const bool &loadinstrument);
 
  API::MatrixWorkspace_sptr xmlCreateMatrixWorkspaceUnknowGeometry(const std::vector<SpiceXMLNode> &vecxmlnode,
                                                                   const std::string &detnodename,
                                                                   const bool &loadinstrument);
 
  API::MatrixWorkspace_sptr xmlParseDetectorNode(const std::string &detvaluestr, bool loadinstrument,
                                                 double &max_counts);
 
  void setupSampleLogFromSpiceTable(const API::MatrixWorkspace_sptr &matrixws,
                                    const API::ITableWorkspace_sptr &spicetablews, int ptnumber);
 
  bool setupSampleLogs(const API::MatrixWorkspace_sptr &outws);
 
  void loadInstrument(const API::MatrixWorkspace_sptr &matrixws, const std::string &idffilename);
 
  bool getHB3AWavelength(const API::MatrixWorkspace_sptr &dataws, double &wavelength);
 
  void setXtoLabQ(const API::MatrixWorkspace_sptr &dataws, const double &wavelength);
 
  std::string m_detXMLFileName;
  std::string m_detXMLNodeName;
  size_t m_numPixelX;
  size_t m_numPixelY;
  bool m_loadInstrument;
  double m_detSampleDistanceShift;
  bool m_hasScanTable;
  int m_ptNumber4Log;
  std::string m_idfFileName;
  double m_userSpecifiedWaveLength;
  double m_detXShift;
  double m_detYShift;
};
 
} // namespace DataHandling
} // namespace Mantid