stat_summary.h
Go to the documentation of this file.
1 
8 #pragma once
9 
10 #include <cstddef>
11 #include <climits>
14 
15 namespace illumina { namespace interop { namespace model { namespace summary
16 {
17 
25  {
26  public:
29  public:
34  stat_summary(const size_t /*channel_count*/) :
35  m_percent_gt_q30(std::numeric_limits<float>::quiet_NaN()),
36  m_yield_g(std::numeric_limits<float>::quiet_NaN()),
37  m_projected_yield_g(0),
38  m_reads(0),
39  m_reads_pf(0),
40  m_percent_occupied(std::numeric_limits<float>::quiet_NaN())
41 
42  {
43  }
44 
45  public:
61  float percent_gt_q30() const
62  {
63  return m_percent_gt_q30;
64  }
65 
72  float yield_g() const
73  {
74  return m_yield_g;
75  }
76 
83  float projected_yield_g() const
84  {
85  return m_projected_yield_g;
86  }
87 
92  uint64_t reads() const
93  {
94  return m_reads;
95  }
96 
101  uint64_t reads_pf() const
102  {
103  return m_reads_pf;
104  }
105 
106  public:
111  const metric_stat_t &density() const
112  {
113  return m_density;
114  }
115 
120  const metric_stat_t &density_pf() const
121  {
122  return m_density_pf;
123  }
124 
129  const metric_stat_t &cluster_count() const
130  {
131  return m_cluster_count;
132  }
133 
138  const metric_stat_t &cluster_count_pf() const
139  {
140  return m_cluster_count_pf;
141  }
142 
147  const metric_stat_t &percent_pf() const
148  {
149  return m_percent_pf;
150  }
151 
156  const metric_stat_t &phasing() const
157  {
158  return m_phasing;
159  }
160 
165  const metric_stat_t &prephasing() const
166  {
167  return m_prephasing;
168  }
169 
174  const metric_stat_t &percent_aligned() const
175  {
176  return m_percent_aligned;
177  }
178 
185  const metric_stat_t &error_rate() const
186  {
187  return m_error_rate;
188  }
189 
196  const metric_stat_t &error_rate_35() const
197  {
198  return m_error_rate_35;
199  }
200 
207  const metric_stat_t &error_rate_50() const
208  {
209  return m_error_rate_50;
210  }
211 
218  const metric_stat_t &error_rate_75() const
219  {
220  return m_error_rate_75;
221  }
222 
229  const metric_stat_t &error_rate_100() const
230  {
231  return m_error_rate_100;
232  }
233 
238  const metric_stat_t &first_cycle_intensity() const
239  {
240  return m_first_cycle_intensity;
241  }
246  const metric_stat_t &phasing_slope() const
247  {
248  return m_phasing_slope;
249  }
254  const metric_stat_t &phasing_offset() const
255  {
256  return m_phasing_offset;
257  }
262  const metric_stat_t &prephasing_slope() const
263  {
264  return m_prephasing_slope;
265  }
270  const metric_stat_t &prephasing_offset() const
271  {
272  return m_prephasing_offset;
273  }
278  const metric_stat_t &percent_occupied() const
279  {
280  return m_percent_occupied;
281  }
282 
285  public:
290  void percent_gt_q30(const float val)
291  {
292  m_percent_gt_q30 = val;
293  }
298  void yield_g(const float val)
299  {
300  m_yield_g = val;
301  }
306  void projected_yield_g(const float val)
307  {
308  m_projected_yield_g = val;
309  }
314  void reads(const uint64_t val)
315  {
316  m_reads = val;
317  }
322  void reads_pf(const uint64_t val)
323  {
324  m_reads_pf = val;
325  }
330  void density(const metric_stat_t& stat)
331  {
332  m_density = stat;
333  }
338  void density_pf(const metric_stat_t& stat)
339  {
340  m_density_pf = stat;
341  }
346  void cluster_count(const metric_stat_t& stat)
347  {
348  m_cluster_count = stat;
349  }
354  void cluster_count_pf(const metric_stat_t& stat)
355  {
356  m_cluster_count_pf = stat;
357  }
362  void percent_pf(const metric_stat_t& stat)
363  {
364  m_percent_pf = stat;
365  }
370  void phasing(const metric_stat_t& stat)
371  {
372  m_phasing = stat;
373  }
378  void prephasing(const metric_stat_t& stat)
379  {
380  m_prephasing = stat;
381  }
386  void percent_aligned(const metric_stat_t& stat)
387  {
388  m_percent_aligned = stat;
389  }
394  void error_rate(const metric_stat_t& stat)
395  {
396  m_error_rate = stat;
397  }
402  void error_rate_35(const metric_stat_t& stat)
403  {
404  m_error_rate_35 = stat;
405  }
410  void error_rate_50(const metric_stat_t& stat)
411  {
412  m_error_rate_50 = stat;
413  }
418  void error_rate_75(const metric_stat_t& stat)
419  {
420  m_error_rate_75 = stat;
421  }
426  void error_rate_100(const metric_stat_t& stat)
427  {
428  m_error_rate_100 = stat;
429  }
434  void first_cycle_intensity(const metric_stat_t & stat)
435  {
436  m_first_cycle_intensity=stat;
437  }
442  void phasing_slope(const metric_stat_t& stat)
443  {
444  m_phasing_slope = stat;
445  }
450  void phasing_offset(const metric_stat_t& stat)
451  {
452  m_phasing_offset = stat;
453  }
458  void prephasing_slope(const metric_stat_t& stat)
459  {
460  m_prephasing_slope = stat;
461  }
466  void prephasing_offset(const metric_stat_t& stat)
467  {
468  m_prephasing_offset = stat;
469  }
474  void percent_occupied(const metric_stat_t& val)
475  {
476  m_percent_occupied = val;
477  }
478 
479  public:
482  void resize_stat(const size_t)
483  {
484  }
485 
486  private:
487  float m_percent_gt_q30;
488  float m_yield_g;
489  float m_projected_yield_g;
490  uint64_t m_reads;
491  uint64_t m_reads_pf;
492 
493  private:
494  metric_stat_t m_density;
495  metric_stat_t m_density_pf;
496  metric_stat_t m_cluster_count;
497  metric_stat_t m_cluster_count_pf;
498  metric_stat_t m_percent_pf;
499  metric_stat_t m_phasing;
500  metric_stat_t m_prephasing;
501  metric_stat_t m_percent_aligned;
502  metric_stat_t m_error_rate;
503  metric_stat_t m_error_rate_35;
504  metric_stat_t m_error_rate_50;
505  metric_stat_t m_error_rate_75;
506  metric_stat_t m_error_rate_100;
507  metric_stat_t m_first_cycle_intensity;
508  metric_stat_t m_phasing_slope;
509  metric_stat_t m_phasing_offset;
510  metric_stat_t m_prephasing_slope;
511  metric_stat_t m_prephasing_offset;
512  metric_stat_t m_percent_occupied;
513  template<class MetricType, int Version>
514  friend struct io::generic_layout;
515  };
516 
517 }}}}
518 
void reads(const uint64_t val)
Definition: stat_summary.h:314
void percent_occupied(const metric_stat_t &val)
Definition: stat_summary.h:474
const metric_stat_t & cluster_count_pf() const
Definition: stat_summary.h:138
void phasing_offset(const metric_stat_t &stat)
Definition: stat_summary.h:450
Definition: enum_description.h:15
void cluster_count_pf(const metric_stat_t &stat)
Definition: stat_summary.h:354
void reads_pf(const uint64_t val)
Definition: stat_summary.h:322
void cluster_count(const metric_stat_t &stat)
Definition: stat_summary.h:346
const metric_stat_t & error_rate_35() const
Definition: stat_summary.h:196
const metric_stat_t & prephasing() const
Definition: stat_summary.h:165
const metric_stat_t & phasing_slope() const
Definition: stat_summary.h:246
void percent_aligned(const metric_stat_t &stat)
Definition: stat_summary.h:386
metric_stat metric_stat_t
Definition: stat_summary.h:28
void percent_gt_q30(const float val)
Definition: stat_summary.h:290
void density(const metric_stat_t &stat)
Definition: stat_summary.h:330
void phasing_slope(const metric_stat_t &stat)
Definition: stat_summary.h:442
void percent_pf(const metric_stat_t &stat)
Definition: stat_summary.h:362
void error_rate_75(const metric_stat_t &stat)
Definition: stat_summary.h:418
const metric_stat_t & percent_pf() const
Definition: stat_summary.h:147
void error_rate_35(const metric_stat_t &stat)
Definition: stat_summary.h:402
void phasing(const metric_stat_t &stat)
Definition: stat_summary.h:370
void prephasing_offset(const metric_stat_t &stat)
Definition: stat_summary.h:466
float projected_yield_g() const
Definition: stat_summary.h:83
void yield_g(const float val)
Definition: stat_summary.h:298
const metric_stat_t & density() const
Definition: stat_summary.h:111
const metric_stat_t & prephasing_offset() const
Definition: stat_summary.h:270
const metric_stat_t & prephasing_slope() const
Definition: stat_summary.h:262
const metric_stat_t & first_cycle_intensity() const
Definition: stat_summary.h:238
const metric_stat_t & error_rate_50() const
Definition: stat_summary.h:207
void error_rate_50(const metric_stat_t &stat)
Definition: stat_summary.h:410
def summary(run_metrics, level='Total', columns=None, dtype='f4', ignore_missing_columns=True, extra)
Definition: core.py:217
Definition: generic_layout.h:24
void resize_stat(const size_t)
Definition: stat_summary.h:482
void density_pf(const metric_stat_t &stat)
Definition: stat_summary.h:338
void error_rate(const metric_stat_t &stat)
Definition: stat_summary.h:394
const metric_stat_t & percent_occupied() const
Definition: stat_summary.h:278
void first_cycle_intensity(const metric_stat_t &stat)
Definition: stat_summary.h:434
const metric_stat_t & error_rate_75() const
Definition: stat_summary.h:218
float percent_gt_q30() const
Definition: stat_summary.h:61
stat_summary(const size_t)
Definition: stat_summary.h:34
void error_rate_100(const metric_stat_t &stat)
Definition: stat_summary.h:426
const metric_stat_t & phasing_offset() const
Definition: stat_summary.h:254
const metric_stat_t & density_pf() const
Definition: stat_summary.h:120
float yield_g() const
Definition: stat_summary.h:72
const metric_stat_t & percent_aligned() const
Definition: stat_summary.h:174
uint64_t reads() const
Definition: stat_summary.h:92
const metric_stat_t & phasing() const
Definition: stat_summary.h:156
void projected_yield_g(const float val)
Definition: stat_summary.h:306
const metric_stat_t & cluster_count() const
Definition: stat_summary.h:129
const metric_stat_t & error_rate() const
Definition: stat_summary.h:185
uint64_t reads_pf() const
Definition: stat_summary.h:101
void prephasing(const metric_stat_t &stat)
Definition: stat_summary.h:378
const metric_stat_t & error_rate_100() const
Definition: stat_summary.h:229
void prephasing_slope(const metric_stat_t &stat)
Definition: stat_summary.h:458