Package htsjdk.samtools.util
Class SamRecordIntervalIteratorFactory
- java.lang.Object
-
- htsjdk.samtools.util.SamRecordIntervalIteratorFactory
-
-
Constructor Summary
Constructors Constructor Description SamRecordIntervalIteratorFactory()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CloseableIterator<SAMRecord>
makeSamRecordIntervalIterator(SamReader samReader, List<Interval> uniqueIntervals, boolean useIndex)
-
-
-
Method Detail
-
makeSamRecordIntervalIterator
public CloseableIterator<SAMRecord> makeSamRecordIntervalIterator(SamReader samReader, List<Interval> uniqueIntervals, boolean useIndex)
- Parameters:
samReader
-uniqueIntervals
- list of intervals of interest, with overlaps merged, in coordinate orderuseIndex
- if false, do not use a BAM index even if it is present.- Returns:
- an iterator that will be filtered so that only SAMRecords overlapping the intervals in uniqueIntervals will be returned. If a BAM index is available, it will be used to improve performance. Note however that if there are many intervals that cover a great deal of the genome, using the BAM index may actually make performance worse.
-
-