https://github.com/diamondlightsource/adcorr
A collection of pure python functions for performing area detector corrections
https://github.com/diamondlightsource/adcorr
corrections python xray-diffraction
Last synced: 7 months ago
JSON representation
A collection of pure python functions for performing area detector corrections
- Host: GitHub
- URL: https://github.com/diamondlightsource/adcorr
- Owner: DiamondLightSource
- License: apache-2.0
- Created: 2022-06-30T15:28:27.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-13T18:26:16.000Z (about 2 years ago)
- Last Synced: 2025-02-23T09:34:29.340Z (over 1 year ago)
- Topics: corrections, python, xray-diffraction
- Language: Python
- Homepage:
- Size: 158 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.rst
- Contributing: .github/CONTRIBUTING.rst
- License: LICENSE
Awesome Lists containing this project
README
adcorr
======
|code_ci| |docs_ci| |coverage| |pypi_version| |license|
This package provides a set of pure python functions for performing corrections on area
detector data.
Install via PyPI with:
.. code:: bash
pip install adcorr
Useful Links
------------
============== ==============================================
PyPI https://pypi.org/project/adcorr/
Source code https://github.com/DiamondLightSource/adcorr
Documentation https://DiamondLightSource.github.io/adcorr
Releases https://github.com/DiamondLightSource/adcorr/releases
============== ==============================================
Brief Example
-------------
A brief example of performing corrections using the library is presented below:
.. code:: python
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 `_ |tests_numcertain| |coverage_numcertain|
`Pint `_ |tests_pint| |coverage_pint|
================================================================ ================== =====================
.. |code_ci| image:: https://github.com/DiamondLightSource/adcorr/workflows/Code%20CI/badge.svg?branch=main
:target: https://github.com/DiamondLightSource/adcorr/actions?query=workflow%3ACode+branch%3Amain
:alt: Code CI
.. |docs_ci| image:: https://github.com/DiamondLightSource/adcorr/workflows/Docs%20CI/badge.svg?branch=main
:target: https://github.com/DiamondLightSource/adcorr/actions?query=workflow%3ACode+branch%3Amain
:alt: Docs CI
.. |coverage| image:: https://codecov.io/gh/DiamondLightSource/adcorr/branch/main/graph/badge.svg?flag=core
:target: https://codecov.io/gh/DiamondLightSource/adcorr
:alt: Test Coverage
.. |tests_numcertain| image:: https://raw.githubusercontent.com/DiamondLightSource/adcorr/gh-badges/main/ubuntu-latest_3.9_false_numcertain.svg
:target: https://github.com/DiamondLightSource/adcorr/actions?query=workflow%3ACode+branch%3Amain
:alt: Numcertain Compatibility Test Outcome
.. |coverage_numcertain| image:: https://codecov.io/gh/DiamondLightSource/adcorr/branch/main/graph/badge.svg?flag=numcertain
:target: https://codecov.io/gh/DiamondLightSource/adcorr
:alt: Numcertain Compatibility Test Coverage
.. |tests_pint| image:: https://raw.githubusercontent.com/DiamondLightSource/adcorr/gh-badges/main/ubuntu-latest_3.9_false_pint.svg
:target: https://github.com/DiamondLightSource/adcorr/actions?query=workflow%3ACode+branch%3Amain
:alt: Pint Compatibility Test Outcome
.. |coverage_pint| image:: https://codecov.io/gh/DiamondLightSource/adcorr/branch/main/graph/badge.svg?flag=pint
:target: https://codecov.io/gh/DiamondLightSource/adcorr
:alt: Pint Compatibility Test Coverage
.. |pypi_version| image:: https://img.shields.io/pypi/v/adcorr.svg
:target: https://pypi.org/project/adcorr
:alt: Latest PyPI version
.. |license| image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
:target: https://opensource.org/licenses/Apache-2.0
:alt: Apache License
..
Anything below this line is used when viewing README.rst and will be replaced
when included in index.rst
See https://DiamondLightSource.github.io/adcorr for more detailed documentation.