eleanor.source
index
/home/dinilbose/github/eleanor/eleanor/source.py

 
Modules
       
astropy.io.fits
numpy
os
sys
astropy.units
urllib
warnings

 
Classes
       
builtins.object
Source

 
class Source(builtins.object)
    A single source observed by TESS.
 
Parameters
----------
tic : int, optional
    The TIC ID of the source.
gaia : int, optional
    The Gaia DR2 source_id.
coords : tuple or astropy.coordinates.SkyCoord, optional
    The (RA, Dec) coords of the object in degrees or an astropy SkyCoord object.
name : str, optional
    The name of your target (e.g. "HD#####" or "M31").
fn : str, optional
    Filename of a TPF corresponding to the desired source.
sector : int or str
    The sector for which data should be returned, or `recent` to
    obtain data for the most recent sector which contains this target.
tc : bool, optional
    If True, use a TessCut cutout to produce postcards rather than downloading the eleanor
    postcard data products.
 
Attributes
----------
tess_mag : float
    The TESS magnitude from the TIC.
sector : int
    Sector in which source was observed by TESS.
camera : int
    TESS camera on which source falls.
chip : int
    TESS chip on which source falls.
position_on_chip : (int, int)
    Predicted (x,y) coords of object center on chip.
postcard : str
    Name of the best postcard (postcard where source should be located closest to the center).
position_on_postcard : (int, int)
    Predicted (x, y) coords of object center on the above-named postcard.
    Does NOT take into account additional pointing corrections; these will be applied when making the TPF.
all_postcards : list of strs
    Names of all postcards where the source appears.
 
  Methods defined here:
__init__(self, tic=None, gaia=None, coords=None, name=None, fn=None, sector=None, fn_dir=None, tc=False, local=False, post_dir=None, pm_dir=None)
Initialize self.  See help(type(self)) for accurate signature.
locate_on_tess(self)
Finds the TESS sector, camera, chip, and position on chip for the source.
 
Attributes
----------
sector : int
camera : int
chip : int
position_on_chip : np.array
locate_postcard(self, local)
Finds the eleanor postcard, if available, this star falls on.
 
Attributes
---------- 
postcard : str
postcard_bkg : str
postcard_path : str
position_on_postcard : list
all_postcards : list
mast_list : astropy.table.Table
locate_with_tesscut(self)
Finds the best TESS postcard(s) and the position of the source on postcard.
 
Attributes
----------
postcard : list
postcard_path : str
position_on_postcard : list 
all_postcards : list
sector : int
camera : int
chip : int
position_on_chip : np.array
search_tesscut(self, download_dir, coords)
Searches to see if the TESSCut cutout has already been downloaded.
tesscut_dir(self)
Creates a TESSCut directory in the hidden eleanor directory.

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
Functions
       
multi_sectors(sectors, tic=None, gaia=None, coords=None, name=None, tc=False, local=False, post_dir=None, pm_dir=None)
Obtain a list of Source objects for a single target, for each of multiple sectors for which the target was observed.
 
Parameters
----------
sectors : list or str
    The list of sectors for which data should be returned, or `'all'` to return all sectors
    for which there are data.
tic : int, optional
    The TIC ID of the source.
gaia : int, optional
    The Gaia DR2 source_id.
coords : tuple, optional
    The (RA, Dec) coords of the object in degrees.
tc : bool, optional
    If True, use a TessCut cutout to produce postcards rather than downloading the eleanor
    postcard data products.

 
Data
        __all__ = ['Source', 'multi_sectors']