364 lines
14 KiB
Python
364 lines
14 KiB
Python
"""
|
|
repeated xps scans with reference sample
|
|
|
|
usage
|
|
=====
|
|
|
|
1. set the NUMBER_OF_ITERATIONS
|
|
2. set the REFERENCE_POSITION and SAMPLE_POSITION
|
|
3. set the REGION parameters
|
|
|
|
troubleshooting
|
|
===============
|
|
|
|
if the script runs through very quickly without measuring anything:
|
|
check that all position values include a decimal point!!!
|
|
|
|
"""
|
|
|
|
# dummy scan (time series)
|
|
MOTORS = [dummy]
|
|
|
|
# number of cycles (integer - not decimal point!)
|
|
# (actual number of cycles is + 1)
|
|
NUMBER_OF_CYCLES = 0
|
|
POSITIONS = [1., 10., NUMBER_OF_CYCLES]
|
|
SCAN = 'lscan'
|
|
|
|
# seconds to wait between positioning command and triggering the detector
|
|
LATENCY = 0.0
|
|
|
|
# region setup
|
|
#
|
|
# for each region, define a python dictionary with the following items.
|
|
# optional items can be left unspecified and will default to the indicated values.
|
|
# for swept mode, include 'elo', 'ehi', 'estep', 'iter' values, but do not include 'efix'.
|
|
# for fixed mode, include 'efix' value, but do not include 'elo', 'ehi', 'estep', 'iter'.
|
|
#
|
|
# 'name': user-specific name of the region (for graph title and RegionName attribute in data file)
|
|
# 'elo': lower kinetic energy boundary of the spectrum
|
|
# 'ehi': upper kinetic energy boundary of the spectrum
|
|
# 'estep': energy step size
|
|
# 'efix': center kinetic energy in fixed mode
|
|
# 'epass': pass energy
|
|
# 'ephot': photon energy (default: unchanged)
|
|
# 'tstep': dwell time in seconds
|
|
# 'iter': number of iterations/sweeps (default 1)
|
|
# 'cis': True = constant initial state (photoemission line), False = constant final state (Auger peak), (default False)
|
|
# 'slit': exit slit (default: unchanged)
|
|
# 'position': 'reference' or 'sample'
|
|
|
|
REFERENCE_POSITION = {'X': -0.7,'Y': 0., 'Z': 118., 'Theta': -9., 'Tilt': -2.0, 'Phi': -90.}
|
|
SAMPLE_POSITION = {'X': -1.1,'Y': 0., 'Z': 114., 'Theta': -9., 'Tilt': -2.0, 'Phi': -90.}
|
|
|
|
# REGIONS for 578 eV
|
|
REGION1 = {'name': 'Cu3p','ephot': 578., 'elo': 482., 'ehi':492., 'estep': 0.02, 'epass': 50., 'tstep': 0.2, 'iter': 1, 'cis': False, 'position': 'reference'}
|
|
REGION2 = {'name': 'In4d','ephot': 578., 'elo': 552.5, 'ehi':559., 'estep':0.02, 'epass': 50., 'tstep': 0.1, 'iter': 1, 'cis': False, 'position': 'sample'}
|
|
REGION3 = {'name': 'As3d','ephot': 578., 'elo': 529., 'ehi':534.5, 'estep':0.02, 'epass': 50., 'tstep': 0.1, 'iter': 1, 'cis': False, 'position': 'sample'}
|
|
REGION4 = {'name': 'In3d','ephot': 578., 'elo': 119., 'ehi':124., 'estep':0.02, 'epass': 50., 'tstep': 0.1, 'iter': 1, 'cis': False, 'position': 'sample'}
|
|
|
|
# REGIONS for 1050 eV
|
|
#REGION1 = {'name': 'Au4f', 'ephot': 1050., 'elo': 954., 'ehi':964, 'estep': 0.02, 'epass': 50., 'tstep': 0.2, 'iter': 1, 'cis': False, 'position': 'reference'}
|
|
#REGION2 = {'name': 'In4d','ephot': 1050., 'elo': 1024.5, 'ehi':1031., 'estep':0.02, 'epass': 50., 'tstep': 0.1, 'iter': 1, 'cis': False, 'position': 'sample'}
|
|
#REGION3 = {'name': 'As3d','ephot': 1050., 'elo': 1002., 'ehi':1007.5, 'estep':0.02, 'epass': 50., 'tstep': 0.2, 'iter': 1, 'cis': False, 'position': 'sample'}
|
|
#REGION4 = {'name': 'In3d','ephot': 1050., 'elo': 591., 'ehi':596., 'estep':0.02, 'epass': 50., 'tstep': 0.2, 'iter': 1, 'cis': False, 'position': 'sample'}
|
|
|
|
|
|
# list of region dictionaries to execute at each scan position
|
|
REGIONS = [REGION1, REGION2, REGION3, REGION4]
|
|
|
|
# close beam shutter and turn off analyser at the end of the scan
|
|
# True or False
|
|
CLOSE_SHUTTER_AT_END = False
|
|
|
|
|
|
# --- DO NOT EDIT BELOW THIS LINE! ---
|
|
|
|
set_exec_pars(keep=False)
|
|
set_exec_pars(compression=True)
|
|
|
|
def check_region(region):
|
|
"""
|
|
check region dictionary items and apply defaults where necessary
|
|
"""
|
|
region['fixed'] = 'efix' in region
|
|
if region['fixed']:
|
|
region['elo'] = region['efix']
|
|
region['ehi'] = region['efix']
|
|
if 'iter' not in region:
|
|
region['iter'] = 1
|
|
print("region {0}: setting default iter = {1}".format(region['name'], region['iter']))
|
|
if 'cis' not in region:
|
|
region['cis'] = False
|
|
print("region {0}: setting default cis = {1}".format(region['name'], region['cis']))
|
|
|
|
def move_to_position(pdict):
|
|
ManipulatorX.move(pdict['X'])
|
|
ManipulatorY.move(pdict['Y'])
|
|
ManipulatorZ.move(pdict['Z'])
|
|
ManipulatorTheta.move(pdict['Theta'])
|
|
ManipulatorTilt.move(pdict['Tilt'])
|
|
ManipulatorPhi.move(pdict['Phi'])
|
|
|
|
class SpectrumReader(ReadonlyRegisterBase, ReadonlyRegisterArray):
|
|
"""
|
|
pseudo-device class to acquire and read out a Scienta spectrum per region.
|
|
|
|
this devices starts the spectrum acquisition and organises the data file.
|
|
"""
|
|
def initialize(self):
|
|
#super(SpectrumReader, self).initialize()
|
|
self.scan_index = -1
|
|
|
|
def create_datasets(self):
|
|
path = get_exec_pars().scanPath + self.region_name + "/"
|
|
|
|
self.channel_begin_dataset_name = path + "ScientaChannelBegin"
|
|
self.channel_end_dataset_name = path + "ScientaChannelEnd"
|
|
create_dataset(self.channel_begin_dataset_name, 'd')
|
|
create_dataset(self.channel_end_dataset_name, 'd')
|
|
if self.region['fixed']:
|
|
self.channel_center_dataset_name = path + "ScientaChannelCenter"
|
|
create_dataset(self.channel_center_dataset_name, 'd')
|
|
else:
|
|
self.step_energy_dataset_name = path + "ScientaStepEnergy"
|
|
create_dataset(self.step_energy_dataset_name, 'd')
|
|
|
|
if 'epass' in self.region:
|
|
self.pass_energy_dataset_name = path + "ScientaPassEnergy"
|
|
create_dataset(self.pass_energy_dataset_name, 'd')
|
|
if 'tstep' in self.region:
|
|
self.step_time_dataset_name = path + "ScientaStepTime"
|
|
create_dataset(self.step_time_dataset_name, 'd')
|
|
if 'iter' in self.region:
|
|
self.iterations_dataset_name = path + "ScientaIterations"
|
|
create_dataset(self.iterations_dataset_name, 'd')
|
|
if 'slit' in self.region:
|
|
self.slit_dataset_name = path + "ExitSlit"
|
|
create_dataset(self.slit_dataset_name, 'd')
|
|
if 'position' in self.region:
|
|
position_names = {key:path + "Position"+ key for key in ['X','Y','Z','Theta','Tilt','Phi']}
|
|
self.position_dataset_names = position_names
|
|
for datanames in self.position_dataset_names.values():
|
|
create_dataset(datanames, 'd')
|
|
|
|
def setup(self):
|
|
# print("spectrum.setup")
|
|
if self.scan_index != get_exec_pars().index:
|
|
self.scan_index = get_exec_pars().index
|
|
self.create_datasets()
|
|
|
|
print "scan {0}, region {1} ({2})".format(self.scan_index, self.region_index, self.region['name'])
|
|
|
|
edelta = 0.0
|
|
try:
|
|
ephot = self.region['ephot']
|
|
Eph.move(ephot)
|
|
except KeyError:
|
|
ephot = Eph.take(100)
|
|
|
|
if isinstance(ephot, float) and ephot > 0.:
|
|
try:
|
|
if self.region['cis']:
|
|
edelta = ephot - self.ephot_start
|
|
except AttributeError:
|
|
self.ephot_start = ephot
|
|
|
|
elo = self.region['elo'] + edelta
|
|
ehi = self.region['ehi'] + edelta
|
|
|
|
if self.region['fixed']:
|
|
Scienta.setAcquisitionMode(ch.psi.pshell.epics.Scienta.AcquisitionMode.Fixed)
|
|
Scienta.centerEnergy.write(elo)
|
|
append_dataset(self.channel_center_dataset_name, elo)
|
|
else:
|
|
Scienta.setAcquisitionMode(ch.psi.pshell.epics.Scienta.AcquisitionMode.Swept)
|
|
Scienta.lowEnergy.write(elo)
|
|
Scienta.highEnergy.write(ehi)
|
|
Scienta.stepSize.write(self.region['estep'])
|
|
append_dataset(self.step_energy_dataset_name, self.region['estep'])
|
|
|
|
try:
|
|
Scienta.setPassEnergy(int(self.region['epass']))
|
|
append_dataset(self.pass_energy_dataset_name, self.region['epass'])
|
|
except KeyError:
|
|
pass
|
|
|
|
try:
|
|
Scienta.stepTime.write(self.region['tstep'])
|
|
append_dataset(self.step_time_dataset_name, self.region['tstep'])
|
|
except KeyError:
|
|
pass
|
|
|
|
try:
|
|
Scienta.setIterations(self.region['iter'])
|
|
append_dataset(self.iterations_dataset_name, self.region['iter'])
|
|
except KeyError:
|
|
pass
|
|
|
|
try:
|
|
ExitSlit.write(self.region['slit'])
|
|
append_dataset(self.slit_dataset_name, self.region['slit'])
|
|
except KeyError:
|
|
pass
|
|
|
|
if self.region['position'] == 'sample':
|
|
move_to_position(SAMPLE_POSITION)
|
|
|
|
for name in SAMPLE_POSITION.keys():
|
|
append_dataset(self.position_dataset_names[name], SAMPLE_POSITION[name])
|
|
|
|
elif self.region['position'] == 'reference':
|
|
move_to_position(REFERENCE_POSITION)
|
|
|
|
for name in REFERENCE_POSITION.keys():
|
|
append_dataset(self.position_dataset_names[name], SAMPLE_POSITION[name])
|
|
|
|
Scienta.update()
|
|
|
|
def read(self):
|
|
# print("spectrum.read")
|
|
global current_region_index
|
|
current_region_index = self.region_index
|
|
self.setup()
|
|
# print("Acquiring region {0}.".format(self.region['name']))
|
|
trig_scienta()
|
|
time.sleep(0.1)
|
|
sp = Scienta.getSpectrum().read()
|
|
append_dataset(self.channel_begin_dataset_name, Scienta.getChannelBegin().getValue())
|
|
append_dataset(self.channel_end_dataset_name, Scienta.getChannelEnd().getValue())
|
|
return sp
|
|
|
|
def getSize(self):
|
|
# this is called before the scan starts - we have to predict the spectrum size
|
|
# wrong values don't seem to affect the data files, however
|
|
if self.region['fixed']:
|
|
nx = 1066
|
|
else:
|
|
nx = int((self.region['ehi'] - self.region['elo']) / self.region['estep']) + 1
|
|
return nx
|
|
|
|
|
|
class ImageReader(ReadonlyRegisterBase, ReadonlyRegisterMatrix):
|
|
"""
|
|
pseudo-device class to read out the Scienta image per region.
|
|
|
|
this device just reads out the Scienta image that has been acquired by SpectrumReader.
|
|
"""
|
|
def read(self):
|
|
# print("image.read")
|
|
return Scienta.getDataMatrix().read()
|
|
|
|
def getWidth(self):
|
|
# this is called before the scan starts - we have to predict the spectrum size
|
|
# wrong values don't seem to affect the data files, however
|
|
if self.region['fixed']:
|
|
nx = 1066
|
|
else:
|
|
nx = int((self.region['ehi'] - self.region['elo']) / self.region['estep']) + 1
|
|
return nx
|
|
|
|
def getHeight(self):
|
|
# this is called before the scan starts - the number of slices is an independent parameter
|
|
ny = Scienta.slices.read()
|
|
return ny
|
|
|
|
class SimpleDeviceReader(Readable):
|
|
"""
|
|
pseudo-device class to read out another device once per region.
|
|
|
|
the device must be set assigned to the source attribute.
|
|
"""
|
|
def read(self):
|
|
return self.source.read()
|
|
|
|
|
|
def setup_live_plots(regions):
|
|
global live_plots
|
|
global current_region_index
|
|
names = [region['name'] for region in regions]
|
|
live_plots = plot(None, names, title="Live Spectra")
|
|
current_region_index = 0
|
|
|
|
def update_live_plots():
|
|
global live_plots
|
|
global current_region_index
|
|
try:
|
|
while get_context().state.running:
|
|
y = Scienta.spectrum.take(100)
|
|
x = Scienta.spectrumX
|
|
try:
|
|
series = live_plots[current_region_index].getSeries(0)
|
|
series.setData(x, y)
|
|
except IndexError:
|
|
pass
|
|
time.sleep(1.0)
|
|
finally:
|
|
print "Stopping live spectra"
|
|
|
|
def do_scan(scan, motors, positions, regions, latency):
|
|
"""
|
|
set up detectors and run the scan
|
|
|
|
for each region we have to add a SpectrumReader and an ImageReader pseudo-device to the SENSORS list.
|
|
the order SpectrumReader, ImageReader is important because the SpectrumReader triggers the Scienta,
|
|
whereafter the ImageReader reads the image.
|
|
"""
|
|
global SENSORS
|
|
|
|
SENSORS = []
|
|
|
|
for (index, region) in enumerate(regions):
|
|
check_region(region)
|
|
|
|
reader = SpectrumReader()
|
|
reader.region_index = index
|
|
reader.region_name = "region{0}".format(index + 1)
|
|
reader.region = region
|
|
reader.initialize()
|
|
set_device_alias(reader, reader.region_name + "/ScientaSpectrum")
|
|
SENSORS.append(reader)
|
|
|
|
image = ImageReader()
|
|
image.region_index = index
|
|
image.region = region
|
|
image.initialize()
|
|
set_device_alias(image, reader.region_name + "/ScientaImage")
|
|
SENSORS.append(image)
|
|
|
|
dev = SimpleDeviceReader()
|
|
dev.source = SampleCurrent
|
|
set_device_alias(dev, reader.region_name + "/SampleCurrent")
|
|
SENSORS.append(dev)
|
|
|
|
dev = SimpleDeviceReader()
|
|
dev.source = RefCurrent
|
|
set_device_alias(dev, reader.region_name + "/RefCurrent")
|
|
SENSORS.append(dev)
|
|
|
|
adjust_sensors()
|
|
set_adc_averaging()
|
|
|
|
if scan == 'ascan':
|
|
ascan(motors, SENSORS, positions[0], positions[1], positions[2], latency, False, zigzag = True, before_read=wait_beam, after_read = after_readout)
|
|
elif scan == 'lscan':
|
|
lscan(motors, SENSORS, positions[0], positions[1], positions[2], latency, False, before_read=wait_beam, after_read = after_readout)
|
|
elif scan == 'vscan':
|
|
vscan(motors, SENSORS, positions, True, latency,False, before_read=wait_beam, after_read = after_readout)
|
|
else:
|
|
print('unknown scan mode {}'.format(scan))
|
|
|
|
for (index, region) in enumerate(regions):
|
|
set_attribute(get_exec_pars().scanPath + "region{0}/ScientaSpectrum".format(index + 1), "RegionName", region['name'])
|
|
set_attribute(get_exec_pars().scanPath + "region{0}/ScientaImage".format(index + 1), "RegionName", region['name'])
|
|
set_attribute(get_exec_pars().scanPath, "Regions", [region['name'] for region in regions])
|
|
|
|
try:
|
|
setup_live_plots(REGIONS)
|
|
task = fork(update_live_plots)
|
|
do_scan(SCAN, MOTORS, POSITIONS, REGIONS, LATENCY)
|
|
finally:
|
|
if CLOSE_SHUTTER_AT_END:
|
|
after_scan()
|
|
|