Mantid
Loading...
Searching...
No Matches
FilterByTime.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"
12
13namespace Mantid {
14
15namespace Algorithms {
16
24class MANTID_ALGORITHMS_DLL FilterByTime : public API::DistributedAlgorithm {
25public:
27 const std::string name() const override { return "FilterByTime"; };
29 const std::string summary() const override {
30 return "This algorithm filters out events from an EventWorkspace that are "
31 "not between given start and stop times.";
32 }
33
35 int version() const override { return 1; };
36 const std::vector<std::string> seeAlso() const override {
37 return {"LoadEventNexus", "FilterByXValue", "FilterEvents", "FilterLogByTime", "FilterBadPulses"};
38 }
40 const std::string category() const override { return "Events\\EventFiltering"; }
41
42private:
43 // Implement abstract Algorithm methods
44 void init() override;
45 void exec() override;
46
49};
50
51} // namespace Algorithms
52} // namespace Mantid
Base class for algorithms that treat all spectra independently, i.e., we can trivially parallelize ov...
Filters an EventWorkspace by wall-clock time, and outputs to a new event workspace or replaces the ex...
Definition: FilterByTime.h:24
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso algorithms related to this algorithm.
Definition: FilterByTime.h:36
int version() const override
Algorithm's version for identification overriding a virtual method.
Definition: FilterByTime.h:35
const std::string name() const override
Algorithm's name for identification overriding a virtual method.
Definition: FilterByTime.h:27
DataObjects::EventWorkspace_const_sptr eventW
Pointer for an event workspace.
Definition: FilterByTime.h:48
const std::string summary() const override
Summary of algorithms purpose.
Definition: FilterByTime.h:29
const std::string category() const override
Algorithm's category for identification overriding a virtual method.
Definition: FilterByTime.h:40
std::shared_ptr< const EventWorkspace > EventWorkspace_const_sptr
shared pointer to a const Workspace2D
Helper class which provides the Collimation Length for SANS instruments.