Skip to content
Snippets Groups Projects
ConvertToEventWorkspace.h 2.11 KiB
Newer Older
#ifndef MANTID_ALGORITHMS_CONVERTTOEVENTWORKSPACE_H_
#define MANTID_ALGORITHMS_CONVERTTOEVENTWORKSPACE_H_
#include "MantidAPI/Algorithm.h"
namespace Mantid {
namespace Algorithms {
/** Perform a conversion for a Workspace2D to an equivalent
 * EventWorkspace
  @author Janik Zikovsky
  @date 2011-08-23
  Copyright © 2011 ISIS Rutherford Appleton Laboratory, NScD Oak Ridge
 National Laboratory & European Spallation Source
  This file is part of Mantid.
  Mantid is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 3 of the License, or
  (at your option) any later version.
  Mantid is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
  You should have received a copy of the GNU General Public License
  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  File change history is stored at: <https://github.com/mantidproject/mantid>
  Code Documentation is available at: <http://doxygen.mantidproject.org>
*/
class DLLExport ConvertToEventWorkspace : public API::Algorithm {
public:
  /// Algorithm's name for identification
  const std::string name() const override { return "ConvertToEventWorkspace"; };
  /// Summary of algorithms purpose
  const std::string summary() const override {
    return "Converts a Workspace2D from histograms to events in an "
           "EventWorkspace by converting each bin to an equivalent weighted "
           "event.";
  }
  /// Algorithm's version for identification
  int version() const override { return 1; };
  /// Algorithm's category for identification
  const std::string category() const override { return "Events"; }
private:
  /// Initialise the properties
  void init() override;
  /// Run the algorithm
  void exec() override;
#endif /* MANTID_ALGORITHMS_CONVERTTOEVENTWORKSPACE_H_ */