Package gaiasky.data.group
Interface IStarGroupDataProvider
- All Superinterfaces:
IParticleGroupDataProvider
- All Known Implementing Classes:
AbstractStarGroupDataProvider
,BinaryDataProvider
,CsvCatalogDataProvider
,SerializedDataProvider
,STILDataProvider
public interface IStarGroupDataProvider extends IParticleGroupDataProvider
Data provider for a star group, which contains an index map with the names
and indices of the stars.
-
Method Summary
Modifier and Type Method Description com.badlogic.gdx.utils.LongMap<float[]>
getColors()
long[]
getCountsPerMag()
Gets the star counts per magnitudejava.util.List<IParticleRecord>
loadData(java.io.InputStream is, double factor)
Loads the data applying a factor.java.util.List<IParticleRecord>
loadData(java.lang.String file, double factor)
Loads the data applying a factor.java.util.List<IParticleRecord>
loadDataMapped(java.lang.String file, double factor)
Loads the data applying a factor using a memory mapped file for improved speed.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(java.lang.String additionalFile)
Set location of additional columns file or directoryvoid
setColumns(java.lang.String columns)
List of column names, separated by commas, indicating the position of each field to loadvoid
setDistanceCap(double distCap)
Sets a distance cap.void
setMagCorrections(boolean magCorrections)
Sets the flag to apply magnitude and color corrections for extinction and reddeningvoid
setMustLoadIds(java.util.Set<java.lang.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 applicablevoid
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
setRUWECap(double RUWE)
Sets the RUWE criteria.Methods inherited from interface gaiasky.data.group.IParticleGroupDataProvider
loadData, setFileNumberCap, setStarNumberCap
-
Method Details
-
getColors
com.badlogic.gdx.utils.LongMap<float[]> getColors() -
loadDataMapped
Loads the data applying a factor using a memory mapped file for improved speed.- Specified by:
loadDataMapped
in interfaceIParticleGroupDataProvider
- Parameters:
file
- The file to loadfactor
- Factor to apply to the positions- Returns:
- Array of particle beans
-
loadData
Loads the data applying a factor.- Specified by:
loadData
in interfaceIParticleGroupDataProvider
- Parameters:
file
- The file to loadfactor
- Factor to apply to the positions- Returns:
- Array of particle beans
-
loadData
Loads the data applying a factor.- Specified by:
loadData
in interfaceIParticleGroupDataProvider
- Parameters:
is
- Input stream to load the data fromfactor
- Factor to apply to the positions- Returns:
- Array of particle beans
-
setParallaxErrorFactorFaint
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]. This applies to faint stars (gmag >= 13.1) More specifically, the following must be met:
pllx_err < pllx * pllxErrFactor
- Parameters:
parallaxErrorFactor
- The percentage value of parallax errors with respect to parallax
-
setParallaxErrorFactorBright
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]. This applies to bright stars (gmag < 13.1) More specifically, the following must be met:
pllx_err < pllx * pllxErrFactor
- Parameters:
parallaxErrorFactor
- The percentage value of parallax errors with respect to parallax
-
setAdaptiveParallax
void setAdaptiveParallax(boolean adaptive)Whether to use an adaptive threshold, relaxing it for bright (appmag >= 13) stars to let more bright stars in. -
setParallaxZeroPoint
void setParallaxZeroPoint(double parallaxZeroPoint)Sets the zero point of the parallax as an addition to the parallax values, in [mas]- Parameters:
parallaxZeroPoint
- The parallax zero point
-
setMagCorrections
void setMagCorrections(boolean magCorrections)Sets the flag to apply magnitude and color corrections for extinction and reddening- Parameters:
magCorrections
- Whether to apply the corrections
-
setAdditionalFiles
void setAdditionalFiles(java.lang.String additionalFile)Set location of additional columns file or directory- Parameters:
additionalFile
- File or directory with additional columns per sourceId
-
setRUWECap
void setRUWECap(double RUWE)Sets the RUWE criteria. RUWE file must have been set- Parameters:
RUWE
- The criteria (usually 1.4)
-
setDistanceCap
void setDistanceCap(double distCap)Sets a distance cap. Stars beyond this distance will not be loaded- Parameters:
distCap
- The distance cap, in parsecs
-
getCountsPerMag
long[] getCountsPerMag()Gets the star counts per magnitude -
setMustLoadIds
void setMustLoadIds(java.util.Set<java.lang.Long> ids)Adds a set with all the ids which will be loaded regardless of any other conditions (i.e. parallax error thresholds)- Parameters:
ids
- The ids that must be loaded
-
setColumns
void setColumns(java.lang.String columns)List of column names, separated by commas, indicating the position of each field to load- Parameters:
columns
- The column name list
-
setOutputFormatVersion
void setOutputFormatVersion(int version)Set the preferred output format version, if applicable- Parameters:
version
- The version number
-