generic_layout< image_metric, 1 > Struct Template Reference

Inheritance diagram for generic_layout< image_metric, 1 >:

Public Types
typedef layout::base_cycle_metric< ::uint16_t >	metric_id_t
typedef generic_layout< image_metric, 1 >	record_t
typedef ::uint16_t	channel_t
typedef ::uint16_t	contrast_t
Public Types inherited from default_layout< 1, 1 >
enum
typedef ::uint8_t	record_size_t
typedef ::uint8_t	version_t

Static Public Member Functions
template<class Metric , class Header >
static std::streamsize	map_stream (std::istream &stream, Metric &metric, Header &, const bool)
template<class Metric , class Header >
static std::streamsize	map_stream (std::ostream &stream, Metric &metric, Header &, const bool)
template<class Metric , class Header >
static std::streamsize	map_stream (const char *, const Metric &, const Header &, const bool)
static record_size_t	compute_size (const image_metric::header_type &)
static record_size_t	compute_header_size (const image_metric::header_type &)
static size_t	compute_buffer_size (const model::metric_base::metric_set< image_metric > &metric_set)
Static Public Member Functions inherited from default_layout< 1, 1 >
static std::streamsize	map_stream_for_header (Stream &, Header &)
static RecordSize	map_stream_record_size (Stream &stream, RecordSize record_size)
static bool	skip_metric (const Metric &metric)
static bool	is_valid (const LayoutId &id)

Public Attributes
channel_t	channel
contrast_t	min_contrast
contrast_t	max_contrast

Detailed Description

template<>
struct illumina::interop::io::generic_layout< image_metric, 1 >

Image Metric Record Layout Version 1

This class provides an interface to reading the image metric file:

• InterOp/ImageMetrics.bin
• InterOp/ImageMetricsOut.bin

The class takes two template arguments:

 1. Metric Type: image_metric
 2. Version: 1

Member Typedef Documentation

typedef ::uint16_t channel_t

Channel type

typedef ::uint16_t contrast_t

Contrast type

typedef layout::base_cycle_metric< ::uint16_t > metric_id_t

Metric ID type

typedef generic_layout<image_metric, 1> record_t

Record type

Member Function Documentation

static size_t compute_buffer_size ( const model::metric_base::metric_set< image_metric > &  metric_set )

inlinestatic

Compute the buffer size

Parameters

metric_set

set of metrics

Returns

buffer size for entire metric set

static record_size_t compute_header_size ( const image_metric::header_type &  )

inlinestatic

Compute header size

Returns

header size

static record_size_t compute_size ( const image_metric::header_type &  )

inlinestatic

Compute the size of a single metric record

Returns

record size

static std::streamsize map_stream ( std::istream &  stream, Metric &  metric, Header &  , const bool    )

inlinestatic

Read metric from the input stream

Parameters

stream	input stream
metric	destination metric

Returns

number of bytes read or total number of bytes written

static std::streamsize map_stream ( std::ostream &  stream, Metric &  metric, Header &  , const bool    )

inlinestatic

Write metric to the output stream

Parameters

stream	output stream
metric	source metric

Returns

number of bytes read or total number of bytes written

static std::streamsize map_stream ( const char *  , const Metric &  , const Header &  , const bool    )

inlinestatic

Throws an unimplemented error

Member Data Documentation

channel_t channel

Channel

contrast_t max_contrast

Maximum contrast

contrast_t min_contrast

Minimum contrast

---

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

• /io/src/interop/model/metrics/image_metric.cpp