The Gaudi Framework  master (37c0b60a)
P1D.cpp
Go to the documentation of this file.
1 /***********************************************************************************\
2 * (c) Copyright 1998-2019 CERN for the benefit of the LHCb and ATLAS collaborations *
3 * *
4 * This software is distributed under the terms of the Apache version 2 licence, *
5 * copied verbatim in the file "LICENSE". *
6 * *
7 * In applying this licence, CERN does not waive the privileges and immunities *
8 * granted to it by virtue of its status as an Intergovernmental Organization *
9 * or submit itself to any jurisdiction. *
10 \***********************************************************************************/
11 #ifdef __ICC
12 // disable icc remark #2259: non-pointer conversion from "X" to "Y" may lose significant bits
13 // TODO: To be removed, since it comes from ROOT TMathBase.h
14 # pragma warning( disable : 2259 )
15 #endif
16 #ifdef WIN32
17 // Disable warning
18 // warning C4996: 'sprintf': This function or variable may be unsafe.
19 // coming from TString.h
20 # pragma warning( disable : 4996 )
21 #endif
22 
23 #include "GaudiPI.h"
24 #include <Gaudi/MonitoringHub.h>
26 #include <GaudiCommonSvc/P1D.h>
28 
29 #include <cmath>
30 
32  const std::string& title, int nBins, double xlow,
33  double xup, double ylow, double yup,
34  const std::string& opt ) {
35  auto _p = new TProfile( title.c_str(), title.c_str(), nBins, xlow, xup, ylow, yup, opt.c_str() );
36  auto p = new Profile1D( _p );
37  svcLocator->monitoringHub().registerEntity( "", path, "histogram:ProfileHistogram:double", *p );
38  return { p, p };
39 }
40 
42  const std::string& title, const Edges& e, double ylow,
43  double yup, const std::string& opt ) {
44  auto p =
45  new Profile1D( new TProfile( title.c_str(), title.c_str(), e.size() - 1, &e.front(), ylow, yup, opt.c_str() ) );
46  svcLocator->monitoringHub().registerEntity( "", path, "histogram:ProfileHistogram:double", *p );
47  return { p, p };
48 }
49 
51  const AIDA::IProfile1D& hist ) {
52  TProfile* h = getRepresentation<AIDA::IProfile1D, TProfile>( hist );
53  auto n = ( h ? new Profile1D( new TProfile( *h ) ) : nullptr );
54  if ( n ) { svcLocator->monitoringHub().registerEntity( "", path, "histogram:ProfileHistogram:double", *n ); }
55  return { n, n };
56 }
57 
58 namespace Gaudi {
59  template <>
61  return int( m_rep->GetBinEntries( rIndex( index ) ) + 0.5 );
62  }
63 
64  template <>
65  void* Generic1D<AIDA::IProfile1D, TProfile>::cast( const std::string& className ) const {
66  return className == "AIDA::IProfile1D"
67  ? const_cast<AIDA::IProfile1D*>( static_cast<const AIDA::IProfile1D*>( this ) )
68  : className == "AIDA::IProfile" ? const_cast<AIDA::IProfile*>( static_cast<const AIDA::IProfile*>( this ) )
69  : className == "AIDA::IBaseHistogram"
70  ? const_cast<AIDA::IBaseHistogram*>( static_cast<const AIDA::IBaseHistogram*>( this ) )
71  : nullptr;
72  }
73 
74  template <>
76  TProfile* imp = dynamic_cast<TProfile*>( rep );
77  if ( !imp ) throw std::runtime_error( "Cannot adopt native histogram representation." );
78  m_rep.reset( imp );
79  m_axis.initialize( m_rep->GetXaxis(), true );
80  const TArrayD* a = m_rep->GetSumw2();
81  if ( !a || ( a && a->GetSize() == 0 ) ) m_rep->Sumw2();
82  setTitle( m_rep->GetTitle() );
83  }
84 } // namespace Gaudi
85 
86 Gaudi::Profile1D::Profile1D() : Base( new TProfile() ) { init( "", false ); }
87 
88 Gaudi::Profile1D::Profile1D( TProfile* rep ) : Base( rep ) { init( m_rep->GetTitle() ); }
89 
90 void Gaudi::Profile1D::init( const std::string& title, bool initialize_axis ) {
91  m_classType = "IProfile1D";
92  setTitle( title );
93  setName( title );
94  if ( initialize_axis ) { axis().initialize( m_rep->GetXaxis(), false ); }
95  // m_rep->SetErrorOption("s");
96  m_rep->SetDirectory( nullptr );
97  m_sumEntries = 0;
98 }
99 
100 bool Gaudi::Profile1D::setBinContents( int i, int entries, double height, double /*error*/, double spread,
101  double /* centre */ ) {
102  m_rep->SetBinEntries( rIndex( i ), entries );
103  // set content takes in root height * entries
104  m_rep->SetBinContent( rIndex( i ), height * entries );
105  // set error takes sqrt of bin sum(w*y**2)
106  double sumwy2Bin = ( spread * spread + height * height ) * entries;
107  m_rep->SetBinError( rIndex( i ), sqrt( sumwy2Bin ) );
108  m_sumEntries += entries;
109  // not very efficient (but do evey bin since root cannot figure out by himself)
110  m_rep->SetEntries( m_sumEntries );
111  return true;
112 }
113 
114 bool Gaudi::Profile1D::fill( double x, double y, double weight ) {
115  // avoid race conditions when filling the profile
116  auto guard = std::scoped_lock{ m_fillSerialization };
117  m_rep->Fill( x, y, weight );
118  return true;
119 }
Gaudi::Profile1D::setBinContents
virtual bool setBinContents(int i, int entries, double height, double error, double spread, double centre)
Definition: P1D.cpp:100
Gaudi::Accumulators::sqrt
auto sqrt(std::chrono::duration< Rep, Period > d)
sqrt for std::chrono::duration
Definition: Counters.h:34
Gaudi::Generic1D< AIDA::IProfile1D, TProfile >::m_rep
std::unique_ptr< TProfile > m_rep
Reference to underlying implementation.
Definition: Generic1D.h:141
ISvcLocator::monitoringHub
Gaudi::Monitoring::Hub & monitoringHub()
Definition: ISvcLocator.cpp:25
std::string
STL class.
AtlasMCRecoFullPrecedenceDump.path
path
Definition: AtlasMCRecoFullPrecedenceDump.py:49
MonitoringHub.h
std::pair
ISvcLocator
Definition: ISvcLocator.h:46
P1D.h
ObjectFactory.h
HistogramUtility.h
Gaudi::svcLocator
GAUDI_API ISvcLocator * svcLocator()
std::string::c_str
T c_str(T... args)
AlgSequencer.h
h
Definition: AlgSequencer.py:31
Gaudi::Profile1D::Profile1D
Profile1D()
Default Constructor.
Definition: P1D.cpp:86
GaudiPython.Bindings.nullptr
nullptr
Definition: Bindings.py:87
Gaudi::Monitoring::Hub::registerEntity
void registerEntity(std::string c, std::string n, std::string t, T &ent)
Definition: MonitoringHub.h:140
std::runtime_error
STL class.
Gaudi::createProf1D
std::pair< DataObject *, AIDA::IProfile1D * > createProf1D(ISvcLocator *svcLocator, const std::string &path, const AIDA::IProfile1D &hist)
Copy constructor.
Gaudi::Profile1D::init
void init(const std::string &title, bool initialize_axis=true)
Definition: P1D.cpp:90
Gaudi
This file provides a Grammar for the type Gaudi::Accumulators::Axis It allows to use that type from p...
Definition: __init__.py:1
cpluginsvc.n
n
Definition: cpluginsvc.py:234
Gaudi::Profile1D::fill
bool fill(double x, double y, double weight=1.) override
Fill the Profile1D with a value and the corresponding weight.
Definition: P1D.cpp:114
GaudiPI.h
Gaudi::Generic1D::binEntries
int binEntries(int index) const override
Number of entries in the corresponding bin (ie the number of times fill was called for this bin).
Gaudi::Generic1D
Definition: Generic1D.h:46
Gaudi::ParticleProperties::index
size_t index(const Gaudi::ParticleProperty *property, const Gaudi::Interfaces::IParticlePropertySvc *service)
helper utility for mapping of Gaudi::ParticleProperty object into non-negative integral sequential id...
Definition: IParticlePropertySvc.cpp:39