Catalog

giant.catalogs.meta_catalog:

class giant.catalogs.meta_catalog.Catalog(include_proper_motion=True)

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

This class defines the minimum required attributes and methods that GIANT expects when interfacing with a star catalog. 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 catalog, though it is still strongly encouraged.

To define a new Catalog you pretty much only need to implement a query_catalog() method with the call signature specified in the abstract method documentation. This is what GIANT will use when retrieving stars from the catalog. 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_catalog().

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

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 catalog

include_proper_motion: bool

Apply proper motion to queried star locations to get the location at the requested time

Summary of Methods

query_catalog	This method queries stars from the catalog that meet specified constraints and returns them as a DataFrame with columns of GIANT_COLUMNS.
get_stars_directions_and_pixels	This function produces the visible stars in an image, including their records, their inertial unit vectors, and their pixel locations.