Run Metrics

Modules
	Corrected Intensity Metrics
	Dynamic Phasing Metrics
	Error Metrics
	Extended Tile Metrics
	Extraction Metrics
	Image Metrics
	Index Metrics
	Phasing Metrics
	Quality Metrics By Lane
	Collapsed Q metrics
	Quality Metrics
	Run distortion metric
	Tile Metrics
	Run Info
	Run Parameters

Classes
class	run_metrics

Functions
void	legacy_channel_update (const constants::instrument_type type)
void	set_naming_method (const constants::tile_naming_method naming_method)
size_t	count_legacy_bins (const size_t legacy_bin_count=std::numeric_limits< size_t >::max()) const
bool	is_run_parameters_required (const size_t legacy_bin_count=std::numeric_limits< size_t >::max()) const
const run::info &	run_info () const
void	run_info (const run::info &info)

Variables
void read(const std::string &run_folder, const size_t thread_count=1) INTEROP_THROW_SPEC((xml void read(const std::string &run_folder, const std::vector< unsigned char > &valid_to_load, const size_t thread_count=1, const bool skip_loaded=false) INTEROP_THROW_SPEC((xml size_t read_xml(const std::string &run_folder) INTEROP_THROW_SPEC((io void read_run_info(const std::string &run_folder) INTEROP_THROW_SPEC((xml size_t read_run_parameters(const std::string &run_folder, const bool force_load=false) INTEROP_THROW_SPEC((io void finalize_after_load(size_t count=std::numeric_limits< size_t >::max()) INTEROP_THROW_SPEC((model bool	empty () const

Detailed Description

All the InterOp data as well as the RunInfo

See full class description

Function Documentation

size_t count_legacy_bins

(

const size_t

legacy_bin_count = std::numeric_limits<size_t>::max()

)

const

Get number of legacy bins

Parameters

legacy_bin_count

known number of bins

Returns

number of legacy bins

bool is_run_parameters_required

(

const size_t

legacy_bin_count = std::numeric_limits<size_t>::max()

)

const

Test whether run parameters must be loaded

This is used to determine channel count and legacy q-score bins

Parameters

legacy_bin_count

known number of bins

Returns

true if run parameters is required

void legacy_channel_update

(

const constants::instrument_type

type

)

Update channels for legacy runs

Parameters

type	instrument type

const run::info& run_info ( ) const

inline

Get information about the run

Returns

run info

void run_info ( const run::info &  info )

inline

Set information about the run

Parameters

info

run info

void set_naming_method

(

const constants::tile_naming_method

naming_method

)

Set the tile naming method

Parameters

naming_method

tile naming method

Variable Documentation

bool empty

Read binary metrics and XML files from the run folder

Note

invalid_run_info_cycle_exception and invalid_tile_list_exception can be safely caught and ignored

Parameters

run_folder	run folder path
thread_count	number of threads to use for network loading Read binary metrics and XML files from the run folder

Note

invalid_run_info_cycle_exception and invalid_tile_list_exception can be safely caught and ignored

Parameters

run_folder	run folder path
valid_to_load	list of metrics to load
thread_count	number of threads to use for network loading
skip_loaded	skip metrics that are already loaded Read XML files: RunInfo.xml and possibly RunParameters.xml
run_folder	run folder path Read RunInfo.xml
run_folder	run folder path Read RunParameters.xml if necessary
run_folder	run folder path
force_load	force loading of run parameters Finalize the metric sets after loading from disk
count	number of bins for legacy q-metrics Test if all metrics are empty

Returns

true if all metrics are empty

Test if all metrics are empty

Returns

true if all metrics are empty