Functions

float percent_gt_q30 () const
 
float yield_g () const
 
float projected_yield_g () const
 
uint64_t reads () const
 
uint64_t reads_pf () const
 
const metric_stat_t & density () const
 
const metric_stat_t & density_pf () const
 
const metric_stat_t & cluster_count () const
 
const metric_stat_t & cluster_count_pf () const
 
const metric_stat_t & percent_pf () const
 
const metric_stat_t & phasing () const
 
const metric_stat_t & prephasing () const
 
const metric_stat_t & percent_aligned () const
 
const metric_stat_t & error_rate () const
 
const metric_stat_t & error_rate_35 () const
 
const metric_stat_t & error_rate_50 () const
 
const metric_stat_t & error_rate_75 () const
 
const metric_stat_t & error_rate_100 () const
 
const metric_stat_t & first_cycle_intensity () const
 
const metric_stat_t & phasing_slope () const
 
const metric_stat_t & phasing_offset () const
 
const metric_stat_t & prephasing_slope () const
 
const metric_stat_t & prephasing_offset () const
 
const metric_stat_t & percent_occupied () const
 

Detailed Description

Summary of key metrics

See full class description See full class description

Function Documentation

const metric_stat_t& cluster_count ( ) const
inline

Get statistics summarizing the cluster count of tiles in the lane

Returns
statistics summarizing the cluster count of tiles in the lane
const metric_stat_t& cluster_count_pf ( ) const
inline

Get statistics summarizing the passing filter cluster count of tiles in the lane

Returns
statistics summarizing the passing filter cluster count of tiles in the lane
const metric_stat_t& density ( ) const
inline

Get statistics summarizing the density of tiles in the lane (in clusters per mm2)

Returns
statistics summarizing the density of tiles in the lane
const metric_stat_t& density_pf ( ) const
inline

Get statistics summarizing the passing filter density of tiles in the lane (in clusters per mm2)

Returns
statistics summarizing the passing filter density of tiles in the lane
const metric_stat_t& error_rate ( ) const
inline

Get statistics summarizing the PhiX error rate of tiles in the lane over all usable cycles

A "usable cycle" is a cycle that is fully corrected, so the last cycle of a read is excluded.

Returns
statistics summarizing the PhiX error rate of tiles in the lane over all usable cycles
const metric_stat_t& error_rate_100 ( ) const
inline

Get statistics summarizing the PhiX error rate over the first 100 usable cycles of tiles in the lane

A "usable cycle" is a cycle that is fully corrected, so the last cycle of a read is excluded.

Returns
statistics summarizing the PhiX error rate over the first 100 usable cycles of tiles in the lane
const metric_stat_t& error_rate_35 ( ) const
inline

Get statistics summarizing the PhiX error rate over the first 35 usable cycles of tiles in the lane

A "usable cycle" is a cycle that is fully corrected, so the last cycle of a read is excluded.

Returns
statistics summarizing the PhiX error rate over the first 35 usable cycles of tiles in the lane
const metric_stat_t& error_rate_50 ( ) const
inline

Get statistics summarizing the PhiX error rate over the first 50 usable cycles of tiles in the lane

A "usable cycle" is a cycle that is fully corrected, so the last cycle of a read is excluded.

Returns
statistics summarizing the PhiX error rate over the first 50 usable cycles of tiles in the lane
const metric_stat_t& error_rate_75 ( ) const
inline

Get statistics summarizing the PhiX error rate over the first 75 usable cycles of tiles in the lane

A "usable cycle" is a cycle that is fully corrected, so the last cycle of a read is excluded.

Returns
statistics summarizing the PhiX error rate over the first 75 usable cycles of tiles in the lane
const metric_stat_t& first_cycle_intensity ( ) const
inline

Get statistics summarizing the first cycle intensity of tiles in the lane

Returns
statistics summarizing the first cycle intensity of tiles in the lane
const metric_stat_t& percent_aligned ( ) const
inline

Get statistics summarizing the PhiX percent aligned of tiles in the lane

Returns
statistics summarizing the PhiX percent aligned of tiles in the lane
float percent_gt_q30 ( ) const
inline

Get the percent of bases greater than or equal to Q30 over all usable cycles

A "usable cycle" is a cycle that is fully corrected, so the last cycle of a read is excluded.

Returns
percent of bases greater than or equal to Q30 over all usable cycles
const metric_stat_t& percent_occupied ( ) const
inline

Get mean summarizing the percent occupied

Returns
statistics summarizing the percent occupied
const metric_stat_t& percent_pf ( ) const
inline

Get statistics summarizing the percent of clusters passing filter of tiles in the lane

Returns
statistics summarizing the percent of clusters passing filter of tiles in the lane
const metric_stat_t& phasing ( ) const
inline

Get statistics summarizing the phasing of tiles in the lane

Returns
statistics summarizing the phasing of tiles in the lane
const metric_stat_t& phasing_offset ( ) const
inline

Get statistics summarizing the phasing offset

Returns
statistics summarizing the offset of the best fit line of phasing weight vs cycle
const metric_stat_t& phasing_slope ( ) const
inline

Get statistics summarizing the phasing slope

Returns
statistics summarizing the slope of the best fit line of phasing weight vs cycle
const metric_stat_t& prephasing ( ) const
inline

Get statistics summarizing the prephasing of tiles in the lane

Returns
statistics summarizing the prephasing of tiles in the lane
const metric_stat_t& prephasing_offset ( ) const
inline

Get statistics summarizing the prephasing offset

Returns
statistics summarizing the offset of the best fit line of prephasing weight vs cycle
const metric_stat_t& prephasing_slope ( ) const
inline

Get statistics summarizing the prephasing slope

Returns
statistics summarizing the slope of the best fit line of prephasing weight vs cycle
float projected_yield_g ( ) const
inline

Get the projected yield of the run in gigabases over all usable cycles

A "usable cycle" is a cycle that is fully corrected, so the last cycle of a read is excluded.

Returns
projected yield of the run in gigabases over all usable cycles
uint64_t reads ( ) const
inline

Get the total number of clusters in the lane

Returns
total number of clusters in the lane
uint64_t reads_pf ( ) const
inline

Get the total number of clusters passing filter in the lane

Returns
total number of clusters passing filter in the lane
float yield_g ( ) const
inline

Get the yield of the run in gigabases over all usable cycles

A "usable cycle" is a cycle that is fully corrected, so the last cycle of a read is excluded.

Returns
yield of the run in gigabases over all usable cycles