Spectroscopy tasks

How to use

These tasks come from est. It can be installed with

pip install est

ℹ️ These tasks are used at the following ESRF beamlines: BM08, BM23, ID24

EnergyROIProcess

Identifier:

est.core.process.energyroi.EnergyROIProcess

Task type:

class

Inputs:

xas_obj*

energy_roi

Outputs:

xas_obj

IgnoreOutput

Simple Ignore task when an input is provided but no output. Used in the case of pure display widget.

.. note::

Each OW should define it own task to ensure a safe conversion to ewoks.

Identifier:

est.core.process.ignoreprocess.IgnoreOutput

Task type:

class

Inputs:

xas_obj*

BlankTask

Simple black task which will copy received xas_obj from inputs to outputs.

.. note::

Each OW should define it own task to ensure a safe conversion to ewoks.

Identifier:

est.core.process.ignoreprocess.BlankTask

Task type:

class

Inputs:

xas_obj*

Outputs:

xas_obj

IgnoreSavingPoint

Identifier:

est.core.process.ignoreprocess.IgnoreSavingPoint

Task type:

class

Inputs:

xas_obj*

Outputs:

xas_obj

IgnoreE0Calculation

Identifier:

est.core.process.ignoreprocess.IgnoreE0Calculation

Task type:

class

Inputs:

xas_obj*

Outputs:

xas_obj

ReadXasObject

Identifier:

est.core.process.io.ReadXasObject

Task type:

class

Inputs:

input_information*

Outputs:

xas_obj

DumpXasObject

Identifier:

est.core.process.io.DumpXasObject

Task type:

class

Inputs:

output_file*

xas_obj*

Outputs:

result

NoiseProcess

Identifier:

est.core.process.noise.NoiseProcess

Task type:

class

Inputs:

xas_obj*

e_max

e_min

polynomial_order

window_size

Outputs:

xas_obj

PlotSpectrumData

Identifier:

est.core.process.plotspectrumdata.PlotSpectrumData

Task type:

class

Inputs:

xas_obj*

plot_names

Outputs:

plot_data

ReadXasObject

Identifier:

est.core.process.read.ReadXasObject

Task type:

class

Inputs:

input_information*

Outputs:

xas_obj

ROIProcess

Identifier:

est.core.process.roi.ROIProcess

Task type:

class

Inputs:

roi_origin*

roi_size*

xas_obj*

Outputs:

xas_obj

SplitBlissScan

Split a Bliss scan in subscans as determined by a channel which is monotonically increasing or descreasing in each subscan or determined by subscan size.

param input_names:

• filename: HDF5 file name containing the Bliss scan.

• scan_number: The Bliss scan number.

• monotonic_channel: HDF5 path relative to the scan group.

• out_filename: HDF5 file name to save subscans as a result of splitting the Bliss scan.

param optional_input_names:

• subscan_size: Fix length subscan size.

• trim_n_points: Trim N points from the start and end of each subscan.

• wait_finished: Wait for the Bliss scan to be complete in HDF5.

• retry_timeout: Timeout of waiting for the Bliss scan to be complete in HDF5.

• retry_period: Check period of waiting for the Bliss scan to be complete in HDF5.

• counter_group: Group of counters to check whether a subscan is fully complete.

param output_names:

• out_urls: HDF5 URL’s of the subscans as a result of splitting the Bliss scan.

Identifier:

est.core.process.split.SplitBlissScan

Task type:

class

Inputs:

filename*

monotonic_channel*

out_filename*

scan_number*

counter_group

retry_period

retry_timeout

subscan_size

trim_n_points

wait_finished

Outputs:

out_urls

WriteXasObject

Identifier:

est.core.process.write.WriteXasObject

Task type:

class

Inputs:

output_file*

xas_obj*

Outputs:

result

Larch_autobk

Extract the fine-structure from XAS spectra by subtracting the “background” (the jump without oscillations).

Identifier:

est.core.process.larch.autobk.Larch_autobk

Task type:

class

Inputs:

xas_obj*

autobk_config

Outputs:

xas_obj

Larch_mback

Identifier:

est.core.process.larch.mback.Larch_mback

Task type:

class

Inputs:

xas_obj*

mback_config

Outputs:

xas_obj

Larch_mback_norm

Identifier:

est.core.process.larch.mback_norm.Larch_mback_norm

Task type:

class

Inputs:

xas_obj*

mback_norm

mback_norm_config

Outputs:

xas_obj

Larch_pre_edge

Pre- and post-edge normalization of XAS spectra.

Identifier:

est.core.process.larch.pre_edge.Larch_pre_edge

Task type:

class

Inputs:

xas_obj*

pre_edge_config

Outputs:

xas_obj

Larch_xftf

Fourier transform of the XAS fine-structure.

Identifier:

est.core.process.larch.xftf.Larch_xftf

Task type:

class

Inputs:

xas_obj*

xftf_config

Outputs:

xas_obj

PyMca_exafs

Extract the fine-structure from XAS spectra.

Identifier:

est.core.process.pymca.exafs.PyMca_exafs

Task type:

class

Inputs:

xas_obj*

exafs

Outputs:

xas_obj

PyMca_ft

Fourier transform of the XAS fine-structure.

Identifier:

est.core.process.pymca.ft.PyMca_ft

Task type:

class

Inputs:

xas_obj*

ft

Outputs:

xas_obj

PyMca_k_weight

K-weighting XAS spectra.

Identifier:

est.core.process.pymca.k_weight.PyMca_k_weight

Task type:

class

Inputs:

xas_obj*

k_weight

Outputs:

xas_obj

PyMca_normalization

Pre- and post-edge normalization of XAS spectra.

Identifier:

est.core.process.pymca.normalization.PyMca_normalization

Task type:

class

Inputs:

xas_obj*

normalization

Outputs:

xas_obj