Automated version of Extended Aperture Photometry developed for high amplitude K2 variable stars.
Project description
The Automated Extended Aperture Photometry (autoEAP) is developed for high amplitude K2 variable stars. The details of autoEAP are published in Bódi et al.,2022,PASP,134,14503 and Plachy et al.,2019,ApJS,244,32. A short summary of automatization is published here.
Installation and dependencies
To install the package, use:
pip install autoeap
Example usage
To create your own photomery, you'll need a Target Pixel File, such as this one. Then, after starting Python, you can do:
yourtpf = '/path/to/your/tpf/ktwo212466080-c17_lpd-targ.fits'
import autoeap
time, flux, flux_err = autoeap.createlightcurve(yourtpf)
Or if you want to let autoEAP download the TPF from MAST database, you can just provide a target name and optionally a campaign number:
import autoeap
targetID = 'EPIC 212466080'
campaign = 17
time, flux, flux_err = autoeap.createlightcurve(targetID,campaign=campaign)
With this last line, you can create autoEAP photometry for any K2 variable star.
Plotting our results gives:
import matplotlib.pyplot as plt
plt.figure(figsize=(10,5))
plt.plot(time,flux,'.')
plt.xlabel('KBJD')
plt.ylabel('Flux')
plt.show()
The details of the workflow is described in docs.
You can find Google Colab friendly tutorials in the examples.
Apply K2 Systematics Correction (K2SC)
If you want to apply K2SC correction for your freshly made raw-photometry, first you should install K2SC. AutoEAP is based on that package, so if you find K2SC useful, please cite Aigrain et al.,2016,MNRAS,459,2408.
Installation with george
:
pip install george k2sc
And then without much hassle, you can apply the correction in python:
import autoeap
targetID = 'EPIC 212466080'
campaign = 17
time, flux, flux_err = autoeap.createlightcurve(targetID,campaign=campaign,apply_K2SC=True)
The result is quite delightful:
import matplotlib.pyplot as plt
plt.figure(figsize=(10,5))
plt.plot(time,flux,'.')
plt.xlabel('KBJD')
plt.ylabel('Flux')
plt.show()
Apply trend correction
We have also built-in a method to remove trends using low-order splines. To correct the raw light curve, do:
import autoeap
time, flux, flux_err = autoeap.createlightcurve(yourtpf,detrend=True)
Or do this to remove a spline from the K2SC light curve:
import autoeap
time, flux, flux_err = autoeap.createlightcurve(yourtpf,apply_K2SC=True,detrend=True)
Available options
apply_K2SC
IfTrue
, after the raw photomery, K2SC will be applied to remove systematics from the extracted light curve.detrend
IfTrue
, after the raw photomery, a low-order spline will be fitted and removed from the extracted light curve. Ifapply_K2SC
is alsoTrue
, then this step will be done after the K2SC.save_lc
IfTrue
, the intermediate and the final light curves will be save as a file.save_aperture
IfTrue
the final aperture will be saved to a FITS file.campaign
If local TPF file is not found, it will be downloaded from MAST, butcampaign
number should be defined as well, if the target has been observed in more than one campaign. Otherwise that campaign will be used in which the target were first observed.show_plots
IfTrue
, all the plots that visualize each step of photometry will be displayed.save_plots
IfTrue
, all the plots that visualize each step of photometry will be saved to a subdirectory.polyorder
The order of the detrending polynomial. Applies only ifdetrend
isTrue
. Default is'auto'
.sigma_detrend
The number of standard deviations to use for sigma clipping limit before spline correction. Applies only ifdetrend
isTrue
. Default is10
.max_missing_pos_corr
Maximum number of missing position correction (POS_CORR) values. If too many POS_CORR is missing, then less reliable photometrically estimated centroids will be used for K2SC. Missing POS_CORR values reduce the number of light curve points! Default is10
.TH
Threshold to segment each target in each TPF candence. Only used if targets cannot be separated normally. Default is8
. Do not change this value unless you are aware of what you are doing!ROI_lower
The aperture frequency grid range of interest threshold given in absolute number of selections above which pixels are considered to define the apertures. Do not change this value unless you are aware of what you are doing! Default is100
.ROI_upper
The aperture frequency grid range of interest threshold given in relative number of selections w.r.t. the number of all cadences below which pixels are considered to define the apertures. Do not change this value unless you are aware of what you are doing! Default is0.85
.**kwargs
Dictionary of arguments to be passed tok2sc.detrend
. See options here.
Command-line tools
After installation, autoEAP
will be available from the command line:
autoEAP <EPIC number or TPF path> [options]
Listed below are the usage instructions:
$ autoeap --help
usage: autoeap [-h] [--campaign <campaign-number>] [--applyK2SC]
[--removespline] [--polyorder <detrending-polynomial-order>]
[--sigmadetrend <detrending-sigma-limit>] [--saveplots]
[--maxmissingposcorr <max-missing-pos-corr>]
[--TH <threshold-value>] [--ROIlower <lower-ROI-value>]
[--ROIupper <upper-ROI-value>]
<path-to-targettpf-or-EPIC-number>
Perform autoEAP photometry on K2 variable stars.
positional arguments:
<path-to-targettpf-or-EPIC-number>
The location of the local TPF file or an EPIC number to be downloaded from MAST. Valid inputs include: The name of the object as a string, e.g. 'ktwo251812081'. The EPIC identifier as an integer, e.g. 251812081.
optional arguments:
-h, --help show this help message and exit
--campaign <campaign-number>
If the target has been observed in more than one campaign, download this light curve. If not given, the first campaign will be downloaded.
--applyK2SC After the raw photomery, apply K2SC to remove systematics from the extracted light curve.
--detrend After the raw or K2SC photomery, remove a low-order spline from the extracted light curve.
--polyorder <detrending-polynomial-order>
The order of the detrending polynomial. Default is auto.
--sigmadetrend <detrending-sigma-limit>
The number of standard deviations to use for sigma clipping limit before spline correction. Default is 10.0
--saveplots Save all the plots that show each step into a subdirectory.
--maxmissingposcorr <max-missing-pos-corr>
Maximum number of missing position correction (POS_CORR) values. If too many POS_CORR is missing, then less reliable photometrically estimated centroids will be used for K2SC. Missing POS_CORR values reduce the number of light curve points!
--TH <threshold-value>
Threshold to segment each target in each TPF candence. Only used if targets cannot be separated normally. Default is 8.
--ROIlower <lower-ROI-value>
The aperture frequency grid range of interest threshold given in absolute number of selections above which pixels are considered to define the apertures. Default is 100.
--ROIupper <upper-ROI-value>
The aperture frequency grid range of interest threshold given in relative number of selections w.r.t. the number of all cadences below which pixels are considered to define the apertures. Default is 0.85.
Data Access
We provide photometry for targets for the following Guest Observation Programs: GO0055, GO1018, GO2040, GO3040, GO4069, GO5069, GO6082, GO7082, GO8037, GO10037, GO12111, GO13111, GO14058, GO15058, GO16058, GO17033, GO18033, GO19033.
Slightly less than 2000 RRLs. See: K2 approved targets & programs.
The data we have already created have been uploaded to our webpage.
Standalone PDM-based detrender
The PDM-based polynomial fitting and detrending can be used as a standalone module to be applied to e.g. raw autoEAP
light curves or any other data sets given a time series with times, fluxes and flux errors. The detrend_wrt_PDM
method returns the corrected flux values.
from autoeap.detrender import detrend_wrt_PDM
corrflux = detrend_wrt_PDM(time, # Time values
flux, # Flux values
flux_err, # Flux errors
polyorder='auto', # Polynomial order or 'auto'
sigma=10, # Sigma value for sigma clipping before PDM calculation
show_plots=True, # Show the detrending process
save_plots=False, # Save the detrending process plot
filename=None) # to this file as PNG.
Contributing
Feel free to open PR / Issue, or contact us here or here.
Citing
If you use data provided by this pipeline please cite Bódi et al.,2022,PASP,134,14503 and Plachy et al.,2019,ApJS,244,32. Here are the BibTeX sources:
@ARTICLE{2022PASP..134a4503B,
author = {{B{\'o}di}, Attila and {Szab{\'o}}, P{\'a}l and {Plachy}, Emese and {Moln{\'a}r}, L{\'a}szl{\'o} and {Szab{\'o}}, R{\'o}bert},
title = "{Automated Extended Aperture Photometry of K2 Variable Stars}",
journal = {\pasp},
keywords = {1307, 1620, 1855, Astrophysics - Instrumentation and Methods for Astrophysics, Astrophysics - Solar and Stellar Astrophysics},
year = 2022,
month = jan,
volume = {134},
number = {1031},
eid = {014503},
pages = {014503},
doi = {10.1088/1538-3873/ac4398},
archivePrefix = {arXiv},
eprint = {2112.07496},
primaryClass = {astro-ph.IM},
adsurl = {https://ui.adsabs.harvard.edu/abs/2022PASP..134a4503B},
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}
@ARTICLE{2019ApJS..244...32P,
author = {{Plachy}, Emese and {Moln{\'a}r}, L{\'a}szl{\'o} and {B{\'o}di}, Attila and {Skarka}, Marek and {Szab{\'o}}, P{\'a}l and {Szab{\'o}}, R{\'o}bert and {Klagyivik}, P{\'e}ter and {S{\'o}dor}, {\'A}d{\'a}m and {Pope}, Benjamin J.~S.},
title = "{Extended Aperture Photometry of K2 RR Lyrae stars}",
journal = {\apjs},
keywords = {RR Lyrae variable stars: 1410, Light curves (918, Space telescopes (1547, 1410, 918, 1547, Astrophysics - Instrumentation and Methods for Astrophysics, Astrophysics - Solar and Stellar Astrophysics},
year = 2019,
month = oct,
volume = {244},
number = {2},
eid = {32},
pages = {32},
doi = {10.3847/1538-4365/ab4132},
archivePrefix = {arXiv},
eprint = {1909.00446},
primaryClass = {astro-ph.IM},
adsurl = {https://ui.adsabs.harvard.edu/abs/2019ApJS..244...32P},
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}
Acknowledgements
This project was made possible by the funding provided by the National Research, Development and Innovation Office of Hungary, funding granted under project 2018-2.1.7-UK_GYAK-2019-00009 and by the Lendület Program of the Hungarian Academy of Sciences, project No LP2018-7.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file autoeap-0.3.1.4.tar.gz
.
File metadata
- Download URL: autoeap-0.3.1.4.tar.gz
- Upload date:
- Size: 5.5 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/3.10.0 pkginfo/1.6.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e293d91efc9911c6a2d96b1e0349912363800dbfbd63af5dc7aea3f3b28f6bcc |
|
MD5 | 82e724084cb574f8b263c4c3d32fad09 |
|
BLAKE2b-256 | 2c6b3d8ca1d0978d3dd102ca4f3c46c0819fbe5d2c4d213469a6b7c0d20a420b |
File details
Details for the file autoeap-0.3.1.4-cp37-cp37m-macosx_10_9_x86_64.whl
.
File metadata
- Download URL: autoeap-0.3.1.4-cp37-cp37m-macosx_10_9_x86_64.whl
- Upload date:
- Size: 71.7 kB
- Tags: CPython 3.7m, macOS 10.9+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/3.10.0 pkginfo/1.6.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e7fc0353bcdf7586e6698a81e6bb9a6971e9f475062b59491bc8dfd9efd93917 |
|
MD5 | 526a3b3d18a567e932ebd4b39ca0fcbc |
|
BLAKE2b-256 | 06160f08038290ab58889ce7cba900be72bb64a2876c49b7548f5d46c242fdd4 |