NeuNorm

NeuNorm: Neutron Imaging Normalization Library - Published in JOSS (2018)

https://github.com/scikit-beam/neunorm

Science Score: 95.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 4 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org, zenodo.org
  • Committers with academic emails
    1 of 2 committers (50.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Scientific Fields

Mathematics Computer Science - 37% confidence
Last synced: 10 months ago · JSON representation

Repository

Normalization of fits and tiff files

Basic Info
  • Host: GitHub
  • Owner: scikit-beam
  • License: bsd-3-clause
  • Language: Python
  • Default Branch: master
  • Size: 5.45 MB
Statistics
  • Stars: 2
  • Watchers: 11
  • Forks: 1
  • Open Issues: 6
  • Releases: 4
Created almost 9 years ago · Last pushed over 2 years ago
Metadata Files
Readme Contributing License

README.md

PyPI version codecov Documentation Status DOI DOI

Abstract

NeuNorm is an open-source Python library that normalized neutron imaging measurements.

In order to cancel detector electronic noises, source beam fluctuations and other pollution signals from close by beam lines, every data acquired need to be normalized. In order to perform the normalization, one must take, in addition to his data set, either 1 or 2 extra data set. A set of open beam (OB) when sample has been removed but beam is on. An optional set of dark field (DF) is taken when beam is off and sample off. The dark field allows to clean the electronic noises from the images. The principle of normalization can be summarized by the following figure.

which is defined by the following equation

where In is the image normalized, I the raw image, DF the dark field, OB the open beam and i and j the x and y-pixels along the images.

To improve the normalization, the program also allows the user to select a region of interest (ROI) in the sample images in order to match the background of the raw data with the background of the open beam. This is necessary for some beam lines where the fluctuations of the beam are too important to be neglected. The program calculates then, for each raw data, the average counts of this ROI divided by the average counts of the same ROI of the open beams, then apply this ratio to the normalized data.

Input data often contains very hight counts coming from gamma rays. Those are also corrected by the program by doing a median filter around those "gamma" pixels. How those gamma pixels are determined. They are always the highest counts for the input file format.

References

[1] NumPy python library. Stéfan van der Walt and S. Chris Colbert and Gaël Varoquaux, The NumPy Array: A Structure for Efficient Numerical Computation, Computing in Science & Engineering. Volume 13, Number 2, (22-30) 2011

[2 SciPy python library. Travis E. Oliphant, SciPy: Open source scientific tools for Python, Computing in Science and Engineering, Volume 9, (10-20) 2007

Meta

Jean Bilheux - bilheuxjm@ornl.gov

Distributed under the BSD license. See LICENSE.txt for more information

Acknowledgements

This work is sponsored by the Laboratory Directed Research and Development Program of Oak Ridge National Laboratory, managed by UT-Battelle LLC, under Contract No. DE-AC05-00OR22725 with the U.S. Department of Energy. The United States Government retains and the publisher, by accepting the article for publication, acknowledges that the United States Government retains a non-exclusive, paid-up, irrevocable, worldwide license to publish or reproduce the published form of this manuscript, or allow others to do so, for United States Government purposes. The Department of Energy will provide public access to these results of federally sponsored research in accordance with the DOE Public Access Plan(http://energy.gov/downloads/doe-public-access-plan).

Owner

  • Name: scikit-beam
  • Login: scikit-beam
  • Kind: organization

Python library for Electrons, Neutrons and X-Rays

JOSS Publication

NeuNorm: Neutron Imaging Normalization Library
Published
September 18, 2018
Volume 3, Issue 29, Page 815
Authors
Jean Bilheux ORCID
Oak Ridge National Laboratory
Editor
Arfon Smith ORCID
Tags
normalization neutron imaging

GitHub Events

Total
  • Watch event: 1
Last Year
  • Watch event: 1

Committers

Last synced: 11 months ago

All Time
  • Total Commits: 172
  • Total Committers: 2
  • Avg Commits per committer: 86.0
  • Development Distribution Score (DDS): 0.017
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
JeanBilheux b****m@o****v 169
Chen Zhang c****2@g****m 3
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 15
  • Total pull requests: 1
  • Average time to close issues: 4 months
  • Average time to close pull requests: 2 days
  • Total issue authors: 2
  • Total pull request authors: 1
  • Average comments per issue: 0.93
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • JeanBilheux (11)
  • stuartcampbell (4)
Pull Request Authors
  • KedoKudo (2)
Top Labels
Issue Labels
enhancement (4) invalid (2) bug (2)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 2
conda-forge.org: neunorm

NeuNorm is an open-source Python library that normalized neutron imaging measurements

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 34.0%
Dependent packages count: 51.2%
Average: 51.6%
Stargazers count: 60.1%
Forks count: 61.1%
Last synced: 10 months ago

Dependencies

ImagingReso.egg-info/requires.txt pypi
  • astropy *
  • numpy *
  • pathlib *
  • pillow *
  • pyfits *
  • scipy *