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

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

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)
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

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.