Welcome to the Documentation for rms-psfmodel!

Introduction

psfmodel provides abstract and concrete classes for modeling point spread functions (PSFs) and fitting them to image data. It includes an analytic 2-D Gaussian PSF with optional rotation, pixel integration, motion smearing, and background polynomial fitting, plus helpers for astrometric position estimation via bounded optimization.

psfmodel is a product of the PDS Ring-Moon Systems Node.

Installation

The psfmodel module is available via the rms-psfmodel package on PyPI and can be installed with:

pip install rms-psfmodel

Getting Started

Details of each class are available in the module documentation.

After installation, an optional Tkinter-based PSF explorer is available as the psf_gui command (or python -m psf_gui with src on PYTHONPATH). A working Tcl/Tk installation is required (for example, install the python3-tk package on Debian/Ubuntu).

A characterization tool that systematically measures Gaussian PSF fitting accuracy across a wide parameter space is available in the repository. Clone the repo, install with pip install -e ".[characterize]", and run it with python -m characterize_gauss_fit.

Contributing

Information on contributing to this package can be found in the Contributing Guide.

Licensing

This code is licensed under the Apache License v2.0.

Indices and tables