generic_layout< tile_metric, 2 > Struct Template Reference
Inheritance diagram for generic_layout< tile_metric, 2 >:
![](structillumina_1_1interop_1_1io_1_1generic__layout_3_01tile__metric_00_012_01_4.png)
Public Types | |
enum | TileMetricCode { ClusterDensity = 100, ClusterDensityPf = 101, ClusterCount = 102, ClusterCountPf = 103, Phasing = 200, Prephasing = 201, PercentAligned = 300, ControlLane = 400 } |
typedef layout::base_metric< ::uint16_t > | metric_id_t |
typedef generic_layout< tile_metric, 2 > | record_t |
typedef ::uint16_t | code_t |
typedef float | value_t |
![]() | |
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 is_new) |
template<class Metric , class Header > | |
static std::streamsize | map_stream (std::ostream &out, 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 tile_metric::header_type &) |
static record_size_t | compute_header_size (const tile_metric::header_type &) |
static size_t | compute_buffer_size (const model::metric_base::metric_set< tile_metric > &metric_set) |
![]() | |
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 | |
code_t | code |
value_t | value |
Detailed Description
template<>
struct illumina::interop::io::generic_layout< tile_metric, 2 >
Tile Metric Record Layout Version 2
This class provides an interface to reading the tile metric file:
- InterOp/TileMetrics.bin
- InterOp/TileMetricsOut.bin
The class takes two template arguments:
1. Metric Type: tile_metric 2. Version: 2
Member Typedef Documentation
typedef ::uint16_t code_t |
Code type
typedef layout::base_metric< ::uint16_t > metric_id_t |
Metric ID type
typedef generic_layout<tile_metric, 2> record_t |
Record type
typedef float value_t |
Value type
Member Enumeration Documentation
enum TileMetricCode |
Member Function Documentation
|
inlinestatic |
Compute the buffer size
- Parameters
-
metric_set set of metrics
- Returns
- buffer size for entire metric set
|
inlinestatic |
Compute header size
- Returns
- header size
|
inlinestatic |
Compute the size of a single metric record
- Returns
- record size
|
inlinestatic |
Read metric from the input stream
- Parameters
-
stream input stream metric destination metric is_new true if metric is new
- Returns
- number of bytes read or total number of bytes written
|
inlinestatic |
Write metric to the output stream
- Parameters
-
out output stream metric source metric
- Returns
- number of bytes read or total number of bytes written
|
inlinestatic |
Throws an unimplemented error
Member Data Documentation
code_t code |
Tile Metric Code
value_t value |
Tile Metric Value
The documentation for this struct was generated from the following file:
- /io/src/interop/model/metrics/tile_metric.cpp