forked from npshub/mantid
-
Notifications
You must be signed in to change notification settings - Fork 0
/
RRFMuonTest.h
200 lines (178 loc) · 7.94 KB
/
RRFMuonTest.h
1
2
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
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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
// NScD Oak Ridge National Laboratory, European Spallation Source,
// Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
#include "MantidAPI/AnalysisDataService.h"
#include "MantidAPI/Axis.h"
#include "MantidAPI/MatrixWorkspace.h"
#include "MantidAPI/WorkspaceFactory.h"
#include "MantidKernel/UnitFactory.h"
#include "MantidMuon/RRFMuon.h"
#include <cxxtest/TestSuite.h>
using namespace Mantid::Algorithms;
using namespace Mantid::API;
class RRFMuonTest : public CxxTest::TestSuite {
public:
void testName() { TS_ASSERT_EQUALS(rrfMuon.name(), "RRFMuon"); }
void testCategory() { TS_ASSERT_EQUALS(rrfMuon.category(), "Muon") }
void testRRFMuonZeroFrequency() {
// Test of the algorithm at zero frequency
// At zero frequency input and output workspaces should contain the same X,
// Y data
// Create input workspace with three spectra
MatrixWorkspace_sptr ws = createDummyWorkspace();
// Initialise
TS_ASSERT_THROWS_NOTHING(rrfMuon.initialize());
TS_ASSERT(rrfMuon.isInitialized());
// Set Values
TS_ASSERT_THROWS_NOTHING(rrfMuon.setProperty("InputWorkspace", ws));
TS_ASSERT_THROWS_NOTHING(rrfMuon.setProperty("OutputWorkspace", "outputWs"));
TS_ASSERT_THROWS_NOTHING(rrfMuon.setProperty("Frequency", "0"));
TS_ASSERT_THROWS_NOTHING(rrfMuon.setProperty("FrequencyUnits", "MHz"));
TS_ASSERT_THROWS_NOTHING(rrfMuon.setProperty("Phase", "0"));
// Execute
TS_ASSERT_THROWS_NOTHING(rrfMuon.execute());
TS_ASSERT(rrfMuon.isExecuted());
// Get result
MatrixWorkspace_const_sptr ows =
std::dynamic_pointer_cast<MatrixWorkspace>(AnalysisDataService::Instance().retrieve("outputWs"));
TS_ASSERT(ows);
// Checks
// X values
TS_ASSERT_EQUALS(ws->x(0), ows->x(0));
TS_ASSERT_EQUALS(ws->x(1), ows->x(1));
// Y values
TS_ASSERT_EQUALS(ws->y(0), ows->y(0));
TS_ASSERT_EQUALS(ws->y(1), ows->y(1));
}
void testRRFMuonNonZeroFrequency() {
// Test of the algorithm at non-zero frequency
// Create input workspace with three spectra
MatrixWorkspace_sptr ws = createDummyWorkspace();
// Initialise
TS_ASSERT_THROWS_NOTHING(rrfMuon.initialize());
TS_ASSERT(rrfMuon.isInitialized());
// Set Values
TS_ASSERT_THROWS_NOTHING(rrfMuon.setProperty("InputWorkspace", ws));
TS_ASSERT_THROWS_NOTHING(rrfMuon.setProperty("OutputWorkspace", "outputWs"));
TS_ASSERT_THROWS_NOTHING(rrfMuon.setProperty("Frequency", "1"));
TS_ASSERT_THROWS_NOTHING(rrfMuon.setProperty("FrequencyUnits", "MHz"));
TS_ASSERT_THROWS_NOTHING(rrfMuon.setProperty("Phase", "0"));
// Execute
TS_ASSERT_THROWS_NOTHING(rrfMuon.execute());
TS_ASSERT(rrfMuon.isExecuted());
// Get result
MatrixWorkspace_const_sptr ows =
std::dynamic_pointer_cast<MatrixWorkspace>(AnalysisDataService::Instance().retrieve("outputWs"));
TS_ASSERT(ows);
// Checks
// X values
TS_ASSERT_EQUALS(ws->x(0), ows->x(0));
TS_ASSERT_EQUALS(ws->x(1), ows->x(1));
// Y values
// The input frequency is close to the precession frequency, so:
// The real part of the RRF polarization should be close to 1 for all X
// values
// The imaginary part should be close to 0 for all X values
TS_ASSERT_DELTA(ows->y(0)[0], 1, 0.001);
TS_ASSERT_DELTA(ows->y(0)[100], 1, 0.001);
TS_ASSERT_DELTA(ows->y(0)[200], 1, 0.001);
TS_ASSERT_DELTA(ows->y(1)[0], 0, 0.001);
TS_ASSERT_DELTA(ows->y(1)[100], 0, 0.001);
TS_ASSERT_DELTA(ows->y(1)[200], 0, 0.001);
}
void testRRFMuonUnits() {
// Test of the algorithm at non-zero frequency
// Create input workspace with three spectra
MatrixWorkspace_sptr ws = createDummyWorkspace();
// Initialise
TS_ASSERT_THROWS_NOTHING(rrfMuon.initialize());
TS_ASSERT_THROWS_NOTHING(rrfMuon2.initialize());
TS_ASSERT_THROWS_NOTHING(rrfMuon3.initialize());
TS_ASSERT(rrfMuon.isInitialized());
TS_ASSERT(rrfMuon2.isInitialized());
TS_ASSERT(rrfMuon3.isInitialized());
// Set Values
// First run
TS_ASSERT_THROWS_NOTHING(rrfMuon.setProperty("InputWorkspace", ws));
TS_ASSERT_THROWS_NOTHING(rrfMuon.setProperty("OutputWorkspace", "outputWs1"));
TS_ASSERT_THROWS_NOTHING(rrfMuon.setProperty("Frequency", "1"));
TS_ASSERT_THROWS_NOTHING(rrfMuon.setProperty("FrequencyUnits", "MHz"));
TS_ASSERT_THROWS_NOTHING(rrfMuon.setProperty("Phase", "0"));
// Second run
TS_ASSERT_THROWS_NOTHING(rrfMuon2.setProperty("InputWorkspace", ws));
TS_ASSERT_THROWS_NOTHING(rrfMuon2.setProperty("OutputWorkspace", "outputWs2"));
TS_ASSERT_THROWS_NOTHING(rrfMuon2.setProperty("Frequency", "0.159155"));
TS_ASSERT_THROWS_NOTHING(rrfMuon2.setProperty("FrequencyUnits", "Mrad/s"));
TS_ASSERT_THROWS_NOTHING(rrfMuon2.setProperty("Phase", "0"));
// Third run
TS_ASSERT_THROWS_NOTHING(rrfMuon3.setProperty("InputWorkspace", ws));
TS_ASSERT_THROWS_NOTHING(rrfMuon3.setProperty("OutputWorkspace", "outputWs3"));
TS_ASSERT_THROWS_NOTHING(rrfMuon3.setProperty("Frequency", "11.742398"));
TS_ASSERT_THROWS_NOTHING(rrfMuon3.setProperty("FrequencyUnits", "Gauss"));
TS_ASSERT_THROWS_NOTHING(rrfMuon3.setProperty("Phase", "0"));
// Execute all of them
TS_ASSERT_THROWS_NOTHING(rrfMuon.execute());
TS_ASSERT_THROWS_NOTHING(rrfMuon2.execute());
TS_ASSERT_THROWS_NOTHING(rrfMuon3.execute());
TS_ASSERT(rrfMuon.isExecuted());
TS_ASSERT(rrfMuon2.isExecuted());
TS_ASSERT(rrfMuon3.isExecuted());
// Get results
MatrixWorkspace_const_sptr ows1 =
std::dynamic_pointer_cast<MatrixWorkspace>(AnalysisDataService::Instance().retrieve("outputWs1"));
TS_ASSERT(ows1);
MatrixWorkspace_const_sptr ows2 =
std::dynamic_pointer_cast<MatrixWorkspace>(AnalysisDataService::Instance().retrieve("outputWs2"));
TS_ASSERT(ows2);
MatrixWorkspace_const_sptr ows3 =
std::dynamic_pointer_cast<MatrixWorkspace>(AnalysisDataService::Instance().retrieve("outputWs3"));
TS_ASSERT(ows3);
// Check Y values
// ows1 vs ows2
// Results with different frequency units should be very similar
TS_ASSERT_DELTA(ows1->y(0)[5], ows2->y(0)[5], 0.000001);
TS_ASSERT_DELTA(ows1->y(0)[98], ows2->y(0)[98], 0.000001);
TS_ASSERT_DELTA(ows1->y(0)[276], ows2->y(0)[276], 0.000001);
// But not exactly the same
// (They should only be the same if the input frequency in rrfMuon2 were
// exactly 1/2/M_PI)
TS_ASSERT_DIFFERS(ows1->y(0)[5], ows2->y(0)[5]);
TS_ASSERT_DIFFERS(ows1->y(0)[98], ows2->y(0)[98]);
TS_ASSERT_DIFFERS(ows1->y(0)[276], ows2->y(0)[276]);
// ows1 vs ows3
// Results with different frequency units should be very similar
TS_ASSERT_DELTA(ows1->y(0)[8], ows3->y(0)[8], 0.000001);
TS_ASSERT_DELTA(ows1->y(0)[109], ows3->y(0)[109], 0.000001);
TS_ASSERT_DELTA(ows1->y(0)[281], ows3->y(0)[281], 0.000001);
// But not exactly the same
// (They should only be the same if the input frequency in rrfMuon3 were
// exactly 1/2/M_PI/MU
// being MU the muon gyromagnetic ratio)
TS_ASSERT_DIFFERS(ows1->y(0)[8], ows3->y(0)[8]);
TS_ASSERT_DIFFERS(ows1->y(0)[109], ows3->y(0)[109]);
TS_ASSERT_DIFFERS(ows1->y(0)[281], ows3->y(0)[281]);
}
private:
RRFMuon rrfMuon;
RRFMuon rrfMuon2, rrfMuon3;
MatrixWorkspace_sptr createDummyWorkspace() {
int nBins = 300;
MatrixWorkspace_sptr ws = WorkspaceFactory::Instance().create("Workspace2D", 2, nBins + 1, nBins);
for (int i = 0; i < nBins; i++) {
double x = i / static_cast<double>(nBins);
ws->mutableX(0)[i] = x;
ws->mutableY(0)[i] = cos(2 * M_PI * x);
ws->mutableX(1)[i] = x;
ws->mutableY(1)[i] = sin(2 * M_PI * x);
}
ws->mutableX(0)[nBins] = nBins;
ws->mutableX(1)[nBins] = nBins;
// Units
ws->getAxis(0)->unit() = Mantid::Kernel::UnitFactory::Instance().create("TOF");
return ws;
}
};