Package gaiasky.data.group

Class BinaryDataProvider

java.lang.Object

gaiasky.data.group.AbstractStarGroupDataProvider

gaiasky.data.group.BinaryDataProvider

All Implemented Interfaces:

IParticleGroupDataProvider, IStarGroupDataProvider

public class BinaryDataProvider
extends AbstractStarGroupDataProvider

Reads arrays of star beans from binary files, usually to go in an octree. The header of the format depends on the version.

• Versions 0 and 1:
  • int: number of stars
• Version 2+:
  • int: negative integer token to differentiate from versions 0/1 (-1)
  • int: format version number
  • int: number of stars

Nested Class Summary

Nested classes/interfaces inherited from class gaiasky.data.group.AbstractStarGroupDataProvider

AbstractStarGroupDataProvider.AdditionalCols, AbstractStarGroupDataProvider.ColId

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_OUTPUT_VERSION	The default output format version to use for writing
static int	MAX_OUTPUT_VERSION
static int	MIN_OUTPUT_VERSION

Fields inherited from class gaiasky.data.group.AbstractStarGroupDataProvider

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

Constructor Summary

Constructors

Constructor	Description
BinaryDataProvider()

Method Summary

Modifier and Type	Method	Description
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>	loadDataMapped(String file, double factor)	Loads the data applying a factor using a memory mapped file for improved speed.
List<IParticleRecord>	loadDataMapped(String file, double factor, int versionHint)	Loads data mapped with a version hint.
List<IParticleRecord>	readData(InputStream in, double factor)
void	setOutputFormatVersion(int version)	Set the preferred output format version, if applicable
void	writeData(List<IParticleRecord> data, OutputStream out)
void	writeData(List<IParticleRecord> data, OutputStream out, int version)

Methods inherited from class gaiasky.data.group.AbstractStarGroupDataProvider

acceptDistance, acceptParallax, colIdFromStr, countLines, countLines, dumpToDisk, dumpToDiskBin, dumpToDiskCsv, getAdditionalValue, getColors, getCountsPerMag, getGeoDistance, getRuweValue, hasAdditional, hasAdditionalColumn, hasCol, idx, initLists, initLists, initLists, loadData, mustLoad, setAdaptiveParallax, setAdditionalFiles, setColumns, setDistanceCap, setFileNumberCap, setMagCorrections, setMustLoadIds, setParallaxErrorFactorBright, setParallaxErrorFactorFaint, setParallaxZeroPoint, setProviderParams, setRUWECap, setStarNumberCap

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_OUTPUT_VERSION

public static int DEFAULT_OUTPUT_VERSION

The default output format version to use for writing

MIN_OUTPUT_VERSION

public static int MIN_OUTPUT_VERSION

MAX_OUTPUT_VERSION

public static int MAX_OUTPUT_VERSION

Constructor Details

BinaryDataProvider

public BinaryDataProvider()

Method Details

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:

Array of particle beans

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:

Array of particle beans

writeData

public void writeData(List<IParticleRecord> data,
 OutputStream out)

writeData

public void writeData(List<IParticleRecord> data,
 OutputStream out,
 int version)

readData

public List<IParticleRecord> readData(InputStream in,
 double factor)

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:

Array of particle beans

loadDataMapped

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

Loads data mapped with a version hint.

Parameters:

file - The file to load

factor - Distance factor, if any

versionHint - Data version number, in case of version 0 or 1, since these formats were not annotated. If version >=2, the version number is read from the file header

Returns:

setOutputFormatVersion

public void setOutputFormatVersion(int version)

Description copied from interface: IStarGroupDataProvider

Set the preferred output format version, if applicable

Specified by:

setOutputFormatVersion in interface IStarGroupDataProvider

Overrides:

setOutputFormatVersion in class AbstractStarGroupDataProvider

Parameters:

version - The version number