LoadRKH.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2009 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/IFileLoader.h"
#include "MantidDataHandling/DllConfig.h"
#include "MantidHistogramData/Histogram.h"
#include "MantidKernel/FileDescriptor.h"
#include "MantidKernel/cow_ptr.h"
 
#include <fstream>
 
namespace Mantid {
namespace DataHandling {
class MANTID_DATAHANDLING_DLL LoadRKH : public API::IFileLoader<Kernel::FileDescriptor> {
public:
  const std::string name() const override { return "LoadRKH"; }
  const std::string summary() const override { return "Load a file written in the RKH format"; }
 
  int version() const override { return (1); }
  const std::vector<std::string> seeAlso() const override { return {"SaveRKH"}; }
  const std::string category() const override { return "DataHandling\\Text;SANS\\DataHandling"; }
 
  int confidence(Kernel::FileDescriptor &descriptor) const override;
 
private:
  std::unordered_set<std::string> m_unitKeys;
  std::unordered_set<std::string> m_RKHKeys;
  std::ifstream m_fileIn;
 
  // Initialisation code
  void init() override;
  // Execution code
  void exec() override;
 
  bool is2D(const std::string &testLine);
  const API::MatrixWorkspace_sptr read1D();
  const API::MatrixWorkspace_sptr read2D(const std::string &firstLine);
  API::Progress read2DHeader(const std::string &initalLine, API::MatrixWorkspace_sptr &outWrksp, MantidVec &axis0Data);
  const std::string readUnit(const std::string &line);
  void readNumEntrys(const int nEntries, MantidVec &output);
  void binCenter(const MantidVec &oldBoundaries, MantidVec &toCenter) const;
 
  // Remove lines from an input stream
  void skipLines(std::istream &strm, int nlines);
 
  bool hasXerror(std::ifstream &stream);
 
  void readLinesForRKH1D(std::istream &stream, int readStart, int readEnd, HistogramData::Points &x,
                         HistogramData::Counts &y, HistogramData::CountStandardDeviations &ye,
                         HistogramData::PointStandardDeviations &xe, API::Progress &prog, bool readXError = false);
};
} // namespace DataHandling
} // namespace Mantid