Newer
Older
#ifndef MANTID_DATAHANDLING_COMPRESSEVENTS_H_
#define MANTID_DATAHANDLING_COMPRESSEVENTS_H_
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
namespace Mantid
{
namespace DataHandling
{
/** Compress an EventWorkspace by lumping together events with very close TOF value,
* while ignoring the event's pulse time.
*
* This algorithm will go through all event lists and sum up together the weights and errors
* of events with times-of-flight within a specified tolerance.
* The event list data type is converted to WeightedEventNoTime, where the pulse time information
* is not saved, in order to save memory.
@author Janik Zikovsky, SNS
@date Jan 19, 2011
Copyright © 2011 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory
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://svn.mantidproject.org/mantid/trunk/Code/Mantid>.
Code Documentation is available at: <http://doxygen.mantidproject.org>
*/
class DLLExport CompressEvents : public API::Algorithm
{
public:
CompressEvents();
virtual ~CompressEvents();
/// Algorithm's name for identification overriding a virtual method
virtual const std::string name() const { return "CompressEvents";};
/// Algorithm's version for identification overriding a virtual method
virtual int version() const { return 1;};
/// Algorithm's category for identification overriding a virtual method
virtual const std::string category() const { return "DataHandling";}
private:
// Implement abstract Algorithm methods
void init();
void exec();
};
} // namespace DataHandling
} // namespace Mantid
#endif /*MANTID_DATAHANDLING_COMPRESSEVENTS_H_*/