Catalogue

giant.catalogues.meta_catalogue:

class giant.catalogues.meta_catalogue.Catalogue(include_proper_motion=True)

This is the abstract base class for star catalogues that GIANT can use for star identification.

This class defines the minimum required attributes and methods that GIANT expects when interfacing with a star catalogue. It is also set up to implement duck typing, so if you don’t want to you don’t need to subclass this class directly when defining a new catalogue, though it is still strongly encouraged.

To define a new Catalogue you pretty much only need to implement a query_catalogue() method with the call signature specified in the abstract method documentation. This is what GIANT will use when retrieving stars from the catalogue. Beyond that, you should probably also implement and use an instance attribute include_proper_motion (although this is not required) as a flag that the user could use to turn proper motion applying on or off on a call to query_catalogue().

If you are just trying to use a GIANT catalogue, you don’t need to worry about this class, instead see one of the concrete implementations in ucac, tycho, or giant_catalogue

Note

Because this is an ABC, you cannot create an instance of this class.

Parameters:

include_proper_motion (bool) – A flag indicating that proper motion should be applied to query results from this catalogue

Summary of Methods

query_catalogue

This method queries stars from the catalogue that meet specified constraints and returns them as a DataFrame with columns of GIANT_COLUMNS.