Ewoks tasks#

This document provides the available Ewoks tasks in ewoksid31.

FlatFieldFromEnergy#

Interpolate an energy-stack of flat-field images.

The resulting flat-field image can be used as follows to correct diffraction patterns for flat field:

Icor = I / flatfield

Output:

  • flatfield: 2D numpy.ndarray

Identifier:
ewoksid31.tasks.flatfield.FlatFieldFromEnergy
Task type:
class
Inputs:
newflat* : str

Filename of ID31 P3 detector flatfield

Examples:
  • '/data/id31/inhouse/P3/flats.mat'
oldflat* : str

Filename of ID31 P3 detector ‘old’ flatfield

Examples:
  • '/data/id31/inhouse/P3/flats_old.mat'
energy* : float | str

X-ray energy in KeV or URL of hdf5 dataset storing its value

Examples:
  • 75.0
  • '/path/to/file.f5::/2.1/instrument/positioners/energy'
enabled : bool= True
Outputs:
flatfield

SaveNexusPatternsAsId31TomoHdf5#

Save integrated XRD patterns into an HDF5 file compatible with ID31 tomography workflow.

Output:

  • filename (str): Path to the written HDF5 file, or empty string if skipped.

Identifier:
ewoksid31.tasks.tomo.SaveNexusPatternsAsId31TomoHdf5
Task type:
class
Inputs:
scan_entry_url* : str

HDF5 URL to the NXentry group containing the ‘measurement’ group

Examples:
  • '/path/to/raw_data/file.f5::/2.1'
rot_name* : str

Dataset name in ‘measurement’ for rotation angles

Examples:
  • 'nth'
y_name* : str

Dataset name in ‘measurement’ for horizontal positions

Examples:
  • 'ny'
nxdata_url* : str

HDF5 URL to the NXdata group containing integrated patterns

Examples:
  • '/path/to/processed_data/file.f5::/2.1/p3_integrate/integrated'
output_filename* : str

Path to the output HDF5 file

Examples:
  • '/path/to/processed_data/tomo.f5'
enabled : bool= True
overwrite : bool= False
retry_timeout : float | None= None

Duration in seconds for which to try to open HDF5 files

retry_period : float | None= None

Amount of time in seconds between each attempt to open HDF5 files

Outputs:
filename