Mantid
Loading...
Searching...
No Matches
FilterByLogValue.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
10#include "MantidAlgorithms/DllConfig.h"
12
13namespace Mantid {
14namespace Algorithms {
17class MANTID_ALGORITHMS_DLL FilterByLogValue : public API::DistributedAlgorithm {
18public:
20 const std::string name() const override { return "FilterByLogValue"; };
22 const std::string summary() const override {
23 return "Filter out events from an EventWorkspace based on a sample log "
24 "value satisfying filter criteria.";
25 }
26
28 int version() const override { return 1; };
29 const std::vector<std::string> seeAlso() const override {
30 return {"FilterByXValue", "FilterEvents", "FilterLogByTime", "FilterBadPulses", "FilterByTime"};
31 }
33 const std::string category() const override { return "Events\\EventFiltering"; }
34
35 std::map<std::string, std::string> validateInputs() override;
36
37private:
38 // Implement abstract Algorithm methods
39 void init() override;
40 void exec() override;
41};
42
43} // namespace Algorithms
44} // namespace Mantid
Base class for algorithms that treat all spectra independently, i.e., we can trivially parallelize ov...
Filters events in an EventWorkspace using values in a SampleLog.
int version() const override
Algorithm's version for identification overriding a virtual method.
const std::string name() const override
Algorithm's name for identification overriding a virtual method.
const std::string summary() const override
Summary of algorithms purpose.
const std::string category() const override
Algorithm's category 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.
Helper class which provides the Collimation Length for SANS instruments.