LoadTOFRawNexus.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 "MantidAPI/IFileLoader.h"
#include "MantidAPI/Sample.h"
#include "MantidAPI/SpectraDetectorTypes.h"
#include "MantidDataHandling/DllConfig.h"
#include "MantidDataObjects/Workspace2D.h"
#include "MantidKernel/DateAndTime.h"
#include "MantidKernel/NexusDescriptor.h"
#include "MantidNexus/NexusClasses.h"
 
#include <mutex>
 
namespace Mantid {
 
namespace DataHandling {
class MANTID_DATAHANDLING_DLL LoadTOFRawNexus : public API::IFileLoader<Kernel::NexusDescriptor> {
public:
  LoadTOFRawNexus();
 
  const std::string name() const override { return "LoadTOFRawNexus"; }
 
  const std::string summary() const override { return "Loads a NeXus file confirming to the TOFRaw format"; }
 
  int version() const override { return 1; }
  const std::vector<std::string> seeAlso() const override { return {"LoadNexus"}; }
 
  const std::string category() const override { return "DataHandling\\Nexus"; }
 
  static std::string getEntryName(const std::string &filename);
 
  int confidence(Kernel::NexusDescriptor &descriptor) const override;
 
  void countPixels(const std::string &nexusfilename, const std::string &entry_name,
                   std::vector<std::string> &bankNames);
 
  size_t m_numPixels;
 
  int m_signalNo;
 
protected:
  void init() override;
  void exec() override;
 
  void checkOptionalProperties();
 
  void runLoadInstrument(DataObjects::Workspace2D_sptr);
 
  void loadSampleData(DataObjects::Workspace2D_sptr, Mantid::NeXus::NXEntry &entry);
 
  void loadBank(const std::string &nexusfilename, const std::string &entry_name, const std::string &bankName,
                const API::MatrixWorkspace_sptr &WS, const detid2index_map &id_to_wi);
 
  std::vector<Types::Core::DateAndTime> pulseTimes;
 
  size_t m_numBins;
 
  specnum_t m_spec_min, m_spec_max;
 
  std::string m_dataField;
 
  std::string m_axisField;
 
  std::string m_xUnits;
 
  std::mutex m_fileMutex;
 
  bool m_assumeOldFile;
};
 
} // namespace DataHandling
} // namespace Mantid