diff --git a/src/pint/fits_utils.py b/src/pint/fits_utils.py index 61ab27d40..cb2f55621 100644 --- a/src/pint/fits_utils.py +++ b/src/pint/fits_utils.py @@ -5,21 +5,30 @@ from erfa import DAYSEC as SECS_PER_DAY +from astropy.io import fits + from pint.pulsar_mjd import fortran_float __all__ = ["read_fits_event_mjds", "read_fits_event_mjds_tuples"] -def read_fits_event_mjds_tuples(event_hdu, timecolumn="TIME"): +def read_fits_event_mjds_tuples( + event_hdu: fits.hdu.BinTableHDU, timecolumn: str = "TIME" +) -> np.ndarray: """Read a set of MJDs from a FITS HDU, with proper conversion of times to MJD The FITS time format is defined here: https://heasarc.gsfc.nasa.gov/docs/journal/timing3.html + Parameters + ---------- + event_hdu : fits.hdu.BinTableHDU + timecolumn : str, optional + Returns ------- - mjds: MJDs returned are tuples of two doubles (jd1, jd2), as use by + mjds: MJDs returned are tuples of two doubles (jd1, jd2), as used by astropy Time() objects. """ @@ -63,13 +72,24 @@ def read_fits_event_mjds_tuples(event_hdu, timecolumn="TIME"): ) -def read_fits_event_mjds(event_hdu, timecolumn="TIME"): +def read_fits_event_mjds( + event_hdu: fits.hdu.BinTableHDU, timecolumn: str = "TIME" +) -> np.ndarray: """Read a set of MJDs from a FITS HDU, with proper conversion of times to MJD The FITS time format is defined here: https://heasarc.gsfc.nasa.gov/docs/journal/timing3.html MJDs returned are double precision floats + + Parameters + ---------- + event_hdu : fits.hdu.BinTableHDU + timecolumn : str, optional + + Returns + ------- + mjds: np.ndarray """ event_hdr = event_hdu.header