all_sources_cutout¶
- tessilator.tessilator.all_sources_cutout(t_targets, period_file, ref_name, 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, choose_sec=None, save_phot=False, cbv_flag=False, store_lc=False, tot_attempts=3, cap_sectors=None, res_ext='results', lc_ext='lc', pg_ext='pg', fits_ext='fits', clean_fail_modes=False, keep_data=False, fix_noise=False, shuf_per=False, shuf_ext='shuf_plots', calc_cont=True, lc_cont=False, make_plot=False, make_shuf_plot=False)[source]¶
Run the tessilator for all targets.
- Parameters:
- t_targets
astropy.table.Table Table of input data for the tessilator, with the following columns:
name: name of the target (
str)source_id: Gaia DR3 source identifier (
str)ra: right ascension
dec: declination
parallax: parallax
Gmag: Gaia DR3 apparent G-band magnitude
BPmag: Gaia DR3 apparent BP-band magnitude
RPmag: Gaia DR3 apparent RP-band magnitude
log_tot_bg: log-10 value of the flux ratio between contaminants and target (optional)
log_max_bg: log-10 value of the flux ratio between the largest contaminant and target (optional)
num_tot_bg: number of contaminant sources (optional)
- period_file
str Name of the file to store periodogram results.
- lc_con
bool Decides if a lightcurve analysis is to be performed for the 5 strongest contaminants. Here, the data required for further analysis are stored in a table.
- flux_con
bool Decides if the flux contribution from contaminants is to be calculated.
- ref_name
str The reference name for each subdirectory which will connect all output files.
- 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.
- choose_sec
None,int, orIterable, optional, default=None The sector, or sectors required for download.
- 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.
- tot_attempts
int, optional, default=3 The number of sql queries in case of request or server errors.
- cap_sectors
int, optional, default=None The maximum number of sectors for each target.
- res_ext
str, optional, default=’results’ The directory to store the final results file.
- lc_ext
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.
- 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
- fits_ext
str, optional, default=’fits’ The name of the directory to store the fits files.
- keep_data
bool Choose to save the input data to file.
- fix_noise
bool, optional, default=False Choose to apply the noise correction to the cleaned lightcurve.
- 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.
- t_targets
- Returns:
- Nothing returned. The final table is saved to file and the program
- terminates.