| The Gaudi Framework v32r1 (f65d50dc)

Enumerations | Functions
Gaudi::Utils::Histos::Formats Namespace Reference

The 15 format fields are predefined now: More...

## Enumerations
enum | Format { Default = 0, Old, Full, FullStat, Stat, StatOnly, Stat1, ShapeOnly, Shape, LineTitle, LineOnly, PathTitle }
| the ID for predefined formats More...

## Functions
GAUDI_API std::string | format (const int ID=Default)
| get the format by enum More...
GAUDI_API std::string | header (const int ID=Default)
| get the recommended header by enum More...

## Detailed Description

The 15 format fields are predefined now:

- 1 : the histogram path in transient store (without '/stat/')
- 2 : the histogram title
- 3 : number of ALL entries
- 4 : number of UNDERFLOW entries
- 5 : number of OVERFLOW entries
- 6 : the statistics of equivalent entries
- 7 : the full integral in range
- 8 : mean value
- 9 : the estimated uncertainty in the mean value
- 10 : rms value
- 11 : the estimated uncertainty in the rms value
- 12 : skewness value
- 13 : the estimated uncertainty in the skewness value
- 14 : kurtosis value
- 15 : the estimated uncertainty in the kurtosis value
- 16 : full intergal (in and out-range)
- 17 : error on the full intergal (16)
- 18 : error on the full intergal in range (7)
- 19 : fraction of overflow entries [%]
- 20 : (binomial) error on fraction of overflow entries [%]
- 21 : fraction of underflow entries [%]
- 22 : (binomial) error on fraction of underflow entries [%]
- 23 : fraction of overflow integral
- 24 : error on fraction of overflow integral
- 25 : fraction of underflow integral
- 26 : error on fraction of underflow integral

See also
  Gauid::Utils::HistoStats

Unlike parameters 3-7 & 16-19, the parameters 8-15 and 19-26 are sensitive only to the shape of the distribution.

Simple collection of predefiend formats for the histogram

Author
  Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yed.e.nosp@m.du

Date
  2007-08-07

## Enumeration Type Documentation

## ◆ Format

enum Gaudi::Utils::Histos::Formats::Format

the ID for predefined formats

- Default : the default format
- Old : the old-style format (title,integra,entries,mean,rms)
- Full : FULL information (all 15 predefiend values)
- FullStat : FULL statistical information (all 13 statistical values)
- Stat : title, #entries,mean, rms, skewness&kurtosis
- StatOnly : #entries,mean, rms, skewness&kurtosis
- Stat1 : #entries,mean+-, rms+-, skewness+-&kurtosis+-
- ShapeOnly : mean,rms,skewness,kurtosis,underflow&overflow fractions
- Shape : as ShapeOnly but with errors
- LineTitle : line-format title, mean,rms,skewness&kurtosis
- LineOnly : line-format mean,rms,skewness&kurtosis
- PathTitle : path & title

Enumerator
Default |
Old |
Full |
FullStat |
Stat |
StatOnly |
Stat1 |
ShapeOnly |
Shape |
LineTitle |
LineOnly |
PathTitle |

Definition at line 85 of file HistoTableFormat.h.

85 {
86 Default = 0, // default format
87 Old, // "OLD"-line format: title,integral,#ent,mean,rms
88 Full, // FULL format: the first 15 positions
89 FullStat, // Full statistical info (3-15)
90 Stat, // title,#ent,mean,rms,skewness&kurtosis
91 StatOnly, // #entries,mean,rms,skewness&kurtosis
92 Stat1, // #entries,mean+-,rms+-,skewness+-&kurtosis+-
93 ShapeOnly, // mean,rms,skewness,kurtosis,underflow&overflow fractions
94 Shape, // as ShapeOnly but with errors
95 LineTitle, // line-format : title,mean,rms,skewness&kurtosis
96 LineOnly, // line-format : mean,rms,skewness&kurtosis
97 PathTitle // "PathTitle" : path & title
98 };
Gaudi::Utils::Histos::Formats::Stat
Definition: HistoTableFormat.h:90
Gaudi::Utils::Histos::Formats::Old
Definition: HistoTableFormat.h:87
Gaudi::Utils::Histos::Formats::LineOnly
Definition: HistoTableFormat.h:96
Gaudi::Utils::Histos::Formats::Full
Definition: HistoTableFormat.h:88
Gaudi::Utils::Histos::Formats::PathTitle
Definition: HistoTableFormat.h:97
Gaudi::Utils::Histos::Formats::Shape
Definition: HistoTableFormat.h:94
Gaudi::Utils::Histos::Formats::Default
Definition: HistoTableFormat.h:86
Gaudi::Utils::Histos::Formats::LineTitle
Definition: HistoTableFormat.h:95
Gaudi::Utils::Histos::Formats::ShapeOnly
Definition: HistoTableFormat.h:93
Gaudi::Utils::Histos::Formats::Stat1
Definition: HistoTableFormat.h:92
Gaudi::Utils::Histos::Formats::FullStat
Definition: HistoTableFormat.h:89
Gaudi::Utils::Histos::Formats::StatOnly
Definition: HistoTableFormat.h:91

## Function Documentation

## ◆ format()

std::string Gaudi::Utils::Histos::Formats::format | ( | const int | ID = `Default` | ) |

get the format by enum

See also
  Gaudi::Utils::Histos::Formats::Format

Parameters

  ID | the format idenfifier

Returns
  format associated with ID

Author
  Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date
  2007-08-08

default:

Definition at line 154 of file HistoTableFormat.cpp.

154 {
155 switch ( ID ) {
156 case Old:
157 return s_histoFormatOld;
158 case Full:
159 return s_histoFormatFull;
160 case FullStat:
161 return s_histoFormatFullStat;
162 case Stat:
163 return s_histoFormatStat;
164 case StatOnly:
165 return s_histoFormatStatOnly;
166 case Stat1:
167 return s_histoFormatStat1;
168 case ShapeOnly:
169 return s_histoFormatShapeOnly;
170 case Shape:
171 return s_histoFormatShape;
172 case LineTitle:
173 return s_histoFormatLineTitle;
174 case LineOnly:
175 return s_histoFormatLineOnly;
176 case PathTitle:
177 return s_histoFormatPathTitle;
178 default:
179 break;
180 }
182 return s_histoFormatStat;
183 }
Gaudi::Utils::Histos::Formats::Stat
Definition: HistoTableFormat.h:90
Gaudi::Utils::Histos::Formats::Old
Definition: HistoTableFormat.h:87
Gaudi::Utils::Histos::Formats::LineOnly
Definition: HistoTableFormat.h:96
Gaudi::Utils::Histos::Formats::Full
Definition: HistoTableFormat.h:88
Gaudi::Utils::Histos::Formats::PathTitle
Definition: HistoTableFormat.h:97
Gaudi::Utils::Histos::Formats::Shape
Definition: HistoTableFormat.h:94
Gaudi::Utils::Histos::Formats::LineTitle
Definition: HistoTableFormat.h:95
Gaudi::Utils::Histos::Formats::ShapeOnly
Definition: HistoTableFormat.h:93
Gaudi::Utils::Histos::Formats::Stat1
Definition: HistoTableFormat.h:92
Gaudi::Utils::Histos::Formats::FullStat
Definition: HistoTableFormat.h:89
Gaudi::Utils::Histos::Formats::StatOnly
Definition: HistoTableFormat.h:91

## ◆ header()

std::string Gaudi::Utils::Histos::Formats::header | ( | const int | ID = `Default` | ) |

get the recommended header by enum

See also
  Gaudi::Utils::Histos::Formats::Format

Parameters

  ID | the format idenfifier

Returns
  header associated with ID

Author
  Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date
  2007-08-08

default:

Definition at line 187 of file HistoTableFormat.cpp.

187 {
188 switch ( ID ) {
189 case Old:
190 return s_histoFormatOldHeader;
191 case Full:
192 return s_histoFormatFullHeader;
193 case FullStat:
194 return s_histoFormatFullStatHeader;
195 case Stat:
196 return s_histoFormatStatHeader;
197 case Stat1:
198 return s_histoFormatStat1Header;
199 case StatOnly:
200 return s_histoFormatStatOnlyHeader;
201 case ShapeOnly:
202 return s_histoFormatShapeOnlyHeader;
203 case Shape:
204 return s_histoFormatShapeHeader;
205 case LineTitle:
206 return s_histoFormatLineTitleHeader;
207 case LineOnly:
208 return s_histoFormatLineOnlyHeader;
209 case PathTitle:
210 return s_histoFormatPathTitleHeader;
211 default:;
212 }
214 return s_histoFormatStatHeader;
215 }
Gaudi::Utils::Histos::Formats::Stat
Definition: HistoTableFormat.h:90
Gaudi::Utils::Histos::Formats::Old
Definition: HistoTableFormat.h:87
Gaudi::Utils::Histos::Formats::LineOnly
Definition: HistoTableFormat.h:96
Gaudi::Utils::Histos::Formats::Full
Definition: HistoTableFormat.h:88
Gaudi::Utils::Histos::Formats::PathTitle
Definition: HistoTableFormat.h:97
Gaudi::Utils::Histos::Formats::Shape
Definition: HistoTableFormat.h:94
Gaudi::Utils::Histos::Formats::LineTitle
Definition: HistoTableFormat.h:95
Gaudi::Utils::Histos::Formats::ShapeOnly
Definition: HistoTableFormat.h:93
Gaudi::Utils::Histos::Formats::Stat1
Definition: HistoTableFormat.h:92
Gaudi::Utils::Histos::Formats::FullStat
Definition: HistoTableFormat.h:89
Gaudi::Utils::Histos::Formats::StatOnly
Definition: HistoTableFormat.h:91