LoadEMU.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2010 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 "LoadANSTOEventFile.h"
#include "LoadANSTOHelper.h"
#include "MantidAPI/IFileLoader.h"
#include "MantidAPI/LogManager.h"
#include "MantidDataHandling/DllConfig.h"
#include "MantidDataObjects/EventWorkspace.h"
#include "MantidGeometry/Instrument.h"
#include "MantidKernel/FileDescriptor.h"
#include "MantidNexus/NexusDescriptor.h"
 
namespace Mantid {
namespace DataHandling {
 
using ANSTO::EventVector_pt;
 
/*
Loads an ANSTO EMU event file and stores it in an event workspace.
 
@author Geish Miladinovic (ANSTO)
*/
 
template <typename FD> class LoadEMU : public API::IFileLoader<FD> {
 
protected:
  using Base = API::IFileLoader<FD>;
 
  // detailed init and exec code
  void init(bool hdfLoader);
  void exec(const std::string &hdfFile, const std::string &eventFile);
 
private:
  using Base::exec;
  using Base::init;
  // region of intereset
  std::vector<bool> createRoiVector(const std::string &seltubes, const std::string &maskfile);
 
protected:
  // load parameters from input file
  void loadParameters(const std::string &hdfFile, API::LogManager &logm);
  void loadEnvironParameters(const std::string &hdfFile, API::LogManager &logm);
 
  // load the instrument definition and instrument parameters
  void loadInstrument();
 
  // create workspace
  void createWorkspace(const std::string &title);
 
  // dynamically update the neutronic position
  void loadDetectorL2Values();
  void updateNeutronicPostions(detid_t detID, double sampleAnalyser);
 
  // load and log the Doppler parameters
  void loadDopplerParameters(API::LogManager &logm);
 
  // calibrate doppler phase
  void calibrateDopplerPhase(const std::vector<size_t> &eventCounts, const std::vector<EventVector_pt> &eventVectors);
  void dopplerTimeToTOF(const std::vector<EventVector_pt> &eventVectors, double &minTOF, double &maxTOF);
 
  // prepare event storage
  void prepareEventStorage(ANSTO::ProgressTracker &prog, const std::vector<size_t> &eventCounts,
                           std::vector<EventVector_pt> &eventVectors);
 
  // set up the detector masks
  void setupDetectorMasks(const std::vector<bool> &roi);
 
  // shared member variables
  DataObjects::EventWorkspace_sptr m_localWorkspace;
  std::vector<double> m_detectorL2;
  int32_t m_datasetIndex;
  std::string m_startRun;
 
  // Doppler characteristics
  double m_dopplerAmpl;
  double m_dopplerFreq;
  double m_dopplerPhase;
  int32_t m_dopplerRun;
  bool m_calibrateDoppler;
};
 
// Implemented the two classes explicitly rather than through specialization as
// the instantiation and linking did not behave consistently across platforms.
 
extern template class LoadEMU<Kernel::FileDescriptor>;
extern template class LoadEMU<Nexus::NexusDescriptor>;
 
class MANTID_DATAHANDLING_DLL LoadEMUTar : public LoadEMU<Kernel::FileDescriptor> {
public:
  int version() const override;
  const std::vector<std::string> seeAlso() const override;
  const std::string category() const override;
  const std::string name() const override;
  const std::string summary() const override;
  int confidence(Kernel::FileDescriptor &descriptor) const override;
 
private:
  void exec() override;
  void init() override;
};
 
class MANTID_DATAHANDLING_DLL LoadEMUHdf : public LoadEMU<Nexus::NexusDescriptor> {
public:
  int version() const override;
  const std::vector<std::string> seeAlso() const override;
  const std::string category() const override;
  const std::string name() const override;
  const std::string summary() const override;
  int confidence(Nexus::NexusDescriptor &descriptor) const override;
 
private:
  void exec() override;
  void init() override;
};
 
} // namespace DataHandling
} // namespace Mantid