Struct FilterParams 

pub struct FilterParams {
    pub filter_on: Option<bool>,
    pub abun_filter: (Option<u32>, Option<u32>),
    pub err_filter: f64,
    pub strand_filter: f64,
}

Used to pass around filter options for sketching

Fields

filter_on: Option<bool>

abun_filter: (Option<u32>, Option<u32>)

err_filter: f64

strand_filter: f64

Implementations

impl FilterParams

pub fn filter_sketch(&self, sketch: &mut Sketch)

Filter the sketch according to these FilterParams

pub fn filter_counts(&mut self, hashes: &[KmerCount]) -> Vec<KmerCount>

Returns the filtered kmer counts.

If the err filter determined a different low_abundance_filter update self to that one.

pub fn to_serialized(&self) -> HashMap<String, String>

pub fn from_serialized(filters: &HashMap<String, String>) -> FinchResult<Self>

Trait Implementations

impl Clone for FilterParams

fn clone(&self) -> FilterParams

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FilterParams

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for FilterParams

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for FilterParams

fn eq(&self, other: &FilterParams) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for FilterParams