All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.broadinstitute.hellbender.engine.AssemblyRegionEvaluator Maven / Gradle / Ivy

The newest version!
package org.broadinstitute.hellbender.engine;

import org.broadinstitute.hellbender.utils.activityprofile.ActivityProfileState;

/**
 * Classes that implement this interface have the ability to evaluate how likely it is that a site is "active"
 * (contains potential real variation).
 */
@FunctionalInterface
public interface AssemblyRegionEvaluator {

    /**
     * Given a pileup over a single locus, returns an ActivityProfileState containing the probability (0.0 to 1.0) that
     * the locus is an "active" site.
     *
     * @param locusPileup reads pileup to examine
     * @param referenceContext reference base overlapping the pileup locus
     * @param featureContext features overlapping the pileup locus
     * @return ActivityProfileState containing the probability between 0.0 and 1.0 that the site is active
     */
    ActivityProfileState isActive( final AlignmentContext locusPileup, final ReferenceContext referenceContext, final FeatureContext featureContext );
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy