EXOSIMS.StarCatalog package

Submodules

EXOSIMS.StarCatalog.EXOCAT1 module

class EXOSIMS.StarCatalog.EXOCAT1.EXOCAT1(catalogpath=None, wdsfilepath=None, **specs)[source]

Bases: StarCatalog

EXOCAT Catalog class

This class populates the star catalog used in EXOSIMS from Margaret Turnbull’s EXOCAT catalog, retrieved from the NASA Exoplanet Archive as a VOTABLE. Documentation of fields available at: https://exoplanetarchive.ipac.caltech.edu/docs/API_mission_stars.html

Parameters:

  • catalogpath (str) – Full path to catalog VOTABLE. If None (default) uses default catalogfile in EXOSIMS.StarCatalog directory.

  • wdsfilepath (str) – Full path to WDS catalog

  • **specs – Input Specification

Only StarCatalog prototype attributes are used.

EXOSIMS.StarCatalog.FakeCatalog module

class EXOSIMS.StarCatalog.FakeCatalog.FakeCatalog(ntargs=1000, star_dist=5, ra0=0, dec0=0, **specs)[source]

Bases: StarCatalog

Fake Catalog class This class generates an artificial target list of stars with a logistic distribution.

Parameters:

  • ntargs (int) – Number of targets

  • star_dist (float) – Distance of the stars from observer

  • ra0 (float) – Reference right ascension

  • dec0 (float) – Reference declination

get_angularDistributions(f, d, pos=True)[source]

Get the distribution of target positions

Parameters:

  • f (array) – Distribution function evaluated

  • d (float) – Star distance

  • pos (boolean) – North or south

Returns:

array:

Right ascension values

array:

Declination values

array:

Distances of the star

Return type:

tuple

inverse_method(N, d)[source]

Obtain coordinates for the targets from the inverse of a logistic function

Parameters:

  • N (int) – Number of targets

  • d (float) – Star distance

Returns:

The coordinates for the targets

Return type:

SkyCoord module

EXOSIMS.StarCatalog.FakeCatalog_UniformAngles module

class EXOSIMS.StarCatalog.FakeCatalog_UniformAngles.FakeCatalog_UniformAngles(ntargs=20, star_dist=5, **specs)[source]

Bases: StarCatalog

Fake Catalog of stars separated uniformly by angle

Generate a fake catalog of stars that are uniformly separated.

Parameters:

  • ntargs (int) – Sqrt of number of target stars to generate. ntargs by ntargs grid in ra and dec.

  • star_dist (float) – Star distance from observer

  • specs – Additional parameters passed to StarCatalog parent class

EXOSIMS.StarCatalog.FakeCatalog_UniformSpacing_wInput module

class EXOSIMS.StarCatalog.FakeCatalog_UniformSpacing_wInput.FakeCatalog_UniformSpacing_wInput(lat_sep=0.3, lon_sep=0.3, star_dist=10, lat_extra=array([], dtype=float64), lon_extra=array([], dtype=float64), dist_extra=array([], dtype=float64), **specs)[source]

Bases: StarCatalog

Fake catalog with uniformly spaced stars along with extra additional stars

lon_sep and lat_sep should be in deg

Parameters:

  • lat_sep (float) – Ecliptic latitude separation between the uniformly spaced entries

  • lon_sep (float) – Ecliptic longitude separation between the uniformly spaced entries

  • star_dist (float) – Distance of uniformly spaces stars from observer

  • lat_extra (array) – Additional ecliptic latitude values

  • lon_extra (array) – Corresponding additional ecliptic longitude values

  • dist_extra (array) – Corresponding additional distances from the observer

  • specs – Additional arguments to be passed to parent class

EXOSIMS.StarCatalog.GaiaCat1 module

class EXOSIMS.StarCatalog.GaiaCat1.GaiaCat1(catalogfile='Glt15Dlt200DSNgt4-result.fits', **specs)[source]

Bases: StarCatalog

Gaia-derived Catalog class

This class populates the star catalog used in EXOSIMS from a dump of Gaia DR2 data.

Parameters:

  • catalogfile (string) – Name of catalog FITS Table. Defaults to Glt15Dlt200DSNgt4-result.fits Assumed to be in downloads directory.

  • **specs – Input Specification

Only StarCatalog prototype attributes are used.

EXOSIMS.StarCatalog.HIPfromSimbad module

class EXOSIMS.StarCatalog.HIPfromSimbad.HIPfromSimbad(catalogpath=None, **specs)[source]

Bases: StarCatalog

Catalog generator class that uses astroquery to get stellar properties from SIMBAD

Parameters:

  • HIP (list or string) – List of Hipparcos identifiers (HIP numbers) or path to text file.

  • **specs – Input Specification

Example file format:

`HIP 37279` `HIP 97649`

EXOSIMS.StarCatalog.HWOMissionStars module

class EXOSIMS.StarCatalog.HWOMissionStars.HWOMissionStars(forceNew=False, **specs)[source]

Bases: StarCatalog

HWO Mission Star List. Documentation available at: https://exoplanetarchive.ipac.caltech.edu/docs/2645_NASA_ExEP_Target_List_HWO_Documentation_2023.pdf # noqa: E501

Parameters:

forceNew (bool) – Run a fresh query even if results exist on disk. Defaults False.

EXOSIMS.StarCatalog.SIMBAD300Catalog module

class EXOSIMS.StarCatalog.SIMBAD300Catalog.SIMBAD300Catalog(cachedir=None, **specs)[source]

Bases: SIMBADCatalog

SIMBAD300 Catalog class

This class populates the star catalog used in EXOSIMS from the SIMBAD300 catalog.

EXOSIMS.StarCatalog.SIMBADCatalog module

class EXOSIMS.StarCatalog.SIMBADCatalog.SIMBADCatalog(ntargs=1, cachedir=None, VmagFill=0.1, **specs)[source]

Bases: StarCatalog

SIMBAD Catalog class

This class provides the functions to populate the star catalog used in EXOSIMS from the SIMBAD star catalog data.

SIMBAD_mat2pkl(matpath, pklpath)[source]

Writes pickled dictionary file from .mat file

This method takes a .mat star catalog, converts it to a Python dictionary, pickles the dictionary, and stores it in the StarCatalog directory.

Parameters:

  • matpath (string) – path to .mat file

  • pklpath (str) – pat to .pkl file to be written

Returns:

True if successful, False if not

Return type:

bool (boolean)

Stores pickled dictionary file with same name as .mat file (and extension of .pkl) containing lists of required values needed to populate the Star Catalog object in StarCatalog directory.

populatepkl(pklpath, **specs)[source]

Populates the star catalog and returns True if successful

This method populates the star catalog from a pickled dictionary file housed in the StarCatalog directory and returns True if successful.

Parameters:

  • pklpath (string) – path to the pickled dictionary file with extension .pkl

  • **specs – Input Specification

Returns:

True if successful, False if not

Return type:

bool (boolean)