EXOSIMS.TargetList package

Submodules

EXOSIMS.TargetList.EclipticTargetList module

class EXOSIMS.TargetList.EclipticTargetList.EclipticTargetList(**specs)

Bases: TargetList

Target list in which star positions may be obtained in heliocentric equatorial or ecliptic coordinates.

Parameters:

**specs – user specified values

nan_filter()

Populates Target List and filters out values which are nan

revise_lists(sInds)

Replaces Target List catalog attributes with filtered values, and updates the number of target stars.

Parameters:

sInds (integer ndarray) – Integer indices of the stars of interest

starprop(sInds, currentTime, eclip=False)

Finds target star positions vector in heliocentric equatorial (default) or ecliptic frame for current time (MJD).

This method uses ICRS coordinates which is approximately the same as equatorial coordinates.

Parameters:

• sInds (integer ndarray) – Integer indices of the stars of interest

• currentTime (astropy Time) – Current absolute mission time in MJD

• eclip (boolean) – Boolean used to switch to heliocentric ecliptic frame. Defaults to False, corresponding to heliocentric equatorial frame.

Returns:

Target star positions vector in heliocentric equatorial (default) or ecliptic frame in units of pc. Will return an m x n x 3 array where m is size of currentTime, n is size of sInds. If either m or n is 1, will return n x 3 or m x 3.

Return type:

r_targ (astropy Quantity array)

Note: Use eclip=True to get ecliptic coordinates.

EXOSIMS.TargetList.GaiaCatTargetList module

class EXOSIMS.TargetList.GaiaCatTargetList.GaiaCatTargetList(**specs)

Bases: TargetList

Target list based on Gaia catalog inputs.

Parameters:

**specs – user specified values

set_catalog_attributes()

Hepler method that sets possible and required catalog attributes.

Sets attributes:

catalog_atts (list):

Attributes to try to copy from star catalog. Missing ones will be ignored and removed from this list.

required_catalog_atts(list):

Attributes that cannot be missing or nan.

stellar_mass()

Populates target list with ‘true’ and ‘approximate’ stellar masses

This method calculates stellar mass via interpolation of data from: “A Modern Mean Dwarf Stellar Color and Effective Temperature Sequence” http://www.pas.rochester.edu/~emamajek/EEM_dwarf_UBVIJHK_colors_Teff.txt Eric Mamajek (JPL/Caltech, University of Rochester)

For more details see MeanStars documentation.

Function called by reset sim

EXOSIMS.TargetList.KnownRVPlanetsTargetList module

class EXOSIMS.TargetList.KnownRVPlanetsTargetList.KnownRVPlanetsTargetList(**specs)

Bases: TargetList

Target list based on population of known RV planets from IPAC. Intended for use with the KnownRVPlanets family of modules.

Parameters:

**specs – Input Specification

filter_target_list(**specs)

Filtering is done as part of populating the table, so this method is overloaded to do nothing.

populate_target_list(**specs)

This function is responsible for populating values from the star catalog into the target list attributes and enforcing attribute requirements.

Parameters:

**specs – Input Specification

set_catalog_attributes()

Hepler method that sets possible and required catalog attributes.

Sets attributes:

catalog_atts (list):

Attributes to try to copy from star catalog. Missing ones will be ignored and removed from this list.

required_catalog_atts(list):

Attributes that cannot be missing or nan.