forked from npshub/mantid
-
Notifications
You must be signed in to change notification settings - Fork 0
/
calculate_transmission_test.py
286 lines (239 loc) · 17 KB
/
calculate_transmission_test.py
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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
# 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 +
import unittest
from sans.common.enums import (RebinType, RangeStepType, FitType, DataType, SANSFacility, SANSInstrument)
from sans.state.StateObjects.StateCalculateTransmission import (StateCalculateTransmission,
StateCalculateTransmissionLOQ,
get_calculate_transmission)
from sans.state.StateObjects.StateData import get_data_builder
from sans.test_helper.file_information_mock import SANSFileInformationMock
# ----------------------------------------------------------------------------------------------------------------------
# State
# ----------------------------------------------------------------------------------------------------------------------
class StateCalculateTransmissionTest(unittest.TestCase):
@staticmethod
def _set_fit(state, default_settings, custom_settings, fit_key):
for key, value in list(default_settings.items()):
if key in custom_settings:
value = custom_settings[key]
if value is not None: # If the value is None, then don't set it
setattr(state.fit[fit_key.value], key, value)
@staticmethod
def _get_calculate_transmission_state(trans_entries, fit_entries):
state = StateCalculateTransmission()
if trans_entries is None:
trans_entries = {}
trans_settings = {"transmission_radius_on_detector": 12., "transmission_roi_files": ["test.xml"],
"transmission_mask_files": ["test.xml"], "default_transmission_monitor": 3,
"transmission_monitor": 4, "default_incident_monitor": 1, "incident_monitor": 2,
"prompt_peak_correction_min": 123., "prompt_peak_correction_max": 1234.,
"rebin_type": RebinType.REBIN, "wavelength_low": [1.], "wavelength_high": [2.7],
"wavelength_step": 0.5, "wavelength_step_type": RangeStepType.LIN,
"use_full_wavelength_range": True, "wavelength_full_range_low": 12.,
"wavelength_full_range_high": 434., "background_TOF_general_start": 1.4,
"background_TOF_general_stop": 24.5, "background_TOF_monitor_start": {"1": 123, "2": 123},
"background_TOF_monitor_stop": {"1": 234, "2": 2323}, "background_TOF_roi_start": 12.,
"background_TOF_roi_stop": 123.}
for key, value in list(trans_settings.items()):
if key in trans_entries:
value = trans_entries[key]
if value is not None: # If the value is None, then don't set it
setattr(state, key, value)
fit_settings = {"fit_type": FitType.POLYNOMIAL, "polynomial_order": 1, "wavelength_low": 12.,
"wavelength_high": 232.}
if fit_entries is None:
fit_entries = {}
StateCalculateTransmissionTest._set_fit(state, fit_settings, fit_entries, DataType.SAMPLE)
StateCalculateTransmissionTest._set_fit(state, fit_settings, fit_entries, DataType.CAN)
return state
@staticmethod
def _get_dict(entry_name, value):
output = {}
if value is not None:
output.update({entry_name: value})
return output
def check_bad_and_good_values(self, bad_trans=None, bad_fit=None, good_trans=None, good_fit=None):
# Bad values
state = self._get_calculate_transmission_state(bad_trans, bad_fit)
with self.assertRaises(ValueError):
state.validate()
# Good values
state = self._get_calculate_transmission_state(good_trans, good_fit)
self.assertIsNone(state.validate())
def test_that_is_sans_state_data_object(self):
state = StateCalculateTransmissionLOQ()
self.assertTrue(isinstance(state, StateCalculateTransmission))
def test_that_raises_when_no_incident_monitor_is_available(self):
self.check_bad_and_good_values(bad_trans={"incident_monitor": None, "default_incident_monitor": None},
good_trans={"incident_monitor": 1, "default_incident_monitor": None})
self.check_bad_and_good_values(bad_trans={"incident_monitor": None, "default_incident_monitor": None},
good_trans={"incident_monitor": 1, "default_incident_monitor": 1})
def test_that_raises_when_no_transmission_is_specified(self):
self.check_bad_and_good_values(bad_trans={"transmission_monitor": None, "default_transmission_monitor": None,
"transmission_radius_on_detector": None,
"transmission_roi_files": None},
good_trans={"transmission_monitor": 4, "default_transmission_monitor": None,
"transmission_radius_on_detector": None,
"transmission_roi_files": None})
def test_that_raises_for_inconsistent_prompt_peak(self):
self.check_bad_and_good_values(bad_trans={"prompt_peak_correction_min": 1., "prompt_peak_correction_max": None},
good_trans={"prompt_peak_correction_min": None,
"prompt_peak_correction_max": None})
self.check_bad_and_good_values(bad_trans={"prompt_peak_correction_min": 1.,
"prompt_peak_correction_max": None},
good_trans={"prompt_peak_correction_min": 1., "prompt_peak_correction_max": 2.})
def test_that_raises_for_lower_bound_larger_than_upper_bound_for_prompt_peak(self):
self.check_bad_and_good_values(bad_trans={"prompt_peak_correction_min": 2., "prompt_peak_correction_max": 1.},
good_trans={"prompt_peak_correction_min": 1., "prompt_peak_correction_max": 2.})
def test_that_raises_when_not_all_elements_are_set_for_wavelength(self):
self.check_bad_and_good_values(bad_trans={"wavelength_low": [1.], "wavelength_high": [2.],
"wavelength_step": 0.5, "wavelength_step_type": None},
good_trans={"wavelength_low": [1.], "wavelength_high": [2.],
"wavelength_step": 0.5, "wavelength_step_type": RangeStepType.LIN})
def test_that_raises_for_inconsistent_general_background(self):
self.check_bad_and_good_values(bad_trans={"background_TOF_general_start": 1.,
"background_TOF_general_stop": None},
good_trans={"background_TOF_general_start": None,
"background_TOF_general_stop": None})
def test_that_raises_for_lower_bound_larger_than_upper_bound_for_general_background(self):
self.check_bad_and_good_values(bad_trans={"background_TOF_general_start": 2.,
"background_TOF_general_stop": 1.},
good_trans={"background_TOF_general_start": 1.,
"background_TOF_general_stop": 2.})
def test_that_raises_for_inconsistent_roi_background(self):
self.check_bad_and_good_values(bad_trans={"background_TOF_roi_start": 1.,
"background_TOF_roi_stop": None},
good_trans={"background_TOF_roi_start": None,
"background_TOF_roi_stop": None})
def test_that_raises_for_lower_bound_larger_than_upper_bound_for_roi_background(self):
self.check_bad_and_good_values(bad_trans={"background_TOF_roi_start": 2.,
"background_TOF_roi_stop": 1.},
good_trans={"background_TOF_roi_start": 1.,
"background_TOF_roi_stop": 2.})
def test_that_raises_for_inconsistent_monitor_background(self):
self.check_bad_and_good_values(bad_trans={"background_TOF_monitor_start": {"1": 12., "2": 1.},
"background_TOF_monitor_stop": None},
good_trans={"background_TOF_monitor_start": None,
"background_TOF_monitor_stop": None})
def test_that_raises_when_lengths_of_monitor_backgrounds_are_different(self):
self.check_bad_and_good_values(bad_trans={"background_TOF_monitor_start": {"1": 1., "2": 1.},
"background_TOF_monitor_stop": {"1": 2.}},
good_trans={"background_TOF_monitor_start": {"1": 1., "2": 1.},
"background_TOF_monitor_stop": {"1": 2., "2": 2.}})
def test_that_raises_when_monitor_name_mismatch_exists_for_monitor_backgrounds(self):
self.check_bad_and_good_values(bad_trans={"background_TOF_monitor_start": {"1": 1., "2": 1.},
"background_TOF_monitor_stop": {"1": 2., "3": 2.}},
good_trans={"background_TOF_monitor_start": {"1": 1., "2": 1.},
"background_TOF_monitor_stop": {"1": 2., "2": 2.}})
def test_that_raises_lower_bound_larger_than_upper_bound_for_monitor_backgrounds(self):
self.check_bad_and_good_values(bad_trans={"background_TOF_monitor_start": {"1": 1., "2": 2.},
"background_TOF_monitor_stop": {"1": 2., "2": 1.}},
good_trans={"background_TOF_monitor_start": {"1": 1., "2": 1.},
"background_TOF_monitor_stop": {"1": 2., "2": 2.}})
def test_that_polynomial_order_can_only_be_set_with_polynomial_setting(self):
self.check_bad_and_good_values(bad_fit={"fit_type": FitType.POLYNOMIAL, "polynomial_order": 0},
good_fit={"fit_type": FitType.POLYNOMIAL, "polynomial_order": 4})
def test_convert_step_type_from_RANGE_LIN_to_LIN(self):
state = StateCalculateTransmission()
state.wavelength_step_type = RangeStepType.RANGE_LIN
self.assertEqual(state.wavelength_step_type_lin_log, RangeStepType.LIN)
def test_convert_step_type_from_RANGE_LOG_to_LOG(self):
state = StateCalculateTransmission()
state.wavelength_step_type = RangeStepType.RANGE_LOG
self.assertEqual(state.wavelength_step_type_lin_log, RangeStepType.LOG)
def test_convert_step_type_does_not_change_LIN(self):
state = StateCalculateTransmission()
state.wavelength_step_type = RangeStepType.LIN
self.assertEqual(state.wavelength_step_type_lin_log, RangeStepType.LIN)
def test_convert_step_type_does_not_change_LOG(self):
state = StateCalculateTransmission()
state.wavelength_step_type = RangeStepType.LOG
self.assertEqual(state.wavelength_step_type_lin_log, RangeStepType.LOG)
def test_convert_step_type_does_not_change_NOT_SET(self):
state = StateCalculateTransmission()
state.wavelength_step_type = RangeStepType.NOT_SET
self.assertEqual(state.wavelength_step_type_lin_log, RangeStepType.NOT_SET)
# ----------------------------------------------------------------------------------------------------------------------
# Builder
# ----------------------------------------------------------------------------------------------------------------------
class StateCalculateTransmissionBuilderTest(unittest.TestCase):
def test_that_reduction_state_can_be_built(self):
# Arrange
facility = SANSFacility.ISIS
file_information = SANSFileInformationMock(instrument=SANSInstrument.LOQ, run_number=74044)
data_builder = get_data_builder(facility, file_information)
data_builder.set_sample_scatter("LOQ74044")
data_info = data_builder.build()
# Act
state_transmission = get_calculate_transmission(data_info.instrument)
state_transmission.prompt_peak_correction_min = 12.0
state_transmission.prompt_peak_correction_max = 17.0
state_transmission.incident_monitor = 1
state_transmission.default_incident_monitor = 2
state_transmission.transmission_monitor = 3
state_transmission.default_transmission_monitor = 4
state_transmission.transmission_radius_on_detector = 1.
state_transmission.transmission_roi_files = ["sdfs", "sddfsdf"]
state_transmission.transmission_mask_files = ["sdfs", "bbbbbb"]
state_transmission.rebin_type = RebinType.REBIN
state_transmission.wavelength_low = [1.5]
state_transmission.wavelength_high = [2.7]
state_transmission.wavelength_interval.wavelength_step = 0.5
state_transmission.wavelength_step_type = RangeStepType.LIN
state_transmission.use_full_wavelength_range = True
state_transmission.wavelength_full_range_low = 12.
state_transmission.wavelength_full_range_high = 24.
state_transmission.background_TOF_general_start = 1.4
state_transmission.background_TOF_general_stop = 34.4
state_transmission.background_TOF_monitor_start = {"1": 123, "2": 123}
state_transmission.background_TOF_monitor_stop = {"1": 234, "2": 2323}
state_transmission.background_TOF_roi_start = 1.4
state_transmission.background_TOF_roi_stop = 34.4
state_transmission.set_sample_fit_type(FitType.LINEAR)
state_transmission.set_sample_polynomial_order(0)
state_transmission.set_sample_wavelength_low(10.0)
state_transmission.set_sample_wavelength_high(20.0)
state_transmission.set_can_fit_type(FitType.POLYNOMIAL)
state_transmission.set_can_polynomial_order(3)
state_transmission.set_can_wavelength_low(10.0)
state_transmission.set_can_wavelength_high(20.0)
# Assert
self.assertEqual(state_transmission.prompt_peak_correction_min, 12.0)
self.assertEqual(state_transmission.prompt_peak_correction_max, 17.0)
self.assertEqual(state_transmission.incident_monitor, 1)
self.assertEqual(state_transmission.default_incident_monitor, 2)
self.assertEqual(state_transmission.transmission_monitor, 3)
self.assertEqual(state_transmission.default_transmission_monitor, 4)
self.assertEqual(state_transmission.transmission_radius_on_detector, 1.)
self.assertEqual(state_transmission.transmission_roi_files, ["sdfs", "sddfsdf"])
self.assertEqual(state_transmission.transmission_mask_files, ["sdfs", "bbbbbb"])
self.assertEqual(state_transmission.rebin_type, RebinType.REBIN)
self.assertEqual(state_transmission.wavelength_low, [1.5])
self.assertEqual(state_transmission.wavelength_high, [2.7])
self.assertEqual(state_transmission.wavelength_interval.wavelength_step, 0.5)
self.assertEqual(state_transmission.wavelength_step_type, RangeStepType.LIN)
self.assertEqual(state_transmission.use_full_wavelength_range, True)
self.assertEqual(state_transmission.wavelength_full_range_low, 12.)
self.assertEqual(state_transmission.wavelength_full_range_high, 24.)
self.assertEqual(state_transmission.background_TOF_general_start, 1.4)
self.assertEqual(state_transmission.background_TOF_general_stop, 34.4)
self.assertEqual(
len(set(state_transmission.background_TOF_monitor_start.items()) & set({"1": 123, "2": 123}.items())), 2)
self.assertEqual(
len(set(state_transmission.background_TOF_monitor_stop.items()) & set({"1": 234, "2": 2323}.items())), 2)
self.assertEqual(state_transmission.background_TOF_roi_start, 1.4)
self.assertEqual(state_transmission.background_TOF_roi_stop, 34.4)
self.assertEqual(state_transmission.fit[DataType.SAMPLE.value].fit_type, FitType.LINEAR)
self.assertEqual(state_transmission.fit[DataType.SAMPLE.value].polynomial_order, 0)
self.assertEqual(state_transmission.fit[DataType.SAMPLE.value].wavelength_low, 10.)
self.assertEqual(state_transmission.fit[DataType.SAMPLE.value].wavelength_high, 20.)
self.assertEqual(state_transmission.fit[DataType.CAN.value].fit_type, FitType.POLYNOMIAL)
self.assertEqual(state_transmission.fit[DataType.CAN.value].polynomial_order, 3)
self.assertEqual(state_transmission.fit[DataType.CAN.value].wavelength_low, 10.)
self.assertEqual(state_transmission.fit[DataType.CAN.value].wavelength_high, 20.)
if __name__ == '__main__':
unittest.main()