Class AbstractStarGroupDataProvider
- All Implemented Interfaces:
IParticleGroupDataProvider
,IStarGroupDataProvider
- Direct Known Subclasses:
BinaryDataProvider
,SerializedDataProvider
,STILDataProvider
-
Nested Class Summary
Modifier and TypeClassDescriptionclass
static enum
Represents a column type. -
Field Summary
Modifier and TypeFieldDescriptionprotected boolean
Whether to use an adaptive threshold which lets more bright stars in to avoid artifacts.protected List<AbstractStarGroupDataProvider.AdditionalCols>
protected String[]
Files or folders with optionally gzipped CSVs containing additional columns to be matched by sourceid with the main catalog.protected com.badlogic.gdx.utils.LongMap<float[]>
protected long[]
protected double
Distance cap in parsecsprotected int
Maximum number of files to load.protected Map<AbstractStarGroupDataProvider.ColId,
Integer> protected List<IParticleRecord>
protected static Logger.Log
protected boolean
Apply magnitude/color corrections for extinction/reddeningstatic double
protected double
The loader will only load stars for which the parallax error is at most the percentage given here, in [0..1].protected double
The loader will only load stars for which the parallax error is at most the percentage given here, in [0..1].protected double
The zero point for the parallaxes in mas.protected final int
Parallelism valueprotected Double
RUWE cap value.protected com.badlogic.gdx.utils.LongMap<double[]>
protected int
Maximum number of files to load per fileprotected Matrix4d
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
acceptDistance
(double distance) Checks whether to accept the distanceprotected boolean
acceptParallax
(double appmag, double pllx, double pllxerr) Checks whether the parallax is accepted or not.colIdFromStr
(String name) protected int
countLines
(com.badlogic.gdx.files.FileHandle f) protected int
Counts the lines on this input streamprotected void
dumpToDisk
(List<IParticleRecord> data, String filename, String format) protected void
dumpToDiskBin
(List<IParticleRecord> data, String filename, boolean serialized) protected void
dumpToDiskCsv
(List<IParticleRecord> data, String filename) protected Double
getAdditionalValue
(AbstractStarGroupDataProvider.ColId col, Long sourceId) com.badlogic.gdx.utils.LongMap<float[]>
long[]
Gets the star counts per magnitude.protected double
getGeoDistance
(long sourceId) Gets the distance in parsecs to the star from the additional columns map, if it exists.protected float
getRuweValue
(long sourceId, String[] tokens) protected boolean
hasAdditional
(AbstractStarGroupDataProvider.ColId col, Long sourceId) protected boolean
protected boolean
protected int
protected void
protected void
initLists
(int elems) Initialises the lists and structures given number of elementsprotected void
initLists
(com.badlogic.gdx.files.FileHandle f) Initialises the lists and structures given a file by counting the number of linesLoads the data as it is.protected boolean
mustLoad
(long id) Returns whether the star must be loaded or notvoid
setAdaptiveParallax
(boolean adaptive) Whether to use an adaptive threshold, relaxing it for bright (appmag >= 13) stars to let more bright stars in.void
setAdditionalFiles
(String additionalFiles) Set location of additional columns file or directory.void
setColumns
(String columns) List of column names, separated by commas, indicating the position of each field to load.void
setDistanceCap
(double distCap) Sets a distance cap.void
setFileNumberCap
(int cap) Sets a cap on the number of files to load.void
setMagCorrections
(boolean magCorrections) Sets the flag to apply magnitude and color corrections for extinction and reddening.void
setMustLoadIds
(Set<Long> ids) Adds a set with all the ids which will be loaded regardless of any other conditions (i.e.void
setOutputFormatVersion
(int version) Set the preferred output format version, if applicable.void
setParallaxErrorFactorBright
(double parallaxErrorFactor) The loader will only load stars for which the parallax error is at most the percentage given here, in [0..1].void
setParallaxErrorFactorFaint
(double parallaxErrorFactor) The loader will only load stars for which the parallax error is at most the percentage given here, in [0..1].void
setParallaxZeroPoint
(double parallaxZeroPoint) Sets the zero point of the parallax as an addition to the parallax values, in [mas].void
setProviderParams
(Map<String, Object> params) Set provider parameters as a map.void
setRUWECap
(double RUWE) Sets the RUWE criteria.void
setStarNumberCap
(int starNumberCap) Sets the maximum number of stars to be processed per file.void
setTransformMatrix
(Matrix4d transform) Sets a transform matrix to apply to all data points.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface gaiasky.data.api.IStarGroupDataProvider
loadData, loadData, loadDataMapped
-
Field Details
-
NEGATIVE_DIST
public static double NEGATIVE_DIST -
logger
-
parallelism
protected final int parallelismParallelism value -
params
-
indexMap
-
list
-
sphericalPositions
protected com.badlogic.gdx.utils.LongMap<double[]> sphericalPositions -
colors
protected com.badlogic.gdx.utils.LongMap<float[]> colors -
countsPerMag
protected long[] countsPerMag -
transform
-
mustLoadIds
-
additional
-
additionalFiles
Files or folders with optionally gzipped CSVs containing additional columns to be matched by sourceid with the main catalog. Column names must comport toAbstractStarGroupDataProvider.ColId
. -
ruwe
RUWE cap value. Will accept all stars with star_ruwe invalid input: '<'= ruwe -
distCap
protected double distCapDistance cap in parsecs -
parallaxErrorFactorFaint
protected double parallaxErrorFactorFaintThe loader will only load stars for which the parallax error is at most the percentage given here, in [0..1]. Faint stars (gmag >= 13.1) More specifically, the following must be met:
pllx_err < pllx * pllxErrFactor
-
parallaxErrorFactorBright
protected double parallaxErrorFactorBrightThe loader will only load stars for which the parallax error is at most the percentage given here, in [0..1]. Bright stars (gmag invalid input: '<' 13.1) More specifically, the following must be met:
pllx_err < pllx * pllxErrFactor
-
adaptiveParallax
protected boolean adaptiveParallaxWhether to use an adaptive threshold which lets more bright stars in to avoid artifacts. -
parallaxZeroPoint
protected double parallaxZeroPointThe zero point for the parallaxes in mas. Gets added to all loaded parallax values -
magCorrections
protected boolean magCorrectionsApply magnitude/color corrections for extinction/reddening -
fileNumberCap
protected int fileNumberCapMaximum number of files to load. Negative for unlimited -
starNumberCap
protected int starNumberCapMaximum number of files to load per file
-
-
Constructor Details
-
AbstractStarGroupDataProvider
public AbstractStarGroupDataProvider()
-
-
Method Details
-
colIdFromStr
-
idx
-
hasCol
-
hasAdditional
-
hasAdditionalColumn
-
getAdditionalValue
-
initLists
protected void initLists(com.badlogic.gdx.files.FileHandle f) Initialises the lists and structures given a file by counting the number of lines- Parameters:
f
- The file handle to count the lines
-
initLists
protected void initLists(int elems) Initialises the lists and structures given number of elements -
initLists
protected void initLists() -
loadData
Description copied from interface:IParticleGroupDataProvider
Loads the data as it is.- Specified by:
loadData
in interfaceIParticleGroupDataProvider
- Parameters:
file
- The file to load.- Returns:
- The array of particle records.
-
mustLoad
protected boolean mustLoad(long id) Returns whether the star must be loaded or not- Parameters:
id
- The star ID- Returns:
- Whether the star with the given ID must be loaded
-
acceptParallax
protected boolean acceptParallax(double appmag, double pllx, double pllxerr) Checks whether the parallax is accepted or not.If adaptive is not enabled:
accepted = pllx > 0 invalid input: '&'invalid input: '&' pllx_err invalid input: '<' pllx * pllx_err_factor invalid input: '&'invalid input: '&' pllx_err invalid input: '<'= 1
If adaptive is enabled:
accepted = pllx > 0 invalid input: '&'invalid input: '&' pllx_err invalid input: '<' pllx * max(0.5, pllx_err_factor) invalid input: '&'invalid input: '&' pllx_err invalid input: '<'= 1, if apparent_magnitude invalid input: '<' 13.2 accepted = pllx > 0 invalid input: '&'invalid input: '&' pllx_err invalid input: '<' pllx * pllx_err_factor invalid input: '&'invalid input: '&' pllx_err invalid input: '<'= 1, otherwise
- Parameters:
appmag
- Apparent magnitude of starpllx
- Parallax of starpllxerr
- Parallax error of star- Returns:
- True if parallax is accepted, false otherwise
-
getRuweValue
-
getGeoDistance
protected double getGeoDistance(long sourceId) Gets the distance in parsecs to the star from the additional columns map, if it exists. Otherwise, it returns a negative value.- Parameters:
sourceId
- The source id of the source- Returns:
- The geometric distance in parsecs if it exists, -1 otherwise.
-
acceptDistance
protected boolean acceptDistance(double distance) Checks whether to accept the distance- Parameters:
distance
- Distance in parsecs- Returns:
- Whether to accept the distance or not
-
countLines
- Throws:
IOException
-
setColumns
Description copied from interface:IStarGroupDataProvider
List of column names, separated by commas, indicating the position of each field to load.- Specified by:
setColumns
in interfaceIStarGroupDataProvider
- Parameters:
columns
- The column name list.
-
setMustLoadIds
Description copied from interface:IStarGroupDataProvider
Adds a set with all the ids which will be loaded regardless of any other conditions (i.e. parallax error thresholds).- Specified by:
setMustLoadIds
in interfaceIStarGroupDataProvider
- Parameters:
ids
- The ids that must be loaded.
-
countLines
Counts the lines on this input stream- Parameters:
is
- The input stream- Returns:
- The number of lines
- Throws:
IOException
-
dumpToDisk
-
dumpToDiskBin
-
dumpToDiskCsv
-
getColors
public com.badlogic.gdx.utils.LongMap<float[]> getColors()- Specified by:
getColors
in interfaceIStarGroupDataProvider
-
setParallaxErrorFactorFaint
public void setParallaxErrorFactorFaint(double parallaxErrorFactor) Description copied from interface:IStarGroupDataProvider
The loader will only load stars for which the parallax error is at most the percentage given here, in [0..1]. This applies to faint stars (gmag >= 13.1) More specifically, the following must be met:
pllx_err < pllx * pllxErrFactor
- Specified by:
setParallaxErrorFactorFaint
in interfaceIStarGroupDataProvider
- Parameters:
parallaxErrorFactor
- The percentage value of parallax errors with respect to parallax.
-
setParallaxErrorFactorBright
public void setParallaxErrorFactorBright(double parallaxErrorFactor) Description copied from interface:IStarGroupDataProvider
The loader will only load stars for which the parallax error is at most the percentage given here, in [0..1]. This applies to bright stars (gmag invalid input: '<' 13.1) More specifically, the following must be met:
pllx_err < pllx * pllxErrFactor
- Specified by:
setParallaxErrorFactorBright
in interfaceIStarGroupDataProvider
- Parameters:
parallaxErrorFactor
- The percentage value of parallax errors with respect to parallax.
-
setAdaptiveParallax
public void setAdaptiveParallax(boolean adaptive) Description copied from interface:IStarGroupDataProvider
Whether to use an adaptive threshold, relaxing it for bright (appmag >= 13) stars to let more bright stars in.- Specified by:
setAdaptiveParallax
in interfaceIStarGroupDataProvider
-
setParallaxZeroPoint
public void setParallaxZeroPoint(double parallaxZeroPoint) Description copied from interface:IStarGroupDataProvider
Sets the zero point of the parallax as an addition to the parallax values, in [mas].- Specified by:
setParallaxZeroPoint
in interfaceIStarGroupDataProvider
- Parameters:
parallaxZeroPoint
- The parallax zero point.
-
setMagCorrections
public void setMagCorrections(boolean magCorrections) Description copied from interface:IStarGroupDataProvider
Sets the flag to apply magnitude and color corrections for extinction and reddening.- Specified by:
setMagCorrections
in interfaceIStarGroupDataProvider
- Parameters:
magCorrections
- Whether to apply the corrections.
-
getCountsPerMag
public long[] getCountsPerMag()Description copied from interface:IStarGroupDataProvider
Gets the star counts per magnitude.- Specified by:
getCountsPerMag
in interfaceIStarGroupDataProvider
-
setAdditionalFiles
Description copied from interface:IStarGroupDataProvider
Set location of additional columns file or directory.- Specified by:
setAdditionalFiles
in interfaceIStarGroupDataProvider
- Parameters:
additionalFiles
- File or directory with additional columns per sourceId.
-
setDistanceCap
public void setDistanceCap(double distCap) Description copied from interface:IStarGroupDataProvider
Sets a distance cap. Stars beyond this distance will not be loaded.- Specified by:
setDistanceCap
in interfaceIStarGroupDataProvider
- Parameters:
distCap
- The distance cap, in parsecs.
-
setRUWECap
public void setRUWECap(double RUWE) Description copied from interface:IStarGroupDataProvider
Sets the RUWE criteria. RUWE file must have been set.- Specified by:
setRUWECap
in interfaceIStarGroupDataProvider
- Parameters:
RUWE
- The criteria (usually 1.4).
-
setFileNumberCap
public void setFileNumberCap(int cap) Description copied from interface:IParticleGroupDataProvider
Sets a cap on the number of files to load. Set to negative for unlimited.- Specified by:
setFileNumberCap
in interfaceIParticleGroupDataProvider
- Parameters:
cap
- The file cap number.
-
setStarNumberCap
public void setStarNumberCap(int starNumberCap) Description copied from interface:IParticleGroupDataProvider
Sets the maximum number of stars to be processed per file. Set to negative for unlimited.- Specified by:
setStarNumberCap
in interfaceIParticleGroupDataProvider
- Parameters:
starNumberCap
- The star cap number.
-
setOutputFormatVersion
public void setOutputFormatVersion(int version) Description copied from interface:IStarGroupDataProvider
Set the preferred output format version, if applicable.- Specified by:
setOutputFormatVersion
in interfaceIStarGroupDataProvider
- Parameters:
version
- The version number.
-
setProviderParams
Description copied from interface:IParticleGroupDataProvider
Set provider parameters as a map.- Specified by:
setProviderParams
in interfaceIParticleGroupDataProvider
- Parameters:
params
- The parameters map.
-
setTransformMatrix
Description copied from interface:IParticleGroupDataProvider
Sets a transform matrix to apply to all data points.- Specified by:
setTransformMatrix
in interfaceIParticleGroupDataProvider
- Parameters:
transform
- The transform matrix.
-