SaveNexusProcessed.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 "MantidAPI/Progress.h"
#include "MantidDataHandling/DllConfig.h"
#include "MantidDataObjects/EventWorkspace.h"
#include "MantidNexus/NexusFile.h"
#include <climits>
#include <optional>
 
namespace Mantid {
namespace Nexus {
class NexusFileIO;
}
namespace DataHandling {
class MANTID_DATAHANDLING_DLL SaveNexusProcessed : public API::Algorithm {
public:
  const std::string name() const override { return "SaveNexusProcessed"; }
  const std::string summary() const override {
    return "The SaveNexusProcessed algorithm will write the given Mantid "
           "workspace to a Nexus file. SaveNexusProcessed may be invoked by "
           "SaveNexus.";
  }
 
  int version() const override { return 1; }
  const std::vector<std::string> seeAlso() const override { return {"SaveNexus", "LoadNexusProcessed"}; }
  const std::string category() const override { return "DataHandling\\Nexus"; }
 
  void saveSpectraDetectorMapNexus(const API::MatrixWorkspace &ws, Nexus::File *file, const std::vector<int> &wsIndices,
                                   const NXcompression compression = NXcompression::LZW) const;
 
  void saveSpectrumNumbersNexus(const API::MatrixWorkspace &ws, Nexus::File *file, const std::vector<int> &wsIndices,
                                const NXcompression compression = NXcompression::LZW) const;
 
  virtual bool saveLegacyInstrument() { return true; }
 
protected:
  bool processGroups() override;
 
  void init() override;
  void exec() override;
 
private:
  void getWSIndexList(std::vector<int> &indices, const Mantid::API::MatrixWorkspace_const_sptr &matrixWorkspace);
 
  template <class T>
  static void appendEventListData(const std::vector<T> &events, size_t offset, double *tofs, float *weights,
                                  float *errorSquareds, int64_t *pulsetimes);
 
  void execEvent(const Mantid::Nexus::NexusFileIO *nexusFile, const bool uniformSpectra, const bool raggedSpectra,
                 const std::vector<int> &spec);
  void setOtherProperties(IAlgorithm *alg, const std::string &propertyName, const std::string &propertyValue,
                          int perioidNum) override;
  void doExec(const Mantid::API::Workspace_sptr &inputWorkspace, std::shared_ptr<Mantid::Nexus::NexusFileIO> &nexusFile,
              const bool keepFile = false, std::optional<size_t> entryNumber = std::optional<size_t>());
 
  API::MatrixWorkspace_const_sptr m_inputWorkspace;
  DataObjects::EventWorkspace_const_sptr m_eventWorkspace;
  double m_timeProgInit{0.0};
  std::unique_ptr<API::Progress> m_progress;
};
 
} // namespace DataHandling
} // namespace Mantid