Modules

 Index Count Summary
 

Functions

index_count_summary & operator[] (const size_type n) INTEROP_THROW_SPEC((model
 
const index_count_summary & operator[] (const size_t n) const INTEROP_THROW_SPEC((model
 
index_count_summary & at (const size_t n) INTEROP_THROW_SPEC((model
 
const_reference at (const size_type n) const INTEROP_THROW_SPEC((model
 
read_count_t total_reads () const
 
read_count_t total_pf_reads () const
 
float total_fraction_mapped_reads () const
 
float mapped_reads_cv () const
 
float min_mapped_reads () const
 
float max_mapped_reads () const
 

Detailed Description

Information used in the SAV Indexing Tab

See full class description

Function Documentation

index_count_summary& at ( const size_t  n)
inline

Get reference to lane summary at given index

Deprecated:
Will be removed in next feature version (use operator[] instead for C++ Code)
Parameters
nindex
Returns
reference to lane summary
const_reference at ( const size_type  n) const
inline

Get constant reference to lane summary at given index

Deprecated:
Will be removed in next feature version (use operator[] instead for C++ Code)
Parameters
nindex
Returns
constant reference to lane summary
float mapped_reads_cv ( ) const
inline

Coefficient of variation of the mapped reads

This is a measure of relative variability

Returns
coefficient of variation of the mapped reads
float max_mapped_reads ( ) const
inline

Maximum of the mapped reads

Returns
maximum of the mapped reads
float min_mapped_reads ( ) const
inline

Minimum of the mapped reads

Returns
minimum of the mapped reads
index_count_summary& operator[] ( const size_type  n)
inline

Get reference to lane summary at given index

Note, in Python, C#, etc, this is converted to .at(index)

Parameters
nindex
Returns
reference to lane summary
const index_count_summary& operator[] ( const size_t  n) const
inline

Get constant reference to lane summary at given index

Note, in Python, C#, etc, this is converted to .at(index)

Parameters
nindex
Returns
constant reference to lane summary
float total_fraction_mapped_reads ( ) const
inline

Total fraction of mapped reads (this is stored as a percent)

Displayed as % Reads Identified (PF) in SAV

Returns
total fraction of mapped reads
read_count_t total_pf_reads ( ) const
inline

Total PF reads

Returns
total PF reads
read_count_t total_reads ( ) const
inline

Total Reads

Returns
total reads