SaveNXSPE.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 +
// Mantid Repository : https://github.com/mantidproject/mantid
#pragma once
 
//---------------------------------------------------
// Includes
//---------------------------------------------------
#include "MantidAPI/Algorithm.h"
#include "MantidDataHandling/DllConfig.h"
 
namespace Mantid {
namespace DataHandling {
 
class MANTID_DATAHANDLING_DLL SaveNXSPE final : public API::Algorithm {
public:
  SaveNXSPE();
  const std::string name() const override { return "SaveNXSPE"; }
  const std::string summary() const override { return "Writes a MatrixWorkspace to a file in the NXSPE format."; }
 
  int version() const override { return (1); }
  const std::vector<std::string> seeAlso() const override { return {"LoadNXSPE", "SaveSPE"}; }
  const std::string category() const override {
    return R"(DataHandling\Nexus;DataHandling\SPE;Inelastic\DataHandling)";
  }
  // public for testing only
  std::vector<double> getIndirectEfixed(const Mantid::API::MatrixWorkspace_sptr &inputWS) const;
 
private:
  void init() override;
  void exec() override;
  std::map<std::string, std::string> validateInputs() override;
 
  // Some constants to be written for masked values.
  static const double MASK_FLAG;
  static const double MASK_ERROR;
  static const std::string NXSPE_VER;
  static const size_t MAX_CHUNK_SIZE;
};
 
} // namespace DataHandling
} // namespace Mantid