org.broadinstitute.hellbender.utils.downsampling

Class ReadsDownsamplingIterator

java.lang.Object

org.broadinstitute.hellbender.utils.iterators.PushToPullIterator<GATKRead>

org.broadinstitute.hellbender.utils.downsampling.ReadsDownsamplingIterator

All Implemented Interfaces:

java.lang.Iterable<GATKRead>, java.util.Iterator<GATKRead>

public final class ReadsDownsamplingIterator
extends PushToPullIterator<GATKRead>

Iterator wrapper around our generic ReadsDownsampler) interface. Wraps an iterator of reads, and downsamples the reads from that iterator using the provided downsampler. Converts the push-style ReadsDownsampler) interface to a pull model.

Constructor Summary

Constructors

Constructor and Description
ReadsDownsamplingIterator(java.util.Iterator<GATKRead> iter, ReadsDownsampler downsampler)

Method Summary

Methods inherited from class org.broadinstitute.hellbender.utils.iterators.PushToPullIterator

hasNext, iterator, next, remove

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ReadsDownsamplingIterator

public ReadsDownsamplingIterator(java.util.Iterator<GATKRead> iter,
                                 ReadsDownsampler downsampler)

Parameters:

iter - wrapped iterator from which this iterator will pull reads to be downsampled

downsampler - downsampler through which the reads from the wrapped iterator will be fed