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

                    {
          Default = 0, // default format
          Old,         // "OLD"-line format: title,integral,#ent,mean,rms
          Full,        // FULL format: the first 15 positions
          FullStat,    // Full statistical info (3-15)
          Stat,        // title,#ent,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    // "PathTitle" : path & title
        };

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 153 of file HistoTableFormat.cpp.

                                                        {
  switch ( ID ) {
  case Old:
    return s_histoFormatOld;
  case Full:
    return s_histoFormatFull;
  case FullStat:
    return s_histoFormatFullStat;
  case Stat:
    return s_histoFormatStat;
  case StatOnly:
    return s_histoFormatStatOnly;
  case Stat1:
    return s_histoFormatStat1;
  case ShapeOnly:
    return s_histoFormatShapeOnly;
  case Shape:
    return s_histoFormatShape;
  case LineTitle:
    return s_histoFormatLineTitle;
  case LineOnly:
    return s_histoFormatLineOnly;
  case PathTitle:
    return s_histoFormatPathTitle;
  default:
    break;
  }
  return s_histoFormatStat;
}

◆ 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