LoadNexusProcessed.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 "MantidAPI/IFileLoader.h"
#include "MantidAPI/ITableWorkspace_fwd.h"
#include "MantidAPI/MatrixWorkspace_fwd.h"
#include "MantidAPI/Sample.h"
#include "MantidDataHandling/DllConfig.h"
#include "MantidHistogramData/BinEdges.h"
#include "MantidKernel/cow_ptr.h"
#include "MantidNexus/NexusClasses_fwd.h"
#include "MantidNexus/NexusDescriptorLazy.h"
#include <map>
#include <memory>
#include <vector>
 
namespace Mantid {
 
namespace DataObjects {
class SpecialWorkspace2D;
}
 
namespace DataHandling {
class MANTID_DATAHANDLING_DLL LoadNexusProcessed : public API::IFileLoader<Mantid::Nexus::NexusDescriptorLazy> {
 
public:
  LoadNexusProcessed();
  ~LoadNexusProcessed() override;
  const std::string name() const override { return "LoadNexusProcessed"; }
  const std::string summary() const override {
    return "The LoadNexusProcessed algorithm will read the given Nexus "
           "Processed data file containing a Mantid Workspace. The data is "
           "placed in the named workspace. LoadNexusProcessed may be invoked "
           "by LoadNexus if it is given a Nexus file of this type.";
  }
 
  int version() const override { return 1; };
  const std::vector<std::string> seeAlso() const override { return {"LoadNexus"}; }
  const std::string category() const override { return "DataHandling\\Nexus"; }
 
  int confidence(Nexus::NexusDescriptorLazy &descriptor) const override;
 
protected:
  void readInstrumentGroup(Mantid::Nexus::NXEntry &mtd_entry, API::MatrixWorkspace &local_workspace);
 
private:
  virtual void readSpectraToDetectorMapping(Mantid::Nexus::NXEntry &mtd_entry, Mantid::API::MatrixWorkspace &ws);
 
  std::map<std::string, std::string> validateInputs() override;
  void init() override;
  void exec() override;
 
  void reinitSpecialWorkspace2D(std::shared_ptr<Mantid::DataObjects::SpecialWorkspace2D> specialLocalWorkspace);
 
  std::string buildWorkspaceName(const std::string &name, const std::string &baseName, size_t wsIndex);
 
  void correctForWorkspaceNameClash(std::string &wsName);
 
  std::vector<std::string> extractWorkspaceNames(Mantid::Nexus::NXRoot &root, size_t nWorkspaceEntries);
 
  std::string loadWorkspaceName(Mantid::Nexus::NXRoot &root, const std::string &entry_name);
 
  virtual bool loadNexusGeometry(Mantid::API::Workspace & /* ws */, size_t /* entryNumber */,
                                 Kernel::Logger & /* logger */,
                                 const std::string & /* filePath */) { /* args not used */
    return false;                                                      /*do nothing*/
  }
 
  API::Workspace_sptr loadEntry(Mantid::Nexus::NXRoot &root, const std::string &entry_name, const double &progressStart,
                                const double &progressRange);
 
  API::Workspace_sptr loadTableEntry(const Mantid::Nexus::NXEntry &entry);
 
  template <typename ColumnType, typename NexusType>
  void loadNumericColumn(const Mantid::Nexus::NXData &tableData, const std::string &dataSetName,
                         const API::ITableWorkspace_sptr &tableWs, const std::string &columnType);
 
  template <typename Type>
  void loadVectorColumn(const Mantid::Nexus::NXData &tableData, const std::string &dataSetName,
                        const API::ITableWorkspace_sptr &tableWs, const std::string &columnType);
 
  void loadV3DColumn(Mantid::Nexus::NXDouble &data, const API::ITableWorkspace_sptr &tableWs);
 
  API::Workspace_sptr loadPeaksEntry(const Mantid::Nexus::NXEntry &entry);
 
  API::Workspace_sptr loadLeanElasticPeaksEntry(const Mantid::Nexus::NXEntry &entry);
 
  API::MatrixWorkspace_sptr loadEventEntry(Mantid::Nexus::NXData &wksp_cls, Mantid::Nexus::NXDouble &xbins,
                                           const double &progressStart, const double &progressRange);
  API::MatrixWorkspace_sptr loadNonEventEntry(Mantid::Nexus::NXData &wksp_cls, Mantid::Nexus::NXDouble &xbins,
                                              const double &progressStart, const double &progressRange,
                                              const Mantid::Nexus::NXEntry &mtd_entry, const int64_t xlength,
                                              std::string &workspaceType);
 
  void readSampleGroup(Mantid::Nexus::NXEntry &mtd_entry, API::MatrixWorkspace_sptr local_workspace);
  bool addSampleProperty(Mantid::Nexus::NXClass &sample_entry, const std::string &entryName,
                         API::Sample &sampleDetails);
  void getWordsInString(const std::string &words3, std::string &w1, std::string &w2, std::string &w3);
  void getWordsInString(const std::string &words4, std::string &w1, std::string &w2, std::string &w3, std::string &w4);
 
  void readBinMasking(const Mantid::Nexus::NXData &wksp_cls, const API::MatrixWorkspace_sptr &local_workspace);
 
  void loadBlock(Mantid::Nexus::NXDouble &data, Mantid::Nexus::NXDouble &errors, Mantid::Nexus::NXDouble &farea,
                 bool hasFArea, Mantid::Nexus::NXDouble &xErrors, bool hasXErrors, int64_t blocksize, int64_t nchannels,
                 int64_t &hist, const API::MatrixWorkspace_sptr &local_workspace);
 
  void loadBlock(Mantid::Nexus::NXDouble &data, Mantid::Nexus::NXDouble &errors, Mantid::Nexus::NXDouble &farea,
                 bool hasFArea, Mantid::Nexus::NXDouble &xErrors, bool hasXErrors, int64_t blocksize, int64_t nchannels,
                 int64_t &hist, int64_t &wsIndex, const API::MatrixWorkspace_sptr &local_workspace);
  void loadBlock(Mantid::Nexus::NXDouble &data, Mantid::Nexus::NXDouble &errors, Mantid::Nexus::NXDouble &farea,
                 bool hasFArea, Mantid::Nexus::NXDouble &xErrors, bool hasXErrors, Mantid::Nexus::NXDouble &xbins,
                 int64_t blocksize, int64_t nchannels, int64_t &hist, int64_t &wsIndex,
                 const API::MatrixWorkspace_sptr &local_workspace);
 
  void loadNonSpectraAxis(const API::MatrixWorkspace_sptr &local_workspace, const Mantid::Nexus::NXData &data);
 
  void checkOptionalProperties(const std::size_t numberofspectra);
 
  std::size_t calculateWorkspaceSize(const std::size_t numberofspectra, bool gen_filtered_list = false);
 
  Mantid::API::Workspace_sptr doAccelleratedMultiPeriodLoading(Mantid::Nexus::NXRoot &root,
                                                               const std::string &entryName,
                                                               Mantid::API::MatrixWorkspace_sptr &tempMatrixWorkspace,
                                                               const size_t nWorkspaceEntries, const size_t p);
 
  void applyLogFiltering(const Mantid::API::Workspace_sptr &local_workspace);
 
  bool m_shared_bins;
  HistogramData::BinEdges m_xbins;
  MantidVec m_axis1vals;
 
  bool m_list;
  bool m_interval;
 
  int m_spec_min;
  int m_spec_max;
 
  std::vector<int> m_spec_list;
  std::vector<int> m_filtered_spec_idxs;
 
  // Handle to the NeXus file
  std::unique_ptr<Nexus::File> m_nexusFile;
};
bool UDlesserExecCount(const Mantid::Nexus::NXClassInfo &elem1, const Mantid::Nexus::NXClassInfo &elem2);
 
} // namespace DataHandling
} // namespace Mantid