LoadILLDiffraction.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2017 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 <utility>
 
#include "MantidAPI/IFileLoader.h"
#include "MantidDataHandling/DllConfig.h"
#include "MantidKernel/DateAndTime.h"
#include "MantidKernel/NexusDescriptor.h"
#include "MantidKernel/V3D.h"
#include "MantidNexus/NexusClasses.h"
 
namespace Mantid {
namespace DataHandling {
 
class MANTID_DATAHANDLING_DLL LoadILLDiffraction : public API::IFileLoader<Kernel::NexusDescriptor> {
public:
  const std::string name() const override;
  int version() const override;
  const std::vector<std::string> seeAlso() const override { return {"LoadNexus"}; }
  const std::string category() const override;
  const std::string summary() const override;
  int confidence(Kernel::NexusDescriptor &descriptor) const override;
  LoadILLDiffraction();
 
private:
  enum ScanType : size_t { NoScan = 0, DetectorScan = 1, OtherScan = 2 };
 
  struct ScannedVariables {
    int axis;
    int scanned;
    std::string name;
    std::string property;
    std::string unit;
 
    ScannedVariables(std::string n, std::string p, std::string u)
        : axis(0), scanned(0), name(std::move(n)), property(std::move(p)), unit(std::move(u)) {}
 
    void setAxis(int a) { axis = a; }
    void setScanned(int s) { scanned = s; }
  };
 
  void init() override;
  std::map<std::string, std::string> validateInputs() override;
  void exec() override;
 
  void calculateRelativeRotations(std::vector<double> &instrumentAngles, const Kernel::V3D &firstTubePosition);
 
  void fillDataScanMetaData(const NeXus::NXDouble &);
  void fillMovingInstrumentScan(const NeXus::NXUInt &, const NeXus::NXDouble &);
  void fillStaticInstrumentScan(const NeXus::NXUInt &, const NeXus::NXDouble &, const double &);
 
  std::vector<Types::Core::DateAndTime> getAbsoluteTimes(const NeXus::NXDouble &) const;
  std::vector<double> getAxis(const NeXus::NXDouble &) const;
  std::vector<double> getDurations(const NeXus::NXDouble &) const;
  std::vector<double> getMonitor(const NeXus::NXDouble &) const;
  std::string getInstrumentFilePath(const std::string &) const;
  Kernel::V3D getReferenceComponentPosition(const API::MatrixWorkspace_sptr &instrumentWorkspace);
  bool containsCalibratedData(const std::string &filename) const;
 
  std::vector<double> getScannedVaribleByPropertyName(const NeXus::NXDouble &scan,
                                                      const std::string &propertyName) const;
 
  void initStaticWorkspace(const std::string &start_time);
  void initMovingWorkspace(const NeXus::NXDouble &scan, const std::string &start_time);
 
  void loadDataScan();
  API::MatrixWorkspace_sptr loadEmptyInstrument(const std::string &start_time);
  void loadMetaData();
  void loadScanVars();
  void loadStaticInstrument();
  void moveTwoThetaZero(double);
  void resolveInstrument();
  void resolveScanType();
  void setSampleLogs();
  void computeThetaOffset();
  void convertAxisAndTranspose();
 
  double m_offsetTheta{0.};
  size_t m_sizeDim1;              
  size_t m_sizeDim2;              
  size_t m_numberDetectorsRead;   
  size_t m_numberDetectorsActual; 
  size_t m_numberScanPoints;      
  size_t m_resolutionMode;        
 
  std::string m_instName;               
  std::set<std::string> m_instNames;    
  std::string m_filename;               
  Types::Core::DateAndTime m_startTime; 
  ScanType m_scanType;                  
  double m_pixelHeight{0.};             
  double m_maxHeight{0.};               
 
  std::vector<ScannedVariables> m_scanVar;  
  API::MatrixWorkspace_sptr m_outWorkspace; 
  bool m_useCalibratedData{false};          
  bool m_isSpectrometer{false};
};
 
} // namespace DataHandling
} // namespace Mantid