LoadNexusMonitors2.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2015 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/MatrixWorkspace_fwd.h"
#include "MantidAPI/ParallelAlgorithm.h"
#include "MantidDataHandling/DllConfig.h"
#include "MantidGeometry/IDTypes.h"
#include <boost/scoped_array.hpp>
// clang-format off
#include <nexus/NeXusFile.hpp>
#include <nexus/NeXusException.hpp>
// clang-format on
 
namespace Mantid {
 
namespace HistogramData {
class Counts;
class BinEdges;
} // namespace HistogramData
namespace DataHandling {
 
namespace LoadNexusMonitorsAlg {
// spectrum  is implicit in the structure as index + 1 - TODO was spectrumNo
struct MonitorInfo {
  std::string name{""}; 
  detid_t detNum{0}; 
  specnum_t specNum{0};
  bool hasEvent{false};
  bool hasHisto{false};
};
} // namespace LoadNexusMonitorsAlg
 
class MANTID_DATAHANDLING_DLL LoadNexusMonitors2 : public API::ParallelAlgorithm {
public:
  const std::string name() const override { return "LoadNexusMonitors"; }
 
  const std::string summary() const override { return "Load all monitors from a NeXus file into a workspace."; }
 
  int version() const override { return 2; }
  const std::vector<std::string> seeAlso() const override { return {"LoadNexus"}; }
 
  const std::string category() const override { return "DataHandling\\Nexus"; }
 
protected:
  void init() override;
 
  void exec() override;
 
private:
  void fixUDets(::NeXus::File &file);
 
  void runLoadLogs(const std::string &filename, const API::MatrixWorkspace_sptr &localWorkspace);
 
  bool canOpenAsNeXus(const std::string &fname);
 
  void splitMutiPeriodHistrogramData(const size_t numPeriods);
 
  size_t getMonitorInfo(NeXus::File &file, size_t &numPeriods);
 
  bool createOutputWorkspace(std::vector<bool> &loadMonitorFlags);
 
  void readEventMonitorEntry(NeXus::File &file, size_t ws_index);
 
  void readHistoMonitorEntry(NeXus::File &file, size_t ws_index, size_t numPeriods);
 
private:
  std::vector<LoadNexusMonitorsAlg::MonitorInfo> m_monitorInfo;
  std::vector<HistogramData::BinEdges> m_multiPeriodBinEdges;
  std::vector<HistogramData::Counts> m_multiPeriodCounts;
  std::string m_filename;                
  API::MatrixWorkspace_sptr m_workspace; 
  size_t m_monitor_count{0};             
  std::string m_top_entry_name;          
};
 
} // namespace DataHandling
} // namespace Mantid