ucac

This module defines the interface to the UCAC4 star catalogue.

Catalogue Description

The UCAC4 is a catalogue of 113 million stars with 105 million including proper motion solutions. It is complete to about a magnitude of 16. It is generally very accurate for positions, but less so for magnitudes.

The UCAC 4 uses a file based database system that is fast for small queries, but can be slow for queries over a large area. It also does not include blended stars (stars that are close enough that they appear as a single star in an image). If you need faster retrieval and/or blended stars then you should use the giant_catalogue instead, which is built primarily using the UCAC4 catalogue.

Use

The UCAC4 catalogue can be used anywhere that a star catalogue is required in GIANT. It is stored in a number of index and binary data files on disk and takes about 9 GB of space. If you attempt to initialize the class and point it to a directory that does not contain the UCAC4 data it will ask you if you want to download the catalogue (note that the UCAC4 data is not included by default so if you have not downloaded it yourself you will definitely need to). If you answer yes, be aware that it may take a very long time to download.

Once you have initialized the class (and downloaded the data files), then you can access the catalogue as you would any GIANT usable catalogue. Simply call query_catalogue() to get the GIANT records for the stars as a dataframe with columns according the GIANT_COLUMNS. This class also provides 2 helper methods, query_catalogue_raw() which can be used to retrieve the raw catalogue entries (instead of the GIANT entries) and cross_ref_tycho() which can be used to get the raw Tycho 2 catalogue records for a UCAC4 star (if available).

Classes

ColumnOrder	This enumeration specifies whether a column is sorted in ascending or descending order.
UCAC4	This class provides access to the UCAC4 star catalogue.

Function

binary_search	This helper function does a binary search on a sorted file with fixed width lines.
check_file	This checks the md5sum of a file to ensure it wasn't corrupted.
download_ucac	This function downloads the UCAC4 catalogue from vizier to the target directory.