public class DownsamplingIteratorFactory extends Object
Modifier and Type | Class | Description |
---|---|---|
static class |
DownsamplingIteratorFactory.Strategy |
Describes the available downsampling strategies.
|
Modifier and Type | Field | Description |
---|---|---|
static String |
CHAINED_DESCRIPTION |
|
static String |
CONSTANT_MEMORY_DESCRPTION |
|
static String |
HIGH_ACCURACY_DESCRIPTION |
Constructor | Description |
---|---|
DownsamplingIteratorFactory() |
Modifier and Type | Method | Description |
---|---|---|
static DownsamplingIterator |
make(SamReader reader,
DownsamplingIteratorFactory.Strategy strategy,
double proportion,
double accuracy,
int seed) |
Convenience method that constructs a downsampling iterator for all the reads available from a SamReader.
|
static DownsamplingIterator |
make(File samFile,
DownsamplingIteratorFactory.Strategy strategy,
double proportion,
double accuracy,
int seed) |
Convenience method that constructs a downsampling iterator for all the reads in a SAM file.
|
static DownsamplingIterator |
make(Iterator<SAMRecord> iterator,
DownsamplingIteratorFactory.Strategy strategy,
double proportion,
double accuracy,
int seed) |
Creates a new DownsamplingIterator using the supplied Strategy that attempts to read from the provided iterator and return
approximately proportion of the records read.
|
public static final String HIGH_ACCURACY_DESCRIPTION
public static final String CONSTANT_MEMORY_DESCRPTION
public static final String CHAINED_DESCRIPTION
public static DownsamplingIterator make(Iterator<SAMRecord> iterator, DownsamplingIteratorFactory.Strategy strategy, double proportion, double accuracy, int seed)
iterator
- The iterator from which to consume SAMRecordsstrategy
- The downsampling strategy to useproportion
- The proportion of records the downsampling strategy should attempt to emitaccuracy
- If supported by the downsampling strategy, the accuracy goal for the downsampler. Higher accuracy will generally
require higher memory usage. An accuracy value of 0.0001 tells the strategy to try and ensure the emitted proportion
is within proportion +/0 0.0001.seed
- The seed value to use for any random process used in down-sampling.public static DownsamplingIterator make(File samFile, DownsamplingIteratorFactory.Strategy strategy, double proportion, double accuracy, int seed)
make(Iterator, Strategy, double, double, int)
for detailed parameter information.public static DownsamplingIterator make(SamReader reader, DownsamplingIteratorFactory.Strategy strategy, double proportion, double accuracy, int seed)
make(Iterator, Strategy, double, double, int)
for detailed parameter information.