calibration

Algorithms for the calibration of raw detector data frames.

This module contains algorithms that calibrate raw detector data frames, preparing them for data extraction,

Jungfrau1MCalibration

See documentation of the __init__ function.

__init__(*, dark_filenames, gain_filenames, photon_energy_kev)

Calibration of Jungfrau 1M detector.

This algorithm stores all the parameters required to calibrate the raw data frames collected by a Jungfrau 1M detector. After the algorithm has been initialized, it can be invoked to apply the calibration to a data frame.

Parameters:

Name	Type	Description	Default
dark_filenames	List[str]	A list of relative or absolute paths to files containing dark data for the calibration of the detector.	required
gain_filenames	List[str]	A list of relative or absolute paths to files containing gain data for the calibration of the detector.	required
photon_energy_kev	float	the photon energy (in Kev) at which the detector is operated.	required

apply_calibration(*, data)

Applies the calibration to a detector data frame.

This function calibrates the provided raw detector data frame. It determines the gain stage for each pixel in the frame, and applies the corresponding gain and offset corrections.

Parameters:

Name	Type	Description	Default
data	NDArray[numpy.int_]	The raw detector data frame to calibrate.	required

Returns:

Type	Description
NDArray[numpy.float_]	The calibrated data frame.