Skip to main content

Astronomical observation logging software

Project description

pydeepskylog

Table of Contents

Description

A Python package with utilities for calculating contrast reserve and optimal detection magnification for deep sky objects.

In the future, it will also include utilities for fetching and adding observation logs from/to the DeepSkyLog website.

Installation

pip install pydeepskylog

Usage

import pydeepskylog as pds

# Calculate contrast reserve
contrast_reserve = pds.contrast_reserve(sqm=22, telescope_diameter=457, magnification=118, magnitude=11, object_diameter1=600, object_diameter2=600)
print(contrast_reserve)

# Define a list of possible magnifications
possible_magnifications = [50, 100, 150, 200, 250]

# Calculate optimal detection magnification
optimal_detection_magnification = pds.optimal_detection_magnification(sqm=22, telescope_diameter=457, magnitude=11, object_diameter1=600, object_diameter2=600, magnifications=possible_magnifications)
print(optimal_detection_magnification)

Astronomical background

Contrast Reserve

The contrast reserve is a measure of the difference in brightness between the object and the sky background. It is calculated as the difference between the object's surface brightness and the sky background brightness. The contrast reserve is a useful metric for determining the visibility of deep sky objects through a telescope.

The higher the contrast reserve, the easier it is to see the object. The following table can be used to interpret the contrast reserve:

Contrast Reserve Visibility Typical color
< -0.2 Not visible dark grey
-0.2 < CR < 0.1 Questionable light grey
0.1 < CR < 0.35 Difficult dark red
0.35 < CR < 0.5 Quite difficult to see light red
0.5 < CR < 1.0 Easy to see dark green
1.0 < CR Very easy to see light green

The contrast reserved is calculated for the object as a whole. Smaller details in the object might be visible even if the contrast reserve of the object as a whole is below -0.2. This is certainly the case for galaxies, where the core might be much brighter than the outer regions.

It is important to note that the contrast reserve is a theoretical value and that the actual visibility of an object will depend on a number of other factors, including the observer's experience, the transparency of the sky, and the seeing conditions. The contrast reserve is just a guideline.

The calculation of the contrast reserve depends heavily on the quality of the object database. A small error in the object's magnitude or size can lead to a large error in the contrast reserve.

Only if the observer tries to observe the object, he/she will know if the object is visible or not.

Optimal Detection Magnification

The optimal detection magnification is the magnification at which the object is most easily visible. Take into account that the optimal detection magnification is not the same as the best magnification for observing details in an object, but for the object as a whole.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

GPL-3.0

Acknowledgements

This package is inspired by the DeepskyLog website and the code is based on the formulas used in DeepskyLog. We would like to thank the DeepskyLog developers team.

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

pydeepskylog-1.0.tar.gz (20.3 kB view details)

Uploaded Source

Built Distribution

pydeepskylog-1.0-py3-none-any.whl (19.2 kB view details)

Uploaded Python 3

File details

Details for the file pydeepskylog-1.0.tar.gz.

File metadata

  • Download URL: pydeepskylog-1.0.tar.gz
  • Upload date:
  • Size: 20.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for pydeepskylog-1.0.tar.gz
Algorithm Hash digest
SHA256 1330b4cd4dd8bdd306182ae1c1eafd7fa323cb9f8135588ee34fe123a445cd91
MD5 721e1d7dbc8fd1ef29ed410e6f16e976
BLAKE2b-256 a983d030ce894a6f27c4c39574ca3d8fc0483d931c99b75e3d37b003a24f461b

See more details on using hashes here.

File details

Details for the file pydeepskylog-1.0-py3-none-any.whl.

File metadata

  • Download URL: pydeepskylog-1.0-py3-none-any.whl
  • Upload date:
  • Size: 19.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for pydeepskylog-1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 eaf0cedecf96f1288b222cf702089bd6744f3ec11909a21f6e6866b6c1be0549
MD5 9d6cf75cea81eb2e5f27fc20e7d4659f
BLAKE2b-256 b090418cb1e66709ed9959ac4123509410211ab4f16883abf94bb4216774ecb6

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