LoadMuonNexus.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 "MantidDataHandling/DllConfig.h"
#include "MantidDataObjects/Workspace2D.h"
#include "MantidKernel/NexusDescriptor.h"
 
//----------------------------------------------------------------------
// Forward declaration
//----------------------------------------------------------------------
class MuonNexusReader;
 
namespace Mantid {
namespace DataHandling {
class MANTID_DATAHANDLING_DLL LoadMuonNexus : public API::IFileLoader<Kernel::NexusDescriptor> {
public:
  LoadMuonNexus();
  const std::string name() const override { return "LoadMuonNexus"; }
  const std::string summary() const override {
    return "The LoadMuonNexus algorithm will read the given NeXus Muon data "
           "file Version 1 and use the results to populate the named "
           "workspace. LoadMuonNexus may be invoked by LoadNexus if it is "
           "given a NeXus file of this type.";
  }
 
  int version() const override { return 1; }
  const std::string category() const override { return "DataHandling\\Nexus;Muon\\DataHandling"; }
 
  int confidence(Kernel::NexusDescriptor &descriptor) const override;
 
protected:
  virtual void runLoadInstrumentFromNexus(DataObjects::Workspace2D_sptr) {}
  void checkOptionalProperties();
  void runLoadInstrument(const DataObjects::Workspace2D_sptr &);
  Mantid::API::Algorithm_sptr createSampleLogAlgorithm(DataObjects::Workspace2D_sptr &ws);
  void addToSampleLog(const std::string &logName, const int logNumber, DataObjects::Workspace2D_sptr &ws);
  void addToSampleLog(const std::string &logName, const std::string &log, DataObjects::Workspace2D_sptr &ws);
 
  std::string m_filename;
  std::string m_entry_name;
  std::string m_instrument_name;
  std::string m_samplename;
  int64_t m_entrynumber;
  specnum_t m_numberOfSpectra;
  int64_t m_numberOfPeriods;
  bool m_list;
  bool m_interval;
  std::vector<specnum_t> m_spec_list;
  specnum_t m_spec_min;
  specnum_t m_spec_max;
  std::vector<detid_t> m_groupings;
 
private:
  void init() override;
};
 
} // namespace DataHandling
} // namespace Mantid