LoadRaw3.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
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidDataHandling/LoadRawHelper.h"
#include "MantidDataObjects/Workspace2D.h"
#include <climits>
 
//----------------------------------------------------------------------
// Forward declaration
//----------------------------------------------------------------------
class ISISRAW2;
 
namespace Mantid {
namespace DataHandling {
class MANTID_DATAHANDLING_DLL LoadRaw3 : public LoadRawHelper {
 
public:
  LoadRaw3();
  const std::string name() const override { return "LoadRaw"; }
  const std::string summary() const override {
    return "Loads a data file in ISIS  RAW format and stores it in a 2D "
           "workspace (Workspace2D class).";
  }
 
  int version() const override { return 3; }
  const std::vector<std::string> seeAlso() const override {
    return {"LoadVesuvio", "RawFileInfo", "LoadSampleDetailsFromRaw", "LoadRawBin0", "LoadRawSpectrum0"};
  }
  const std::string category() const override { return "DataHandling\\Raw"; }
 
private:
  void init() override;
  void exec() override;
 
  bool isMonitor(const std::vector<specnum_t> &monitorIndexes, specnum_t spectrumNum);
 
  void validateWorkspaceSizes(bool bexcludeMonitors, bool bseparateMonitors, const int64_t normalwsSpecs,
                              const int64_t monitorwsSpecs);
 
  void excludeMonitors(FILE *file, const int &period, const std::vector<specnum_t> &monitorList,
                       const DataObjects::Workspace2D_sptr &ws_sptr);
 
  void includeMonitors(FILE *file, const int64_t &period, const DataObjects::Workspace2D_sptr &ws_sptr);
 
  void separateMonitors(FILE *file, const int64_t &period, const std::vector<specnum_t> &monitorList,
                        const DataObjects::Workspace2D_sptr &ws_sptr, const DataObjects::Workspace2D_sptr &mws_sptr);
 
  void skipPeriod(FILE *file, const int64_t &period);
  bool isSelectedPeriods() const { return !m_periodList.empty(); }
  bool isPeriodIncluded(int period) const;
  int getPreviousPeriod(int period) const;
 
  void setOptionalProperties();
 
  void setProg(double);
 
  std::string m_filename;
 
  specnum_t m_numberOfSpectra;
  std::vector<std::string> m_cache_options;
  std::map<int64_t, int64_t> m_specTimeRegimes;
  int64_t m_noTimeRegimes;
  double m_prog;
  double m_prog_start;
  double m_prog_end;
 
  int64_t m_lengthIn;
  std::vector<std::shared_ptr<HistogramData::HistogramX>> m_timeChannelsVec;
  int64_t m_total_specs;
  std::vector<int> m_periodList;
};
 
} // namespace DataHandling
} // namespace Mantid