LoadSQW.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 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/IFileLoader.h"
#include "MantidAPI/Progress.h"
#include "MantidDataObjects/MDEventFactory.h"
#include "MantidGeometry/MDGeometry/MDHistoDimensionBuilder.h"
#include "MantidKernel/FileDescriptor.h"
#include "MantidMDAlgorithms/DllConfig.h"
#include <fstream>
#include <string>
 
namespace Mantid {
namespace MDAlgorithms {
 
/*==================================================================================
   Region: Declarations and Definitions in the following region are candidates
   for refactoring. Copied from MD_FileHoraceReader
   ==================================================================================*/
namespace LoadSQWHelper {
/*Helper type lifted from MD_FileHoraceReader,
  The structure describes the positions of the different sqw data parts in the
  total binary sqw data file
  TODO. Replace.*/
struct dataPositions {
  std::streamoff if_sqw_start;
  std::streamoff n_dims_start;
  std::streamoff sqw_header_start;
  std::vector<std::streamoff> component_headers_starts;
  std::streamoff detectors_start;
  std::streamoff data_start;
  std::streamoff geom_start;
  std::streamoff npax_start;
  std::streamoff s_start;
  std::streamoff err_start;
  std::streamoff n_cell_pix_start; // where data.npix  array starts
  std::streamoff min_max_start;    // data range positions (uRange -- this is the
                                   // data which describe the extents of the
                                   // MDPixesl (events))
  std::streamoff pix_start;        //< event data positions
  size_t mdImageSize;              //< the variable describes the size of Horace MD image
                                   //(number of pixels in Horace DND object or number of bins
  // in Mantid Histo workspace)
 
  dataPositions()
      : if_sqw_start(18), n_dims_start(22), sqw_header_start(26), component_headers_starts(), detectors_start(0),
        data_start(0), geom_start(0), npax_start(0), s_start(0),
        // the following values have to be identified from the file
        // itself
        err_start(0), n_cell_pix_start(0), min_max_start(0), pix_start(0),
        mdImageSize(0){}; // the following values have to be identified from the
                          // file itself
 
  // the helper methods
  void parse_sqw_main_header(std::ifstream &dataStream); // Legacy - candidate for removal
  std::streamoff parse_component_header(std::ifstream &dataStream,
                                        std::streamoff start_location); // Legacy -candidate for removal
  std::streamoff parse_sqw_detpar(std::ifstream &dataStream,
                                  std::streamoff start_location); // Legacy - candidate for removal
  void parse_data_locations(std::ifstream &dataStream, std::streamoff data_start, std::vector<size_t> &nBins,
                            uint64_t &nDataPoints); // Legacy - candidate for removal
};
} // namespace LoadSQWHelper
 
class MANTID_MDALGORITHMS_DLL LoadSQW : public API::IFileLoader<Kernel::FileDescriptor> {
public:
  LoadSQW();
  ~LoadSQW() override;
 
  const std::string name() const override { return "LoadSQW"; };
  const std::string summary() const override {
    return "Create a MDEventWorkspace with events in reciprocal space (Qx, Qy, "
           "Qz, Energy) from a SQW file.";
  }
 
  int version() const override { return 1; };
  const std::string category() const override { return "DataHandling\\SQW;MDAlgorithms\\DataHandling"; }
 
  int confidence(Kernel::FileDescriptor &descriptor) const override;
 
private:
  void init() override;
  void exec() override;
 
protected: // for testing
  virtual void readEvents(Mantid::DataObjects::MDEventWorkspace<DataObjects::MDEvent<4>, 4> *ws);
 
  void readDNDDimensions(std::vector<Mantid::Geometry::MDHistoDimensionBuilder> &DimVectorOut,
                         bool arrangeByMDImage = true);
  void readSQWDimensions(std::vector<Mantid::Geometry::MDHistoDimensionBuilder> &DimVectorOut);
 
  virtual void addLattice(Mantid::DataObjects::MDEventWorkspace<DataObjects::MDEvent<4>, 4> *ws);
 
  void parseMetadata(const std::string &fileName); // New controlling function
                                                   // over legacy ones.
  void buildMDDimsBase(std::vector<Mantid::Geometry::MDHistoDimensionBuilder> &DimVector);
  void addDimsToWs(Mantid::DataObjects::MDEventWorkspace<DataObjects::MDEvent<4>, 4> *ws,
                   std::vector<Mantid::Geometry::MDHistoDimensionBuilder> &DimVector);
 
  void readBoxSizes();
 
  std::string m_fileName;
  std::ifstream m_fileStream;
 
  Mantid::API::Progress *m_prog;
 
  std::string m_outputFile;
 
  LoadSQWHelper::dataPositions m_dataPositions;
  // the array of horace boxe sizes;
  std::vector<uint64_t> m_boxSizes;
 
  uint64_t m_nDataPoints;
  size_t m_mdImageSize;
  size_t m_nDims;
  std::vector<size_t> m_nBins;
 
  /*==================================================================================
  End Region
  ==================================================================================*/
};
 
} // namespace MDAlgorithms
} // namespace Mantid