SaveNXTomo.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
 
//---------------------------------------------------
// Includes
//---------------------------------------------------
#include "MantidAPI/Algorithm.h"
#include "MantidDataHandling/DllConfig.h"
#include "MantidDataObjects/Workspace2D.h"
#include "MantidGeometry/Instrument/RectangularDetector.h"
#include "MantidNexus/NexusFile_fwd.h"
#include <vector>
 
namespace Mantid {
namespace DataHandling {
 
class MANTID_DATAHANDLING_DLL SaveNXTomo final : public API::Algorithm {
public:
  SaveNXTomo();
  const std::string name() const override { return "SaveNXTomo"; }
 
  const std::string summary() const override {
    return "Saves one or more workspaces (of type MatrixWorkspace) to a file "
           "in the NXTomo format.";
  }
 
  int version() const override { return (1); }
  const std::vector<std::string> seeAlso() const override { return {"SaveNexusProcessed"}; }
 
  const std::string category() const override {
    return "DataHandling\\Nexus;DataHandling\\Imaging;"
           "Diffraction\\DataHandling";
  }
 
private:
  void init() override;
  void exec() override;
  bool processGroups() override;
 
  void setupFile();
 
  void writeSingleWorkspace(const DataObjects::Workspace2D_sptr &workspace);
 
  void writeLogValues(const DataObjects::Workspace2D_sptr &workspace, std::size_t thisFileInd);
  void writeIntensityValue(const DataObjects::Workspace2D_sptr &workspace, std::size_t thisFileInd);
  void writeImageKeyValue(const DataObjects::Workspace2D_sptr &workspace, std::size_t thisFileInd);
 
  void processAll();
 
  // Include error data in the written file
  bool m_includeError;
  bool m_overwriteFile;
  size_t m_spectraCount;
  Nexus::DimVector m_slabStart;
  Nexus::DimVector m_slabSize;
  std::string m_filename;
  // Dimensions for axis in nxTomo file.
  Nexus::DimVector m_dimensions;
  // Infinite file range dimensions / for use with makeData data and error
  Nexus::DimVector m_infDimensions;
 
  static const std::string NXTOMO_VER;
 
  std::vector<DataObjects::Workspace2D_sptr> m_workspaces;
 
  // hold reference to NeXusFile;
  std::unique_ptr<Nexus::File> m_nxFile;
};
 
} // namespace DataHandling
} // namespace Mantid