Mantid
Loading...
Searching...
No Matches
SaveVTK.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2008 ISIS Rutherford Appleton Laboratory UKRI,
4// NScD Oak Ridge National Laboratory, European Spallation Source,
5// Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
6// SPDX - License - Identifier: GPL - 3.0 +
7#pragma once
8
9//---------------------------------------------------
10// Includes
11//---------------------------------------------------
12#include "MantidAPI/Algorithm.h"
13#include "MantidDataHandling/DllConfig.h"
14
15namespace Mantid {
16namespace DataHandling {
43class MANTID_DATAHANDLING_DLL SaveVTK final : public API::Algorithm {
44
45public:
47 SaveVTK();
48
50 const std::string name() const override { return "SaveVTK"; };
52 const std::string summary() const override {
53 return "Save a workspace out to a VTK file format for use with 3D "
54 "visualisation tools such as Paraview.";
55 }
56
58 int version() const override { return 1; };
60 const std::string category() const override { return "DataHandling\\XML"; }
61
62private:
64 void init() override;
65
67 void exec() override;
68
70 void checkOptionalProperties();
71
73 void writeVTKPiece(std::ostream &outVTP, const std::vector<double> &xValue, const std::vector<double> &yValue,
74 const std::vector<double> &errors, int index) const;
75
77 double m_Xmin;
78
80 double m_Xmax;
81};
82} // namespace DataHandling
83} // namespace Mantid
std::map< DeltaEMode::Type, std::string > index
Definition: DeltaEMode.cpp:19
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
Saves a 1D or 2D workspace using the vtk file format described in the "file formats" document at http...
Definition: SaveVTK.h:43
const std::string name() const override
Algorithm's name.
Definition: SaveVTK.h:50
int version() const override
Algorithm's version.
Definition: SaveVTK.h:58
double m_Xmin
The x-axis minimum.
Definition: SaveVTK.h:77
const std::string category() const override
Algorithm's category.
Definition: SaveVTK.h:60
double m_Xmax
The x-axis minimum.
Definition: SaveVTK.h:80
const std::string summary() const override
Summary of algorithms purpose.
Definition: SaveVTK.h:52
Helper class which provides the Collimation Length for SANS instruments.