UpdateInstrumentFromFile.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2011 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 "MantidDataHandling/DllConfig.h"
#include "MantidGeometry/IDetector.h"
 
namespace NeXus {
class File;
}
 
namespace Mantid {
namespace Geometry {
class DetectorInfo;
class Instrument;
} // namespace Geometry
 
namespace DataHandling {
class MANTID_DATAHANDLING_DLL UpdateInstrumentFromFile final : public API::Algorithm {
public:
  UpdateInstrumentFromFile();
  const std::string name() const override { return "UpdateInstrumentFromFile"; }
  const std::string summary() const override {
    return "Updates detector positions initially loaded in from the Instrument "
           "Definition File (IDF) with information from the provided file.";
  }
 
  const std::string alias() const override { return "UpdateInstrumentFromRaw"; }
 
  int version() const override { return 1; };
  const std::vector<std::string> seeAlso() const override { return {"LoadInstrument"}; }
 
  const std::string category() const override { return "DataHandling\\Instrument;DataHandling\\Raw"; }
 
private:
  void init() override;
  void exec() override;
 
  void updateFromRaw(const std::string &filename);
  void updateFromNeXus(::NeXus::File &nxFile);
  void updateFromAscii(const std::string &filename);
 
  struct AsciiFileHeader {
    AsciiFileHeader()
        : colCount(0), rColIdx(0), thetaColIdx(0), phiColIdx(0) {} // Zero is invalid as this is reserved for detID
 
    size_t colCount;
    size_t rColIdx, thetaColIdx, phiColIdx;
    std::set<size_t> detParCols;
    std::map<size_t, std::string> colToName;
  };
 
  bool parseAsciiHeader(AsciiFileHeader &headerInfo);
  void setDetectorPositions(const std::vector<int32_t> &detID, const std::vector<float> &l2,
                            const std::vector<float> &theta, const std::vector<float> &phi);
  void setDetectorPosition(Geometry::DetectorInfo &detectorInfo, const size_t index, const float l2, const float theta,
                           const float phi);
 
  API::MatrixWorkspace_sptr m_workspace;
 
  bool m_ignorePhi;
  bool m_ignoreMonitors;
};
 
} // namespace DataHandling
} // namespace Mantid