LoadAscii2.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2007 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 "MantidAPI/MatrixWorkspace_fwd.h"
#include "MantidDataHandling/DllConfig.h"
#include "MantidDataObjects/Histogram1D.h"
#include "MantidKernel/FileDescriptor.h"
 
#include <list>
 
namespace Mantid {
namespace DataHandling {
class MANTID_DATAHANDLING_DLL LoadAscii2 : public API::IFileLoader<Kernel::FileDescriptor> {
public:
  LoadAscii2();
  const std::string name() const override { return "LoadAscii"; }
  const std::string summary() const override {
    return "Loads data from a text file and stores it in a 2D workspace "
           "or Table Workspace.";
  }
 
  int version() const override { return 2; }
  const std::vector<std::string> seeAlso() const override { return {"SaveAscii"}; }
  const std::string category() const override { return "DataHandling\\Text"; }
  int confidence(Kernel::FileDescriptor &descriptor) const override;
 
protected:
  virtual API::Workspace_sptr readData(std::ifstream &file);
  virtual API::Workspace_sptr readTable(std::ifstream &file);
  bool skipLine(const std::string &line, bool header = false) const;
  bool badLine(const std::string &line) const;
  void newSpectra();
  void inconsistantIDCheck() const;
  int splitIntoColumns(std::list<std::string> &columns, const std::string &str) const;
  void fillInputValues(std::vector<double> &values, const std::list<std::string> &columns) const;
  // write the values in the current line to teh end fo teh current spectra
  void addToCurrentSpectra(const std::list<std::string> &columns);
  // check that the number of columns in the current line match the number found
  // previously
  void checkLineColumns(const size_t &cols) const;
  // interpret a line that has been deemed valid enough to look at.
  void parseLine(const std::string &line, std::list<std::string> &columns);
  // find the number of columns we should expect from now on
  void setcolumns(std::ifstream &file, std::string &line, std::list<std::string> &columns);
  // wirte the spectra to the workspace
  void writeToWorkspace(API::MatrixWorkspace_sptr &localWorkspace, const size_t &numSpectra) const;
  // Process the header information. This implementation just skips it entirely.
  void processHeader(std::ifstream &file);
  // Set the Distribution on the workspace, either from input property or file header
  bool setDistribution(std::ifstream &file);
  std::string m_columnSep;
 
private:
  void init() override;
  void exec() override;
 
  std::map<std::string, std::string> m_separatorIndex;
  std::string m_comment;
  size_t m_baseCols;
  size_t m_specNo;
  size_t m_lastBins;
  size_t m_curBins;
  bool m_spectraStart;
  size_t m_spectrumIDcount;
  size_t m_lineNo;
  std::vector<DataObjects::Histogram1D> m_spectra;
  std::unique_ptr<DataObjects::Histogram1D> m_curSpectra;
  std::vector<double> m_curDx;
  std::vector<double> m_spectrumAxis;
};
 
} // namespace DataHandling
} // namespace Mantid