full_run_lc¶
- tessilator.tessilator.full_run_lc(file_in, t_target, scc, res_table, gaia_sys=True, xy_pos=(10.0, 10.0), ap_rad=1.0, sky_ann=(6.0, 8.0), fix_rad=False, n_cont=10, cont_rad=10.0, mag_lim=3.0, tot_attempts=3, ref_name='targets', cutout_size=20, save_phot=False, cbv_flag=False, store_lc=False, lc_dir='lc', pg_dir='pg', plot_ext='plots', clean_fail_modes=False, keep_data=False, calc_cont=False, lc_cont=False, fix_noise=False, shuf_per=False, make_plot=False, make_shuf_plot=False, shuf_dir='plot_shuf')[source]¶
Aperture photometry, lightcurve cleaning and periodogram analysis.
This function calls a set of functions in the lc_analysis.py module to perform aperture photometry, clean the lightcurves from spurious data and runs the Lomb-Scargle periodogram to measure rotation periods.
- Parameters:
- file_in
str Name of the input TESS fits file.
- t_target
astropy.table.Table Details of the target star.
- scc
list, size=3 List containing the sector number, camera and CCD.
- res_table
astropy.table.Table The table to store the final tessilator results.
- gaia_sys
bool, optional, default=True Choose to format the data based on Gaia DR3. Note that no contamination can be calculated if this is False.
- xy_pos
tuple, size=2x2, optional, default=(10.,10.) The centroid of the target in pixels.
- ap_rad
float, optional, default=1. The size of the aperture radius in pixels.
- sky_ann
tuple, optional, default=(6.,8.) A 2-element tuple defining the inner and outer annulus to calculate the background flux.
- fix_rad
bool, optional, default=False If True, then set the aperture radius equal to ap_rad, otherwise run the calc_rad algorithm.
- n_cont
int, optional, default=10 The maximum number of neighbouring contaminants to store to table.
- cont_rad
float, optional, default=10. The maximum pixel radius to search for contaminants
- mag_lim
float, optional, default=3. The faintest magnitude to search for contaminants.
- tot_attempts
int, optional, default=3 The number of sql queries in case of request or server errors.
- ref_name
str, optional, default=’targets’ The reference name for each subdirectory which will connect all output files.
- cutout_size
int, optional, default=20 The pixel length of the downloaded cutout.
- save_phot
bool, optional, default=False Decide whether to save the full results from the aperture photometry.
- cbv_flag
bool, optional, default=False Decide whether to run the lightcurve analysis with a CBV-correction applied.
- store_lc
bool, optional, default=False Choose to save the cleaned lightcurve to file.
- lc_dir
str, optional, default=’lc’ The directory used to store the lightcurve files if lc_dir==True.
- pg_dir
str, optional, default=’pg’ The directory used to store the periodogram data.
- plot_ext
str, optional, default=’plots’ The directory used to store the plots if make_plot==True.
- clean_fail_modes
bool, optional, default=False Choose to remove parts of the lightcurve that are reported as problematic in the TESS Data Release Notes
- keep_data
bool Choose to save the input data to file.
- flux_con
bool, optional, default=False Decides if the flux contribution from contaminants is to be calculated.
- lc_con
bool, optional, default=0 Decides if a lightcurve analysis is to be performed for the n strongest contaminants.
- fix_noise
bool, optional, default=False Choose to apply corrections accounting for systematic noise.
- shuf_per
bool, optional, default=False Choose to run the shuffled period analysis (True=yes, False=no)
- make_shuf_plot
bool, optional, default=False Choose to make a plot for the shuffled period analysis
- shuf_dir
str, optional, default=’plot_shuf’ The name of the directory to save the plots of the shuffled period analysis.
- file_in
- Returns:
- A data entry for the final period file.
- A plot of the lightcurve (if requested).