Skip to main content

No project description provided

Project description

Test status PyPI version

lkPRF

lkPRF is a tool to work with PRF files from missions like NASA Kepler and TESS. This tool enables you to load in PRF files from the engineering data, and evaluate them at given pixel positions.

What is lkPRF doing?

This tool is doing two things for you:

  1. Downloading and formating the engineering files for you.
  2. Evaluating the PRF files on a pixel grid.

Installation

You can install lkprf using pip:

pip install lkprf --upgrade

Usage

:question: Note: lkprf uses tuples to specify positions and uses the Python convention of (row, column).

To use the package you first initialize a PRF model based on the mission you want to use

import lkprf
prf = lkprf.KeplerPRF(channel=42)

or

import lkprf
prf = lkprf.TESSPRF(camera=1, ccd=1) # Optionally specify a sector 

You can then use either the evaluate or gradient functions to get the estimate of the PRF at a location, as shown below.

prf.evaluate(targets=[(5, 5)], origin=(0, 0), shape=(11, 11))

This will return an array with shape (1, 11, 11), which contains an (11, 11) image containing one target at location (row=5, column=5). The image origin is at (row=0, column=0). Note that for Kepler and TESS, an origin of (0,0) contains collateral (non-science) pixels; however, lkprf will still generate the expected model at this location.

prf.evaluate(targets=[(5, 5), (9, 9)], origin=(0, 0), shape=(11, 11))

This will return an array with shape (2, 11, 11), which contains two (11, 11) images. The first image contains one target at location (row=5, column=5). The second image contains one target at location (row=9, column=9). You can pass in a list of any number of target tuples to create PRFs for each target. PRFs are normalized such that, if all target flux falls in a pixel, the total flux will be one.

:question: Note: If the "target" doesn't appear in your image, make sure the origin and shape keywords would create an array that contains your target coordinates.

Similarly you can get the gradient of the PRF

prf.gradient(targets=[(5, 5)], origin=(0, 0), shape=(11, 11))

This will return a tuple containing two arrays, each with shape (1, 11, 11). The first array is the gradient with respect to row, and the second is the gradient with respect to column. You can similarly pass in any number of targets to calculate the gradient for more targets.

Examples

The below examples are created using the snippet

prf.evaluate(targets=[(5, 5)], origin=(0, 0), shape=(11, 11))

Kepler

Below is an example image for the Kepler PRF, for channel 42, with a source at position (row=5, column=5).

Kepler PRF Example

TESS

Below is an example image for the TES PRF, for Camera 1, CCD 1, with a source at position (row=5, column=5).

TESS PRF Example

Where can I learn more?

For more examples of how to use lkprf to generate TPF-like PRF models, see this tutorial.

Problems with downloading PRF data

To use lkPRF you will have to be connected to the internet to download the relevant files. After you download the data for a given Camera/CCD/Channel these files will be stored within the package, so you will be able to use the data offline.

If you evaluate a PRF from a particular Camera/CCD/Channel once, you will notice a slow down as lkPRF downloads and builds the right files for you. If you interupt the download you may find that the file is corrupted. To ensure that the file is downloaded again, you will have to clear the cache. You can do this using

import lkprf
lkprf.clear_kepler_cache()
lkprf.clear_tess_cache()

When lkprf can not find a PRF file on disk it will attempt to download it again.

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

lkprf-1.1.1.tar.gz (10.6 kB view details)

Uploaded Source

Built Distribution

lkprf-1.1.1-py3-none-any.whl (11.5 kB view details)

Uploaded Python 3

File details

Details for the file lkprf-1.1.1.tar.gz.

File metadata

  • Download URL: lkprf-1.1.1.tar.gz
  • Upload date:
  • Size: 10.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for lkprf-1.1.1.tar.gz
Algorithm Hash digest
SHA256 164ee331b1bedab2413785ee3faf61704fe9998d93aa25016edef0558741454c
MD5 0e5df137c0b042ae70b408c582bb50fa
BLAKE2b-256 d549cd047f78c468561e70a3627e9315ba4334ebdea8fd667c40789f467fe3af

See more details on using hashes here.

Provenance

File details

Details for the file lkprf-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: lkprf-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 11.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for lkprf-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ff3f96fa5febd422a88a85071d92e49e534f1ce454cf7026f9f6b0285caa6f84
MD5 18e45ca6464e474d3e0d8187b4639f5f
BLAKE2b-256 a6ee4e1fa9530f905dbcd678cc3bb0bec1ef9564fd27011efa222b163f33b5b9

See more details on using hashes here.

Provenance

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