Skip to main content

Plot identification charts for Kepler, K2 and TESS.

Project description

tpfi

PyPI version License: MIT

tpfi is an easy-to-use visualization tool for astronomers to identify and analyze stars in the Kepler, K2, and TESS missions. The main focus of this project is on two functions: plot_identification and plot_season. These functions create plots to help visualize target stars and their surrounding environments.


Plot identification charts for Kepler, K2 and TESS.

pPKxsjH.png

pPKxcDA.png

pPKx6ud.png

The plot_identification function creates identification charts, which are useful for determining if a target is contaminated by nearby stars. In each chart, the right panel overlays the Gaia DR3 catalog onto the TESS Target Pixel Files (TPF) with the target marked by a cross symbol. The circle size represents the relative brightness of the stars according to Gaia G magnitude. The left panel displays the same sky coverage but taken from the DSS2 Red survey.

This function is revised based on tpfplotter.


Plot season charts for Kepler targets.

pPKxrge.png

The Kepler Space Telescope was designed to observe a specific field of stars continuously, but it also needed to ensure its solar panels faced the Sun to power its operations. As Kepler orbited the Sun, it performed a 90-degree roll every three months (or every quarter) to keep its solar panels sunward. After four of these quarterly rolls, amounting to a full year and a complete 360-degree rotation, Kepler would return to its original orientation. Consequently, every set of quarters separated by four (e.g., Q1, Q5, Q9) would find Kepler with the same pointing towards its target field, as the telescope effectively revisited its initial orientation after its annual orbit.

The plot_season function creates a plot of the TPF for each season of the Kepler mission for a given target star. Since the aperture mask may change even in the same season, the function only plots the aperture mask for the first quarter of each season. This function is only applicable for Kepler targets.

Season 1: Q1, Q5, Q9, Q13, Q17

Season 2: Q2, Q6, Q10, Q14

Season 3: Q3, Q7, Q11, Q15

Season 4: Q4, Q8, Q12, Q16

Installation

You can install this package using pip:

pip install tpfi

To upgrade to the latest version, run:

pip install -U tpfi

How to use

See the example notebook for more details.

How to cite

If you use this package in your research, please add the following sentence to the footnote or acknowledgement section of your paper:

This work has made use of \texttt{tpfi} (publicly available at \url{https://github.com/keyuxing/tpfi}).

and cite our paper:

Xing et al., 2024 [ads link][iop link]

Contributing

If you would like to contribute to this project, feel free to submit a pull request or open an issue on GitHub. Any suggestion, improvement, or bug report is welcomed.

License

This project is licensed under the MIT License - see the LICENSE file for details.

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

tpfi-1.2.5.tar.gz (10.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tpfi-1.2.5-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

Details for the file tpfi-1.2.5.tar.gz.

File metadata

  • Download URL: tpfi-1.2.5.tar.gz
  • Upload date:
  • Size: 10.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for tpfi-1.2.5.tar.gz
Algorithm Hash digest
SHA256 58a7abe8f7c77e60dc7c4a9e1a87f00898691ba8f15812a0de6624ce64c22a42
MD5 58e6ac646c2016819e54b47a363676dd
BLAKE2b-256 78c6073930d77a077c1e21b9b48ba53fedeb42ebb562c6adda2ff260669658f8

See more details on using hashes here.

Provenance

The following attestation bundles were made for tpfi-1.2.5.tar.gz:

Publisher: release.yml on keyuxing/tpfi

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file tpfi-1.2.5-py3-none-any.whl.

File metadata

  • Download URL: tpfi-1.2.5-py3-none-any.whl
  • Upload date:
  • Size: 10.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for tpfi-1.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 6420c4f03905912ee514bd51c1c6abecbbf5a8d934124636a1a23df317992d1f
MD5 7929624361700445bbf24eb4e6dfd056
BLAKE2b-256 7d7016e54ac72808bf2cad3321348f1b58879df542612bb1488e0459b7896ff0

See more details on using hashes here.

Provenance

The following attestation bundles were made for tpfi-1.2.5-py3-none-any.whl:

Publisher: release.yml on keyuxing/tpfi

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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