Mantid
Loading...
Searching...
No Matches
CompressEvents.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2011 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
10#include "MantidDataHandling/DllConfig.h"
11
12namespace Mantid {
13namespace DataHandling {
28class MANTID_DATAHANDLING_DLL CompressEvents : public API::DistributedAlgorithm {
29public:
31 const std::string name() const override { return "CompressEvents"; };
33 const std::string summary() const override {
34 return "Reduce the number of events in an EventWorkspace by grouping "
35 "together events with identical or similar X-values "
36 "(time-of-flight).";
37 }
38
40 int version() const override { return 1; };
41 const std::vector<std::string> seeAlso() const override { return {"LoadEventNexus", "LoadEventAndCompress"}; }
43 const std::string category() const override { return "Events"; }
44
45private:
46 // Implement abstract Algorithm methods
47 void init() override;
48 void exec() override;
49};
50
51} // namespace DataHandling
52} // namespace Mantid
Base class for algorithms that treat all spectra independently, i.e., we can trivially parallelize ov...
Compress an EventWorkspace by lumping together events with very close TOF value, while ignoring the e...
int version() const override
Algorithm's version for identification overriding a virtual method.
const std::string summary() const override
Summary of algorithms purpose.
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso (these are not validated) algorithms related to this algorithm....
const std::string name() const override
Algorithm's name for identification overriding a virtual method.
const std::string category() const override
Algorithm's category for identification overriding a virtual method.
Helper class which provides the Collimation Length for SANS instruments.