Metadata-Version: 2.4
Name: ccdfits
Version: 1.2.1
Summary: Utilities to work with .fits files that were taken with CCDs and Skipper CCDs
Project-URL: GitLab, https://gitlab.com/nicolaseavalos/ccdfits
Author-email: Nicolás Avalos <nicolaseavalos@gmail.com>
License-Expression: MIT
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.6
Requires-Dist: astropy
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: scipy
Provides-Extra: pandas
Requires-Dist: pandas; extra == 'pandas'
Provides-Extra: scikit-image
Requires-Dist: scikit-image; extra == 'scikit-image'
Provides-Extra: scikit-learn
Requires-Dist: scikit-learn; extra == 'scikit-learn'
Description-Content-Type: text/markdown

# CCDFits

This package provides utilities to work with .fits files that were taken with CCDs. It provides a FITS class to easily view and analyse images, along with useful functions to process them. It is particularly useful for Skipper CCD images, which can be calibrated by fitting gaussians to the zero- and one-electron peaks.

## Installation

### Pre-requisites

This library has been developed for Python 3.

`ccdfits` requires the following packages:
* numpy
* scipy
* astropy
* matplotlib

In addition, if you intend to use `ccdfits.processing`, you will also need to install:
* scikit-learn (for `cal2phys`)
* scikit-image (for `generateMask`)

### Install ccdfits via pip:

`python -m pip install ccdfits`


### Installing latest public version (may be different from that on pypi)

`python -m pip install git+https://gitlab.com/nicolaseavalos/ccdfits.git`


## Usage

The following example shows how to load and view a .fits image. Replace `'ccd-image.fits'` with a string indicating the full or relative path to the image you are trying to load.

    # imports
    from ccdfits import Fits
    import matplotlib.pyplot as plt
    plt.ion()

    # set the image path
    fits_path = 'ccd-image.fits'

    # load and view the image
    img = Fits(fits_path)
    img.view()

Complete documentation is in process.

## Changelog

### Version 1.1
- Added more options to event extraction

### Version 1.0
- FITS class renamed to Fits
- Some documentation inside the code
- Various changes throughout the library

### Hotfix 0.3.1
- Optimized for installation via pip

### Version 0.3.0
- Added `skp2raw_lowmem` function to `ccdfits.processing`

### Hotfix 0.2.1
- Added `subtract_baseline` option to `ccdfits.processing.raw2proc`

### Version 0.2.0
- Added `skp2raw` function to `ccdfits.processing`