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

 
Modules
       
copy
astropy.io.fits
numpy
os
pandas
matplotlib.pyplot
sys
warnings

 
Classes
       
builtins.object
Postcard

 
class Postcard(builtins.object)
    TESS FFI data for one postcard across one sector.
 
A postcard is an rectangular subsection cut out from the FFIs. 
It's like a TPF, but bigger. 
The Postcard object contains a stack of these cutouts from all available 
FFIs during a given sector of TESS observations.
 
Parameters
----------
filename : str
    Filename of the downloaded postcard.
location : str, optional
    Filepath to `filename`.
 
Attributes
----------
dimensions : tuple
    (`x`, `y`, `time`) dimensions of postcard.
flux, flux_err : numpy.ndarray
    Arrays of shape `postcard.dimensions` containing flux or error on flux 
    for each pixel.
time : float
    ?
header : dict
    Stored header information for postcard file.
center_radec : tuple
    RA & Dec coordinates of the postcard's central pixel.
center_xy : tuple
    (`x`, `y`) coordinates corresponding to the location of 
    the postcard's central pixel on the FFI.
origin_xy : tuple
    (`x`, `y`) coordinates corresponding to the location of 
    the postcard's (0,0) pixel on the FFI.
background2d : np.ndarray
    The 2D modeled background array.
 
  Methods defined here:
__init__(self, filename, background, filepath)
Initialize self.  See help(type(self)) for accurate signature.
__repr__(self)
Return repr(self).
find_sources(self)
Finds the cataloged sources in the postcard and returns a table.
 
Returns
-------
result : astropy.table.Table
    All the sources in a postcard with TIC IDs or Gaia IDs.
plot(self, frame=0, ax=None, scale='linear', **kwargs)
Plots a single frame of a postcard.
 
Parameters
----------
frame : int, optional
    Index of frame. Default 0.
 
ax : matplotlib.axes.Axes, optional
    Axes on which to plot. Creates a new object by default.
 
scale : str
    Scaling for colorbar; acceptable inputs are 'linear' or 'log'.
    Default 'linear'.
 
**kwargs : passed to matplotlib.pyplot.imshow
 
Returns
-------
ax : matplotlib.axes.Axes

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
barycorr
bkg
center_radec
center_xy
dimensions
ffiindex
flux
flux_err
header
origin_xy
quality
time
wcs

 
Data
        __all__ = ['Postcard']