image_metric_header Class Reference

#include <image_metric.h>

Inheritance diagram for image_metric_header:

Public Types
enum	{ MAX_CHANNELS = 4 }
typedef ::uint16_t	ushort_t
Public Types inherited from base_cycle_metric_header
typedef constants::base_cycle_t	base_t

Public Member Functions
	image_metric_header (ushort_t channel_count)
ushort_t	channelCount () const
ushort_t	channel_count () const
void	channel_count (const size_t channel_count)
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 image_metric_header	default_header ()
Static Public Member Functions inherited from base_cycle_metric_header
static base_cycle_metric_header	default_header ()

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 ::uint16_t ushort_t

Unsigned int16_t

Member Enumeration Documentation

anonymous enum

Enumerator
MAX_CHANNELS	Maximum number of channels supported

Constructor & Destructor Documentation

image_metric_header ( ushort_t  channel_count )

inline

Constructor

Parameters

channel_count

number of channels

Member Function Documentation

ushort_t channel_count ( ) const

inline

Number of channels

Returns

number of channels

void channel_count ( const size_t  channel_count )

inline

Trim channel count

Parameters

channel_count

number of channels

ushort_t channelCount ( ) const

inline

Number of channels

Deprecated:

Use channel_count() instead

Returns

number of channels

void clear ( )

inline

Clear the data

static image_metric_header default_header ( )

inlinestatic

Generate a default header

Returns

default header

Friends And Related Function Documentation

friend struct io::generic_layout

friend

---

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

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