Mantid
Loading...
Searching...
No Matches
SortEvents.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
10#include "MantidAlgorithms/DllConfig.h"
11
12namespace Mantid {
13namespace Algorithms {
27class MANTID_ALGORITHMS_DLL SortEvents : public API::DistributedAlgorithm {
28public:
30 const std::string name() const override { return "SortEvents"; }
32 const std::string summary() const override { return "Sort the events in an EventWorkspace, for faster rebinning."; }
33
35 int version() const override { return 1; }
36 const std::vector<std::string> seeAlso() const override { return {"LoadEventNexus"}; }
38 const std::string category() const override { return "Events;Utility\\Sorting"; }
39
40protected:
41 // Overridden Algorithm methods
42 void init() override;
43 void exec() override;
44};
45
46} // namespace Algorithms
47} // namespace Mantid
Base class for algorithms that treat all spectra independently, i.e., we can trivially parallelize ov...
Takes an EventWorkspace and sorts by TOF or frame_index.
Definition: SortEvents.h:27
const std::string summary() const override
Summary of algorithms purpose.
Definition: SortEvents.h:32
const std::string category() const override
Algorithm's category for identification overriding a virtual method.
Definition: SortEvents.h:38
const std::string name() const override
Algorithm's name for identification overriding a virtual method.
Definition: SortEvents.h:30
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso algorithms related to this algorithm.
Definition: SortEvents.h:36
int version() const override
Algorithm's version for identification overriding a virtual method.
Definition: SortEvents.h:35
Helper class which provides the Collimation Length for SANS instruments.