Ewoks Tasks#

ReadXasHdf5#

Read one XAS scan with XDI structured metadata.

Identifier:
ewoksbm08.tasks.read_xas.ReadXasHdf5
Task type:
class
Inputs:
filename* : str

Bliss HDF5 file name.

entry_name* : str

NeXus entry name.

Examples:
  • '1.1'
  • '5.2'
mono_counter* : str

Counter of the energy or theta value of the monochromator.

crystal_motor* : str

Motor that selects the monochromator crystal.

optional_counters : list[str | None]= None

Counters other than the energy to be added to the XDI data.

optional_mca_counters : list[str | None]= None

MCA counters (ROI’s) other than the energy to be added to the XDI data.

livetime_normalization : float | None= None

Live-time normalization in seconds for ‘optional_mca_counters’ (None: no normalization, <=0 the median of the elapsed time).

skip_mca : dict[str, list[int | None]]= None

Skip detectors from MCA controllers.

Examples:
  • {'d08xmap': [1, 3]}
retry_timeout : float | None= 0.0

Timeout when trying to read data from HDF5.

mono_edge_theoretical : float | None= None

The theoretical edge position in ‘mono_counter’ units.

mono_edge_experimental : float | None= None

The experimental edge position in ‘mono_counter’ units.

Outputs:
xdi_data : ewoksbm08.io.types.XdiData

SaveXasXdi#

Save one XAS scan as an XDI file.

Identifier:
ewoksbm08.tasks.save_xas.SaveXasXdi
Task type:
class
Inputs:
filename* : str

XDI file name.

xdi_data* : ewoksbm08.io.types.XdiData

XDI data to be saved.

Outputs:
output_filename : str

XDI file name.

Additional models#

XdiData#

Fields:
column_names* : list[str]
column_data* : list[numpy.ndarray]
xdi_metadata* : ewoksbm08.io.types.XdiMetadata

XdiMetadata#

Fields:
Scheme : str= XDI/1.0 GSE/1.0
Title : str= Data collected at BM08-LISA of ESRF preproccessed with the beamline Calibration Tool
Facility* : ewoksbm08.io.types.XdiFacility
Beamline* : ewoksbm08.io.types.XdiBeamline
Scan : ewoksbm08.io.types.XdiScan | None= None
Mono : ewoksbm08.io.types.XdiMono | None= None
Sample : ewoksbm08.io.types.XdiSample | None= None

XdiFacility#

Fields:
name : str= ESRF
xray_source : str= bending magnet
current : float | None= None
fillingMode : str | None= None

XdiBeamline#

Fields:
name : str= BM08-LISA

XdiScan#

Fields:
start_time : str | None= None
end_time : str | None= None

XdiMono#

Fields:
name : str | None= None
d_spacing : float | None= None
notes : str | None= LNT cooled

XdiSample#

Fields:
name : str | None= None

XdiData#

Fields:
column_names* : list[str]
column_data* : list[numpy.ndarray]
xdi_metadata* : ewoksbm08.io.types.XdiMetadata

XdiMetadata#

Fields:
Scheme : str= XDI/1.0 GSE/1.0
Title : str= Data collected at BM08-LISA of ESRF preproccessed with the beamline Calibration Tool
Facility* : ewoksbm08.io.types.XdiFacility
Beamline* : ewoksbm08.io.types.XdiBeamline
Scan : ewoksbm08.io.types.XdiScan | None= None
Mono : ewoksbm08.io.types.XdiMono | None= None
Sample : ewoksbm08.io.types.XdiSample | None= None

XdiFacility#

Fields:
name : str= ESRF
xray_source : str= bending magnet
current : float | None= None
fillingMode : str | None= None

XdiBeamline#

Fields:
name : str= BM08-LISA

XdiScan#

Fields:
start_time : str | None= None
end_time : str | None= None

XdiMono#

Fields:
name : str | None= None
d_spacing : float | None= None
notes : str | None= LNT cooled

XdiSample#

Fields:
name : str | None= None