LoadMuonNexus1.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/LoadMuonNexus.h"
#include "MantidDataObjects/TableWorkspace.h"
#include "MantidDataObjects/Workspace2D.h"
 
// Forward declaration (here, because is not in Mantid namespace)
class MuonNexusReader;
 
namespace Mantid {
//----------------------------------------------------------------------
// Forward declaration
//----------------------------------------------------------------------
namespace NeXus {
class NXRoot;
}
 
namespace DataHandling {
class MANTID_DATAHANDLING_DLL LoadMuonNexus1 : public LoadMuonNexus {
public:
  LoadMuonNexus1();
  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:
  void exec() override;
 
private:
  void loadData(size_t hist, specnum_t &i, specnum_t specNo, MuonNexusReader &nxload, const int64_t lengthIn,
                const DataObjects::Workspace2D_sptr &localWorkspace);
  void runLoadMappingTable(DataObjects::Workspace2D_sptr);
  void runLoadLog(const DataObjects::Workspace2D_sptr &);
  void loadRunDetails(const DataObjects::Workspace2D_sptr &localWorkspace);
  void addPeriodLog(const DataObjects::Workspace2D_sptr &localWorkspace, int64_t period);
  void addGoodFrames(const DataObjects::Workspace2D_sptr &localWorkspace, int64_t period, int nperiods);
 
  void loadDeadTimes(Mantid::NeXus::NXRoot &root);
 
  DataObjects::TableWorkspace_sptr createDeadTimeTable(std::vector<int> specToLoad, std::vector<double> deadTimes);
 
  API::Workspace_sptr loadDetectorGrouping(Mantid::NeXus::NXRoot &root,
                                           const Mantid::Geometry::Instrument_const_sptr &inst);
 
  DataObjects::TableWorkspace_sptr createDetectorGroupingTable(std::vector<int> specToLoad, std::vector<int> grouping);
};
 
} // namespace DataHandling
} // namespace Mantid