Mantid
Loading...
Searching...
No Matches
ConvertToHistogram.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2010 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 "MantidAlgorithms/DllConfig.h"
14
15namespace Mantid {
16namespace Algorithms {
25class MANTID_ALGORITHMS_DLL ConvertToHistogram : public XDataConverter {
26public:
28 const std::string name() const override { return "ConvertToHistogram"; }
30 const std::string summary() const override {
31 return "Converts a workspace containing point data into one containing "
32 "histograms.";
33 }
34 const std::vector<std::string> seeAlso() const override { return {"ConvertToPointData"}; }
36 const std::string category() const override { return "Transforms\\Axes"; }
37
38private:
40 bool isProcessingRequired(const API::MatrixWorkspace_sptr inputWS) const override;
42 std::size_t getNewXSize(const std::size_t ySize) const override;
45 calculateXPoints(Kernel::cow_ptr<HistogramData::HistogramX> inputX) const override;
46};
47
48} // namespace Algorithms
49} // namespace Mantid
Converts a histogram workspace to point data by simply taking the centre point of the bin as the new ...
const std::string name() const override
Algorithm's name for identification overriding a virtual method.
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso algorithms related to this algorithm.
const std::string category() const override
Algorithm's category for identification overriding a virtual method.
const std::string summary() const override
Summary of algorithms purpose.
This is an abstract base class for sharing methods between algorithms that operate only on X data.
Implements a copy on write data template.
Definition: cow_ptr.h:41
std::shared_ptr< MatrixWorkspace > MatrixWorkspace_sptr
shared pointer to the matrix workspace base class
Helper class which provides the Collimation Length for SANS instruments.