Skip to main content

A thorough structure for precise photometry and deconvolution of time series of wide field images.

Project description

logo

JOSS tests Docs python pypi License: GPL v3

lightcurver

Welcome to lightcurver! This is a photometry library leveraging STARRED, best used with time series of wide-field images. You can read more about it in the documentation.

Essentially, lightcurver provides the infrastructure to

  • prepare a Point Spread Function (PSF) model for each wide-field image,
  • precisely calibrate the relative zero point between each image.

This enables STARRED to model the pixels of the region of interest (ROI), yielding of course high quality light curves of the point sources in the ROI, but also recovering the subpixel information to provide a high signal-to-noise ratio deconvolution of the ROI itself. The example below shows a cutout of a wide-field image (one in a set of a hundred), the model/deconvolution, and the Hubble Space Telescope image of the same region.

example_deconvolution

Features

  • Plate solving: uses Astrometry.net to establish the footprint of each frame.
  • Gaia reference stars: leverages Gaia information to select the right reference stars in the field of view of each frame.
  • Preserves sub-pixel information: never interpolates, essential to preserve the sub-pixel information that can be recovered by STARRED in a multi-epoch deconvolution.
  • Incremental: uses SQL queries to dynamically determine which process needs be executed on which frame.
  • Semi-automatic: create a yaml configuration file once for the first few frames, then run the pipeline whenever a new frame is added, providing auto-updating light curves.

Getting Started

  1. Installation: the short version, install via pip:

    pip install lightcurver
    

    The slightly longer version, in case you plan on using a GPU or the plate solving.

  2. Tutorial: follow the tutorial of the documentation, which provides a dataset you can experiment with.

You can also test your installation with a subset of the dataset provided in the tutorial:

cd /clone/of/lightcurver
pytest .

Contributing

If you're encountering problems, then I would like to hear about them and will try to fix them. Feel free to create an issue in this repository. If you're finding this package useful and want to contribute, please create a pull request after forking the repository. If you need general help, feel free to reach out!

License

lightcurver is licensed under the GPL v3.0 License. See the LICENSE file for more details.

The implemented processing steps

This is an overview of the steps taken by the pipeline. flowdiagram

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lightcurver-1.1.0.tar.gz (89.0 kB view details)

Uploaded Source

Built Distribution

lightcurver-1.1.0-py3-none-any.whl (108.4 kB view details)

Uploaded Python 3

File details

Details for the file lightcurver-1.1.0.tar.gz.

File metadata

  • Download URL: lightcurver-1.1.0.tar.gz
  • Upload date:
  • Size: 89.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for lightcurver-1.1.0.tar.gz
Algorithm Hash digest
SHA256 88a1b96edf5e477eb44c6a1cac96f0cc4564eb164693ffc1902ee623bf47924c
MD5 5754b72dc2704e12acd65244856f4fda
BLAKE2b-256 9b824cdcd35b054566010d4f6482ee11d58fa9ebe3da594d34820302cdee17e0

See more details on using hashes here.

File details

Details for the file lightcurver-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: lightcurver-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 108.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for lightcurver-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ecc41cdb0347707cdfbd281228fd7a132f952f3f74d656181a8a63661f66225e
MD5 dd16397e11a9b08fd0089e2991b35bea
BLAKE2b-256 70d329d3317aaff68165e311b593651ebaf80c15e55cb213e34e4a3f4ec67dd3

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page