SIXSLoader#

class cdiutils.io.SIXSLoader(experiment_file_path, scan=None, sample_name=None, detector_name=None, flat_field=None, alien_mask=None, version=None, **kwargs)[source]#

Bases: H5TypeLoader

A class for loading data from SIXS beamline experiments.

The SIXSLoader class handles data loading from the SOLEIL SIXS beamline. It is typically used internally by BcdiPipeline.

See Loader for inherited methods.

angle_names = {'detector_inplane_angle': 'delta', 'detector_outofplane_angle': 'gamma', 'sample_inplane_angle': 'omega', 'sample_outofplane_angle': 'mu'}#
authorised_detector_names = ('maxipix',)#
__init__(experiment_file_path, scan=None, sample_name=None, detector_name=None, flat_field=None, alien_mask=None, version=None, **kwargs)[source]#

Initialise SIXSLoader with experiment data directory path and detector information.

Parameters:

  • experiment_file_path (str) – path to the experiment file.

  • detector_name (str) – name of the detector.

  • sample_name (str, optional) – name of the sample. Defaults to None.

  • flat_field (np.ndarray | str, optional) – flat field to account for the non homogeneous counting of the detector. Defaults to None.

  • alien_mask (np.ndarray | str, optional) – array to mask the aliens. Defaults to None.

  • version (str, optional) – the version of the loader. Defaults to None.

load_detector_data(*args, **kwargs)#
load_motor_positions(*args, **kwargs)#
load_det_calib_params()[source]#

Load detector calibration parameters from experiment file.

Must be implemented by beamline-specific subclass. Typically reads values stored during detector alignment procedure.

Returns:

Calibration parameters with keys:

  • "direct_beam": (y, x) pixel coordinates of direct beam position

  • "detector_distance": sample-to-detector distance in metres

  • "outofplane_angle": detector rotation delta or gamma in degrees

  • "inplane_angle": detector rotation nu in degrees

Return type:

dict

See also

Detector Geometry Calibration for calibration procedures and parameter definitions.

load_energy(*args, **kwargs)#

Load X-ray beam energy for the scan.

Must be implemented by beamline-specific subclass.

Returns:

Beam energy in keV.

load_detector_shape(*args, **kwargs)#

Load detector’s native pixel array shape.

Must be implemented by beamline-specific subclass if detector shape cannot be determined from data files.

Returns:

Detector shape as (n_rows, n_columns) tuple, or None if shape is determined from data.

See Also#

Loader : Base loader class ID01Loader : Similar loader for ESRF ID01