PCL
pcl::XPSD::SearchDataBase Struct Reference

Parameters and output instrumentation data for catalog search operations. More...

#include <StarDatabaseFile.h>

+ Inheritance diagram for pcl::XPSD::SearchDataBase:

Public Attributes

double centerDec = 0
 Field center declination coordinate in degrees (search parameter).
 
double centerRA = 0
 Field center right ascension coordinate in degrees (search parameter).
 
uint32 countIO = 0u
 Total number of I/O operations performed (output data).
 
uint32 excessCount = 0u
 
uint32 exclusionFlags = 0u
 
uint32 inclusionFlags = 0u
 
float magnitudeHigh = 26
 
float magnitudeLow = -1.5
 
double radius = 1
 Field radius in degrees (search parameter).
 
uint32 rejectCount = 0u
 
uint32 requiredFlags = 0u
 
uint32 sourceLimit = uint32_max
 
double timeDecode = 0
 Time consumed by data decoding in seconds (output data).
 
double timeIO = 0
 Time consumed by I/O operations in seconds (output data).
 
double timeTotal = 0
 Total search time in seconds (output data).
 
double timeUncompress = 0
 Time consumed by data uncompression in seconds (output data).
 

Detailed Description

Definition at line 153 of file StarDatabaseFile.h.

Member Data Documentation

◆ excessCount

uint32 pcl::XPSD::SearchDataBase::excessCount = 0u

When sourceLimit is exceeded, this is the number of additional objects found but not included in the stars list (output data).

Definition at line 170 of file StarDatabaseFile.h.

◆ exclusionFlags

uint32 pcl::XPSD::SearchDataBase::exclusionFlags = 0u

Exclusion flags (search parameter). Stars with any of these flags set will not be included in the stars list.

Definition at line 168 of file StarDatabaseFile.h.

◆ inclusionFlags

uint32 pcl::XPSD::SearchDataBase::inclusionFlags = 0u

Inclusion flags (search parameter). If non-zero, only stars with any of these flags set will be included in the stars list.

Definition at line 166 of file StarDatabaseFile.h.

◆ magnitudeHigh

float pcl::XPSD::SearchDataBase::magnitudeHigh = 26

High magnitude (search parameter). Only stars of magnitude less than or equal to this value will be included in the stars list.

Definition at line 160 of file StarDatabaseFile.h.

◆ magnitudeLow

float pcl::XPSD::SearchDataBase::magnitudeLow = -1.5

Low magnitude (search parameter). Only stars of magnitude greater than or equal to this value will be included in the stars list.

Definition at line 158 of file StarDatabaseFile.h.

◆ rejectCount

uint32 pcl::XPSD::SearchDataBase::rejectCount = 0u

Total number of rejected objects (output data). This refers to point sources that have been tested for inclusion in the search result, but have not matched the search criteria.

Definition at line 172 of file StarDatabaseFile.h.

◆ requiredFlags

uint32 pcl::XPSD::SearchDataBase::requiredFlags = 0u

Required flags (search parameter). If non-zero, only stars with all of these flags set will be included in the stars list.

Definition at line 164 of file StarDatabaseFile.h.

◆ sourceLimit

uint32 pcl::XPSD::SearchDataBase::sourceLimit = uint32_max

The search will not include more objects than this limit in the stars list (search parameter).

Definition at line 162 of file StarDatabaseFile.h.


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