adcorr

Code CI Docs CI Test Coverage Latest PyPI version Apache License

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

PyPI

pip install adcorr

Source code

https://github.com/garryod/adcorr

Documentation

https://garryod.github.io/adcorr

Releases

https://github.com/garryod/adcorr/releases

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,
)
...

How the documentation is structured

Documentation is split into four categories, also accessible from links in the side-bar.

Tutorials

Tutorials for installation, library and commandline usage. New users start here.

How-to Guides

Practical step-by-step guides for the more experienced user.

Explanations

Explanation of how the library works and why it works that way.

Reference

Practical step-by-step guides for the more experienced user.

About the documentation

Why is the documentation structured this way?