Delete deprecated old-school traversals.

git-svn-id: file:///humgen/gsa-scr1/gsa-engineering/svn_contents/trunk@758 348d0f76-0448-11de-a6fe-93d51630548a
This commit is contained in:
hanna 2009-05-20 14:57:17 +00:00
parent 3b1f84e15b
commit 96e73e496a
2 changed files with 0 additions and 280 deletions

View File

@ -1,169 +0,0 @@
package org.broadinstitute.sting.gatk.traversals;
import org.broadinstitute.sting.gatk.walkers.LocusWalker;
import org.broadinstitute.sting.gatk.walkers.Walker;
import org.broadinstitute.sting.gatk.LocusContext;
import org.broadinstitute.sting.gatk.refdata.ReferenceOrderedData;
import org.broadinstitute.sting.gatk.refdata.ReferenceOrderedDatum;
import org.broadinstitute.sting.gatk.refdata.RefMetaDataTracker;
import org.broadinstitute.sting.gatk.iterators.ReferenceIterator;
import org.broadinstitute.sting.gatk.iterators.LocusContextIterator;
import org.broadinstitute.sting.gatk.iterators.LocusContextIteratorByHanger;
import org.broadinstitute.sting.utils.GenomeLoc;
import org.broadinstitute.sting.utils.Utils;
import java.util.List;
import java.util.Iterator;
import java.io.File;
import net.sf.samtools.SAMRecord;
import net.sf.samtools.util.CloseableIterator;
import edu.mit.broad.picard.filter.FilteringIterator;
/**
* Created by IntelliJ IDEA.
* User: mdepristo
* Date: Mar 27, 2009
* Time: 10:26:03 AM
* To change this template use File | Settings | File Templates.
*/
public class TraverseByLoci extends TraversalEngine {
public TraverseByLoci(List<File> reads, File ref, List<ReferenceOrderedData<? extends ReferenceOrderedDatum>> rods) {
super(reads, ref, rods);
}
@Override
public <M,T> T traverse(Walker<M,T> walker, List<GenomeLoc> locations) {
if ( walker instanceof LocusWalker ) {
LocusWalker<M, T> locusWalker = (LocusWalker<M, T>)walker;
T sum = traverseByLoci(locusWalker, locations);
return sum;
} else {
throw new IllegalArgumentException("Walker isn't a loci walker!");
}
}
/**
* Traverse by loci -- the key driver of linearly ordered traversal of loci. Provides reads, RODs, and
* the reference base for each locus in the reference to the LocusWalker walker. Supports all of the
* interaction contract implied by the locus walker
*
* @param walker A locus walker object
* @param <M> MapType -- the result of calling map() on walker
* @param <T> ReduceType -- the result of calling reduce() on the walker
* @return 0 on success
*/
protected <M, T> T traverseByLoci(LocusWalker<M, T> walker, List<GenomeLoc> locations) {
logger.debug("Entering traverseByLoci");
if(readsFiles.size() > 1)
throw new UnsupportedOperationException("Cannot do ByLoci traversal on file with multiple inputs.");
samReader = initializeSAMFile(readsFiles.get(0));
verifySortOrder(true);
// initialize the walker object
walker.initialize();
T sum = walker.reduceInit();
if ( ! locations.isEmpty() ) {
logger.debug("Doing interval-based traversal");
if ( ! samReader.hasIndex() )
Utils.scareUser("Processing locations were requested, but no index was found for the input SAM/BAM file. This operation is potentially dangerously slow, aborting.");
// we are doing interval-based traversals
for ( GenomeLoc interval : locations ) {
logger.debug(String.format("Processing locus %s", interval.toString()));
CloseableIterator<SAMRecord> readIter = samReader.queryOverlapping( interval.getContig(),
(int)interval.getStart(),
(int)interval.getStop()+1 );
Iterator<SAMRecord> wrappedIter = wrapReadsIterator( readIter, false );
sum = carryWalkerOverInterval(walker, wrappedIter, sum, interval);
readIter.close();
}
}
else {
// We aren't locus oriented
logger.debug("Doing non-interval-based traversal");
samReadIter = wrapReadsIterator(getReadsIterator(samReader), true);
sum = carryWalkerOverInterval(walker, samReadIter, sum, null);
}
//printOnTraversalDone("loci", sum);
walker.onTraversalDone(sum);
samReader.close();
return sum;
}
protected <M, T> T carryWalkerOverInterval( LocusWalker<M, T> walker, Iterator<SAMRecord> readIter, T sum, GenomeLoc interval ) {
logger.debug(String.format("TraverseByLoci.carryWalkerOverInterval Genomic interval is %s", interval));
// prepare the read filtering read iterator and provide it to a new locus iterator
FilteringIterator filterIter = new FilteringIterator(readIter, new locusStreamFilterFunc());
boolean done = false;
LocusContextIterator iter = new LocusContextIteratorByHanger(filterIter);
while (iter.hasNext() && !done) {
TraversalStatistics.nRecords++;
// actually get the read and hand it to the walker
LocusContext locus = iter.next();
logger.debug(String.format("Crossing locus %s with %d reads", locus.getLocation(), locus.numReads()));
if ( DOWNSAMPLE_BY_COVERAGE )
locus.downsampleToCoverage(downsamplingCoverage);
// if we don't have a particular interval we're processing, check them all, otherwise only operate at this
// location
if ( interval == null || interval.overlapsP(locus.getLocation()) ) {
ReferenceIterator refSite = refIter.seekForward(locus.getLocation());
locus.setReferenceContig(refSite.getCurrentContig());
// Iterate forward to get all reference ordered data covering this locus
final RefMetaDataTracker tracker = getReferenceOrderedDataAtLocus(locus.getLocation());
sum = walkAtLocus( walker, sum, locus, refSite, tracker );
//System.out.format("Working at %s\n", locus.getLocation().toString());
if (this.maxReads > 0 && TraversalStatistics.nRecords > this.maxReads) {
logger.warn(String.format("Maximum number of reads encountered, terminating traversal " + TraversalStatistics.nRecords));
done = true;
}
printProgress("loci", locus.getLocation());
}
done = interval != null && locus.getLocation().isPast(interval);
//System.out.printf("done is %b, %s vs. %s%n", done, interval, locus.getLocation());
}
return sum;
}
protected <M, T> T walkAtLocus( final LocusWalker<M, T> walker,
T sum,
final LocusContext locus,
final ReferenceIterator refSite,
final RefMetaDataTracker tracker ) {
final char refBase = refSite.getBaseAsChar();
//logger.debug(String.format(" Reference: %s:%d %c", refSite.getCurrentContig().getName(), refSite.getPosition(), refBase));
//
// Execute our contract with the walker. Call filter, map, and reduce
//
final boolean keepMeP = walker.filter(tracker, refBase, locus);
if (keepMeP) {
M x = walker.map(tracker, refBase, locus);
sum = walker.reduce(x, sum);
}
//printProgress("loci", locus.getLocation());
return sum;
}
}

View File

@ -1,111 +0,0 @@
package org.broadinstitute.sting.gatk.traversals;
import org.broadinstitute.sting.gatk.walkers.LocusWalker;
import org.broadinstitute.sting.gatk.LocusContext;
import org.broadinstitute.sting.gatk.refdata.ReferenceOrderedData;
import org.broadinstitute.sting.gatk.refdata.ReferenceOrderedDatum;
import org.broadinstitute.sting.gatk.refdata.RefMetaDataTracker;
import org.broadinstitute.sting.gatk.iterators.ReferenceIterator;
import org.broadinstitute.sting.utils.GenomeLoc;
import java.util.List;
import java.util.ArrayList;
import java.io.File;
import net.sf.samtools.SAMRecord;
/**
* A simple, short-term solution to iterating over all reference positions over a series of
* genomic locations. Simply overloads the superclass traverse function to go over the entire
* interval's reference positions.
*/
public class TraverseByReference extends TraverseByLoci {
public TraverseByReference(List<File> reads, File ref, List<ReferenceOrderedData<? extends ReferenceOrderedDatum>> rods) {
super(reads, ref, rods);
logger.debug("Creating TraverseByReference");
if ( reads != null )
throw new IllegalArgumentException("By reference traversal doesn't support reads, but file was given " + reads);
if ( ref == null )
throw new IllegalArgumentException("By reference traversal requires reference file but none was given");
}
/**
* Traverse by loci -- the key driver of linearly ordered traversal of loci. Provides reads, RODs, and
* the reference base for each locus in the reference to the LocusWalker walker. Supports all of the
* interaction contract implied by the locus walker
*
* @param walker A locus walker object
* @param <M> MapType -- the result of calling map() on walker
* @param <T> ReduceType -- the result of calling reduce() on the walker
* @return 0 on success
*/
protected <M, T> T traverseByLoci(LocusWalker<M, T> walker, List<GenomeLoc> locations) {
logger.debug("Entering traverseByReference");
// initialize the walker object
walker.initialize();
T sum = walker.reduceInit();
if ( ! locations.isEmpty() ) {
logger.debug("Doing interval-based traversal");
// we are doing interval-based traversals
for ( GenomeLoc interval : locations ) {
logger.debug(String.format("Processing locus %s", interval.toString()));
sum = carryWalkerOverReference(walker, sum, interval);
}
}
else {
// We aren't locus oriented
logger.debug("Doing non-interval-based traversal");
sum = carryWalkerOverReference(walker, sum, null);
}
//printOnTraversalDone("reference", sum);
walker.onTraversalDone(sum);
return sum;
}
protected <M, T> T carryWalkerOverReference( LocusWalker<M, T> walker,
T sum,
GenomeLoc interval ) {
logger.debug(String.format("traverseByReference.carryWalkerOverReference Genomic interval is %s", interval));
boolean done = false;
List<SAMRecord> NO_READS = new ArrayList<SAMRecord>();
List<Integer> NO_OFFSETS = new ArrayList<Integer>();
ReferenceIterator refSite = null;
if ( interval != null )
refSite = refIter.seekForward(interval); // jump to the first reference site
else
refSite = refIter.next();
// We keep processing while the next reference location is within the interval
while ( (interval == null || interval.containsP(refSite.getLocation())) && ! done ) {
TraversalStatistics.nRecords++;
GenomeLoc current = refSite.getLocation();
// Iterate forward to get all reference ordered data covering this locus
final RefMetaDataTracker tracker = getReferenceOrderedDataAtLocus(current);
LocusContext locus = new LocusContext(current, NO_READS, NO_OFFSETS); // make the empty locus that has no reads
locus.setReferenceContig(refSite.getCurrentContig());
sum = walkAtLocus( walker, sum, locus, refSite, tracker );
if (this.maxReads > 0 && TraversalStatistics.nRecords > this.maxReads) {
logger.warn(String.format("Maximum number of reads encountered, terminating traversal " + TraversalStatistics.nRecords));
done = true;
}
//printProgress("ref", locus.getLocation());
refSite = refIter.next(); // update our location
}
return sum;
}
}