Public Types | Static Public Member Functions | List of all members
text_layout< image_metric, 1 > Struct Template Reference

Public Types

typedef image_metric::header_type header_type
 

Static Public Member Functions

static size_t write_header (std::ostream &out, const header_type &header, const std::vector< std::string > &channel_names, const char sep, const char eol)
 
static size_t write_metric (std::ostream &out, const image_metric &metric, const header_type &header, const char sep, const char eol, const char)
 

Detailed Description

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

Image Metric CSV text format

This class provide an interface for writing the image metrics to a CSV file:

  • ImageMetrics.csv

Member Typedef Documentation

typedef image_metric::header_type header_type

Define a header type

Member Function Documentation

static size_t write_header ( std::ostream &  out,
const header_type &  header,
const std::vector< std::string > &  channel_names,
const char  sep,
const char  eol 
)
inlinestatic

Write header to the output stream

Parameters
outoutput stream
headerimage metric header
channel_nameslist of channel names
sepcolumn separator
eolrow separator
Returns
number of column headers
static size_t write_metric ( std::ostream &  out,
const image_metric &  metric,
const header_type &  header,
const char  sep,
const char  eol,
const char   
)
inlinestatic

Write a image metric to the output stream

Parameters
outoutput stream
metricimage metric
headerimage metric header
sepcolumn separator
eolrow separator
Returns
number of columns written
The documentation for this struct was generated from the following file: