metric_summary Class Reference

#include <metric_summary.h>

Public Member Functions

 metric_summary (const size_t)
 
float error_rate () const
 
float percent_aligned () const
 
float first_cycle_intensity () const
 
float percent_gt_q30 () const
 
float yield_g () const
 
float projected_yield_g () const
 
float percent_occupied () const
 
float percent_occupancy_proxy () const
 
double cluster_count () const
 
double cluster_count_pf () const
 
uint64_t reads () const
 
uint64_t reads_pf () const
 
void first_cycle_intensity (const float val)
 
void error_rate (const float val)
 
void percent_aligned (const float val)
 
void percent_gt_q30 (const float val)
 
void yield_g (const float val)
 
void projected_yield_g (const float val)
 
void percent_occupied (const float val)
 
void percent_occupancy_proxy (const float val)
 
void resize (const size_t)
 
void cluster_count (const double val)
 
void cluster_count_pf (const double val)
 
void reads (const uint64_t val)
 
void reads_pf (const uint64_t val)
 

Friends

template<class MetricType , int Version>
struct io::generic_layout
 

Detailed Description

Summary statistics by read, total and non-indexed

Constructor & Destructor Documentation

metric_summary ( const size_t  )
inline

Constructor

Member Function Documentation

void cluster_count ( const double  val)
inline

Set the cluster count of the run

Parameters
valcluster count of the run.
void cluster_count_pf ( const double  val)
inline

Set the cluster count PF of the run

Parameters
valcluster count PF of the run.
void error_rate ( const float  val)
inline

Set the error rate of PHIX for the run

Parameters
valerror rate of PHIX for run
void first_cycle_intensity ( const float  val)
inline

Set the first cycle intensity

Parameters
valfirst cycle intensity
void percent_aligned ( const float  val)
inline

Set the percent aligned PHIX for the run

Parameters
valpercent aligned PHIX
void percent_gt_q30 ( const float  val)
inline

Set the percent of bases greater than or equal to Q30

Parameters
valpercent of bases greater than or equal to Q30
void percent_occupancy_proxy ( const float  val)
inline

Set the percent occupancy proxy

Also known as % loading concentration

Parameters
valpercent occupancy proxy
void percent_occupied ( const float  val)
inline

Set the percent occupied

Parameters
valpercent occupied
void projected_yield_g ( const float  val)
inline

Set the projected yield of the run in gigabases

Parameters
valprojected yield of the run in gigabases
void reads ( const uint64_t  val)
inline

Set the total reads for the run

Parameters
valtotal reads for run
void reads_pf ( const uint64_t  val)
inline

Set the reads PF for the run

Parameters
valreads PF for run
void resize ( const size_t  )
inline

Resize the underlying data

void yield_g ( const float  val)
inline

Set the yield of the run in gigabases

Parameters
valyield of the run in gigabases

Friends And Related Function Documentation

friend struct io::generic_layout
friend

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