tglc 0.6.5__py3-none-any.whl → 0.7.0__py3-none-any.whl

tglc/target_lightcurve.py

@@ -13,6 +13,10 @@ from os.path import exists
 from tglc.effective_psf import get_psf, fit_psf, fit_lc, fit_lc_float_field, bg_mod
 from tglc.ffi import Source
 from tglc.ffi_cut import Source_cut
+import tglc
+from astropy.coordinates import SkyCoord
+from tglc.barycentric_correction import apply_barycentric_correction
+import astropy.units as u
 
 warnings.simplefilter('always', UserWarning)
 
@@ -20,7 +24,7 @@ warnings.simplefilter('always', UserWarning)
 def lc_output(source, local_directory='', index=0, time=None, psf_lc=None, cal_psf_lc=None, aper_lc=None,
               cal_aper_lc=None, bg=None, tess_flag=None, tglc_flag=None, cadence=None, aperture=None,
               cut_x=None, cut_y=None, star_x=2, star_y=2, x_aperture=None, y_aperture=None, near_edge=False,
-              local_bg=None, save_aper=False, portion=1, prior=None, transient=None):
+              local_bg=None, save_aper=False, portion=1, prior=None, transient=None, target_5x5=None, field_stars_5x5=None, ffi='TICA'):
     """
     lc output to .FITS file in MAST HLSP standards
     :param tglc_flag: np.array(), required
@@ -45,7 +49,7 @@ def lc_output(source, local_directory='', index=0, time=None, psf_lc=None, cal_p
         objid = [int(s) for s in (source.gaia[index]['DESIGNATION']).split() if s.isdigit()][0]
     else:
         objid = transient[0]
-    source_path = f'{local_directory}hlsp_tglc_tess_ffi_gaiaid-{objid}-s{source.sector:04d}-cam{source.camera}-ccd{source.ccd}_tess_v1_llc.fits'
+    source_path = f'{local_directory}hlsp_tglc_tess_ffi_gaiaid-{objid}-s{source.sector:04d}-cam{source.camera}-ccd{source.ccd}_tess_v2_llc.fits'
     source_exists = exists(source_path)
     # if source_exists and (os.path.getsize(source_path) > 0):
     #     print('LC exists, please (re)move the file if you wish to overwrite.')
@@ -82,6 +86,13 @@ def lc_output(source, local_directory='', index=0, time=None, psf_lc=None, cal_p
         primary_hdu = fits.PrimaryHDU(aperture)
     else:
         primary_hdu = fits.PrimaryHDU()
+    # Simulated star images based on ePSF, used to estimate contamination ratio and others
+    image_data = np.zeros((3, 5, 5))
+    image_data[0] = target_5x5
+    image_data[1] = field_stars_5x5
+    # This is the pixel-wise contamination ratio
+    image_data[2] = field_stars_5x5/target_5x5
+    image_hdu = fits.ImageHDU(data=image_data)
 
     primary_hdu.header = fits.Header(cards=[
         fits.Card('SIMPLE', True, 'conforms to FITS standard'),
@@ -96,9 +107,11 @@ def lc_output(source, local_directory='', index=0, time=None, psf_lc=None, cal_p
         fits.Card('STAR_Y', y_aperture, 'star y position in cut'),
         fits.Card('COMMENT', 'hdul[0].data[:,star_y,star_x]=lc'),
         fits.Card('ORIGIN', 'UCSB/TGLC', 'institution responsible for creating this file'),
+        fits.Card('TGLCVER', f'{tglc.__version__}', 'TGLC version'),
         fits.Card('TELESCOP', 'TESS', 'telescope'),
         fits.Card('INSTRUME', 'TESS Photometer', 'detector type'),
         fits.Card('FILTER', 'TESS', 'the filter used for the observations'),
+        fits.Card('FFIVER', ffi, 'the FFI product used (SPOC/TICA)'),
         fits.Card('OBJECT', source.gaia[index]['DESIGNATION'], 'string version of Gaia DR3 ID'),
         fits.Card('GAIADR3', objid, 'integer version of Gaia DR3 ID'),
         fits.Card('TICID', ticid, 'TESS Input Catalog ID'),
@@ -116,6 +129,7 @@ def lc_output(source, local_directory='', index=0, time=None, psf_lc=None, cal_p
         fits.Card('GAIA_bp', gaia_bp, 'Gaia DR3 bp band magnitude'),
         fits.Card('GAIA_rp', gaia_rp, 'Gaia DR3 rp band magnitude'),
         fits.Card('RAWFLUX', raw_flux, 'median flux of raw FFI'),
+        fits.Card('CONTAMRT', round(np.nansum(field_stars_5x5[1:4,1:4])/np.nansum(target_5x5[1:4,1:4]), 9), 'contamination ratio of default 3*3 aperture'),
         fits.Card('CALIB', 'TGLC', 'pipeline used for image calibration')])
     if save_aper:
         primary_hdu.header.comments['NAXIS1'] = "Time (hdul[1].data['time'])"
@@ -130,7 +144,19 @@ def lc_output(source, local_directory='', index=0, time=None, psf_lc=None, cal_p
         exposure_time = 600
     else:  # second extended
         exposure_time = 200
-    c1 = fits.Column(name='time', array=np.array(time), format='D')
+
+    ### barycentric correction for TICA
+    if ffi == 'TICA':
+        sector = source.sector
+        tjd = time
+        coord = SkyCoord([(source.gaia[index]['ra'], source.gaia[index]['dec'])], unit=u.deg,)
+        time_bcc = apply_barycentric_correction(sector, tjd, coord)[0]
+    elif ffi == 'SPOC':
+        time_bcc = np.array(time)
+    else:
+        raise ValueError('ffi must be either TICA or SPOC')
+
+    c1 = fits.Column(name='time', array=np.array(time_bcc), format='D')
     c2 = fits.Column(name='psf_flux', array=np.array(psf_lc), format='E')  # psf factor
     # c3 = fits.Column(name='psf_flux_err',
     #                  array=1.4826 * np.median(np.abs(psf_lc - np.median(psf_lc))) * np.ones(len(psf_lc)), format='E')
@@ -152,7 +178,7 @@ def lc_output(source, local_directory='', index=0, time=None, psf_lc=None, cal_p
     table_hdu = fits.BinTableHDU.from_columns([c1, c2, c4, c6, c8, c10, c11, c12, c13])
     table_hdu.header.append(('INHERIT', 'T', 'inherit the primary header'), end=True)
     table_hdu.header.append(('EXTNAME', 'LIGHTCURVE', 'name of extension'), end=True)
-    table_hdu.header.append(('EXTVER', 1, 'extension version'),  # TODO: version?
+    table_hdu.header.append(('EXTVER', 1, 'extension version'),
                             end=True)
     table_hdu.header.append(('TELESCOP', 'TESS', 'telescope'), end=True)
     table_hdu.header.append(('INSTRUME', 'TESS Photometer', 'detector type'), end=True)
@@ -190,14 +216,15 @@ def lc_output(source, local_directory='', index=0, time=None, psf_lc=None, cal_p
     if type(prior) == float:
         table_hdu.header.append(('PRIOR', prior, 'prior of field stars'), end=True)
 
-    hdul = fits.HDUList([primary_hdu, table_hdu])
+    hdul = fits.HDUList([primary_hdu, table_hdu, image_hdu])
     hdul.writeto(
-        f'{local_directory}hlsp_tglc_tess_ffi_gaiaid-{objid}-s{source.sector:04d}-cam{source.camera}-ccd{source.ccd}_tess_v1_llc.fits',
+        f'{local_directory}hlsp_tglc_tess_ffi_gaiaid-{objid}-s{source.sector:04d}-cam{source.camera}-ccd{source.ccd}_tess_v2_llc.fits',
         overwrite=True)
     return
 
 
-def epsf(source, psf_size=11, factor=2, local_directory='', target=None, cut_x=0, cut_y=0, sector=0,
+
+def epsf(source, psf_size=11, factor=2, local_directory='', target=None, cut_x=0, cut_y=0, sector=0, ffi='TICA',
          limit_mag=16, edge_compression=1e-4, power=1.4, name=None, save_aper=False, no_progress_bar=False, prior=None):
     """
     User function that unites all necessary steps
@@ -310,7 +337,7 @@ def epsf(source, psf_size=11, factor=2, local_directory='', target=None, cut_x=0
                     fit_lc_float_field(A, source, star_info=star_info, x=x_round, y=y_round, star_num=i, e_psf=e_psf,
                                        near_edge=near_edge, prior=prior)
             else:
-                aperture, psf_lc, star_y, star_x, portion = \
+                aperture, psf_lc, star_y, star_x, portion, target_5x5, field_stars_5x5 = \
                     fit_lc(A, source, star_info=star_info, x=x_round[i], y=y_round[i], star_num=i, e_psf=e_psf,
                            near_edge=near_edge)
             aper_lc = np.sum(
@@ -347,16 +374,17 @@ def epsf(source, psf_size=11, factor=2, local_directory='', target=None, cut_x=0
                     lc_output(source, local_directory=lc_directory, index=i,
                               tess_flag=source.quality, cut_x=cut_x, cut_y=cut_y, cadence=source.cadence,
                               aperture=aperture.astype(np.float32), star_y=y_round[i], star_x=x_round[i], tglc_flag=quality,
+                              ffi='SPOC',
                               bg=background_, time=source.time, psf_lc=psf_lc, cal_psf_lc=cal_psf_lc, aper_lc=aper_lc,
                               cal_aper_lc=cal_aper_lc, local_bg=local_bg, x_aperture=x_aperture[i],
                               y_aperture=y_aperture[i], near_edge=near_edge, save_aper=save_aper, portion=portion,
-                              prior=prior)
+                              prior=prior, transient=source.transient, target_5x5=target_5x5, field_stars_5x5=field_stars_5x5)
                 else:
                     lc_output(source, local_directory=lc_directory, index=i,
                               tess_flag=source.quality, cut_x=cut_x, cut_y=cut_y, cadence=source.cadence,
                               aperture=aperture.astype(np.float32), star_y=y_round[i], star_x=x_round[i],
-                              tglc_flag=quality,
+                              tglc_flag=quality, ffi=ffi,
                               bg=background_, time=source.time, psf_lc=psf_lc, cal_psf_lc=cal_psf_lc, aper_lc=aper_lc,
                               cal_aper_lc=cal_aper_lc, local_bg=local_bg, x_aperture=x_aperture[i],
                               y_aperture=y_aperture[i], near_edge=near_edge, save_aper=save_aper, portion=portion,
-                              prior=prior, transient=source.transient)
+                              prior=prior, transient=source.transient, target_5x5=target_5x5, field_stars_5x5=field_stars_5x5)

{tglc-0.6.5.dist-info → tglc-0.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: tglc
-Version: 0.6.5
+Version: 0.7.0
 Summary: TESS-Gaia Light Curve
 Home-page: https://github.com/TeHanHunter/TESS_Gaia_Light_Curve
 Author: Te Han
@@ -8,20 +8,45 @@ Author-email: tehanhunter@gmail.com
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.8
+Requires-Python: >=3.8, <3.13
 Description-Content-Type: text/x-rst
 License-File: LICENSE
-Requires-Dist: astropy >=5.1
-Requires-Dist: astroquery
-Requires-Dist: matplotlib
-Requires-Dist: numpy
+Requires-Dist: astropy<6.2,>=6.1
+Requires-Dist: astroquery==0.4.7
+Requires-Dist: matplotlib<4.0,>=3.8
+Requires-Dist: numpy<2.0,>=1.23
 Requires-Dist: oauthlib
-Requires-Dist: requests
-Requires-Dist: scipy
-Requires-Dist: threadpoolctl
-Requires-Dist: tqdm
-Requires-Dist: wheel
-Requires-Dist: wotan
+Requires-Dist: requests<3.0,>=2.28
+Requires-Dist: scipy<2.0,>=1.10
+Requires-Dist: threadpoolctl<4.0,>=3.1
+Requires-Dist: tqdm>=4.64
+Requires-Dist: wotan~=1.9
+Requires-Dist: seaborn
+Requires-Dist: pandas
+Requires-Dist: importlib_resources
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+.. image:: https://raw.githubusercontent.com/TeHanHunter/TESS_Gaia_Light_Curve/main/logo/TGLC_Title.png
+  :width: 800
+  :alt: TESS-Gaia Light Curve
+
+.. image:: https://zenodo.org/badge/420868490.svg
+   :target: https://zenodo.org/badge/latestdoi/420868490
+
+.. image:: https://static.pepy.tech/personalized-badge/tglc?period=total&units=international_system&left_color=grey&right_color=blue&left_text=Total%20Downloads
+   :target: https://pepy.tech/project/tglc
+
+.. image:: https://img.shields.io/badge/Cite-TGLC-blue
+   :target: https://www.tomwagg.com/software-citation-station/?auto-select=tglc
 
 ==================================
 Introduction
@@ -29,6 +54,10 @@ Introduction
 
 TESS-Gaia Light Curve (`TGLC <https://archive.stsci.edu/hlsp/tglc>`_) is a dataset of TESS full-frame image light curves publicly available via the MAST portal. It is fitted with effective PSF and decontaminated with Gaia DR3 and achieved percent-level photometric precision down to 16th TESS magnitude! It unlocks astrophysics to a vast number of dim stars below 12th TESS magnitude. A package called tglc is pip-installable for customized light curve fits.
 
+.. image:: https://raw.githubusercontent.com/TeHanHunter/TESS_Gaia_Light_Curve/main/logo/EB_comparison_git.png
+  :width: 800
+  :alt: EB light curve comparison to other pipeline
+
 ==================================
 Usage
 ==================================

tglc-0.7.0.dist-info/RECORD

@@ -0,0 +1,28 @@
+tglc/__init__.py,sha256=mRui0a1UV8tt2htxZtyh6RsP2hgeU-0chLUIwgniJl4,116
+tglc/barycentric_correction.py,sha256=hNqlzPunRFuRKoUDsBirsFaDLNUYbPCt5BUN3cGcEtc,4166
+tglc/effective_psf.py,sha256=iaq_dFlReximmb2dlKIOtfqWAQCpSPJEo1eQGoxpWZ0,23575
+tglc/ffi.py,sha256=1_3o849Vaiek5TaQGTWPR1f8qmEku8q9TEIrfkP918w,15718
+tglc/ffi_cut.py,sha256=2yKBuYWp8KrIx2zwOmGMIOog1aoGPQiV29BAgf5rP5w,15971
+tglc/lc_plot.py,sha256=-1wsw3mu0yxDGAEKNxB55Nv9-JQqVt44lB1DJCZbq7I,136246
+tglc/mast.py,sha256=SyLTL6DCp2N_ZK3IwqG6_EISzjlptU_5414BYgPXPRM,4331
+tglc/quick_lc.py,sha256=IgtY9dI5oCHH91n-fzF_pChWFgL4eB6eHPpm6R1TVFw,35610
+tglc/run.py,sha256=exHt6VbrDVHKhho63p_3K-eCM2VRPEkArh7vO3-EgcQ,4123
+tglc/source_output.py,sha256=zdCsgDjc2MB9_bPWlCoKMZjR3SMBZvorM6tIgbcQ7As,3171
+tglc/target_lightcurve.py,sha256=Fso6hK1lFS1aHXNmivNqWcTreGgW2-nEdCKBeZ_mgFQ,22162
+tglc/background_mask/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tglc/background_mask/median_mask.fits,sha256=1manbdxSQ_x780Puk8Lm4zDZOaEghknc2LbZA8J6P-Q,267840
+tglc/ephemeris_data/20180720_tess_ephem.csv,sha256=aN4HDJrj7bLYZHAVMy_bregFi9WGS1-nOIY5NL2Zru4,2002174
+tglc/ephemeris_data/20190101_tess_ephem.csv,sha256=WqA6LrDLzD80ilcvaNUqJBqQNbFEUXuZ_BQnahJlOHw,1856649
+tglc/ephemeris_data/20200101_tess_ephem.csv,sha256=4VkN3uJxfsQRU43gVb2huDZEqXKw5Qxv_a3pjOra_f4,1861337
+tglc/ephemeris_data/20210101_tess_ephem.csv,sha256=W9LUTH6sWeSOb1OZ6GWZqNBBeOC6j7ph6cd_tNbL_LQ,1786260
+tglc/ephemeris_data/20211215_tess_ephem.csv,sha256=ZLwZAFjYeLtNZoF_ZM1WHx7poe-qFwzslVW0UvJjFwg,2414158
+tglc/ephemeris_data/20221201_tess_ephem.csv,sha256=r8TnisAwUEPVPOnbXU9D1sgLci4B0VP_PpoIx5zVMi8,1998220
+tglc/ephemeris_data/20231201_tess_ephem.csv,sha256=fFC7foLrhSy_YmJkAtWjyDIAK45VHFR-DLH0O2Wp9fM,2003394
+tglc/ephemeris_data/20241201_tess_ephem.csv,sha256=V3gTJ1gNiS9lj1qmCr4vz5GrbRVBC16P3TvaUmU4FJw,1998712
+tglc/ephemeris_data/README.md,sha256=BHGQ9tC3OThbnyf2ArCACkjUmGeyQLm4_BPjwXCfu0Q,2472
+tglc/ephemeris_data/plot_ephemerides.py,sha256=txnHg3LzRKAH1s2pCMjaL4RZOi09fGaqBX78XMKeuo0,1750
+tglc-0.7.0.dist-info/licenses/LICENSE,sha256=BP8oVkBHG81Tn8BrmTDDrn_i1L_jPpP16pqiqxSZHpw,1063
+tglc-0.7.0.dist-info/METADATA,sha256=CLDVMdiL9jWo29Y0X6uBc2Rg9h4_wiVUNK4R9TBWIpk,6711
+tglc-0.7.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+tglc-0.7.0.dist-info/top_level.txt,sha256=EaP_Ye331aCwisaGDcjQy4LIHXHfD3mL4D1ZiopvGMk,5
+tglc-0.7.0.dist-info/RECORD,,

{tglc-0.6.5.dist-info → tglc-0.7.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.1.0)
+Generator: setuptools (80.10.2)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

tglc-0.6.5.dist-info/RECORD

@@ -1,17 +0,0 @@
-tglc/__init__.py,sha256=_5LSqxLOO4-Aoa5wHuErEHALMwJSjZbatc9k8-StWcE,115
-tglc/effective_psf.py,sha256=S9W7iKdr2amxWO-2eGtxS45X9w4f4ennJN812T8MFyI,22712
-tglc/ffi.py,sha256=8J-BFUbseomP6r00PgjMS-Ize5n1vfH9U8R0T6DdJAE,15656
-tglc/ffi_cut.py,sha256=mPl-8gQK0sPjI0Tq0rbltOjdejqmbVJ_pEETBhKyEQU,11969
-tglc/lc_plot.py,sha256=-1wsw3mu0yxDGAEKNxB55Nv9-JQqVt44lB1DJCZbq7I,136246
-tglc/mast.py,sha256=SyLTL6DCp2N_ZK3IwqG6_EISzjlptU_5414BYgPXPRM,4331
-tglc/quick_lc.py,sha256=CFzZEPT02HLwFkCcZEWzNyMzjDvbcKjsR3N14CF5JQE,31541
-tglc/run.py,sha256=exHt6VbrDVHKhho63p_3K-eCM2VRPEkArh7vO3-EgcQ,4123
-tglc/source_output.py,sha256=zdCsgDjc2MB9_bPWlCoKMZjR3SMBZvorM6tIgbcQ7As,3171
-tglc/target_lightcurve.py,sha256=olJelItQ4Qs_0YXxYO7Ulg8EyGIDCwbudmhpSVBIPdk,20692
-tglc/background_mask/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-tglc/background_mask/median_mask.fits,sha256=1manbdxSQ_x780Puk8Lm4zDZOaEghknc2LbZA8J6P-Q,267840
-tglc-0.6.5.dist-info/LICENSE,sha256=BP8oVkBHG81Tn8BrmTDDrn_i1L_jPpP16pqiqxSZHpw,1063
-tglc-0.6.5.dist-info/METADATA,sha256=qGoqA7AxK9BBcJti1PhNLvcvQ0JNA85QAUkFQAUiWgk,5575
-tglc-0.6.5.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-tglc-0.6.5.dist-info/top_level.txt,sha256=EaP_Ye331aCwisaGDcjQy4LIHXHfD3mL4D1ZiopvGMk,5
-tglc-0.6.5.dist-info/RECORD,,