Skip to main content

Modular image processing pipelines for Astronomy

Project description

prose

Modular image processing pipelines for Astronomy

github license paper documentation

prose is a Python package to build modular image processing pipelines for Astronomy.

powered by astropy and photutils!

Example

Here is a quick example pipeline to characterize the point-spread-function (PSF) of an example image

import matplotlib.pyplot as plt
from prose import Sequence, blocks
from prose.simulations import example_image

# getting the example image
image = example_image()

sequence = Sequence(
    [
        blocks.PointSourceDetection(),  # stars detection
        blocks.Cutouts(shape=21),  # cutouts extraction
        blocks.MedianEPSF(),  # PSF building
        blocks.Moffat2D(),  # PSF modeling
    ]
)

sequence.run(image)

# plotting
image.show()  # detected stars

# effective PSF parameters
image.epsf.params

While being run on a single image, a Sequence is designed to be run on list of images (paths) and provides the architecture to build powerful pipelines. For more details check Quickstart and What is a pipeline?

Installation

latest

prose is written for python 3 and can be installed from pypi with:

pip install prose

For the latest version

pip install 'prose @ git+https://github.com/lgrcia/prose'

Contributions

See our contributions guidelines

Attribution

If you find prose useful for your research, cite Garcia et. al 2022. The BibTeX entry for the paper is:

@ARTICLE{prose,
       author = {{Garcia}, Lionel J. and {Timmermans}, Mathilde and {Pozuelos}, Francisco J. and {Ducrot}, Elsa and {Gillon}, Micha{\"e}l and {Delrez}, Laetitia and {Wells}, Robert D. and {Jehin}, Emmanu{\"e}l},
        title = "{PROSE: a PYTHON framework for modular astronomical images processing}",
      journal = {\mnras},
     keywords = {instrumentation: detectors, methods: data analysis, planetary systems, Astrophysics - Instrumentation and Methods for Astrophysics, Astrophysics - Earth and Planetary Astrophysics},
         year = 2022,
        month = feb,
       volume = {509},
       number = {4},
        pages = {4817-4828},
          doi = {10.1093/mnras/stab3113},
archivePrefix = {arXiv},
       eprint = {2111.02814},
 primaryClass = {astro-ph.IM},
       adsurl = {https://ui.adsabs.harvard.edu/abs/2022MNRAS.509.4817G},
      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}

and read about how to cite the dependencies of your sequences here.

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

prose-3.3.4.tar.gz (83.5 kB view details)

Uploaded Source

Built Distribution

prose-3.3.4-py3-none-any.whl (96.1 kB view details)

Uploaded Python 3

File details

Details for the file prose-3.3.4.tar.gz.

File metadata

  • Download URL: prose-3.3.4.tar.gz
  • Upload date:
  • Size: 83.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.14 Linux/6.5.0-1024-azure

File hashes

Hashes for prose-3.3.4.tar.gz
Algorithm Hash digest
SHA256 5a5340bd65c572f0e36b1cdb87cae549a15331201ed3c608141f3ad179cbba95
MD5 f2fb6bbfeaffc9fc0e3cec38403854d2
BLAKE2b-256 f70df3d10f884b6eb272a98655aa3711fdfa6e7ffea2e82db80c90ab38af8fd4

See more details on using hashes here.

File details

Details for the file prose-3.3.4-py3-none-any.whl.

File metadata

  • Download URL: prose-3.3.4-py3-none-any.whl
  • Upload date:
  • Size: 96.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.14 Linux/6.5.0-1024-azure

File hashes

Hashes for prose-3.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 74d83e153141adec1bd679f9a5c476b7032f7131cbc172b216a126ec68d2be99
MD5 13cb68bb3a2cbc6d71730bc8414f100a
BLAKE2b-256 41ee2d72b259b8e2676c4134078593253100c9140c12210d0651db2f19192eb3

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