adcorr

This package provides a set of pure python functions for performing corrections on area detector data.

Install via PyPI with:

pip install adcorr

Useful Links

PyPI	https://pypi.org/project/adcorr/
Source code	DiamondLightSource/adcorr
Documentation	https://DiamondLightSource.github.io/adcorr
Releases	DiamondLightSource/adcorr

Brief Example

A brief example of performing corrections using the library is presented below:

frames = load_my_frames()
mask = load_my_mask()
count_times = load_count_times()

frames = mask_frames(frames, mask)
frames = correct_deadtime(
    frames,
    count_times,
    DETECTOR_MINIMUM_PULSE_SEPARATION,
    DETECTOR_MINIMUM_ARRIVAL_SEPARATION,
)
frames = correct_dark_current(
    frames,
    count_times,
    BASE_DARK_CURRENT,
    TEMPORAL_DARK_CURRENT,
    FLUX_DEPENDANT_DARK_CURRENT,
)
...

Library Compatibility

Library	Tests	Coverage
numcertain
Pint

How the documentation is structured

The documentation is split into 2 sections:

The User Guide contains documentation on how to install and use adcorr.

The Developer Guide contains documentation on how to develop and contribute changes back to adcorr.