q_score_header Class Reference

#include <q_metric.h>

Inheritance diagram for q_score_header:

Public Types
enum	{ MAX_Q_BINS = 50 }
typedef std::vector< q_score_bin >	qscore_bin_vector_type
typedef q_score_bin	bin_t
Public Types inherited from base_cycle_metric_header
typedef constants::base_cycle_t	base_t

Public Member Functions
	q_score_header ()
	q_score_header (const qscore_bin_vector_type &bins)
const q_score_bin &	bin_at (const size_t n) const INTEROP_THROW_SPEC((model
const qscore_bin_vector_type &	get_bins () const
qscore_bin_vector_type &	bins ()
size_t	bin_count () const
size_t	q_val_count () const
size_t	index_for_q_value (const size_t qval) const
size_t	binCount () const
const q_score_bin &	binAt (const size_t n) const
void	clear ()
Public Member Functions inherited from base_cycle_metric_header
	base_cycle_metric_header ()
base_metric::uint_t	max_cycle () const
void	clear ()

Static Public Member Functions
static q_score_header	default_header ()
Static Public Member Functions inherited from base_cycle_metric_header
static base_cycle_metric_header	default_header ()

Protected Attributes
qscore_bin_vector_type	m_qscore_bins

Friends
template<class MetricType , int Version>
struct	io::generic_layout

Additional Inherited Members
Protected Member Functions inherited from base_cycle_metric_header
template<class Metric >
void	update_max_cycle (const Metric &metric)

Detailed Description

Header information for writing an image metric set

Member Typedef Documentation

typedef q_score_bin bin_t

Q-score bin type

typedef std::vector<q_score_bin> qscore_bin_vector_type

Vector of q-scores type

Member Enumeration Documentation

anonymous enum

Enumerator
MAX_Q_BINS	Maximum number of q-score bins

Constructor & Destructor Documentation

q_score_header ( )

inline

Constructor

q_score_header ( const qscore_bin_vector_type &  bins )

inline

Constructor

Parameters

bins	q-score bin vector

Member Function Documentation

const q_score_bin& binAt ( const size_t  n ) const

inline

Get a q-score bin

Deprecated:

Will be removed in 1.1.x (use bin_at instead)

Returns

q-score bin

size_t binCount ( ) const

inline

Get the number of bins in header

Deprecated:

Will be removed in 1.1.x (use bin_count instead)

Returns

number of bins in header

void clear ( )

inline

Clear the data

static q_score_header default_header ( )

inlinestatic

Generate a default header

Returns

default header

Friends And Related Function Documentation

friend struct io::generic_layout

friend

Member Data Documentation

qscore_bin_vector_type m_qscore_bins

protected

Q-score bins

---

The documentation for this class was generated from the following file:

• /io/interop/model/metrics/q_metric.h