PCL
Public Member Functions | List of all members
pcl::APASSDatabaseFile Class Reference
Star Catalogs and Point Source Databases

APASS catalog star database file (XPSD format). More...

#include <APASSDatabaseFile.h>

+ Inheritance diagram for pcl::APASSDatabaseFile:

Public Member Functions

 APASSDatabaseFile ()=default
 
 APASSDatabaseFile (const APASSDatabaseFile &)=delete
 
 APASSDatabaseFile (const String &filePath)
 
const IsoString & DataRelease () const
 
APASSDatabaseFile & operator= (APASSDatabaseFile &&)=default
 
APASSDatabaseFile & operator= (const APASSDatabaseFile &)=delete
 
void Search (APASSSearchData &data) const
 
- Public Member Functions inherited from pcl::StarDatabaseFile
 StarDatabaseFile ()=default
 
 StarDatabaseFile (const StarDatabaseFile &)=delete
 
 StarDatabaseFile (const String &filePath)
 
 StarDatabaseFile (StarDatabaseFile &&)=default
 
virtual ~StarDatabaseFile () noexcept(false)
 
void Close ()
 
const String & FilePath () const
 
bool IsOpen () const
 
float MagnitudeHigh () const
 
float MagnitudeLow () const
 
const XPSD::Metadata & Metadata () const
 
void Open (const String &filePath)
 
StarDatabaseFile & operator= (const StarDatabaseFile &)=delete
 
StarDatabaseFile & operator= (StarDatabaseFile &&)=default
 
const XPSD::Statistics & Statistics () const
 

Additional Inherited Members

- Static Public Member Functions inherited from pcl::StarDatabaseFile
static void Serialize (const String &filePath, const XPSD::Metadata &metadata, const XPSD::Statistics &statistics, float magnitudeLow, float magnitudeHigh, const Array< XPSD::IndexTree > &index, const ByteArray &data, const Compression *compression=nullptr, const String &parameters=String())
 

Detailed Description

This class implements an interface to XPSD files serializing encoded APASS star data. As of writing this documentation (December 2020), APASS DR9 and DR10 are supported and have been implemented.

The most important functionality of this class is performing fast indexed search operations to retrieve point source data for APASS stars matching a set of user-defined criteria. See the APASSDatabaseFile::Search() member function and the APASSSearchData structure for detailed information.

This implementation provides the following data for the complete APASS DR9 and DR10 catalogs:

  • Source positions.
  • Magnitudes on the Johnson V and B bands (Vega system) and Sloan u', g', r', i', z_s and Y magnitudes (AB system).
  • Data availability and quality flags.

References

Credits

This work makes use of data from the AAVSO Photometric All Sky Survey, whose funding has been provided by the Robert Martin Ayers Sciences Fund and from the NSF (AST-1412587).

See also
StarDatabaseFile, GaiaDatabaseFile

Definition at line 179 of file APASSDatabaseFile.h.

Constructor & Destructor Documentation

◆ APASSDatabaseFile() [1/3]

pcl::APASSDatabaseFile::APASSDatabaseFile ( )
default

Default constructor.

Constructs an invalid instance that cannot be used until initialized by calling the Open() member function.

◆ APASSDatabaseFile() [2/3]

pcl::APASSDatabaseFile::APASSDatabaseFile ( const String &  filePath)
inline

Constructs a &APASSDatabaseFile instance initialized from the specified point source database file in XPSD format. As of writing this documentation (December 2020), The APASS DR9 and DR10 catalogs are available.

In the event of errors or invalid data, this constructor will throw the appropriate Error exception.

Definition at line 200 of file APASSDatabaseFile.h.

◆ APASSDatabaseFile() [3/3]

pcl::APASSDatabaseFile::APASSDatabaseFile ( const APASSDatabaseFile &  )
delete

Deleted copy constructor. APASSDatabaseFile instances are unique, hence cannot be copied.

Member Function Documentation

◆ DataRelease()

const IsoString& pcl::APASSDatabaseFile::DataRelease ( ) const
inline

Returns the name of the APASS data release corresponding to the data available in this database file. As of writing this documentation (December 2020), this member function can return either "DR9" or "DR10".

Definition at line 281 of file APASSDatabaseFile.h.

◆ operator=() [1/2]

APASSDatabaseFile& pcl::APASSDatabaseFile::operator= ( APASSDatabaseFile &&  )
default

Move assignment operator. Returns a reference to this object.

◆ operator=() [2/2]

APASSDatabaseFile& pcl::APASSDatabaseFile::operator= ( const APASSDatabaseFile &  )
delete

Deleted copy assignment operator. APASSDatabaseFile instances are unique, hence cannot be copied.

◆ Search()

void pcl::APASSDatabaseFile::Search ( APASSSearchData &  data) const
inline

Performs a search operation for point sources matching the specified criteria.

This member function performs a fast indexed search for point sources in this database file matching the criteria defined in the specified data structure. See the APASSSearchData structure for detailed information on search parameters and output data.

Summarily, search criteria include:

  • The region of the sky where point sources will be searched for. This region is defined by the equatorial coordinates of a field center and a field radius.
  • An optional range of magnitudes.
  • An optional limit for the number of sources included in the search result.

The result of the search operation is also returned in the specified data structure, including, among others, the following items:

  • The list of point sources found.
  • Instrumentation items for performance analysis, including: total search time, time used for I/O operations, total I/O operations, time used for data decoding, and time used for data decompression.

Definition at line 268 of file APASSDatabaseFile.h.

The documentation for this class was generated from the following file: