PCL
pcl::GaiaSearchData Struct Reference

Data items and parameters for Gaia catalog search operations. More...

#include <GaiaDatabaseFile.h>

+ Inheritance diagram for pcl::GaiaSearchData:

Public Attributes

pcl_bool normalizeSpectrum = false
 
pcl_bool photonFluxUnits = false
 
- Public Attributes inherited from pcl::XPSD::SearchData< GaiaStarData >
Array< GaiaStarDatastars
 The list of stars found by the search operation (output data).
 
- Public Attributes inherited from pcl::XPSD::SearchDataBase
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).
 

Additional Inherited Members

- Public Member Functions inherited from pcl::XPSD::SearchData< GaiaStarData >
void ResetSearchResults ()
 

Detailed Description

Definition at line 223 of file GaiaDatabaseFile.h.

Member Data Documentation

◆ normalizeSpectrum

pcl_bool pcl::GaiaSearchData::normalizeSpectrum = false

When enabled, search operations provide sampled spectrum data normalized to the [0,1] range for each star. When normalization is disabled, spectrum data is provided in either the original power units of spectral irradiance (W*m^-2*nm^-1), or in spectral photon flux units (ph*s^-1*m^-2*nm^-1) if photonFluxUnits=true. Spectrum normalization is disabled by default.

Definition at line 225 of file GaiaDatabaseFile.h.

◆ photonFluxUnits

pcl_bool pcl::GaiaSearchData::photonFluxUnits = false

When true, sampled spectrum data will be transformed to spectral photon flux units (ph*s^-1*m^-2*nm^-1) and then optionally normalized to [0,1] if normalizeSpectrum=true. Photon flux units are disabled by default.

Definition at line 234 of file GaiaDatabaseFile.h.


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