def PyExec(self):
# Input
filename = self.getPropertyValue("Filename")
outws_name = self.getPropertyValue("OutputWorkspace")
norm = self.getPropertyValue("Normalization")
# load data array from the given file
data_array = np.loadtxt(filename)
if not data_array.size:
message = "File " + filename + " does not contain any data!"
self.log().error(message)
raise RuntimeError(message)
# sample logs
logs = {"names": [], "values": [], "units": []}
# load run information
metadata = DNSdata()
try:
metadata.read_legacy(filename)
except RuntimeError as err:
message = "Error of loading of file " + filename + ": " + str(err)
self.log().error(message)
raise RuntimeError(message)
tmp = api.LoadEmptyInstrument(InstrumentName='DNS')
self.instrument = tmp.getInstrument()
api.DeleteWorkspace(tmp)
# load polarisation table and determine polarisation
poltable = self.get_polarisation_table()
pol = self.get_polarisation(metadata, poltable)
if not pol:
pol = ['0', 'undefined']
self.log().warning("Failed to determine polarisation for " + filename +
". Values have been set to undefined.")
ndet = 24
unitX="Wavelength"
arr = data_array[0:ndet, 1:]
if metadata.tof_channel_number < 2:
dataX = np.zeros(2*ndet)
dataX.fill(metadata.wavelength + 0.00001)
dataX[::2] -= 0.000002
else:
unitX="TOF"
# get instrument parameters
l1 = np.linalg.norm(self.instrument.getSample().getPos() - self.instrument.getSource().getPos())
l2 = float(self.instrument.getStringParameter("l2")[0])
self.log().notice("L1 = {} m".format(l1))
self.log().notice("L2 = {} m".format(l2))
dt_factor = float(self.instrument.getStringParameter("channel_width_factor")[0])
# channel width
dt = metadata.tof_channel_width*dt_factor
# calculate tof1
velocity = h/(m_n*metadata.wavelength*1e-10) # m/s
tof1 = 1e+06*l1/velocity # microseconds
self.log().debug("TOF1 = {} microseconds".format(tof1))
self.log().debug("Delay time = {} microsecond".format(metadata.tof_delay_time))
tof2_elastic = 1e+06*l2/velocity
self.log().debug("TOF2 Elastic = {} microseconds".format(tof2_elastic))
# shift channels to keep elastic in the right position
if not metadata.tof_elastic_channel:
metadata.tof_elastic_channel = int(tof2_elastic/dt)
# required during the comissioning, since zero time channel is not yet calibrated
in_comissioning = self.instrument.getStringParameter("tof_comissioning")[0]
if in_comissioning.lower() == "yes":
# this will fail if inelastic peak is stronger than elastic
chmax = int(np.mean(arr.argmax(axis=1)))
self.log().debug("Elastic peak position old: {}".format(chmax))
arr = np.roll(arr, metadata.tof_elastic_channel - chmax, 1)
# create dataX array
x0 = tof1 + metadata.tof_delay_time
dataX = np.linspace(x0, x0+metadata.tof_channel_number*dt, metadata.tof_channel_number+1)
# sample logs
logs["names"].extend(["channel_width", "TOF1", "delay_time", "tof_channels"])
logs["values"].extend([dt, tof1, metadata.tof_delay_time, metadata.tof_channel_number])
logs["units"].extend(["microseconds", "microseconds", "microseconds", ""])
if metadata.tof_elastic_channel:
logs["names"].append("EPP")
logs["values"].append(metadata.tof_elastic_channel)
logs["units"].append("")
if metadata.chopper_rotation_speed:
logs["names"].append("chopper_speed")
logs["values"].append(metadata.chopper_rotation_speed)
logs["units"].append("Hz")
if metadata.chopper_slits:
logs["names"].append("chopper_slits")
logs["values"].append(metadata.chopper_slits)
logs["units"].append("")
# data normalization
factor = 1.0
yunit = "Counts"
ylabel = "Intensity"
if norm == 'duration':
factor = metadata.duration
yunit = "Counts/s"
ylabel = "Intensity normalized to duration"
if factor <= 0:
raise RuntimeError("Duration is invalid for file " + filename + ". Cannot normalize.")
if norm == 'monitor':
factor = metadata.monitor_counts
yunit = "Counts/monitor"
ylabel = "Intensity normalized to monitor"
if factor <= 0:
raise RuntimeError("Monitor counts are invalid for file " + filename + ". Cannot normalize.")
# set values for dataY and dataE
dataY = arr/factor
dataE = np.sqrt(arr)/factor
# create workspace
api.CreateWorkspace(OutputWorkspace=outws_name, DataX=dataX, DataY=dataY,
DataE=dataE, NSpec=ndet, UnitX=unitX)
outws = api.AnalysisDataService.retrieve(outws_name)
api.LoadInstrument(outws, InstrumentName='DNS', RewriteSpectraMap=True)
run = outws.mutableRun()
if metadata.start_time and metadata.end_time:
run.setStartAndEndTime(DateAndTime(metadata.start_time),
DateAndTime(metadata.end_time))
# add name of file as a run title
fname = os.path.splitext(os.path.split(filename)[1])[0]
run.addProperty('run_title', fname, True)
# rotate the detector bank to the proper position
api.RotateInstrumentComponent(outws, "bank0", X=0, Y=1, Z=0, Angle=metadata.deterota)
# add sample log Ei and wavelength
logs["names"].extend(["Ei", "wavelength"])
logs["values"].extend([metadata.incident_energy, metadata.wavelength])
logs["units"].extend(["meV", "Angstrom"])
# add other sample logs
logs["names"].extend(["deterota", "mon_sum", "duration", "huber", "omega", "T1", "T2", "Tsp"])
logs["values"].extend([metadata.deterota, metadata.monitor_counts, metadata.duration,
metadata.huber, metadata.huber - metadata.deterota,
metadata.temp1, metadata.temp2, metadata.tsp])
logs["units"].extend(["Degrees", "Counts", "Seconds", "Degrees", "Degrees", "K", "K", "K"])
# flipper, coil currents and polarisation
flipper_status = 'OFF' # flipper OFF
if abs(metadata.flipper_precession_current) > sys.float_info.epsilon:
flipper_status = 'ON' # flipper ON
logs["names"].extend(["flipper_precession", "flipper_z_compensation", "flipper",
"C_a", "C_b", "C_c", "C_z", "polarisation", "polarisation_comment"])
logs["values"].extend([metadata.flipper_precession_current,
metadata.flipper_z_compensation_current, flipper_status,
metadata.a_coil_current, metadata.b_coil_current,
metadata.c_coil_current, metadata.z_coil_current,
str(pol[0]), str(pol[1])])
logs["units"].extend(["A", "A", "", "A", "A", "A", "A", "", ""])
# slits
logs["names"].extend(["slit_i_upper_blade_position", "slit_i_lower_blade_position",
"slit_i_left_blade_position", "slit_i_right_blade_position"])
logs["values"].extend([metadata.slit_i_upper_blade_position, metadata.slit_i_lower_blade_position,
metadata.slit_i_left_blade_position, metadata.slit_i_right_blade_position])
logs["units"].extend(["mm", "mm", "mm", "mm"])
# add information whether the data are normalized (duration/monitor/no):
api.AddSampleLog(outws, LogName='normalized', LogText=norm, LogType='String')
api.AddSampleLogMultiple(outws, LogNames=logs["names"], LogValues=logs["values"], LogUnits=logs["units"])
outws.setYUnit(yunit)
outws.setYUnitLabel(ylabel)
self.setProperty("OutputWorkspace", outws)
self.log().debug('LoadDNSLegacy: data are loaded to the workspace ' + outws_name)
return
def PyExec(self):
# Input
filename = self.getPropertyValue("Filename")
outws_name = self.getPropertyValue("OutputWorkspace")
norm = self.getPropertyValue("Normalization")
# load data array from the given file
data_array = np.loadtxt(filename)
if not data_array.size:
message = "File " + filename + " does not contain any data!"
self.log().error(message)
raise RuntimeError(message)
# sample logs
logs = {"names": [], "values": [], "units": []}
# load run information
metadata = DNSdata()
try:
metadata.read_legacy(filename)
except RuntimeError as err:
message = "Error of loading of file " + filename + ": " + str(err)
self.log().error(message)
raise RuntimeError(message)
tmp = api.LoadEmptyInstrument(InstrumentName='DNS')
self.instrument = tmp.getInstrument()
api.DeleteWorkspace(tmp)
# load polarisation table and determine polarisation
poltable = self.get_polarisation_table()
pol = self.get_polarisation(metadata, poltable)
if not pol:
pol = ['0', 'undefined']
self.log().warning("Failed to determine polarisation for " + filename +
". Values have been set to undefined.")
ndet = 24
unitX="Wavelength"
arr = data_array[0:ndet, 1:]
if metadata.tof_channel_number < 2:
dataX = np.zeros(2*ndet)
dataX.fill(metadata.wavelength + 0.00001)
dataX[::2] -= 0.000002
else:
unitX="TOF"
# get instrument parameters
l1 = np.linalg.norm(self.instrument.getSample().getPos() - self.instrument.getSource().getPos())
l2 = float(self.instrument.getStringParameter("l2")[0])
self.log().notice("L1 = {} m".format(l1))
self.log().notice("L2 = {} m".format(l2))
dt_factor = float(self.instrument.getStringParameter("channel_width_factor")[0])
# channel width
dt = metadata.tof_channel_width*dt_factor
# calculate tof1
velocity = h/(m_n*metadata.wavelength*1e-10) # m/s
tof1 = 1e+06*l1/velocity # microseconds
self.log().debug("TOF1 = {} microseconds".format(tof1))
self.log().debug("Delay time = {} microsecond".format(metadata.tof_delay_time))
tof2_elastic = 1e+06*l2/velocity
self.log().debug("TOF2 Elastic = {} microseconds".format(tof2_elastic))
# shift channels to keep elastic in the right position
if not metadata.tof_elastic_channel:
metadata.tof_elastic_channel = int(tof2_elastic/dt)
# required during the comissioning, since zero time channel is not yet calibrated
in_comissioning = self.instrument.getStringParameter("tof_comissioning")[0]
if in_comissioning.lower() == "yes":
# this will fail if inelastic peak is stronger than elastic
chmax = int(np.mean(arr.argmax(axis=1)))
self.log().debug("Elastic peak position old: {}".format(chmax))
arr = np.roll(arr, metadata.tof_elastic_channel - chmax, 1)
# create dataX array
x0 = tof1 + metadata.tof_delay_time
dataX = np.linspace(x0, x0+metadata.tof_channel_number*dt, metadata.tof_channel_number+1)
# sample logs
logs["names"].extend(["channel_width", "TOF1", "delay_time", "tof_channels"])
logs["values"].extend([dt, tof1, metadata.tof_delay_time, metadata.tof_channel_number])
logs["units"].extend(["microseconds", "microseconds", "microseconds", ""])
if metadata.tof_elastic_channel:
logs["names"].append("EPP")
logs["values"].append(metadata.tof_elastic_channel)
logs["units"].append("")
if metadata.chopper_rotation_speed:
logs["names"].append("chopper_speed")
logs["values"].append(metadata.chopper_rotation_speed)
logs["units"].append("Hz")
if metadata.chopper_slits:
logs["names"].append("chopper_slits")
logs["values"].append(metadata.chopper_slits)
logs["units"].append("")
# data normalization
factor = 1.0
yunit = "Counts"
ylabel = "Intensity"
if norm == 'duration':
factor = metadata.duration
yunit = "Counts/s"
ylabel = "Intensity normalized to duration"
if factor <= 0:
raise RuntimeError("Duration is invalid for file " + filename + ". Cannot normalize.")
if norm == 'monitor':
factor = metadata.monitor_counts
yunit = "Counts/monitor"
ylabel = "Intensity normalized to monitor"
if factor <= 0:
raise RuntimeError("Monitor counts are invalid for file " + filename + ". Cannot normalize.")
# set values for dataY and dataE
dataY = arr/factor
dataE = np.sqrt(arr)/factor
# create workspace
api.CreateWorkspace(OutputWorkspace=outws_name, DataX=dataX, DataY=dataY,
DataE=dataE, NSpec=ndet, UnitX=unitX)
outws = api.AnalysisDataService.retrieve(outws_name)
api.LoadInstrument(outws, InstrumentName='DNS', RewriteSpectraMap=True)
run = outws.mutableRun()
if metadata.start_time and metadata.end_time:
run.setStartAndEndTime(DateAndTime(metadata.start_time),
DateAndTime(metadata.end_time))
# add name of file as a run title
fname = os.path.splitext(os.path.split(filename)[1])[0]
run.addProperty('run_title', fname, True)
# rotate the detector bank to the proper position
api.RotateInstrumentComponent(outws, "bank0", X=0, Y=1, Z=0, Angle=metadata.deterota)
# add sample log Ei and wavelength
logs["names"].extend(["Ei", "wavelength"])
logs["values"].extend([metadata.incident_energy, metadata.wavelength])
logs["units"].extend(["meV", "Angstrom"])
# add other sample logs
logs["names"].extend(["deterota", "mon_sum", "duration", "huber", "omega", "T1", "T2", "Tsp"])
logs["values"].extend([metadata.deterota, float(metadata.monitor_counts), metadata.duration,
metadata.huber, metadata.huber - metadata.deterota,
metadata.temp1, metadata.temp2, metadata.tsp])
logs["units"].extend(["Degrees", "Counts", "Seconds", "Degrees", "Degrees", "K", "K", "K"])
# flipper, coil currents and polarisation
flipper_status = 'OFF' # flipper OFF
if abs(metadata.flipper_precession_current) > sys.float_info.epsilon:
flipper_status = 'ON' # flipper ON
logs["names"].extend(["flipper_precession", "flipper_z_compensation", "flipper",
"C_a", "C_b", "C_c", "C_z", "polarisation", "polarisation_comment"])
logs["values"].extend([metadata.flipper_precession_current,
metadata.flipper_z_compensation_current, flipper_status,
metadata.a_coil_current, metadata.b_coil_current,
metadata.c_coil_current, metadata.z_coil_current,
str(pol[0]), str(pol[1])])
logs["units"].extend(["A", "A", "", "A", "A", "A", "A", "", ""])
# slits
logs["names"].extend(["slit_i_upper_blade_position", "slit_i_lower_blade_position",
"slit_i_left_blade_position", "slit_i_right_blade_position"])
logs["values"].extend([metadata.slit_i_upper_blade_position, metadata.slit_i_lower_blade_position,
metadata.slit_i_left_blade_position, metadata.slit_i_right_blade_position])
logs["units"].extend(["mm", "mm", "mm", "mm"])
# add information whether the data are normalized (duration/monitor/no):
api.AddSampleLog(outws, LogName='normalized', LogText=norm, LogType='String')
api.AddSampleLogMultiple(outws, LogNames=logs["names"], LogValues=logs["values"], LogUnits=logs["units"])
outws.setYUnit(yunit)
outws.setYUnitLabel(ylabel)
self.setProperty("OutputWorkspace", outws)
self.log().debug('LoadDNSLegacy: data are loaded to the workspace ' + outws_name)
return
