/nirc2_reduce

Software for calibration and analysis of infrared images of solar system objects. Has been applied successfully to NIRC2, OSIRIS, and Lick ShARCS data.

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

Documentation Status codecov DOI

Infrared Imaging Data Pipeline

The nirc2_reduce contains software for calibration, imaging, and analysis of infrared images of solar system objects. Features include:

  • Dark subtraction, flat-fielding, cosmic ray removal
  • Distortion correction and application of astrometry solutions
  • Easy reduction of the famous NIRC2 bxy3 dither pattern (among other supported dithers)
  • Flux calibration and photometry
  • Flexible infrastructure for applying new dither patterns, filter passbands, distortion and solutions, etc. for use cases on new telescopes

This package has been applied successfully to NIRC2 and OSIRIS imager data. We hope to make it work with Lick ShARCS data in the future.

Example images of Solar System planets made using this pipeline are available at the Keck Twilight Zone website.

Usage

See readthedocs page for example workflows

Caveats

This is not yet an official release version, and some customization will be required. This software was originally written in 2016 when I was a first-year grad student and had no idea how to package code. At the time of writing, only the flats and observation modules have been rewritten and nicely packaged; I'm working on the rest. Your development and pull requests are welcomed!

Please note that some functionality that used to be in nirc2_reduce is now located in the pylanetary package. If you got here following the Zenodo link from one of my publications prior to 2023, please look through the GitHub history for an older version.

Cite

If you find this software useful for your research, please cite it using the Zenodo DOI above.

Publications

This pipeline has been used in the following refereed publications: