Struct debruijn::filter::CountFilterSet

pub struct CountFilterSet<D> { /* fields omitted */ }

A simple KmerSummarizer that only accepts kmers that are observed at least a given number of times. The metadata returned about a Kmer is a vector of the unique data values observed for that kmer.

Methods

impl<D> CountFilterSet<D>

pub fn new(min_kmer_obs: usize) -> CountFilterSet<D>

Construct a CountFilterSet KmerSummarizer only accepts kmers that are observed at least min_kmer_obs times.

Trait Implementations

impl<D: Ord> KmerSummarizer<D, Vec<D>> for CountFilterSet<D>

fn summarize<K, F: Iterator<Item = (K, Exts, D)>>(
    &self,
    items: F
) -> (bool, Exts, Vec<D>)

The input items is an iterator over kmer observations. Input observation is a tuple of (kmer, extensions, data). The summarize function inspects the data and returns a tuple indicating: * whether this kmer passes the filtering criteria (e.g. is there a sufficient number of observation) * the accumulated Exts of the kmer * a summary data object of type DO that will be used as a color annotation in the DeBruijn graph.