Skip to main content

Donuts

Latest Pypi Release https://img.shields.io/pypi/pyversions/donuts.svg Powered by astropy Travis Build Status Appveyor Build Status Code Health Test Coverage Latest Documentation Status Gitter Chat

A science frame autoguiding and image alignment algorithm with sub-pixel precision, capable of guiding on defocused stars.

Project documentation: https://donuts.readthedocs.io/en/latest/

See the changelog for latest changes.

Motivation

We operate or have access to several telescopes (NGTS, NITES, Warwick 1m, 1.5m San Pedro Martir) that require precise autoguiding. Sometimes we need to defocus a telescope but we would still like to autoguide. Donuts was designed to allow this. The algorithm had to be simple, fast and accurate. It has been shown to perform well as an autoguiding algorithm for equatorial telescopes (no field rotation).

The process of aligning apertures for photometry is essentially the same. Rather than correcting the telescope pointing, the apertures must track the drift of the stars. Donuts can therefore be used to track the stellar positions for CCD photometry also.

By default Donuts measures frame-to-frame translational offsets (X and Y) using all the stars in the image. The algorithm could be adjusted in the to select a specific region of interest (for extremely wide or distorted fields).

The algorithm has its limitations. It currently does not deal with rotation or very large drifts - where the field moves by approx. half a FOV or more. Our paper describing the details can be found here:

http://adsabs.harvard.edu/abs/2013PASP..125..548M

Example

Below is a sample of 10 nights autoguiding residuals from NGTS while using Donuts. The upper plot shows the frame-to-frame error, while the bottom shows the drift which would have occured if not for Donuts. Aligning photometry apertures is essentially the same process and similar performance is expected under that scenario. We routinely achieve an autoguiding RMS of 1/20 pixels with NGTS.

AgResiduals_802_March2016.png

Contributors

James McCormac, Simon Walker.

License

MIT License

Copyright (c) 2021 James McCormac & Simon Walker

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Metadata

Release files for donuts 0.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for donuts 0.4.0
File Size Uploaded
donuts-0.4.0.tar.gz 172.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for donuts 0.4.0
File Interpreter ABI Platform
donuts-0.4.0-py3-none-any.whl Python 3 none any Details

Total release size: 199.8 kB

Release files / donuts-0.4.0.tar.gz

Download URL donuts-0.4.0.tar.gz
Size 172.6 kB
Tags Source
SHA-256 checksum
How to use checksums
c998a07a9b2f7ec96b2c29eeb0c26fd53ef29743a4e001b8703eb37f23dab371
BLAKE2b-256 checksum
How to use checksums
41c78d64e13abfb084bc98aa7a747524183fa0a7237d2a2b344435e2a44e6e7b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.10.13

Release files / donuts-0.4.0-py3-none-any.whl

Download URL donuts-0.4.0-py3-none-any.whl
Size 27.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
dc7c429dfdcd98580a49d87d5530068e15118c22289dfa5c7a5dca8395c49f30
BLAKE2b-256 checksum
How to use checksums
344e9095fe7ea66a54d66355454437a7aea565131f3e2d9acaadfd4942fd6d67
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.10.13

Release history Release notifications | RSS feed

This release

0.4.0 This release

2 release files

0.3.5

2 release files

0.3.4

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page