rms-starcat 0.0.1__py3-none-any.whl

starcat/ybsc.py

@@ -0,0 +1,510 @@
+################################################################################
+# starcat/ybsc.py
+################################################################################
+
+# The Bright Star Catalogue,  5th Revised Ed. (Preliminary Version)
+#      Hoffleit D., Warren Jr W.H.
+#     <Astronomical Data Center, NSSDC/ADC (1991)>
+#     =1964BS....C......0H
+# From ftp://cdsarc.u-strasbg.fr/cats/V/50/1
+
+from __future__ import print_function
+
+try:
+    from starcatalog import *
+except:
+    from .starcatalog import *
+import numpy as np
+import os.path
+import struct
+
+YBSC_IR_NASA = 0
+YBSC_IR_ENGLES = 1
+YBSC_IR_UNCERTAIN = 2
+
+YBSC_MULTIPLE_NONE = ' '
+YBSC_MULTIPLE_ASTROMETRIC = 'A'
+YBSC_MULTIPLE_DUPLICITY_OCCULTATION = 'D'
+YBSC_MULTIPLE_INNES = 'I'
+YBSC_MULTIPLE_ROSSITER = 'R'
+YBSC_MULTIPLE_DUPLICITY_SPECKLE = 'S'
+YBSC_MULTIPLE_WORLEY = 'W'
+
+YBSC_VMAG_UNCERTAINTY_V = ' '
+YBSC_VMAG_UNCERTAINTY_HR_REDUCED = 'R'
+YBSC_VMAG_UNCERTAINTY_HR = 'H'
+
+# WE SHOULD ADD MORE DEFINITIONS HERE
+
+
+class YBSCStar(Star):
+    """A holder for star attributes.
+
+    This class includes attributes unique to the YBSC catalog."""
+
+    def __init__(self):
+        # Initialize the standard fields
+        Star.__init__(self)
+
+        # Initialize the YBSC-specific fields
+        self.name = None
+        self.durchmusterung_id = None
+        self.draper_number = None
+        self.sao_number = None
+        self.fk5_number = None
+        self.ir_source = None
+        self.ir_source_ref = None
+        self.double_star_code = None
+        self.aitken_designation = None
+        self.ads_components = None
+        self.variable_star_id = None
+        self.galactic_longitude = None
+        self.galactic_latitude = None
+        self.vmag_code = None
+        self.vmag_uncertainty_flag = None
+        self.b_v = None
+        self.u_b = None
+        self.r_i = None
+        self.spectral_class = None
+        self.spectral_class_code = None
+        self.parallax_type = None
+        self.parallax = None
+        self.radial_velocity = None
+        self.radial_velocity_comments = None
+        self.rotational_velocity_limit = None
+        self.rotational_velocity = None
+        self.rotational_velocity_uncertainty_flag = None
+        self.double_mag_diff = None
+        self.double_mag_sep = None
+        self.double_mag_components = None
+        self.multiple_num_components = None
+        self.temperature = None
+
+    def __str__(self):
+        ret = Star.__str__(self)
+
+        ret += 'Name "' + str(self.name) + '"'
+        ret += ' | Durch "' + str(self.durchmusterung_id) + '"'
+        ret += ' | Draper ' + str(self.draper_number)
+        ret += ' | SAO ' + str(self.sao_number)
+        ret += ' | FK5 ' + str(self.fk5_number)
+        ret += '\n'
+
+        ret += 'IR ' + str(self.ir_source) + ' Ref ' + str(self.ir_source_ref)
+        ret += ' | Double "' + str(self.double_star_code) + '"'
+        ret += ' | Aitken ' + str(self.aitken_designation) + ' '
+        ret += str(self.ads_components)
+        ret += ' | Variable ' + str(self.variable_star_id)
+        ret += '\n'
+
+        if self.temperature is None:
+            ret += 'TEMP None'
+        else:
+            ret += 'TEMP %5d' % (self.temperature)
+        ret += ' | SCLASS %2s' % (self.spectral_class)
+        ret += ' ' + str(self.spectral_class_code)
+
+        ret += ' | Galactic LON '
+        if self.galactic_longitude is None:
+            ret += 'None'
+        else:
+            ret += str(self.galactic_longitude*DPR)
+        ret += ' LAT '
+        if self.galactic_latitude is None:
+            ret += 'None'
+        else:
+            ret += str(self.galactic_latitude*DPR)
+        ret += '\n'
+
+        ret += 'B-V ' + str(self.b_v)
+        ret += ' | U-B ' + str(self.u_b)
+        ret += ' | R-I ' + str(self.r_i)
+        ret += '\n'
+
+        ret += 'Parallax "' + str(self.parallax_type) + '"'
+        ret += ' ' + str(self.parallax)
+        ret += ' | RadVel ' + str(self.radial_velocity)
+        ret += ' ' + str(self.radial_velocity_comments)
+        ret += ' ' + str(self.rotational_velocity_limit)
+        ret += ' | RotVel ' +str(self.rotational_velocity)
+        ret += ' ' + str(self.rotational_velocity_uncertainty_flag)
+        ret += '\n'
+
+        ret += 'Double mag diff ' + str(self.double_mag_diff)
+        ret += ' Sep ' + str(self.double_mag_sep)
+        ret += ' Components ' + str(self.double_mag_components)
+        ret += ' Num components ' + str(self.multiple_num_components)
+        ret += '\n'
+
+        return ret
+
+#        TODO
+#        star.cat_match = None
+#        star.num_img_total = None
+#        star.num_img_used = None
+#        star.num_cat_pm = None
+#        star.ra_mean_epoch = None
+#        star.dec_mean_epoch = None
+#        star.id_str = None
+#        star.id_str_ucac2 = None
+
+
+# --------------------------------------------------------------------------------
+#    Bytes Format  Units   Label    Explanations
+# --------------------------------------------------------------------------------
+#    1-  4  I4     ---     HR       [1/9110]+ Harvard Revised Number
+#                                     = Bright Star Number
+#    5- 14  A10    ---     Name     Name, generally Bayer and/or Flamsteed name
+#   15- 25  A11    ---     DM       Durchmusterung Identification (zone in
+#                                     bytes 17-19)
+#   26- 31  I6     ---     HD       [1/225300]? Henry Draper Catalog Number
+#   32- 37  I6     ---     SAO      [1/258997]? SAO Catalog Number
+#   38- 41  I4     ---     FK5      ? FK5 star Number
+#       42  A1     ---     IRflag   [I] I if infrared source
+#       43  A1     ---   r_IRflag  *[ ':] Coded reference for infrared source
+#       44  A1     ---    Multiple *[AWDIRS] Double or multiple-star code
+#   45- 49  A5     ---     ADS      Aitken's Double Star Catalog (ADS) designation
+#   50- 51  A2     ---     ADScomp  ADS number components
+#   52- 60  A9     ---     VarID    Variable star identification
+#   61- 62  I2     h       RAh1900  ?Hours RA, equinox B1900, epoch 1900.0 (1)
+#   63- 64  I2     min     RAm1900  ?Minutes RA, equinox B1900, epoch 1900.0 (1)
+#   65- 68  F4.1   s       RAs1900  ?Seconds RA, equinox B1900, epoch 1900.0 (1)
+#       69  A1     ---     DE-1900  ?Sign Dec, equinox B1900, epoch 1900.0 (1)
+#   70- 71  I2     deg     DEd1900  ?Degrees Dec, equinox B1900, epoch 1900.0 (1)
+#   72- 73  I2     arcmin  DEm1900  ?Minutes Dec, equinox B1900, epoch 1900.0 (1)
+#   74- 75  I2     arcsec  DEs1900  ?Seconds Dec, equinox B1900, epoch 1900.0 (1)
+#   76- 77  I2     h       RAh      ?Hours RA, equinox J2000, epoch 2000.0 (1)
+#   78- 79  I2     min     RAm      ?Minutes RA, equinox J2000, epoch 2000.0 (1)
+#   80- 83  F4.1   s       RAs      ?Seconds RA, equinox J2000, epoch 2000.0 (1)
+#       84  A1     ---     DE-      ?Sign Dec, equinox J2000, epoch 2000.0 (1)
+#   85- 86  I2     deg     DEd      ?Degrees Dec, equinox J2000, epoch 2000.0 (1)
+#   87- 88  I2     arcmin  DEm      ?Minutes Dec, equinox J2000, epoch 2000.0 (1)
+#   89- 90  I2     arcsec  DEs      ?Seconds Dec, equinox J2000, epoch 2000.0 (1)
+#   91- 96  F6.2   deg     GLON     ?Galactic longitude (1)
+#   97-102  F6.2   deg     GLAT     ?Galactic latitude (1)
+#  103-107  F5.2   mag     Vmag     ?Visual magnitude (1)
+#      108  A1     ---   n_Vmag    *[ HR] Visual magnitude code
+#      109  A1     ---   u_Vmag     [ :?] Uncertainty flag on V
+#  110-114  F5.2   mag     B-V      ? B-V color in the UBV system
+#      115  A1     ---   u_B-V      [ :?] Uncertainty flag on B-V
+#  116-120  F5.2   mag     U-B      ? U-B color in the UBV system
+#      121  A1     ---   u_U-B      [ :?] Uncertainty flag on U-B
+#  122-126  F5.2   mag     R-I      ? R-I   in system specified by n_R-I
+#      127  A1     ---   n_R-I      [CE:?D] Code for R-I system (Cousin, Eggen)
+#  128-147  A20    ---     SpType   Spectral type
+#      148  A1     ---   n_SpType   [evt] Spectral type code
+#  149-154  F6.3 arcsec/yr pmRA    *?Annual proper motion in RA J2000, FK5 system
+#  155-160  F6.3 arcsec/yr pmDE     ?Annual proper motion in Dec J2000, FK5 system
+#      161  A1     ---   n_Parallax [D] D indicates a dynamical parallax,
+#                                     otherwise a trigonometric parallax
+#  162-166  F5.3   arcsec  Parallax ? Trigonometric parallax (unless n_Parallax)
+#  167-170  I4     km/s    RadVel   ? Heliocentric Radial Velocity
+#  171-174  A4     ---   n_RadVel  *[V?SB123O ] Radial velocity comments
+#  175-176  A2     ---   l_RotVel   [<=> ] Rotational velocity limit characters
+#  177-179  I3     km/s    RotVel   ? Rotational velocity, v sin i
+#      180  A1     ---   u_RotVel   [ :v] uncertainty and variability flag on
+#                                     RotVel
+#  181-184  F4.1   mag     Dmag     ? Magnitude difference of double,
+#                                     or brightest multiple
+#  185-190  F6.1   arcsec  Sep      ? Separation of components in Dmag
+#                                     if occultation binary.
+#  191-194  A4     ---     MultID   Identifications of components in Dmag
+#  195-196  I2     ---     MultCnt  ? Number of components assigned to a multiple
+#      197  A1     ---     NoteFlag [*] a star indicates that there is a note
+#                                     (see file notes)
+# --------------------------------------------------------------------------------
+# Note (1): These fields are all blanks for stars removed from
+#     the Bright Star Catalogue (see notes).
+# Note on r_IRflag:
+#   Blank if from NASA merged Infrared Catalogue, Schmitz et al., 1978;
+#       ' if from Engles et al. 1982
+#       : if uncertain identification
+# Note on Multiple:
+#       A = Astrometric binary
+#       D = Duplicity discovered by occultation;
+#       I = Innes, Southern Double Star Catalogue (1927)
+#       R = Rossiter, Michigan Publ. 9, 1955
+#       S = Duplicity discovered by speckle interferometry.
+#       W = Worley (1978) update of the IDS;
+# Note on n_Vmag:
+#   blank = V on UBV Johnson system;
+#       R = HR magnitudes reduced to the UBV system;
+#       H = original HR magnitude.
+# Note on pmRA:
+#      As usually assumed, the proper motion in RA is the projected
+#      motion (cos(DE).d(RA)/dt), i.e. the total proper motion is
+#      sqrt(pmRA^2^+pmDE^2^)
+# Note on n_RadVel:
+#      V  = variable radial velocity;
+#      V? = suspected variable radial velocity;
+#      SB, SB1, SB2, SB3 = spectroscopic binaries,
+#                          single, double or triple lined spectra;
+#       O = orbital data available.
+# --------------------------------------------------------------------------------
+
+class YBSCStarCatalog(StarCatalog):
+    def __init__(self, dir=None):
+        if dir is None:
+            self.dirname = os.environ["YBSC_DIR"]
+        else:
+            self.dirname = dir
+
+        self.stars = []
+
+        fp = open(os.path.join(self.dirname, 'catalog'), 'r')
+        while True:
+            record = fp.readline().rstrip()
+            if record == '':
+                break
+            if record[102:107].strip() == '': # No VMAG
+                continue
+            star = self._record_to_star(record)
+            self.stars.append(star)
+        fp.close()
+
+
+    def _find_stars(self, ra_min, ra_max, dec_min, dec_max, **kwargs):
+        """Yield the results for all stars.
+
+        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
+            allow_double         False     Allow double stars
+        """
+
+        vmag_min = kwargs.get('vmag_min', None)
+        vmag_max = kwargs.get('vmag_max', None)
+        allow_double = kwargs.get('allow_double', False)
+
+        for star in self.stars:
+            if not ra_min <= star.ra <= ra_max:
+                continue
+            if not dec_min <= star.dec <= dec_max:
+                continue
+            if vmag_min and star.vmag < vmag_min:
+                continue
+            if vmag_max and star.vmag > vmag_max:
+                continue
+            if not allow_double and star.double_star_code != ' ':
+                continue
+
+            yield star
+
+    @staticmethod
+    def _record_to_star(record):
+        star = YBSCStar()
+
+            ###################
+            # CATALOG NUMBERS #
+            ###################
+
+#    1-  4  I4     ---     HR       [1/9110]+ Harvard Revised Number
+#                                     = Bright Star Number
+#    5- 14  A10    ---     Name     Name, generally Bayer and/or Flamsteed name
+#   15- 25  A11    ---     DM       Durchmusterung Identification (zone in
+#                                     bytes 17-19)
+#   26- 31  I6     ---     HD       [1/225300]? Henry Draper Catalog Number
+#   32- 37  I6     ---     SAO      [1/258997]? SAO Catalog Number
+#   38- 41  I4     ---     FK5      ? FK5 star Number
+
+        star.unique_number = int(record[0:4].strip())
+        star.name = record[4:14].strip()
+        star.durchmusterung_id = record[14:25].strip()
+        if record[25:31].strip() != '':
+            star.draper_number = int(record[25:31].strip())
+        if record[31:37].strip() != '':
+            star.sao_number = int(record[31:37].strip())
+        if record[37:41].strip() != '':
+            star.fk5_number = int(record[37:41].strip())
+
+        ################
+        # SOURCE FLAGS #
+        ################
+
+#       42  A1     ---     IRflag   [I] I if infrared source
+#       43  A1     ---   r_IRflag  *[ ':] Coded reference for infrared source
+#       44  A1     ---    Multiple *[AWDIRS] Double or multiple-star code
+#   45- 49  A5     ---     ADS      Aitken's Double Star Catalog (ADS) designation
+#   50- 51  A2     ---     ADScomp  ADS number components
+#   52- 60  A9     ---     VarID    Variable star identification
+
+        star.ir_source = (record[41] == 'I')
+        if record[42] == ' ':
+            star.ir_source_ref = YBSC_IR_NASA
+        elif record[42] == '\'':
+            star.ir_source_ref = YBSC_IR_ENGLES
+        elif record[42] == ':':
+            star.ir_source_ref = YBSC_IR_UNCERTAIN
+
+        star.double_star_code = record[43]
+        if record[44:49].strip() != '':
+            star.aitken_designation = record[44:49]
+        if record[49:51].strip() != '':
+            star.ads_components = record[49:51].strip()
+        if record[51:60].strip() != '':
+            star.variable_star_id = record[51:60].strip()
+
+        ###########
+        # RA, DEC #
+        ###########
+
+#   76- 77  I2     h       RAh      ?Hours RA, equinox J2000, epoch 2000.0 (1)
+#   78- 79  I2     min     RAm      ?Minutes RA, equinox J2000, epoch 2000.0 (1)
+#   80- 83  F4.1   s       RAs      ?Seconds RA, equinox J2000, epoch 2000.0 (1)
+#       84  A1     ---     DE-      ?Sign Dec, equinox J2000, epoch 2000.0 (1)
+#   85- 86  I2     deg     DEd      ?Degrees Dec, equinox J2000, epoch 2000.0 (1)
+#   87- 88  I2     arcmin  DEm      ?Minutes Dec, equinox J2000, epoch 2000.0 (1)
+#   89- 90  I2     arcsec  DEs      ?Seconds Dec, equinox J2000, epoch 2000.0 (1)
+
+        ra_hr = float(record[75:77])
+        ra_min = float(record[77:79])
+        ra_sec = float(record[79:83])
+        dec_deg = float(record[83:86])
+        dec_min = float(record[86:88])
+        dec_sec = float(record[88:90])
+
+        sign = 1
+        if dec_deg < 0:
+            dec_deg = -dec_deg
+            sign = -1
+
+        star.ra = (ra_hr/24. + ra_min/24./60 + ra_sec/24./60/60)*360 * RPD
+        star.dec = sign*(dec_deg + dec_min/60. + dec_sec/3600.) * RPD
+
+        ########################
+        # GALACTIC COORDINATES #
+        ########################
+
+#   91- 96  F6.2   deg     GLON     ?Galactic longitude (1)
+#   97-102  F6.2   deg     GLAT     ?Galactic latitude (1)
+
+        star.galactic_longitude = float(record[90:96]) * RPD
+        star.galactic_latitude = float(record[96:102]) * RPD
+
+        ##############
+        # MAGNITUDES #
+        ##############
+
+#  103-107  F5.2   mag     Vmag     ?Visual magnitude (1)
+#      108  A1     ---   n_Vmag    *[ HR] Visual magnitude code
+#      109  A1     ---   u_Vmag     [ :?] Uncertainty flag on V
+#  110-114  F5.2   mag     B-V      ? B-V color in the UBV system
+#      115  A1     ---   u_B-V      [ :?] Uncertainty flag on B-V
+#  116-120  F5.2   mag     U-B      ? U-B color in the UBV system
+#      121  A1     ---   u_U-B      [ :?] Uncertainty flag on U-B
+#  122-126  F5.2   mag     R-I      ? R-I   in system specified by n_R-I
+#      127  A1     ---   n_R-I      [CE:?D] Code for R-I system (Cousin, Eggen)
+
+        star.vmag = float(record[102:107])
+        star.vmag_code = record[107]
+        star.vmag_uncertainty_flag = record[108]
+        if record[109:114].strip() != '':
+            star.b_v = float(record[109:114])
+        if record[115:120].strip() != '':
+            star.u_b = float(record[115:120])
+        if record[121:126].strip() != '':
+            star.r_i = float(record[121:126])
+
+        ##################
+        # SPECTRAL CLASS #
+        ##################
+
+#  128-147  A20    ---     SpType   Spectral type
+#      148  A1     ---   n_SpType   [evt] Spectral type code
+
+        star.spectral_class = record[127:147].strip()
+        star.spectral_class_code = record[147]
+
+        #######################
+        # MOTION AND PARALLAX #
+        #######################
+
+#  149-154  F6.3 arcsec/yr pmRA    *?Annual proper motion in RA J2000, FK5 system
+#  155-160  F6.3 arcsec/yr pmDE     ?Annual proper motion in Dec J2000, FK5 system
+#      161  A1     ---   n_Parallax [D] D indicates a dynamical parallax,
+#                                     otherwise a trigonometric parallax
+#  162-166  F5.3   arcsec  Parallax ? Trigonometric parallax (unless n_Parallax)
+#  167-170  I4     km/s    RadVel   ? Heliocentric Radial Velocity
+#  171-174  A4     ---   n_RadVel  *[V?SB123O ] Radial velocity comments
+#  175-176  A2     ---   l_RotVel   [<=> ] Rotational velocity limit characters
+#  177-179  I3     km/s    RotVel   ? Rotational velocity, v sin i
+#      180  A1     ---   u_RotVel   [ :v] uncertainty and variability flag on
+#                                     RotVel
+
+        star.pm_rac = float(record[148:154]) * AS_TO_RAD * YEAR_TO_SEC
+        star.pm_ra = star.pm_rac / np.cos(star.dec)
+        star.pm_dec = float(record[154:160]) * AS_TO_RAD * YEAR_TO_SEC
+
+        star.parallax_type = record[160:161]
+        if record[161:166].strip() != '':
+            star.parallax = float(record[161:166]) * AS_TO_RAD
+        if record[166:170].strip() != '':
+            star.radial_velocity = float(record[166:170])
+        star.radial_velocity_comments = record[170:174].strip()
+        star.rotational_velocity_limit = record[174:176]
+        if record[176:179].strip() != '':
+            star.rotational_velocity = float(record[176:179])
+        star.rotational_velocity_uncertainty_flag = record[179:180]
+
+#  181-184  F4.1   mag     Dmag     ? Magnitude difference of double,
+#                                     or brightest multiple
+#  185-190  F6.1   arcsec  Sep      ? Separation of components in Dmag
+#                                     if occultation binary.
+#  191-194  A4     ---     MultID   Identifications of components in Dmag
+#  195-196  I2     ---     MultCnt  ? Number of components assigned to a multiple
+#      197  A1     ---     NoteFlag [*] a star indicates that there is a note
+#                                     (see file notes)
+
+        if record[180:184].strip() != '':
+            star.double_mag_diff = float(record[180:184])
+        if record[184:190].strip() != '':
+            star.double_mag_sep = float(record[184:190]) * AS_TO_RAD
+        star.double_mag_components = record[190:194]
+        if record[194:196].strip() != '':
+            star.multiple_num_components = int(record[194:196])
+
+            ##################################################
+            # COMPUTE SPECTRAL CLASS AND SURFACE TEMPERATURE #
+            ##################################################
+
+        sclass = star.spectral_class
+        if sclass[0] == 'g':
+            sclass = sclass[1:]
+        sclass = sclass[0:2]
+        star.temperature = StarCatalog.temperature_from_sclass(sclass)
+
+        return star
+
+
+#===============================================================================
+# UNIT TESTS
+#===============================================================================
+
+import unittest
+
+class Test_YBSCStarCatalog(unittest.TestCase):
+
+    def runTest(self):
+        cat = YBSCStarCatalog('/seti/external/YBSC')
+
+        self.assertEqual(len(cat.stars), 9096)
+        self.assertEqual(cat.count_stars(), 7519)
+        self.assertEqual(cat.count_stars(allow_double=True), 9096)
+
+        # Look up Vega
+        ra_vega = 279.2333 * RPD
+        dec_vega = 38.7836 * RPD
+
+        vega_list = list(cat.find_stars(ra_min=ra_vega-0.1*RPD,
+                                        ra_max=ra_vega+0.1*RPD,
+                                        dec_min=dec_vega-0.1*RPD,
+                                        dec_max=dec_vega+0.1*RPD))
+        self.assertEqual(len(vega_list), 1)
+
+        vega = vega_list[0]
+        self.assertEqual(vega.vmag, 0.03)
+
+
+if __name__ == '__main__':
+    unittest.main(verbosity=2)