Class STILDataProvider

java.lang.Object

gaiasky.data.group.AbstractStarGroupDataProvider

gaiasky.data.group.STILDataProvider

All Implemented Interfaces:

IParticleGroupDataProvider, IStarGroupDataProvider

public class STILDataProvider
extends AbstractStarGroupDataProvider

Loads data in VOTable, CSV and FITS formats using the STIL library.

See Also:

• STIL Library homepage

Nested Class Summary

Nested classes/interfaces inherited from class AbstractStarGroupDataProvider

AbstractStarGroupDataProvider.AdditionalCols, AbstractStarGroupDataProvider.ColId

Modifier and Type	Class	Description
static class	AbstractStarGroupDataProvider.AdditionalCols
static enum	AbstractStarGroupDataProvider.ColId	Represents a column type.

Field Summary

Fields inherited from class AbstractStarGroupDataProvider

adaptiveParallax, additional, additionalFiles, colors, countsPerMag, distCap, fileNumberCap, indexMap, list, logger, magCorrections, mustLoadIds, parallaxErrorFactorBright, parallaxErrorFactorFaint, parallaxZeroPoint, parallelism, params, ruwe, sphericalPositions, starNumberCap, transform

Modifier and Type	Field	Description
protected boolean	adaptiveParallax	Whether to use an adaptive threshold which lets more bright stars in to avoid artifacts.
protected List<AbstractStarGroupDataProvider.AdditionalCols>	additional
protected String[]	additionalFiles	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[]>	colors
protected long[]	countsPerMag
protected double	distCap	Distance cap in parsecs
protected int	fileNumberCap	Maximum number of files to load.
protected Map<AbstractStarGroupDataProvider.ColId, Integer>	indexMap
protected List<IParticleRecord>	list
protected static Logger.Log	logger
protected boolean	magCorrections	Apply magnitude/color corrections for extinction/reddening
protected Set<Long>	mustLoadIds
protected double	parallaxErrorFactorBright	The loader will only load stars for which the parallax error is at most the percentage given here, in [0..1].
protected double	parallaxErrorFactorFaint	The loader will only load stars for which the parallax error is at most the percentage given here, in [0..1].
protected double	parallaxZeroPoint	The zero point for the parallaxes in mas.
protected final int	parallelism	Parallelism value
protected Map<String,Object>	params
protected Double	ruwe	RUWE cap value.
protected com.badlogic.gdx.utils.LongMap<double[]>	sphericalPositions
protected int	starNumberCap	Maximum number of files to load per file
protected Matrix4D	transform

Constructor Summary

Constructors

Constructor	Description
STILDataProvider()

Method Summary

Modifier and Type	Method	Description
com.badlogic.gdx.utils.LongMap<float[]>	getColors()
List<uk.ac.starlink.table.ColumnInfo>	getColumnInfoList()
protected boolean	hasCol(AbstractStarGroupDataProvider.ColId colId)
protected int	idx(AbstractStarGroupDataProvider.ColId colId)
boolean	isUniformEpoch()	Do all particles in the group have the same epoch?
List<IParticleRecord>	loadData(InputStream is, double factor)	Loads the data applying a factor.
List<IParticleRecord>	loadData(String file, double factor)	Loads the data applying a factor.
List<IParticleRecord>	loadData(uk.ac.starlink.util.DataSource ds, double factor)
List<IParticleRecord>	loadData(uk.ac.starlink.util.DataSource ds, double factor, Runnable preCallback, BiConsumer<Long,Long> updateCallback, Runnable postCallback)	Loads a dataset (from a data source object) into a list of particle records.
List<IParticleRecord>	loadDataMapped(String file, double factor)	Loads the data applying a factor using a memory mapped file for improved speed.
void	setDatasetOptions(DatasetOptions datasetOptions)
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	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.

Methods inherited from class AbstractStarGroupDataProvider

acceptDistance, acceptParallax, colIdFromStr, countLines, countLines, dumpToDisk, dumpToDiskBin, dumpToDiskCsv, getAdditionalValue, getCountsPerMag, getGeoDistance, getRuweValue, hasAdditional, hasAdditionalColumn, initLists, initLists, initLists, loadData, mustLoad, setAdaptiveParallax, setAdditionalFiles, setColumns, setDistanceCap, setMustLoadIds, setOutputFormatVersion, setRUWECap, setStarNumberCap, setTransformMatrix

Modifier and Type	Method	Description
protected boolean	acceptDistance(double distance)	Checks whether to accept the distance
protected boolean	acceptParallax(double appMag, double parallax, double parallaxError)	Checks whether the parallax is accepted or not.
AbstractStarGroupDataProvider.ColId	colIdFromStr(String name)
protected int	countLines(com.badlogic.gdx.files.FileHandle f)
protected int	countLines(InputStream is)	Counts the lines on this input stream
protected void	dumpToDisk(List<IParticleRecord> data, String filename, String format)
protected void	dumpToDiskBin(List<IParticleRecord> data, String filename)
protected void	dumpToDiskCsv(List<IParticleRecord> data, String filename)
protected Double	getAdditionalValue(AbstractStarGroupDataProvider.ColId col, Long sourceId)
long[]	getCountsPerMag()	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	hasAdditionalColumn(AbstractStarGroupDataProvider.ColId col)
protected void	initLists()
protected void	initLists(int elems)	Initialises the lists and structures given number of elements
protected void	initLists(com.badlogic.gdx.files.FileHandle f)	Initialises the lists and structures given a file by counting the number of lines
List<IParticleRecord>	loadData(String file)	Loads the data as it is.
protected boolean	mustLoad(long id)	Returns whether the star must be loaded or not
void	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	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	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 Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

STILDataProvider

public STILDataProvider()

Method Details

setDatasetOptions

public void setDatasetOptions(DatasetOptions datasetOptions)

loadData

public List<IParticleRecord> loadData(String file,
 double factor)

Description copied from interface: IStarGroupDataProvider

Loads the data applying a factor.

Parameters:

file - The file to load.

factor - Factor to apply to the positions.

Returns:

The array of particle records.

loadData

public List<IParticleRecord> loadData(uk.ac.starlink.util.DataSource ds,
 double factor)

loadData

public List<IParticleRecord> loadData(uk.ac.starlink.util.DataSource ds,
 double factor,
 Runnable preCallback,
 BiConsumer<Long,Long> updateCallback,
 Runnable postCallback)

Loads a dataset (from a data source object) into a list of particle records.

Parameters:

ds - The data source.

factor - Length factor.

preCallback - A function that runs before.

updateCallback - A function that runs after each object has loaded. Gets two longs, the first holds the current number of loaded objects and the second holds the total number of objects to load.

postCallback - A function that runs after the data has been loaded.

Returns:

The list of particle records.

hasCol

protected boolean hasCol(AbstractStarGroupDataProvider.ColId colId)

Overrides:

hasCol in class AbstractStarGroupDataProvider

idx

protected int idx(AbstractStarGroupDataProvider.ColId colId)

Overrides:

idx in class AbstractStarGroupDataProvider

getColumnInfoList

public List<uk.ac.starlink.table.ColumnInfo> getColumnInfoList()

loadData

public List<IParticleRecord> loadData(InputStream is,
 double factor)

Description copied from interface: IStarGroupDataProvider

Loads the data applying a factor.

Parameters:

is - Input stream to load the data from.

factor - Factor to apply to the positions.

Returns:

The array of particle records.

loadDataMapped

public List<IParticleRecord> loadDataMapped(String file,
 double factor)

Description copied from interface: IStarGroupDataProvider

Loads the data applying a factor using a memory mapped file for improved speed.

Parameters:

file - The file to load.

factor - Factor to apply to the positions.

Returns:

The array of particle records.

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 interface IParticleGroupDataProvider

Overrides:

setFileNumberCap in class AbstractStarGroupDataProvider

Parameters:

cap - The file cap number.

getColors

public com.badlogic.gdx.utils.LongMap<float[]> getColors()

Specified by:

getColors in interface IStarGroupDataProvider

Overrides:

getColors in class AbstractStarGroupDataProvider

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 interface IStarGroupDataProvider

Overrides:

setParallaxErrorFactorFaint in class AbstractStarGroupDataProvider

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 < 13.1) More specifically, the following must be met:

pllx_err < pllx * pllxErrFactor

Specified by:

setParallaxErrorFactorBright in interface IStarGroupDataProvider

Overrides:

setParallaxErrorFactorBright in class AbstractStarGroupDataProvider

Parameters:

parallaxErrorFactor - The percentage value of parallax errors with respect to parallax.

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 interface IStarGroupDataProvider

Overrides:

setParallaxZeroPoint in class AbstractStarGroupDataProvider

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 interface IStarGroupDataProvider

Overrides:

setMagCorrections in class AbstractStarGroupDataProvider

Parameters:

magCorrections - Whether to apply the corrections.

setProviderParams

public void setProviderParams(Map<String,Object> params)

Description copied from interface: IParticleGroupDataProvider

Set provider parameters as a map.

Specified by:

setProviderParams in interface IParticleGroupDataProvider

Overrides:

setProviderParams in class AbstractStarGroupDataProvider

Parameters:

params - The parameters map.

isUniformEpoch

public boolean isUniformEpoch()

Description copied from interface: IParticleGroupDataProvider

Do all particles in the group have the same epoch?

Returns:

Whether all particles in the group have the same epoch;