GaiaDR3SourcesCatalog#

class astropop.catalogs.gaia.GaiaDR3SourcesCatalog(center, radius, band='all', max_g_mag=None)#

Bases: _OnlineSourcesCatalog

Sources catalog from Gaia-DR3 catalog.

This class just wraps around Gaia class.

Parameters:
center: string, tuple or `~astropy.coordinates.SkyCoord`

The center of the search field. If center is a string, can be an object name or the string containing the object coordinates. If it is a tuple, have to be (ra, dec) coordinates, in hexa or decimal degrees format.

radius: string, float, `~astropy.coordinates.Angle`

The radius to search. If None, the query will be performed as single object query mode. Else, the query will be performed as field mode. If a string value is passed, it must be readable by astropy.coordinates.Angle. If a float value is passed, it will be interpreted as a decimal degree radius.

band: string or list(string) (optional)

Filters to query photometric informations. If None, photometric informations will be disabled. If 'all' (default), all available filters will be queried. If a list, all filters in that list will be queried. By default, all filters are available.

max_g_mag: float (optional)

Maximum G-band magnitude to query. If None, no magnitude filtering will be performed. Default is None.

Raises:
ValueError:

If a band not available in the filters is passed.

Attributes Summary

available_filters

List available filters for the catalog.

center

Get the SkyCoord of the query center.

filters

Get the list of all active available filters in the query.

query_colnames

Get column names from query

query_table

The query table.

radius

Get the Angle of the earch angle limit.

Methods Summary

copy()

Copy the current catalog to a new instance.

dec()

Get the sources declination in degrees.

get_coordinates([obstime])

Get the skycoord positions from the catalog.

in_galaxy_candidates()

Return if the source is in galaxy candidates table.

mag_list(band)

Get the sources photometric mag in [(mag, mag_error)] format.

magnitude(band)

Get the sources magnitude in QFloat format.

match_objects(ra, dec, limit_angle[, obstime])

Find catalog objects matching the given coordinates.

non_single_star()

Return if each source is the non single star table.

parallax()

Return the parallax for the sources.

phot_variable_flag()

Return the photometric variable flag for the sources.

ra()

Get the sources right ascension in degrees.

ra_dec_list()

Get the sources coordinates in [(ra, dec)] format.

radial_velocity()

Return the radial velocity for the sources.

skycoord()

Get the sources coordinates in SkyCoord format.

sources_id()

Get the list of sources id in catalog.

table()

This catalog in a Table instance.

Attributes Documentation

available_filters#

List available filters for the catalog.

center#

Get the SkyCoord of the query center.

filters#

Get the list of all active available filters in the query.

query_colnames#

Get column names from query

query_table#

The query table.

radius#

Get the Angle of the earch angle limit.

Methods Documentation

copy()#

Copy the current catalog to a new instance.

dec()#

Get the sources declination in degrees.

get_coordinates(obstime=None)#

Get the skycoord positions from the catalog.

in_galaxy_candidates()#

Return if the source is in galaxy candidates table.

mag_list(band)#

Get the sources photometric mag in [(mag, mag_error)] format.

Parameters:
bandstr

The band name.

Returns:
mag_listlist

List of tuples of (mag, mag_error).

magnitude(band)#

Get the sources magnitude in QFloat format.

Parameters:
bandstr

The band name.

Returns:
magfloat

The sources magnitude in QFloat format.

match_objects(ra, dec, limit_angle, obstime=None)#

Find catalog objects matching the given coordinates.

The matching is performed by getting the nearest catalog object from the ra, dec coordinate within the limit angle. No additional matching criteria is used.

Parameters:
ra, dec: float or array-like

RA and Dec coordinates of the objects to be matched to this catalog. All coordinates in decimal degree format.

limit_angle: string, float, `~astropy.coordinates.Angle`

Angle limit for matching indexes. If string, if must be Angle compatible. If float, it will be interpreted as a decimal degree.

obstime: `~astropy.time.Time` (optional)

Observation time. If passed, it will be used to apply the proper motion to the coordinates, if available. Default: None

non_single_star()#

Return if each source is the non single star table.

parallax()#

Return the parallax for the sources.

phot_variable_flag()#

Return the photometric variable flag for the sources.

ra()#

Get the sources right ascension in degrees.

ra_dec_list()#

Get the sources coordinates in [(ra, dec)] format.

radial_velocity()#

Return the radial velocity for the sources.

skycoord()#

Get the sources coordinates in SkyCoord format.

sources_id()#

Get the list of sources id in catalog.

table()#

This catalog in a Table instance.