rms-starcat 0.0.1__py3-none-any.whl

starcat/starcatalog.py

@@ -0,0 +1,414 @@
+################################################################################
+# starcat/starcatalog.py
+################################################################################
+
+import inspect
+import numpy as np
+
+DPR = 180/np.pi
+RPD = np.pi/180
+AS_TO_DEG = 1/3600.
+AS_TO_RAD = AS_TO_DEG * RPD
+MAS_TO_DEG = AS_TO_DEG / 1000.
+MAS_TO_RAD = MAS_TO_DEG * RPD
+YEAR_TO_SEC = 1/365.25/86400.
+
+TWOPI = 2*np.pi
+HALFPI = np.pi/2
+
+#===============================================================================
+#
+# Jacobson B-V photometry vs. stellar spectral classification
+#
+# Data from
+#     Zombeck, M. V. Handbook of Space Astronomy and Astrophysics,
+#     Cambridge, UK: Cambridge University Press, 2nd ed., pp. 68-70
+#     http://ads.harvard.edu/books/hsaa/
+# as transcribed:
+#     http://www.vendian.org/mncharity/dir3/starcolor/details.html
+#
+# The tables below only include main sequence stars, but the temperature
+# difference between main sequence stars and giant stars is minimal for our
+# purposes. Missing values have been linearly interpolated.
+#
+#===============================================================================
+
+SCLASS_TO_B_MINUS_V = {
+    'O5': -0.32,
+    'O6': -0.32,
+    'O7': -0.32,
+    'O8': -0.31,
+    'O9': -0.31,
+    'O9.5': -0.30,
+    'B0': -0.30,
+    'B0.5': -0.28,
+    'B1': -0.26,
+    'B2': -0.24,
+    'B3': -0.20,
+    'B4': -0.18, # Interp
+    'B5': -0.16,
+    'B6': -0.14,
+    'B7': -0.12,
+    'B8': -0.09,
+    'B9': -0.06,
+    'A0': +0.00,
+    'A1': +0.02, # Interp
+    'A2': +0.04, # Interp
+    'A3': +0.06,
+    'A4': +0.10, # Interp
+    'A5': +0.14,
+    'A6': +0.16, # Interp
+    'A7': +0.19,
+    'A8': +0.23, # Interp
+    'A9': +0.27, # Interp
+    'F0': +0.31,
+    'F1': +0.33, # Interp
+    'F2': +0.36,
+    'F3': +0.38, # Interp
+    'F4': +0.41, # Interp
+    'F5': +0.43,
+    'F6': +0.47, # Interp
+    'F7': +0.51, # Interp
+    'F8': +0.54,
+    'F9': +0.56, # Interp
+    'G0': +0.59,
+    'G1': +0.61, # Interp
+    'G2': +0.63,
+    'G3': +0.64, # Interp
+    'G4': +0.65, # Interp
+    'G5': +0.66,
+    'G6': +0.69, # Interp
+    'G7': +0.72, # Interp
+    'G8': +0.74,
+    'G9': +0.78, # Interp
+    'K0': +0.82,
+    'K1': +0.87, # Interp
+    'K2': +0.92,
+    'K3': +0.99, # Interp
+    'K4': +1.07, # Interp
+    'K5': +1.15,
+    'K6': +1.22, # Interp
+    'K7': +1.30,
+    'K8': +1.33, # Interp
+    'K9': +1.37, # Interp
+    'M0': +1.41,
+    'M1': +1.48,
+    'M2': +1.52,
+    'M3': +1.55,
+    'M4': +1.56,
+    'M5': +1.61,
+    'M6': +1.72,
+    'M7': +1.84,
+    'M8': +2.00
+}
+
+SCLASS_TO_SURFACE_TEMP = {
+    'O5': 38000,
+    'O6': 38000,
+    'O7': 38000,
+    'O8': 35000,
+    'O9': 35000,
+    'O9.5': 31900,
+    'B0': 30000,
+    'B0.5': 27000,
+    'B1': 24200,
+    'B2': 22100,
+    'B3': 18800,
+    'B4': 17600, # Interp
+    'B5': 16400,
+    'B6': 15400,
+    'B7': 14500,
+    'B8': 13400,
+    'B9': 12400,
+    'A0': 10800,
+    'A1': 10443, # Interp
+    'A2': 10086, # Interp
+    'A3': 9730,
+    'A4': 9175, # Interp
+    'A5': 8620,
+    'A6': 8405, # Interp
+    'A7': 8190,
+    'A8': 7873, # Interp
+    'A9': 7557, # Interp
+    'F0': 7240,
+    'F1': 7085, # Interp
+    'F2': 6930,
+    'F3': 6800, # Interp
+    'F4': 6670, # Interp
+    'F5': 6540,
+    'F6': 6427, # Interp
+    'F7': 6313, # Interp
+    'F8': 6200,
+    'F9': 6060, # Interp
+    'G0': 5920,
+    'G1': 5850, # Interp
+    'G2': 5780,
+    'G3': 5723, # Interp
+    'G4': 5667, # Interp
+    'G5': 5610,
+    'G6': 5570, # Interp
+    'G7': 5530, # Interp
+    'G8': 5490,
+    'G9': 5365, # Interp
+    'K0': 5240,
+    'K1': 5010, # Interp
+    'K2': 4780,
+    'K3': 4706, # Interp
+    'K4': 4632, # Interp
+    'K5': 4558, # Interp
+    'K6': 4484, # Interp
+    'K7': 4410,
+    'K8': 4247, # Interp
+    'K9': 4083, # Interp
+    'M0': 3800, # M class from https://arxiv.org/abs/0903.3371
+    'M1': 3600,
+    'M2': 3400,
+    'M3': 3250,
+    'M4': 3100,
+    'M5': 2800,
+    'M6': 2600,
+    'M7': 2500,
+    'M8': 2300,
+}
+
+
+#===============================================================================
+#
+# STAR Superclass
+#
+#===============================================================================
+
+class Star(object):
+    """A holder for star attributes.
+
+    This is the base class that defines attributes common to all
+    star catalogs."""
+
+    def __init__(self):
+        """Constructor for Star superclass."""
+
+        self.ra = None
+        """Right ascension at J2000 epoch (radians)"""
+
+        self.ra_sigma = None
+        """Right ascension error (radians)"""
+
+        self.dec = None
+        """Declination at J2000 epoch (radians)"""
+
+        self.dec_sigma = None
+        """Declination error (radians)"""
+
+        self.vmag = None
+        """Visual magnitude"""
+
+        self.vmag_sigma = None
+        """Visual magnitude error"""
+
+        self.pm_ra = None
+        """Proper motion in RA (radians/sec)"""
+
+        self.pm_ra_sigma = None
+        """Proper motion in RA error (radians/sec)"""
+
+        self.pm_dec = None
+        """Proper motion in DEC (radians/sec)"""
+
+        self.pm_dec_sigma = None
+        """Proper motion in DEC error (radians/sec)"""
+
+        self.unique_number = None
+        """Unique catalog number"""
+
+    def __str__(self):
+        ret = 'UNIQUE ID %d' % (self.unique_number)
+
+        if self.ra is not None:
+            ret += ' | RA %.7f' % (self.ra)
+            if self.ra_sigma is not None:
+                ret += ' [+/- %.7f]' % (self.ra_sigma)
+
+            ra_deg = self.ra*DPR/15 # In hours
+            hh = int(ra_deg)
+            mm = int((ra_deg-hh)*60)
+            ss = (ra_deg-hh-mm/60.)*3600
+            ret += ' (%02dh%02dm%05.3fs' % (hh,mm,ss)
+            if self.ra_sigma is not None:
+                ret += ' +/- %.4fs' % (self.ra_sigma*DPR*3600)
+            ret += ')'
+
+        if self.dec is not None:
+            ret += ' | DEC %.7f' % (self.dec)
+            if self.dec_sigma is not None:
+                ret += ' [+/- %.7f]' % (self.dec_sigma)
+
+            dec_deg = self.dec*DPR # In degrees
+            neg = '+'
+            if dec_deg < 0.:
+                neg = '-'
+                dec_deg = -dec_deg
+            dd = int(dec_deg)
+            mm = int((dec_deg-dd)*60)
+            ss = (dec_deg-dd-mm/60.)*3600
+            ret += ' (%s%03dd%02dm%05.3fs' % (neg,dd,mm,ss)
+
+            if self.dec_sigma is not None:
+                ret += ' +/- %.4fs' % (self.dec_sigma*DPR*3600)
+            ret += ')'
+
+        ret += '\n'
+
+        if self.vmag is not None:
+            ret += 'VMAG %6.3f ' % (self.vmag)
+            if self.vmag_sigma is not None:
+                ret += '+/- %6.3f ' % (self.vmag_sigma)
+
+        if self.pm_ra is not None:
+            ret += ' | PM RA %.3f mas/yr ' % (self.pm_ra/MAS_TO_RAD/YEAR_TO_SEC)
+            if self.pm_ra_sigma:
+                ret += '+/- %.3f ' % (self.pm_ra_sigma/MAS_TO_RAD/YEAR_TO_SEC)
+
+        if self.pm_dec is not None:
+            ret += ' | PM DEC %.3f mas/yr ' % (self.pm_dec/MAS_TO_RAD/YEAR_TO_SEC)
+            if self.pm_dec_sigma:
+                ret += '+/- %.3f ' % (self.pm_dec_sigma/MAS_TO_RAD/YEAR_TO_SEC)
+
+        ret += '\n'
+
+        return ret
+
+    def to_dict(self):
+        attribs = inspect.getmembers(self, lambda a:not(inspect.isroutine(a)))
+        attribs = [a for a in attribs if not(a[0].startswith('__') and a[0].endswith('__'))]
+        return dict(attribs)
+
+    def from_dict(self, d):
+        for key in list(d.keys()):
+            setattr(self, key, d[key])
+
+    def ra_dec_with_pm(self, tdb):
+        """Return the star's RA and DEC adjusted for proper motion.
+
+        If no proper motion is available, the original RA and DEC are returned.
+
+        Input:
+            tdb        time since the J2000 epoch in seconds
+        """
+
+        if self.pm_ra is None or self.pm_dec is None:
+            return (self.ra, self.dec)
+
+        return (self.ra + tdb*self.pm_ra, self.dec + tdb*self.pm_dec)
+
+
+class StarCatalog(object):
+    def __init__(self):
+        pass
+
+    def count_stars(self, **kwargs):
+        """Count the stars that match the given search criteria."""
+        count = 0
+        for result in self.find_stars(full_result=False, **kwargs):
+            count += 1
+        return count
+
+    def find_stars(self, **kwargs):
+        """Find the stars that match the given search criteria.
+
+        Optional arguments:      DEFAULT
+            ra_min, ra_max       0, 2PI    RA range in radians
+            dec_min, dec_max     -PI, PI   DEC range in radians
+            vmag_min, vmag_max     ALL     Magnitude range
+        """
+
+        kwargs = kwargs.copy() # Private copy so pop doesn't mutate
+        ra_min = np.clip(kwargs.pop('ra_min', 0), 0., TWOPI)
+        ra_max = np.clip(kwargs.pop('ra_max', TWOPI), 0., TWOPI)
+        dec_min = np.clip(kwargs.pop('dec_min', -HALFPI), -HALFPI, HALFPI)
+        dec_max = np.clip(kwargs.pop('dec_max', HALFPI), -HALFPI, HALFPI)
+
+        if ra_min > ra_max:
+            if dec_min > dec_max:
+                # Split into four searches
+                for star in self._find_stars(0., ra_max, -HALFPI, dec_max,
+                                             **kwargs):
+                    yield star
+                for star in self._find_stars(ra_min, TWOPI, -HALFPI, dec_max,
+                                             **kwargs):
+                    yield star
+                for star in self._find_stars(0., ra_max, dec_min, HALFPI,
+                                             **kwargs):
+                    yield star
+                for star in self._find_stars(ra_min, TWOPI, dec_min, HALFPI,
+                                             **kwargs):
+                    yield star
+            else:
+                # Split into two searches - RA
+                for star in self._find_stars(0., ra_max, dec_min, dec_max,
+                                             **kwargs):
+                    yield star
+                for star in self._find_stars(ra_min, TWOPI, dec_min, dec_max,
+                                             **kwargs):
+                    yield star
+        else:
+            if dec_min > dec_max:
+                # Split into two searches - DEC
+                for star in self._find_stars(ra_min, ra_max, -HALFPI, dec_max,
+                                             **kwargs):
+                    yield star
+                for star in self._find_stars(ra_min, ra_max, dec_min, HALFPI,
+                                             **kwargs):
+                    yield star
+            else:
+                # No need to split at all
+                for star in self._find_stars(ra_min, ra_max,
+                                             dec_min, dec_max, **kwargs):
+                    yield star
+
+    def _find_stars(self, **kwargs):
+        assert False
+
+    @staticmethod
+    def sclass_from_bv(b, v):
+        """Return a star's spectral class given photometric B and V."""
+        bmv = b-v
+
+        best_temp = None
+        best_sclass = None
+        best_resid = 1e38
+
+        min_bmv = 1e38
+        max_bmv = -1e38
+        for sclass, sbmv in SCLASS_TO_B_MINUS_V.items():
+            min_bmv = min(min_bmv, sbmv)
+            max_bmv = max(max_bmv, sbmv)
+            resid = abs(sbmv-bmv)
+            if resid < best_resid:
+                best_resid = resid
+                best_sclass = sclass
+
+        if min_bmv <= bmv <= max_bmv:
+            return best_sclass
+
+        return None
+
+    @staticmethod
+    def temperature_from_sclass(sclass):
+        """Return a star's temperature (K) given its spectral class."""
+        if sclass[-1] == '*': # This happens on some SPICE catalog stars
+            sclass = sclass[:-1]
+        sclass = sclass.strip().upper()
+        try:
+            return SCLASS_TO_SURFACE_TEMP[sclass]
+        except KeyError:
+            return None
+
+    @staticmethod
+    def bmv_from_sclass(sclass):
+        if sclass[-1] == '*': # This happens on some SPICE catalog stars
+            sclass = sclass[:-1]
+        sclass = sclass.strip().upper()
+        try:
+            return SCLASS_TO_B_MINUS_V[sclass]
+        except KeyError:
+            return None