Tile Metrics

Modules

 Read Metrics
 

Functions

float cluster_density () const
 
float cluster_density_k () const
 
float cluster_density_pf () const
 
float cluster_density_pf_k () const
 
float cluster_count () const
 
float cluster_count_k () const
 
float cluster_count_m () const
 
float cluster_count_pf () const
 
float cluster_count_pf_k () const
 
float cluster_count_pf_m () const
 
float percent_pf () const
 
const read_metric_vector & read_metrics () const
 
float percent_aligned (const size_t n) const
 
float percent_phasing (const size_t n) const
 
float percent_prephasing (const size_t n) const
 
float percent_aligned_at (const size_t number) const
 
float percent_phasing_at (const size_t number) const
 
float percent_prephasing_at (const size_t number) const
 
size_t read_count () const
 
bool is_dead_tile () const
 

Detailed Description

Per tile tile metrics:

  1. Clusters passing filter
  2. Density passing filter
  3. Phasing per read
  4. Prephasing per read
  5. Percent aligned per read

See full class description

See read metrics

Note
All metrics in this class are supported by all versions

Function Documentation

float cluster_count ( ) const
inline

Number of clusters for each tile

Returns
number of clusters
float cluster_count_k ( ) const
inline

Number of kilo-clusters for each tile

Returns
number of kilo-clusters
float cluster_count_m ( ) const
inline

Number of mega-clusters for each tile

Returns
number of mega-clusters
float cluster_count_pf ( ) const
inline

Number of clusters passing filter for each tile

Returns
number of clusters passing filter
float cluster_count_pf_k ( ) const
inline

Number of kilo-clusters passing filter for each tile

Returns
number of kilo-clusters passing filter
float cluster_count_pf_m ( ) const
inline

Number of mega-clusters passing filter for each tile

Returns
number of mega-clusters passing filter
float cluster_density ( ) const
inline

Density of clusters for each tile (in clusters per mm2)

Returns
cluster density
float cluster_density_k ( ) const
inline

Density of clusters for each tile (in kilo-clusters per mm2)

Returns
cluster density in kilo-clusters per mm2
float cluster_density_pf ( ) const
inline

Density of clusters passing filter for each tile (in clusters per mm2)

Returns
cluster density passing filter
float cluster_density_pf_k ( ) const
inline

Density of clusters passing filter for each tile (in kilo-clusters per mm2)

Returns
cluster density passing filter (in kilo-clusters per mm2)
bool is_dead_tile ( ) const
inline

Determine if the tile has no raw or PF clusters

Returns
true if the tile has no raw or PF clusters
float percent_aligned ( const size_t  n) const
inline

Percent aligned for read at specified index

Note
If percent aligned was never estimated, then it will be NaN
Parameters
nindex of read
Returns
percent aligned (or NaN is out of bounds)
float percent_aligned_at ( const size_t  number) const
inline

Percent aligned for read read number

Note
If percent aligned was never estimated, then it will be NaN
Parameters
numbernumber of read
Returns
percent aligned (or NaN is out of bounds)
float percent_pf ( ) const
inline

Percent of clusters passing filter

Returns
percent of clusters passing filter
float percent_phasing ( const size_t  n) const
inline

Percent phasing for read at specified index

Note
Supported only in version 2
Parameters
nindex of read
Returns
percent phasing (or NaN is out of bounds)
float percent_phasing_at ( const size_t  number) const
inline

Percent phasing for read read number

Note
Supported only in version 2
Parameters
numbernumber of read
Returns
percent phasing (or NaN is out of bounds)
float percent_prephasing ( const size_t  n) const
inline

Percent prephasing for read at specified index

Note
Supported only in version 2
Parameters
nindex of read
Returns
percent prephasing (or NaN is out of bounds)
float percent_prephasing_at ( const size_t  number) const
inline

Percent prephasing for read number

Note
Supported only in version 2
Parameters
numbernumber of read
Returns
percent prephasing (or NaN is out of bounds)
size_t read_count ( ) const
inline

Number of reads

Returns
number of reads
const read_metric_vector& read_metrics ( ) const
inline

Metrics for each read on the tile

Returns
vector of metrics for each read