Enumerated constants

Enumerations

enum  common { Unknown = 0x800 }
 
enum  metric_type {
  Intensity, FWHM, BasePercent, PercentNoCall,
  Q20Percent, Q30Percent, AccumPercentQ20, AccumPercentQ30,
  QScore, Clusters, ClustersPF, ClusterCount,
  ClusterCountPF, ErrorRate, PercentPhasing, PercentPrephasing,
  PercentAligned, Phasing, PrePhasing, CorrectedIntensity,
  CalledIntensity, SignalToNoise, OccupiedCountK, PercentOccupied,
  PercentPF, MetricTypeCount, UnknownMetricType = 0x800
}
 
enum  metric_group {
  CorrectedInt, Error, Extraction, Image,
  Index, Q, Tile, QByLane,
  QCollapsed, EmpiricalPhasing, DynamicPhasing, ExtendedTile,
  SummaryRun, MetricCount, UnknownMetricGroup = 0x800
}
 
enum  tile_naming_method {
  FourDigit, FiveDigit, Absolute, TileNamingMethodCount,
  UnknownTileNamingMethod = 0x800
}
 
enum  dna_bases {
  NC = -1, A, C, G,
  T, NUM_OF_BASES, NUM_OF_BASES_AND_NC, UnknownBase = 0x800
}
 
enum  surface_type { SentinelSurface, Top, Bottom, UnknownSurface = 0x800 }
 
enum  instrument_type {
  HiSeq, HiScan, MiSeq, NextSeq,
  MiniSeq, NovaSeq, iSeq, NextSeq1k2k,
  InstrumentCount, UnknownInstrument = 0x800
}
 
enum  metric_base_type {
  BaseTileType, BaseCycleType, BaseReadType, BaseLaneType,
  BaseRunType, BaseMetricCount, UnknownBaseType = 0x800
}
 
enum  plot_colors {
  Red, Green, Blue, Black,
  PlotColorCount, UnknownColor = 0x800
}
 
enum  bar_plot_options { Centered, Shifted, UnknownBarPlotOption = 0x800 }
 
enum  metric_data {
  IdType, ValueType, StructType, ChannelArray,
  BaseArray, MetricDataCount, UnknownMetricData = 0x800
}
 
enum  metric_feature_type {
  TileFeature = 0x01, CycleFeature = 0x02, ReadFeature = 0x04, BaseFeature = 0x08,
  ChannelFeature = 0x10, LaneFeature = 0x20, DiskFeature = 0x400, UnknownMetricFeature = 0x800
}
 
enum  plot_types {
  FlowcellPlot, ByCyclePlot, ByLanePlot, QHistogramPlot,
  QHeatmapPlot, SampleQCPlot, UnknownPlotType = 0x800
}
 

Detailed Description

Enumerated constants

See full class description

Enumeration Type Documentation

enum bar_plot_options

Options for a bar plot

Enumerator
Centered 

Bar centered on x-value

Shifted 

Bar shifted to start on x-value

UnknownBarPlotOption 
enum common

Common codes for all enums

Enumerator
Unknown 
enum dna_bases

DNA base constants

Enumerator
NC 

No calls

DNA base adenine

DNA base cytosine

DNA base guanine

DNA base thymine

NUM_OF_BASES 

Number of bases

NUM_OF_BASES_AND_NC 

Number of bases including no calls

UnknownBase 

Unknown base

enum instrument_type

Instrument type

Enumerator
HiSeq 
HiScan 
MiSeq 
NextSeq 
MiniSeq 
NovaSeq 
iSeq 
NextSeq1k2k 
InstrumentCount 
UnknownInstrument 
enum metric_base_type

Base types for each metric

Enumerator
BaseTileType 

Tile base types are written out once for each tile

BaseCycleType 

Cycle base types are written out once for each tile and cycle

BaseReadType 

Read base types are written out once for each tile and read

BaseLaneType 

Lane base types are written out once for each lane and cycle

BaseRunType 

Run base types are written out once per run

BaseMetricCount 
UnknownBaseType 
enum metric_data

Options for a bar plot

Enumerator
IdType 
ValueType 
StructType 
ChannelArray 
BaseArray 
MetricDataCount 
UnknownMetricData 
enum metric_feature_type

Options describing metric features

Enumerator
TileFeature 
CycleFeature 
ReadFeature 
BaseFeature 
ChannelFeature 
LaneFeature 
DiskFeature 
UnknownMetricFeature 
enum metric_group

Codes for each metric group

Enumerator
CorrectedInt 
Error 
Extraction 
Image 
Index 
Tile 
QByLane 
QCollapsed 
EmpiricalPhasing 
DynamicPhasing 
ExtendedTile 
SummaryRun 
MetricCount 
UnknownMetricGroup 
enum metric_type

Codes for each metric type

Enumerator
Intensity 
FWHM 
BasePercent 
PercentNoCall 
Q20Percent 
Q30Percent 
AccumPercentQ20 
AccumPercentQ30 
QScore 
Clusters 
ClustersPF 
ClusterCount 
ClusterCountPF 
ErrorRate 
PercentPhasing 
PercentPrephasing 
PercentAligned 
Phasing 
PrePhasing 
CorrectedIntensity 
CalledIntensity 
SignalToNoise 
OccupiedCountK 
PercentOccupied 
PercentPF 
MetricTypeCount 
UnknownMetricType 
enum plot_colors

Color codes for plotting

Enumerator
Red 

Color for red channel (or A)

Green 

Color for green channel or (C)

Blue 

Color for G

Black 

Color for T

PlotColorCount 
UnknownColor 
enum plot_types

Options for a bar plot

Enumerator
FlowcellPlot 

Spatial plot by tile

ByCyclePlot 

Plot data aggrergated by cycle

ByLanePlot 

Spatial plot aggrergated by lane

QHistogramPlot 

Histogram of q-scores

QHeatmapPlot 

Heatmap of q-scores by cycle

SampleQCPlot 

Indexing tab plot

UnknownPlotType 

Unknown plot type

enum surface_type

Flow cell surface code

Enumerator
SentinelSurface 
Top 
Bottom 
UnknownSurface 
enum tile_naming_method

Tile naming conventions used in various Illumina Platforms

Enumerator
FourDigit 

Four digit tiles for HiSeq and modern MiSeqs

FiveDigit 

Five digit tiles for NextSeq and ...

Absolute 

Absolute naming for tiles GAs and old MiSeqs

TileNamingMethodCount 

Number of naming methods

UnknownTileNamingMethod