ChopperModel.h 3.93 KB
Newer Older
1
2
3
#ifndef MANTID_API_CHOPPERMODEL_H_
#define MANTID_API_CHOPPERMODEL_H_
/**
4
5
  Copyright © 2012 ISIS Rutherford Appleton Laboratory, NScD Oak Ridge
  National Laboratory & European Spallation Source
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

  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/>.

22
  File change history is stored at: <https://github.com/mantidproject/mantid>.
23
24
25
26
27
28
29
  Code Documentation is available at: <http://doxygen.mantidproject.org>
*/
#include "MantidAPI/DllConfig.h"
#include "MantidAPI/Run.h"

#include <string>

30
31
32
33
34
35
namespace Mantid {
namespace API {
//--------------------------------------------------------------------------
// Forward declaration
//--------------------------------------------------------------------------
class Run;
36

37
38
39
40
41
42
43
44
45
46
/**
 * Defines an interface to a chopper model which allows
 * calculating the variance in the time of the pulse through
 * the chopper
 */
class MANTID_API_DLL ChopperModel {
public:
  /// Default constructor required by the factory
  ChopperModel();
  /// Allow inheritance
47
  virtual ~ChopperModel() = default;
48
49
50
51
52
53
54
55
56
57
58
59
  /// Returns a clone of the current object
  virtual boost::shared_ptr<ChopperModel> clone() const = 0;

  /// Set the reference to the run object as we need a default constructor
  /// for the factory
  void setRun(const Run &exptRun);
  /// Initialize with a string of parameters
  void initialize(const std::string &params);

  /// Set the rotation speed in rads/sec
  void setAngularVelocityInHz(const double value);
  /// Set the angular velocity log name
60
  void setAngularVelocityLog(const std::string &logName);
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
  /// Returns the current angular velocity in rads/sec
  double getAngularVelocity() const;
  /// Sets the chopper jitter sigma value in microseconds. This is the FWHH
  /// value
  void setJitterFWHH(const double value);
  /// Returns the std deviation of the jitter value in seconds
  inline double getStdDevJitter() const { return m_jitterSigma; }

  /// Returns the variance of a the time pulse through this chopper in seconds^2
  double pulseTimeVariance() const;
  /// Returns a time sampled from the chopper distribution
  virtual double sampleTimeDistribution(const double randomNo) const = 0;
  /// Returns a time sampled from the jitter distribution
  virtual double sampleJitterDistribution(const double randomNo) const = 0;

protected:
  /// Set a named parameter from a string value
  virtual void setParameterValue(const std::string &name,
                                 const std::string &value) = 0;

  /// The variance of a the time pulse through this chopper in seconds^2
  virtual double calculatePulseTimeVariance() const = 0;
  /// Cache a value of the pulse variance
  void cachePulseVariance(const double value);
  /// Return current pulse variance cache
  inline double getCachedPulseVariance() const { return m_pulseVariance; }

  /// Returns a reference to the run object
  inline const Run &exptRun() const { return *m_exptRun; }

private:
  /// Handle any base parameters before passing to derived
  void setBaseParameters(std::map<std::string, std::string> &keyValues);

  /// A pointer to the run object
  const Run *m_exptRun;
  /// Current rotation speed
  double m_angularSpeed;
  /// Rotation speed log name
  std::string m_angularSpeedLog;
  /// Std deviation of chopper jitter in seconds
  double m_jitterSigma;
  /// Current value of the variance of the pulse
  double m_pulseVariance;
};
}
}
108
109

#endif /* MANTID_API_CHOPPERMODEL_H_ */