| # Gaudi Framework, version v21r7p1 |

Home |  | Generated: 15 Feb 2010

# 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 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 More...
## Functions
GAUDI_API std::string | format (const int ID=Default)
| get the format by enum
GAUDI_API std::string | header (const int ID=Default)
| get the recommended header by enum

## 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 ibelyaev@physics.syed.edu

Date:
  2007-08-07

## Enumeration Type Documentation

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 90 of file HistoTableFormat.h.

    00091           {
    00092             Default = 0 , // default format
    00093             Old         , // "OLD"-line format: title,integral,#ent,mean,rms
    00094             Full        , // FULL format: the first 15 positions
    00095             FullStat    , // Full statistical info (3-15)
    00096             Stat        , // title,#ent,mean,rms,skewness&kurtosis
    00097             StatOnly    , // #entries,mean,rms,skewness&kurtosis
    00098             Stat1       , // #entries,mean+-,rms+-,skewness+-&kurtosis+-
    00099             ShapeOnly   , // mean,rms,skewness,kurtosis,underflow&overflow fractions
    00100             Shape       , // as ShapeOnly but with errors
    00101             LineTitle   , // line-format : title,mean,rms,skewness&kurtosis
    00102             LineOnly    , // line-format : mean,rms,skewness&kurtosis
    00103             PathTitle     // "PathTitle" : path & title
    00104           } ;

## Function Documentation

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 ibelyaev@physics.syr.edu

Date:
  2007-08-08

default:

Definition at line 139 of file HistoTableFormat.cpp.

    00140 {
    00141   switch ( ID )
    00142   {
    00143   case Old       : return s_histoFormatOld       ;
    00144   case Full      : return s_histoFormatFull      ;
    00145   case FullStat  : return s_histoFormatFullStat  ;
    00146   case Stat      : return s_histoFormatStat      ;
    00147   case StatOnly  : return s_histoFormatStatOnly  ;
    00148   case Stat1     : return s_histoFormatStat1     ;
    00149   case ShapeOnly : return s_histoFormatShapeOnly ;
    00150   case Shape     : return s_histoFormatShape     ;
    00151   case LineTitle : return s_histoFormatLineTitle ;
    00152   case LineOnly  : return s_histoFormatLineOnly  ;
    00153   case PathTitle : return s_histoFormatPathTitle ;
    00154   default        : ;
    00155   }
    00157   return s_histoFormatStat ;
    00158 }

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 ibelyaev@physics.syr.edu

Date:
  2007-08-08

default:

Definition at line 162 of file HistoTableFormat.cpp.

    00163 {
    00164   switch ( ID )
    00165   {
    00166   case Old       : return s_histoFormatOldHeader       ;
    00167   case Full      : return s_histoFormatFullHeader      ;
    00168   case FullStat  : return s_histoFormatFullStatHeader  ;
    00169   case Stat      : return s_histoFormatStatHeader      ;
    00170   case Stat1     : return s_histoFormatStat1Header     ;
    00171   case StatOnly  : return s_histoFormatStatOnlyHeader  ;
    00172   case ShapeOnly : return s_histoFormatShapeOnlyHeader ;
    00173   case Shape     : return s_histoFormatShapeHeader     ;
    00174   case LineTitle : return s_histoFormatLineTitleHeader ;
    00175   case LineOnly  : return s_histoFormatLineOnlyHeader  ;
    00176   case PathTitle : return s_histoFormatPathTitleHeader ;
    00177   default        : ;
    00178   }
    00180   return s_histoFormatStatHeader ;
    00181 }