Corrected Intensity Metrics

Functions

ushort_t average_cycle_intensity () const
 
ushort_t corrected_int_all (const constants::dna_bases index) const INTEROP_THROW_SPEC((model
 
float corrected_int_all_float (const constants::dna_bases index) const INTEROP_THROW_SPEC((model
 
float corrected_int_called (const constants::dna_bases index) const INTEROP_THROW_SPEC((model
 
const uint_array_t & called_counts_array () const
 
const float_array_t & corrected_int_called_array () const
 
const ushort_array_t & corrected_int_all_array () const
 
uint_t called_counts (const constants::dna_bases index) const INTEROP_THROW_SPEC((model
 
uint_t no_calls () const
 
float signal_to_noise () const
 
uint_t total_calls (const bool nocalls=false) const
 
uint_t total_intensity () const
 
float total_called_intensity () const
 
float percent_base (const constants::dna_bases index) const INTEROP_THROW_SPEC((model
 
float_array_t percent_bases () const
 
float percent_nocall () const INTEROP_THROW_SPEC((model
 

Detailed Description

Per tile per cycle per channel average intensity values

See full class description

Function Documentation

ushort_t average_cycle_intensity ( ) const
inline

Average intensity over all clusters

Note
Supported version 2, not supported by 3 or later
Returns
average intensity
uint_t called_counts ( const constants::dna_bases  index) const
inline

Number of clusters called per called base (including No Calls)

This member accumulates cluster counts over all four bases and no calls (NC). This is used to calculate the percentage of clusters for which the selected base has been called.

Note
Supported by all versions
Parameters
indexindex of the base (NC=-1, A=0, C=1, G=2, T=3)
Returns
number of clusters called per base
const uint_array_t& called_counts_array ( ) const
inline

Number of clusters called per called base (including No Calls)

Returns
vector of called counts
ushort_t corrected_int_all ( const constants::dna_bases  index) const
inline

Average corrected intensity for each type of base: A, C, G and T

Note
Supported version 2, not supported by 3 or later
Parameters
indexindex of the base (A=0, C=1, G=2, T=3)
Returns
average corrected intensity for specified base
const ushort_array_t& corrected_int_all_array ( ) const
inline

Average corrected intensity for each type of base: A, C, G and T

Note
Supported version 2, not supported by 3 or later
Returns
vector of corrected called intensities
float corrected_int_all_float ( const constants::dna_bases  index) const
inline

Average corrected intensity for each type of base: A, C, G and T

Note
Supported version 2, not supported by 3 or later
Parameters
indexindex of the base (A=0, C=1, G=2, T=3)
Returns
average corrected intensity for specified base
float corrected_int_called ( const constants::dna_bases  index) const
inline

Average corrected intensity for only base called clusters: A, C, G and T

Note
Supported by versions 2 and 3, not later
Parameters
indexindex of the base (A=0, C=1, G=2, T=3)
Returns
average corrected intensity over only base called clusters
const float_array_t& corrected_int_called_array ( ) const
inline

Average corrected intensity for only base called clusters: A, C, G and T

Note
Supported by versions 2 and 3, not later
Returns
vector of corrected called intensities
uint_t no_calls ( ) const
inline

Number of clusters per no call

Note
Supported by all versions
Returns
number of clusters not called
float percent_base ( const constants::dna_bases  index) const
inline

Get the percentage per base

Note
Supported by all versions
Parameters
indexindex of the base (NC=-1, A=0, C=1, G=2, T=3)
Returns
percentage for given base
float_array_t percent_bases ( ) const
inline

Get the percentage per base (does not include no calls)

Note
Supported by all versions
Returns
percentage for given base
float percent_nocall ( ) const
inline

Get the percentage of no calls

Note
Supported by all versions
Returns
percentage for no calls
float signal_to_noise ( ) const
inline

The signal to noise ratio is calculated as mean called intensity divided by standard deviation of non called intensities.

Note
Only supported by version 2, not supported by version 3 or later
Returns
signal to noise calculated from mean called intensity
float total_called_intensity ( ) const
inline

Get the total summed intensity for only called clusters

Note
Supported by versions 2 and 3, not later
Returns
total summed intensity
uint_t total_calls ( const bool  nocalls = false) const
inline

Get the total number of clusters called

Note
Supported by all versions
Parameters
nocallsif true include no calls
Returns
total number of clusters called
uint_t total_intensity ( ) const
inline

Get the total summed intensity for all clusters

Note
Supported version 2, not supported by 3 or later
Returns
total summed intensity