LoadNexusLogs.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2011 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/NexusFileLoader.h"
#include "MantidDataHandling/DllConfig.h"
#include <nexus/NeXusFile.hpp>
#include <vector>
 
namespace Mantid {
namespace Kernel {
class Property;
}
namespace API {
class MatrixWorkspace;
}
 
namespace DataHandling {
 
class MANTID_DATAHANDLING_DLL LoadNexusLogs : public API::NexusFileLoader {
public:
  LoadNexusLogs();
  const std::string name() const override { return "LoadNexusLogs"; }
  const std::string summary() const override {
    return "Loads run logs (temperature, pulse charges, etc.) from a NeXus "
           "file and adds it to the run information in a workspace.";
  }
 
  int version() const override { return 1; }
  const std::vector<std::string> seeAlso() const override { return {"LoadLog", "MergeLogs"}; }
  const std::string category() const override { return "DataHandling\\Logs;DataHandling\\Nexus"; }
 
  int confidence(Kernel::NexusHDF5Descriptor & /*descriptor*/) const override { return 0; }
 
private:
  void init() override;
  void execLoader() override;
 
  void loadLogs(::NeXus::File &file, const std::string &absolute_entry_name, const std::string &entry_class,
                const std::shared_ptr<API::MatrixWorkspace> &workspace, const std::vector<std::string> &allow_list,
                const std::vector<std::string> &block_list) const;
 
  void loadNXLog(::NeXus::File &file, const std::string &absolute_entry_name, const std::string &entry_class,
                 const std::shared_ptr<API::MatrixWorkspace> &workspace) const;
 
  void loadSELog(::NeXus::File &file, const std::string &absolute_entry_name,
                 const std::shared_ptr<API::MatrixWorkspace> &workspace) const;
  void loadVetoPulses(::NeXus::File &file, const std::shared_ptr<API::MatrixWorkspace> &workspace) const;
  void loadNPeriods(::NeXus::File &file, const std::shared_ptr<API::MatrixWorkspace> &workspace) const;
 
  std::shared_ptr<API::Progress> m_progress;
 
  std::string freqStart;
 
  mutable std::vector<std::string> m_logsWithInvalidValues;
};
 
} // namespace DataHandling
} // namespace Mantid