qval_cache Class Reference

#include <quality_summary.h>

Public Member Functions

 qval_cache (const model::summary::run_summary &run, const size_t surface_count=1)
 
void add (const model::metrics::q_collapsed_metric &metric, const size_t read_number, const size_t lane, const size_t surface=0)
 
const qval_totaltotal_for (const size_t read_number, const size_t lane, const size_t surface=0) const
 
size_t metric_count (const size_t read_number, const size_t lane, const size_t surface=0) const
 
size_t tile_count (const size_t lane, const size_t surface=0) const
 

Detailed Description

Cache the q-value by read/lane or read/lane/surface

Constructor & Destructor Documentation

qval_cache ( const model::summary::run_summary run,
const size_t  surface_count = 1 
)
inline

Constructor

Parameters
runrun summary
surface_countnumber of surfaces

Member Function Documentation

void add ( const model::metrics::q_collapsed_metric metric,
const size_t  read_number,
const size_t  lane,
const size_t  surface = 0 
)
inline

Accumulate a metric into the cache

Parameters
metriccollapsed q-metric
read_numberindex of the read
laneindex of the lane
surfacesurface index
size_t metric_count ( const size_t  read_number,
const size_t  lane,
const size_t  surface = 0 
) const
inline

Get number of metrics in read/lane/surface

Parameters
read_numberread index
lanelane index
surfacesurface index
Returns
number of metrics
size_t tile_count ( const size_t  lane,
const size_t  surface = 0 
) const
inline

Get number of tiles for lane/surface

Parameters
lanelane index
surfacesurface index
Returns
number of tiles
const qval_total& total_for ( const size_t  read_number,
const size_t  lane,
const size_t  surface = 0 
) const
inline

Get qval_total struct for given read/lane/surface

Parameters
read_numberread index
lanelane index
surfacesurface index
Returns
qval_total struct

The documentation for this class was generated from the following file: