public class MarkDuplicatesWithMateCigarIterator
extends java.lang.Object
implements htsjdk.samtools.SAMRecordIterator
Constructor and Description |
---|
MarkDuplicatesWithMateCigarIterator(htsjdk.samtools.SAMFileHeader header,
htsjdk.samtools.util.CloseableIterator<htsjdk.samtools.SAMRecord> iterator,
OpticalDuplicateFinder opticalDuplicateFinder,
htsjdk.samtools.DuplicateScoringStrategy.ScoringStrategy duplicateScoringStrategy,
int toMarkQueueMinimumDistance,
boolean removeDuplicates,
boolean skipPairsWithNoMateCigar,
int maxRecordsInRam,
int blockSize,
java.util.List<java.io.File> tmpDirs)
Initializes the mark duplicates iterator.
|
Modifier and Type | Method and Description |
---|---|
htsjdk.samtools.SAMRecordIterator |
assertSorted(htsjdk.samtools.SAMFileHeader.SortOrder sortOrder)
Establishes that records returned by this iterator are expected to
be in the specified sort order.
|
void |
close() |
LibraryIdGenerator |
getLibraryIdGenerator() |
int |
getNumDuplicates() |
int |
getNumRecordsWithNoMateCigar()
Useful for statistics after the iterator has been exhausted and closed.
|
htsjdk.samtools.util.Histogram<java.lang.Short> |
getOpticalDupesByLibraryId() |
boolean |
hasNext() |
void |
logMemoryStats(htsjdk.samtools.util.Log log) |
htsjdk.samtools.SAMRecord |
next() |
void |
remove() |
public MarkDuplicatesWithMateCigarIterator(htsjdk.samtools.SAMFileHeader header, htsjdk.samtools.util.CloseableIterator<htsjdk.samtools.SAMRecord> iterator, OpticalDuplicateFinder opticalDuplicateFinder, htsjdk.samtools.DuplicateScoringStrategy.ScoringStrategy duplicateScoringStrategy, int toMarkQueueMinimumDistance, boolean removeDuplicates, boolean skipPairsWithNoMateCigar, int maxRecordsInRam, int blockSize, java.util.List<java.io.File> tmpDirs) throws PicardException
header
- the SAM headeriterator
- an iterator over the SAM records to consideropticalDuplicateFinder
- the algorithm for optical duplicate detectionduplicateScoringStrategy
- the scoring strategy for choosing duplicates. This cannot be SUM_OF_BASE_QUALITIES.toMarkQueueMinimumDistance
- minimum distance for which to bufferremoveDuplicates
- true to remove duplicates, false to mark duplicatesskipPairsWithNoMateCigar
- true to not return mapped pairs with no mate cigar, false otherwiseblockSize
- the size of the blocks in the underlying buffer/queuetmpDirs
- the temporary directories to use if we spill records to diskPicardException
- if the inputs are not in coordinate sort orderpublic void logMemoryStats(htsjdk.samtools.util.Log log)
public htsjdk.samtools.SAMRecordIterator assertSorted(htsjdk.samtools.SAMFileHeader.SortOrder sortOrder)
assertSorted
in interface htsjdk.samtools.SAMRecordIterator
sortOrder
- The order in which records are expected to be returnedpublic boolean hasNext()
hasNext
in interface java.util.Iterator<htsjdk.samtools.SAMRecord>
public htsjdk.samtools.SAMRecord next() throws PicardException
next
in interface java.util.Iterator<htsjdk.samtools.SAMRecord>
PicardException
public void remove()
remove
in interface java.util.Iterator<htsjdk.samtools.SAMRecord>
public void close()
close
in interface htsjdk.samtools.util.CloseableIterator<htsjdk.samtools.SAMRecord>
close
in interface java.io.Closeable
close
in interface java.lang.AutoCloseable
public int getNumRecordsWithNoMateCigar()
public int getNumDuplicates()
public LibraryIdGenerator getLibraryIdGenerator()
public htsjdk.samtools.util.Histogram<java.lang.Short> getOpticalDupesByLibraryId()