-
Notifications
You must be signed in to change notification settings - Fork 121
/
MDNormSCDPreprocessIncoherent.py
220 lines (190 loc) · 9.43 KB
/
MDNormSCDPreprocessIncoherent.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
# 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 +
from mantid.api import (
DataProcessorAlgorithm,
mtd,
AlgorithmFactory,
FileProperty,
FileAction,
MultipleFileProperty,
WorkspaceProperty,
PropertyMode,
)
from mantid.simpleapi import (
ConvertUnits,
CropWorkspace,
LoadInstrument,
Minus,
Load,
DeleteWorkspace,
LoadIsawDetCal,
LoadMask,
GroupDetectors,
Rebin,
MaskDetectors,
SumSpectra,
SortEvents,
IntegrateFlux,
AnvredCorrection,
NormaliseByCurrent,
)
from mantid.kernel import Direction, Property, FloatMandatoryValidator, VisibleWhenProperty, PropertyCriterion
class MDNormSCDPreprocessIncoherent(DataProcessorAlgorithm):
def category(self):
return "MDAlgorithms\\Normalisation"
def seeAlso(self):
return ["MDNormSCD", "MDNormDirectSC"]
def name(self):
return "MDNormSCDPreprocessIncoherent"
def summary(self):
return "Creates the Solid Angle and Flux workspace from an incoherent scatterer for MDNormSCD"
def PyInit(self):
# files to reduce
self.declareProperty(
MultipleFileProperty(name="Filename", extensions=["_event.nxs", ".nxs.h5", ".nxs"]), "Files to combine in reduction"
)
# background
self.declareProperty(
FileProperty(name="Background", defaultValue="", action=FileAction.OptionalLoad, extensions=["_event.nxs", ".nxs.h5", ".nxs"]),
"Background run",
)
self.declareProperty("BackgroundScale", 1.0, doc="The background will be scaled by this number before being subtracted.")
# Filter by TOF
self.copyProperties("LoadEventNexus", ["FilterByTofMin", "FilterByTofMax"])
# Cropping
self.declareProperty("MomentumMin", Property.EMPTY_DBL, doc="Minimum value in momentum.", validator=FloatMandatoryValidator())
self.declareProperty("MomentumMax", Property.EMPTY_DBL, doc="Maximum value in momentum.", validator=FloatMandatoryValidator())
# Grouping
self.declareProperty(
FileProperty(name="GroupingFile", defaultValue="", action=FileAction.OptionalLoad, extensions=[".xml", ".map"]),
"A file that consists of lists of spectra numbers to group. See :ref:`GroupDetectors <algm-GroupDetectors>`",
)
# Corrections
self.declareProperty("NormaliseByCurrent", True, "Normalise the Solid Angle workspace by the proton charge.")
self.declareProperty(
FileProperty(name="LoadInstrument", defaultValue="", action=FileAction.OptionalLoad, extensions=[".xml"]),
"Load a different instrument IDF onto the data from a file. See :ref:`LoadInstrument <algm-LoadInstrument>`",
)
self.declareProperty(
FileProperty(name="DetCal", defaultValue="", action=FileAction.OptionalLoad, extensions=[".detcal"]),
"Load an ISAW DetCal calibration onto the data from a file. See :ref:`LoadIsawDetCal <algm-LoadIsawDetCal>`",
)
self.declareProperty(
FileProperty(name="MaskFile", defaultValue="", action=FileAction.OptionalLoad, extensions=[".xml", ".msk"]),
"Masking file for masking. Supported file format is XML and ISIS ASCII. See :ref:`LoadMask <algm-LoadMask>`",
)
# Anvred
self.declareProperty(
"SphericalAbsorptionCorrection",
False,
"Apply Spherical Absorption correction using :ref:`AnvredCorrection <algm-AnvredCorrection>`",
)
condition = VisibleWhenProperty("SphericalAbsorptionCorrection", PropertyCriterion.IsNotDefault)
self.copyProperties("AnvredCorrection", ["LinearScatteringCoef", "LinearAbsorptionCoef", "Radius"])
self.setPropertySettings("LinearScatteringCoef", condition)
self.setPropertySettings("LinearAbsorptionCoef", condition)
self.setPropertySettings("Radius", condition)
# Output
self.declareProperty(
WorkspaceProperty("SolidAngleOutputWorkspace", "", optional=PropertyMode.Mandatory, direction=Direction.Output),
"Output Workspace for Solid Angle",
)
self.declareProperty(
WorkspaceProperty("FluxOutputWorkspace", "", optional=PropertyMode.Mandatory, direction=Direction.Output),
"Output Workspace for Flux",
)
# Background
self.setPropertyGroup("Background", "Background")
self.setPropertyGroup("BackgroundScale", "Background")
# Corrections
self.setPropertyGroup("NormaliseByCurrent", "Corrections")
self.setPropertyGroup("LoadInstrument", "Corrections")
self.setPropertyGroup("DetCal", "Corrections")
self.setPropertyGroup("MaskFile", "Corrections")
self.setPropertyGroup("SphericalAbsorptionCorrection", "Corrections")
self.setPropertyGroup("LinearScatteringCoef", "Corrections")
self.setPropertyGroup("LinearAbsorptionCoef", "Corrections")
self.setPropertyGroup("Radius", "Corrections")
def PyExec(self):
_background = bool(self.getProperty("Background").value)
_load_inst = bool(self.getProperty("LoadInstrument").value)
_norm_current = bool(self.getProperty("NormaliseByCurrent").value)
_detcal = bool(self.getProperty("DetCal").value)
_masking = bool(self.getProperty("MaskFile").value)
_grouping = bool(self.getProperty("GroupingFile").value)
_anvred = bool(self.getProperty("SphericalAbsorptionCorrection").value)
_SA_name = self.getPropertyValue("SolidAngleOutputWorkspace")
_Flux_name = self.getPropertyValue("FluxOutputWorkspace")
XMin = self.getProperty("MomentumMin").value
XMax = self.getProperty("MomentumMax").value
rebin_param = ",".join([str(XMin), str(XMax), str(XMax)])
Load(
Filename=self.getPropertyValue("Filename"),
OutputWorkspace="__van",
FilterByTofMin=self.getProperty("FilterByTofMin").value,
FilterByTofMax=self.getProperty("FilterByTofMax").value,
)
if _norm_current:
NormaliseByCurrent(InputWorkspace="__van", OutputWorkspace="__van")
if _background:
Load(
Filename=self.getProperty("Background").value,
OutputWorkspace="__bkg",
FilterByTofMin=self.getProperty("FilterByTofMin").value,
FilterByTofMax=self.getProperty("FilterByTofMax").value,
)
if _norm_current:
NormaliseByCurrent(InputWorkspace="__bkg", OutputWorkspace="__bkg")
else:
pc_van = mtd["__van"].run().getProtonCharge()
pc_bkg = mtd["__bkg"].run().getProtonCharge()
mtd["__bkg"] *= pc_van / pc_bkg
mtd["__bkg"] *= self.getProperty("BackgroundScale").value
Minus(LHSWorkspace="__van", RHSWorkspace="__bkg", OutputWorkspace="__van")
DeleteWorkspace("__bkg")
if _load_inst:
LoadInstrument(Workspace="__van", Filename=self.getProperty("LoadInstrument").value, RewriteSpectraMap=False)
if _detcal:
LoadIsawDetCal(InputWorkspace="__van", Filename=self.getProperty("DetCal").value)
if _masking:
LoadMask(
Instrument=mtd["__van"].getInstrument().getName(), InputFile=self.getProperty("MaskFile").value, OutputWorkspace="__mask"
)
MaskDetectors(Workspace="__van", MaskedWorkspace="__mask")
DeleteWorkspace("__mask")
ConvertUnits(InputWorkspace="__van", OutputWorkspace="__van", Target="Momentum")
Rebin(InputWorkspace="__van", OutputWorkspace="__van", Params=rebin_param)
CropWorkspace(InputWorkspace="__van", OutputWorkspace="__van", XMin=XMin, XMax=XMax)
if _anvred:
AnvredCorrection(
InputWorkspace="__van",
OutputWorkspace="__van",
LinearScatteringCoef=self.getProperty("LinearScatteringCoef").value,
LinearAbsorptionCoef=self.getProperty("LinearAbsorptionCoef").value,
Radius=self.getProperty("Radius").value,
OnlySphericalAbsorption="1",
PowerLambda="0",
)
# Create solid angle
Rebin(InputWorkspace="__van", OutputWorkspace=_SA_name, Params=rebin_param, PreserveEvents=False)
# Create flux
if _grouping:
GroupDetectors(InputWorkspace="__van", OutputWorkspace="__van", MapFile=self.getProperty("GroupingFile").value)
else:
SumSpectra(InputWorkspace="__van", OutputWorkspace="__van")
Rebin(InputWorkspace="__van", OutputWorkspace="__van", Params=rebin_param)
flux = mtd["__van"]
for i in range(flux.getNumberHistograms()):
el = flux.getSpectrum(i)
if flux.readY(i)[0] > 0:
el.divide(flux.readY(i)[0], flux.readE(i)[0])
SortEvents(InputWorkspace="__van", SortBy="X Value")
IntegrateFlux(InputWorkspace="__van", OutputWorkspace=_Flux_name, NPoints=10000)
DeleteWorkspace("__van")
self.setProperty("SolidAngleOutputWorkspace", mtd[_SA_name])
self.setProperty("FluxOutputWorkspace", mtd[_Flux_name])
AlgorithmFactory.subscribe(MDNormSCDPreprocessIncoherent)