Gaia Lightcurve¶
The following module explains all the functions available as part of GaiaCurves
- gaia_lightcurve.fetch_curves(starList, output_dir='../data/', ignore=None)¶
Fetch Gaia Lightcurves for a list of variable stars from Gaia DR2 and DR1 Sources
Returns a dictionary of Gaia IDs, saved photometric CSV paths, and sources for all the given variable star names
- Parameters
starList (list) – List of strings. Variable star names (Cepheids and RRLyrae stars) to fetch lightcurves from Gaia
[output_dir] (string) – Optional. String. By default, the csv files for the lightcurves are stored in the folder ../data/. To change the default path, enter a new path for the folder to save the lightcurve
[ignore] (string) – Optional. String. Takes values None, DR1 and DR2. By default, the lightcurves are downloaded from both DR2 and DR1. To change ignore a source, specify DR1 or DR2.
- Returns
Dictionary. Gives back the path/to/lightcurve/filename.csv as pathname, Gaia ID as id, and DR1 or DR2 as source for star names as Keys.
- gaia_lightcurve.fetch_lightcurve_dr1(gaia_id, output_dir='../data/')¶
Fetch Gaia Lightcurve for a Gaia Source ID (of a variable star) from Gaia DR1 Table (phot_variable_time_series_gfov)
Returns path of csv file stored for given source
- Parameters
gaia_id (string) – String. Gaia Source ID of the variable star you need to fetch the lightcurve from DR1 for
[output_dir] (string) – Optional. String. By default, the csv files for the lightcurves are stored in the folder ../data/. To change the default path, enter a new path for the folder to save the lightcurve
- Returns
String. Gives back the path/to/lightcurve/filename.csv where the lightcurve is stored. Returns empty string if no lightcurve is fetched.
- gaia_lightcurve.fetch_lightcurve_dr2(gaia_id, output_dir='../data/')¶
Fetch Gaia Lightcurve for a Gaia Source ID (of a variable star) from Gaia DR2 Data Link
Returns path of csv file stored for given source
- Parameters
gaia_id (string) – String. Gaia Source ID of the variable star you need to fetch the lightcurve from DR1 for
[output_dir] (string) – Optional. String. By default, the csv files for the lightcurves are stored in the subfolder data/. To change the default path, enter a new path for the folder to save the lightcurve
- Returns
String. Gives back the path/to/lightcurve/filename.csv where the lightcurve is stored. Returns empty string if no lightcurve is fetched.
- gaia_lightcurve.gaia_id(obj_name)¶
Get Gaia ID for an object
Returns Gaia id for objects available in SIMBAD
- Parameters
obj_name (string) – String. Reference name of objects available in the SIMBAD catalog that we need the Gaia ID for.
- Returns
String. Gives back the Gaia ID of the object. Returns empty string if Gaia ID could not be fetched.
- gaia_lightcurve.plot_lightcurve(csv_path, star, id)¶
Plot the Gaia light curve for a given .csv file generated by fetch_curves function.
- Parameters
csv_path (string) – String. Path to the generated .csv file.
star (string) – String. Takes the star name for visualization
id (string) – String. Takes the Gaia ID for the star for visualization
- Returns
None