Package picard.illumina.parser.readers
Class LocsFileReader
java.lang.Object
picard.illumina.parser.readers.AbstractIlluminaPositionFileReader
picard.illumina.parser.readers.LocsFileReader
- All Implemented Interfaces:
htsjdk.samtools.util.CloseableIterator<AbstractIlluminaPositionFileReader.PositionInfo>,Closeable,AutoCloseable,Iterator<AbstractIlluminaPositionFileReader.PositionInfo>
The locs file format is one 3 Illumina formats(pos, locs, and clocs) that stores position data exclusively.
locs files store position data for successive clusters in 4 byte float pairs, described as follows:
bytes 1-4 : (int?) Version number (1)
bytes 5-8 : 4 byte float equaling 1.0
bytes 9-12 : unsigned int numClusters
bytes 13-16: : X coordinate of first cluster (32-bit float)
bytes 17-20: : Y coordinate of first cluster (32-bit float)
The remaining bytes of the file store the X and Y coordinates of the remaining clusters.
-
Nested Class Summary
Nested classes/interfaces inherited from class picard.illumina.parser.readers.AbstractIlluminaPositionFileReader
AbstractIlluminaPositionFileReader.PositionInfo -
Field Summary
Fields inherited from class picard.illumina.parser.readers.AbstractIlluminaPositionFileReader
MAX_POS, MIN_POS, S_LOCS_FILE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidclose()booleanhasNext()Return true if the file has more elements to return, false otherwiseprotected StringCreate a string that will be included in any NoSuchElementException thrown by the next() methodvoidskipRecords(int numToSkip) Returns the next position info.Methods inherited from class picard.illumina.parser.readers.AbstractIlluminaPositionFileReader
getFile, getLane, getTile, next, removeMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface htsjdk.samtools.util.CloseableIterator
stream, toListMethods inherited from interface java.util.Iterator
forEachRemaining
-
Constructor Details
-
LocsFileReader
-
LocsFileReader
-
-
Method Details
-
unsafeNextInfo
Description copied from class:AbstractIlluminaPositionFileReaderReturns the next position info. Implementations of this method do not need to call hasNext since it is called in next()- Specified by:
unsafeNextInfoin classAbstractIlluminaPositionFileReader
-
makeExceptionMsg
Description copied from class:AbstractIlluminaPositionFileReaderCreate a string that will be included in any NoSuchElementException thrown by the next() method- Specified by:
makeExceptionMsgin classAbstractIlluminaPositionFileReader
-
hasNext
public boolean hasNext()Description copied from class:AbstractIlluminaPositionFileReaderReturn true if the file has more elements to return, false otherwise- Specified by:
hasNextin interfaceIterator<AbstractIlluminaPositionFileReader.PositionInfo>- Specified by:
hasNextin classAbstractIlluminaPositionFileReader
-
close
public void close() -
skipRecords
public void skipRecords(int numToSkip)
-