diff --git a/script/MultiRegionScan.py b/script/MultiRegionScan.py index be3f4753..bf4eb2e8 100644 --- a/script/MultiRegionScan.py +++ b/script/MultiRegionScan.py @@ -1,20 +1,63 @@ """ -Arguments: - +Discrete photon energy scan (vector scan) of multiple spectral regions """ +# scan positioner: Eph = photon energy MOTORS = [Eph] +# comma-separated discrete list of scan positions POSITIONS = [600.0, 610.0] +# 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 +# '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 current value) + REGION1 = {'name': 'Peak 1', 'elo': 243.0, 'ehi': 253.0, 'estep': 0.1, 'epass': 50, 'tstep': 0.1, 'iter': 1, 'cis': True} REGION2 = {'name': 'Peak 2', 'elo': 214.0, 'ehi': 219.0, 'estep': 0.1, 'epass': 50, 'tstep': 0.1, 'iter': 2, 'cis': False} + +# list of region dictionaries to execute at each scan position REGIONS = [REGION1, REGION2] +# close beam shutter and turn off analyser at the end of the scan CLOSE_SHUTTER_AT_END = True -Scienta.setAcquisitionMode(ch.psi.pshell.epics.Scienta.AcquisitionMode.Swept) +# --- DO NOT EDIT BELOW THIS LINE! --- + + +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'])) + if 'slit' not in region: + region['slit'] = ExitSlit.read() + print("region {0}: setting default slit = {1}".format(region['name'], region['slit'])) + class SpectrumReader(ReadonlyRegisterBase, ReadonlyRegisterArray): def initialize(self): #super(SpectrumReader, self).initialize() @@ -25,17 +68,21 @@ class SpectrumReader(ReadonlyRegisterBase, ReadonlyRegisterArray): self.channel_begin_dataset_name = path + "ScientaChannelBegin" self.channel_end_dataset_name = path + "ScientaChannelEnd" + self.channel_center_dataset_name = path + "ScientaChannelCenter" self.pass_energy_dataset_name = path + "ScientaPassEnergy" self.step_energy_dataset_name = path + "ScientaStepEnergy" self.step_time_dataset_name = path + "ScientaStepTime" self.iterations_dataset_name = path + "ScientaIterations" - + self.slit_dataset_name = path + "ExitSlit" + create_dataset(self.channel_begin_dataset_name, 'd') create_dataset(self.channel_end_dataset_name, 'd') + create_dataset(self.channel_center_dataset_name, 'd') create_dataset(self.pass_energy_dataset_name, 'd') create_dataset(self.step_energy_dataset_name, 'd') create_dataset(self.step_time_dataset_name, 'd') create_dataset(self.iterations_dataset_name, 'd') + create_dataset(self.slit_dataset_name, 'd') def setup(self): if self.scan_index != get_exec_pars().index: @@ -57,33 +104,48 @@ class SpectrumReader(ReadonlyRegisterBase, ReadonlyRegisterArray): elo = self.region['elo'] + edelta ehi = self.region['ehi'] + edelta - Scienta.lowEnergy.write(elo) - Scienta.highEnergy.write(ehi) - Scienta.stepSize.write(self.region['estep']) + if self.region['fixed']: + Scienta.setAcquisitionMode(ch.psi.pshell.epics.Scienta.AcquisitionMode.Fixed) + Scienta.centerEnergy.write(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']) + Scienta.setPassEnergy(self.region['epass']) Scienta.stepTime.write(self.region['tstep']) Scienta.setIterations(self.region['iter']) + ExitSlit.write(self.region['slit']) Scienta.update() - append_dataset(self.channel_begin_dataset_name, elo) - append_dataset(self.channel_end_dataset_name, ehi) + if self.region['fixed']: + append_dataset(self.channel_center_dataset_name, elo) + else: + append_dataset(self.channel_begin_dataset_name, elo) + append_dataset(self.channel_end_dataset_name, ehi) + append_dataset(self.step_energy_dataset_name, self.region['estep']) + append_dataset(self.pass_energy_dataset_name, self.region['epass']) - append_dataset(self.step_energy_dataset_name, self.region['estep']) append_dataset(self.step_time_dataset_name, self.region['tstep']) append_dataset(self.iterations_dataset_name, self.region['iter']) + append_dataset(self.slit_dataset_name, self.region['slit']) def read(self): global current_region_index current_region_index = self.region_index self.setup() - print "Photon energy {ephot} eV. Acquiring spectrum {elo}-{ehi} eV.".format(ephot=Eph.read(), elo=Scienta.lowEnergy.value, ehi=Scienta.highEnergy.value) + print("Acquiring region {0}.".format(self.region['name']) trig_scienta() time.sleep(0.5) sp = Scienta.getSpectrum().read() return sp def getSize(self): - nx = int((self.region['ehi'] - self.region['elo']) / self.region['estep']) + 1 + if self.region['fixed']: + nx = 992 + else: + nx = int((self.region['ehi'] - self.region['elo']) / self.region['estep']) + 1 return nx @@ -92,7 +154,10 @@ class ImageReader(ReadonlyRegisterBase, ReadonlyRegisterMatrix): return Scienta.getDataMatrix().read() def getWidth(self): - nx = int((self.region['ehi'] - self.region['elo']) / self.region['estep']) + 1 + if self.region['fixed']: + nx = 992 + else: + nx = int((self.region['ehi'] - self.region['elo']) / self.region['estep']) + 1 return nx def getHeight(self): @@ -128,6 +193,8 @@ def do_scan(motors, positions, regions, latency): SENSORS = [] for (index, region) in enumerate(regions): + check_region(region) + reader = SpectrumReader() reader.region_index = index reader.region_name = "region{0}".format(index + 1)