SaveVTK.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2008 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 <span>
 
namespace Mantid {
namespace DataHandling {
class MANTID_DATAHANDLING_DLL SaveVTK final : public API::Algorithm {
 
public:
  SaveVTK();
 
  const std::string name() const override { return "SaveVTK"; };
  const std::string summary() const override {
    return "Save a workspace out to a VTK file format for use with 3D "
           "visualisation tools such as Paraview.";
  }
 
  int version() const override { return 1; };
  const std::string category() const override { return "DataHandling\\XML"; }
 
private:
  void init() override;
 
  void exec() override;
 
  void checkOptionalProperties();
 
  void writeVTKPiece(std::ostream &outVTP, std::span<double const> xValue, std::span<double const> yValue,
                     std::span<double const> errors, int index) const;
 
  double m_Xmin;
 
  double m_Xmax;
};
} // namespace DataHandling
} // namespace Mantid