MuonNexusReader.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
 
#include "MantidAPI/Algorithm.h"
#include "MantidDataObjects/Workspace2D.h"
#include "MantidNexus/DllConfig.h"
#include <boost/date_time/posix_time/posix_time.hpp>
#include <climits>
#include <nexus/NeXusFile.hpp>
 
// class MuonNexusReader - based on ISISRAW this class implements a simple
// reader for Nexus Muon data files.
class MANTID_NEXUS_DLL MuonNexusReader {
private:
  std::string m_nexusInstrumentName;   
  std::string m_nexusSampleName;       
  int m_nexusLogCount = 0;             
  std::vector<bool> m_logType;         
  std::vector<std::string> m_logNames; 
  std::vector<std::string> m_logUnits;
 
  void openFirstNXentry(NeXus::File &handle);
  bool readMuonLogData(NeXus::File &handle);               
  std::vector<std::vector<float>> m_logValues,             
      m_logTimes;                                          
  std::vector<std::vector<std::string>> m_logStringValues; 
  std::string m_startTime;                                 
  std::time_t m_startTime_time_t = 0;                      
  std::time_t to_time_t(const boost::posix_time::ptime &t) 
  {
    if (t == boost::posix_time::neg_infin)
      return 0;
    else if (t == boost::posix_time::pos_infin)
      return LONG_MAX;
    boost::posix_time::ptime start(boost::gregorian::date(1970, 1, 1));
    return (t - start).total_seconds();
  }
  void readPeriodInfo(NeXus::File &handle);
 
public:
  MuonNexusReader() = default;
  ~MuonNexusReader() = default;
 
  void readFromFile(const std::string &filename); 
  void readLogData(const std::string &filename);  
  void getTimeChannels(float *timebnds,
                       const int &nbnds) const; 
  std::string getSampleName() const { return m_nexusSampleName; };
  int numberOfLogs() const;                  
  int getLogLength(const int i) const;       
  std::string getLogName(const int i) const; 
  void getLogValues(const int &logNumber, const int &logSequence, std::time_t &logTime,
                    double &value); 
  void getLogStringValues(const int &logNumber, const int &logSequence, std::time_t &logTime,
                          std::string &value); 
  bool logTypeNumeric(const int i) const;      
  std::string logUnits(const int i) const;
  // following ISISRAW.h
  int t_nsp1 = 0; 
  int t_ntc1 = 0; 
  int t_nper = 0; 
  // for nexus histogram data
  std::vector<float> m_correctedTimes;   
  std::vector<int> m_counts;             
  std::vector<int> m_detectorGroupings;  
  int m_numDetectors = 0;                
  std::string getInstrumentName() const; 
  int m_numPeriodSequences = 0;
  std::string m_periodNames;
  std::string m_periodTypes;
  std::string m_framesPeriodsRequested;
  std::string m_framesPeriodsRaw;
  std::string m_periodsOutput;
  std::string m_periodsCounts;
};