LoadMuonNexusV2.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2020 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 "MantidAPI/WorkspaceGroup_fwd.h"
#include "MantidDataHandling/LoadMuonNexusV2NexusHelper.h"
#include "MantidDataHandling/LoadMuonStrategy.h"
#include "MantidGeometry/IDTypes.h"
#include "MantidNexus/NexusClasses.h"
 
namespace Mantid {
namespace DataHandling {
class MANTID_DATAHANDLING_DLL LoadMuonNexusV2 : public API::NexusFileLoader {
public:
  // Default constructor
  LoadMuonNexusV2();
  const std::string name() const override { return "LoadMuonNexusV2"; }
  const std::string summary() const override {
    return "The LoadMuonNexus algorithm will read the given NeXus Muon data "
           "file Version 2 and use the results to populate the named "
           "workspace. LoadMuonNexus may be invoked by Load if it is "
           "given a NeXus file of this type.";
  }
  int confidence(Kernel::NexusHDF5Descriptor &descriptor) const override;
  // Version
  int version() const override { return 1; }
 
  const std::string category() const override { return "DataHandling\\Nexus"; }
 
private:
  void init() override;
  void execLoader() override;
  // Determines whether entry contains multi period data
  void isEntryMultiPeriod();
  // Run child algorithm LoadISISNexus2
  API::Workspace_sptr runLoadISISNexus();
  // Load Muon specific properties
  void loadMuonProperties(size_t numSpectra);
  std::string m_filename;
  int64_t m_entrynumber;
  // Is file multi period
  bool m_isFileMultiPeriod;
  // Are multi periods loaded
  bool m_multiPeriodsLoaded;
  // Choose loader strategy
  void chooseLoaderStrategy(const API::Workspace_sptr &workspace);
  // The loading strategy used
  std::unique_ptr<LoadMuonStrategy> m_loadMuonStrategy;
  // Nexus loading helper class
  std::unique_ptr<LoadMuonNexusV2NexusHelper> m_nexusLoader;
  // Change the time axis unit as LoadISISNexus has the wrong one
  void applyTimeAxisUnitCorrection(API::Workspace &workspace);
  void loadPeriodInfo(API::Workspace &workspace);
};
} // namespace DataHandling
} // namespace Mantid