| The Gaudi Framework v28r2-patches (bc4ad17a)

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

GaudiHistos.icpp
Go to the documentation of this file.
1 #ifndef GAUDIALG_GAUDIHISTOS_ICPP
2 #define GAUDIALG_GAUDIHISTOS_ICPP 1
3 // ============================================================================
4 /* @file
5 *
6 * Implementation file for class : GaudiHistos
7 *
8 * @author Chris Jones Christopher.Rob.Jones@cern.ch
9 * @author Vanya BELYAEV Ivan.Belyaev@itep.ru
10 * @date 2005-08-08
11 */
12 // ============================================================================
13 // STD & STL
14 // ============================================================================
15 #include <algorithm>
16 #include <cmath>
17 #include <set>
18 #include <string>
19 #include <vector>
20 // ============================================================================
21 // GaudiKernel
22 // ============================================================================
23 #include "GaudiKernel/IHistogramSvc.h"
24 #include "GaudiKernel/MsgStream.h"
25 // ============================================================================
26 // GaudiAlg
27 // ============================================================================
28 #include "GaudiAlg/Fill.h"
29 #include "GaudiAlg/GaudiHistos.h"
30 #include "GaudiAlg/HbookName.h"
31 #include "GaudiAlg/Print.h"
32 // ============================================================================
33 // forward declarations from AIDA
34 // ============================================================================
35 namespace AIDA
36 {
37 class IBaseHistogram;
38 class IHistogram;
39 class IHistogram1D;
40 class IHistogram2D;
41 class IHistogram3D;
42 class IProfile;
43 class IProfile1D;
44 class IProfile2D;
45 }
46 // ============================================================================
47 // utility to allow iteration in order
48 // ============================================================================
49 namespace
50 {
51 constexpr struct ordered_t {
52 template <typename C>
53 std::map<typename C::key_type, typename C::mapped_type> operator()( const C& c ) const
54 {
55 return {std::begin( c ), std::end( c )};
56 }
57 } ordered{};
58
59 template <typename Map>
60 typename Map::mapped_type lookup_( const Map& map, const typename Map::key_type& ID )
61 {
62 auto found = map.find( ID );
63 return found != std::end( map ) ? found->second : nullptr;
64 }
65
66 // ============================================================================
67 // Searches 'title' for all instancies of 'A' and replaces them with 'B'
68 // ============================================================================
69 inline void stringSearchReplace( std::string& title, const std::string& A, const std::string& B )
70 {
71 for ( auto slash = title.find_first_of( A ); slash != std::string::npos; slash = title.find_first_of( A ) ) {
72 title = title.substr( 0, slash ) + B + title.substr( slash + A.size() );
73 }
74 }
75 }
76 // =============================================================================
77 // Constructor initialisation and job options
78 // =============================================================================
79 template <class PBASE>
80 void GaudiHistos<PBASE>::initGaudiHistosConstructor()
81 {
82 m_histosPrint.declareUpdateHandler( &GaudiHistos<PBASE>::printHistoHandler, this );
83 }
84 // ============================================================================
85 // Initialise Histogramming
86 // ============================================================================
87 template <class PBASE>
88 StatusCode GaudiHistos<PBASE>::
89 #ifdef __ICC
90 i_ghInitialize
91 #else
92 initialize
93 #endif
94 ()
95 {
96 // initialize base class
97 const StatusCode sc = PBASE::initialize();
98 if ( sc.isFailure() ) return sc;
99
100 // produce histograms?
101 if ( !produceHistos() ) {
102 this->debug() << "Histogram production is switched OFF" << endmsg;
103 return sc;
104 }
105
106 // check the validity of histogram service
107 if ( !this->histoSvc() ) {
108 return this->Error( "initialize():: IHistogramSvc* is invalid" );
109 }
110
111 // Warn if the user has decided to use numerical automatic IDs
112 if ( useNumericAutoIDs() ) {
113 this->Warning(
114 "Using numerical automatic IDs. These are not guaranteed to be totally deterministic. Use with care...",
115 StatusCode::SUCCESS )
116 .ignore();
117 }
118
119 // Finally, print the location histogram will be written to
120 this->Print( "The histogram path is set to be '" + histoPath() + "'", StatusCode( StatusCode::SUCCESS, true ),
121 MSG::DEBUG )
122 .ignore();
123
124 return sc;
125 }
126 // ============================================================================
127 // Finalise Histogramming
128 // ============================================================================
129 template <class PBASE>
130 StatusCode GaudiHistos<PBASE>::
131 #ifdef __ICC
132 i_ghFinalize
133 #else
134 finalize
135 #endif
136 ()
137 {
138
139 if ( produceHistos() ) {
140
141 // Count how many histos of each type
142 if ( ( !noHistos() ) && histoCountersPrint() ) {
143 const unsigned int n1D = histo1DMapID().size();
144 const unsigned int n2D = histo2DMapID().size();
145 const unsigned int n3D = histo3DMapID().size();
146 const unsigned int n1DP = profile1DMapID().size();
147 const unsigned int n2DP = profile2DMapID().size();
148 const unsigned int total = n1D + n2D + n3D + n1DP + n2DP;
149 if ( total > 0 ) {
150 this->always() << "Booked " << total << " Histogram(s) : ";
151 if ( n1D > 0 ) this->always() << "1D=" << n1D << " ";
152 if ( n2D > 0 ) this->always() << "2D=" << n2D << " ";
153 if ( n3D > 0 ) this->always() << "3D=" << n3D << " ";
154 if ( n1DP > 0 ) this->always() << "1DProf=" << n1DP << " ";
155 if ( n2DP > 0 ) this->always() << "2DProf=" << n2DP << " ";
156 this->always() << endmsg;
157 }
158 }
159
160 // detailed printing
161 if ( histosPrint() ) {
162 printHistos();
163 }
164 }
165
166 // clear all maps
167 m_histo1DMapTitle.clear();
168 m_histo2DMapTitle.clear();
169 m_histo3DMapTitle.clear();
170 m_histo1DMapID.clear();
171 m_histo2DMapID.clear();
172 m_histo3DMapID.clear();
173 m_profile1DMapTitle.clear();
174 m_profile2DMapTitle.clear();
175 m_profile1DMapID.clear();
176 m_profile2DMapID.clear();
177
178 // finalize base class
179 return PBASE::finalize();
180 }
181 // ============================================================================
182 // perform the actual detailed printout of histograms
183 // ============================================================================
184 template <class PBASE>
185 int GaudiHistos<PBASE>::printHistos( const MSG::Level level ) const
186 {
187 using namespace Gaudi::Utils::Histos;
188
189 if ( noHistos() ) {
190 if ( this->msgLevel( MSG::DEBUG ) ) {
191 this->msgStream( level ) << "No histograms are booked" << endmsg;
192 }
193 return 0; // RETURN
194 }
195
196 MsgStream& msg = this->msgStream( level );
197
198 // Printout all histograms
199
200 Gaudi::Utils::Histos::Table table( m_histo1DTableFormat, m_histo1DTableHeader );
201
202 if ( !histo1DMapID().empty() ) {
203 msg << "List of booked 1D histograms in directory "
204 << "\"" << histoPath() << "\" :-";
205
206 if ( !table.header().empty() ) {
207 msg << std::endl << Gaudi::Utils::Histos::format( "ID", table.header(), m_histo1DTableFormatShort );
208 }
209 for ( const auto& entry : ordered( histo1DMapID() ) ) {
210 const auto* aida = entry.second;
211 if ( !aida ) {
212 this->error() << "IHistogram1D points to NULL" << endmsg;
213 continue;
214 }
215 // format and print the row
216 msg << std::endl << table.toString( aida, HistoID( entry.first ), m_histo1DTableFormatShort );
217 }
218 msg << endmsg;
219 }
220 // ==========================================================================
221 if ( !histo2DMapID().empty() ) {
222 msg << "List of booked 2D histograms in directory "
223 << "\"" << histoPath() << "\" :-";
224
225 for ( const auto& entry : ordered( histo2DMapID() ) ) {
226 const auto* aida = entry.second;
227 if ( !aida ) {
228 this->error() << "IHistogram2D points to NULL" << endmsg;
229 continue;
230 }
231 msg << std::endl << GaudiAlg::Print2D::toString( aida, entry.first );
232 }
233 msg << endmsg;
234 }
235 // ==========================================================================
236 if ( !histo3DMapID().empty() ) {
237 msg << "List of booked 3D histograms in directory "
238 << "\"" << histoPath() << "\" :-";
239 for ( const auto& entry : ordered( histo3DMapID() ) ) {
240 const auto* aida = entry.second;
241 if ( !aida ) {
242 this->error() << "IHistogram3D points to NULL" << endmsg;
243 continue;
244 }
245 msg << std::endl << GaudiAlg::Print3D::toString( aida, entry.first );
246 }
247 msg << endmsg;
248 }
249 // ==========================================================================
250 if ( !profile1DMapID().empty() ) {
251 msg << "List of booked 1D profile histograms in directory "
252 << "\"" << histoPath() << "\" :-";
253 for ( const auto& entry : ordered( profile1DMapID() ) ) {
254 const auto* aida = entry.second;
255 if ( !aida ) {
256 this->error() << "IProfile1D points to NULL" << endmsg;
257 continue;
258 }
259 msg << std::endl << GaudiAlg::Print1DProf::toString( aida, entry.first );
260 }
261 msg << endmsg;
262 }
263 // ==========================================================================
264 if ( !profile2DMapID().empty() ) {
265 msg << "List of booked 2D profile histograms in directory "
266 << "\"" << histoPath() << "\" :-";
267 for ( const auto& entry : ordered( profile2DMapID() ) ) {
268 const auto* aida = entry.second;
269 if ( !aida ) {
270 this->error() << "IProfile2D points to NULL" << endmsg;
271 continue;
272 }
273 msg << std::endl << GaudiAlg::Print2DProf::toString( aida, entry.first );
274 }
275 msg << endmsg;
276 }
277 //
278 return this->totalNumberOfHistos();
279 }
280 // ============================================================================
281 // Check if all histogram maps are empty
282 // ============================================================================
283 template <class PBASE>
284 bool GaudiHistos<PBASE>::noHistos() const
285 {
286 return ( histo1DMapTitle().empty() && histo2DMapTitle().empty() && histo3DMapTitle().empty() &&
287 profile1DMapTitle().empty() && profile2DMapTitle().empty() && histo1DMapID().empty() &&
288 histo2DMapID().empty() && histo3DMapID().empty() && profile1DMapID().empty() && profile2DMapID().empty() );
289 }
290 // ============================================================================
291 // Declare a histogram to the monitor service
292 // ============================================================================
293 template <class PBASE>
294 void GaudiHistos<PBASE>::monitorHisto( const AIDA::IBaseHistogram* hist, const HistoID& ID ) const
295 {
296 if ( hist && m_declareMoniHists ) {
297 if ( this->msgLevel( MSG::DEBUG ) ) {
298 this->debug() << "Monitoring histogram '" << ID.idAsString() << "' desc = '"
299 << Gaudi::Utils::Histos::htitle( hist ) << "'" << endmsg;
300 }
301 this->declareInfo( histoPath() + "/" + ID.idAsString(), hist, Gaudi::Utils::Histos::htitle( hist ) );
302 }
303 }
304 // ============================================================================
305 // access the EXISTING 1D histogram by ID
306 // ============================================================================
307 template <class PBASE>
308 AIDA::IHistogram1D* GaudiHistos<PBASE>::histo1D( const HistoID& ID ) const
309 {
310 return lookup_( histo1DMapID(), ID );
311 }
312 // ============================================================================
313 // access the EXISTING 2D histogram by ID
314 // ============================================================================
315 template <class PBASE>
316 AIDA::IHistogram2D* GaudiHistos<PBASE>::histo2D( const HistoID& ID ) const
317 {
318 return lookup_( histo2DMapID(), ID );
319 }
320 // ============================================================================
321 // access the EXISTING 3D histogram by ID
322 // ============================================================================
323 template <class PBASE>
324 AIDA::IHistogram3D* GaudiHistos<PBASE>::histo3D( const HistoID& ID ) const
325 {
326 return lookup_( histo3DMapID(), ID );
327 }
328 // ============================================================================
329 // access the EXISTING 1D profile histogram by ID
330 // ============================================================================
331 template <class PBASE>
332 AIDA::IProfile1D* GaudiHistos<PBASE>::profile1D( const HistoID& ID ) const
333 {
334 return lookup_( profile1DMapID(), ID );
335 }
336 // ============================================================================
337 // access the EXISTING 2D profile histogram by ID
338 // ============================================================================
339 template <class PBASE>
340 AIDA::IProfile2D* GaudiHistos<PBASE>::profile2D( const HistoID& ID ) const
341 {
342 return lookup_( profile2DMapID(), ID );
343 }
344 // ============================================================================
345 // Returns the total number of histograms (of all types) currently booked
346 // ============================================================================
347 template <class PBASE>
348 unsigned int GaudiHistos<PBASE>::totalNumberOfHistos() const
349 {
350 return histo1DMapID().size() + histo2DMapID().size() + histo3DMapID().size() + profile1DMapID().size() +
351 profile2DMapID().size();
352 }
353 // ============================================================================
354 // Create a new histogram ID using the given title
355 // ============================================================================
356 template <class PBASE>
357 void GaudiHistos<PBASE>::newHistoID( const std::string& title, HistoID& ID ) const
358 {
359 if ( useNumericAutoIDs() || title.empty() ) {
360 if ( !useNumericAutoIDs() ) {
361 this->Warning(
362 "Cannot generate automatic literal ID from an empty title ! Using numeric ID instead for histogram ID",
363 StatusCode::SUCCESS );
364 }
365 // propose the histogram ID (always numeric)
366 ID = HistoID( totalNumberOfHistos() + 1 + histoOffSet() );
367 // adjust the proposed ID
368 while ( histoExists( ID ) ) {
369 ID = HistoID( ID.numeric() + 1 );
370 }
371 } else {
372 // use the title to create a unique literal ID
373 ID = HistoID( this->convertTitleToID( title ) );
374 // Just in case ...
375 while ( histoExists( ID ) ) {
376 ID = HistoID( ID.idAsString() + "_" );
377 }
378 }
379 }
380 // ============================================================================
381 // Create an ID string from a title string
382 // ============================================================================
383 template <class PBASE>
384 std::string GaudiHistos<PBASE>::convertTitleToID( std::string title ) const
385 {
386 // clean up the ID string for all unwanted characters
387 for ( const auto& i : m_idReplaceInfo ) {
388 stringSearchReplace( title, i.first, i.second );
389 }
390 return title;
391 }
392 // ============================================================================
393 // the handler for "HistoPrint" property
394 // ============================================================================
395 template <class PBASE>
396 void GaudiHistos<PBASE>::printHistoHandler( Gaudi::Details::PropertyBase& )
397 {
398 // no action if not yet initialized
399 if ( this->FSMState() < Gaudi::StateMachine::INITIALIZED ) {
400 return;
401 }
402 if ( this->histosPrint() ) {
403 this->printHistos( MSG::ALWAYS );
404 }
405 }
406 // ============================================================================
407 // get the constructed histogram path
408 // ============================================================================
409 template <class PBASE>
410 std::string GaudiHistos<PBASE>::histoPath() const
411 {
412 std::string path = histoTopDir() + histoDir();
413 return splitHistoDir() ? dirHbookName( path ) : path;
414 }
415 // ============================================================================
416 // 1D
417 #include "GaudiAlg/GaudiHistos_1DFixedBinning.icpp"
418 #include "GaudiAlg/GaudiHistos_1DVariableBinning.icpp"
419 // 2D
420 #include "GaudiAlg/GaudiHistos_2DFixedBinning.icpp"
421 #include "GaudiAlg/GaudiHistos_2DVariableBinning.icpp"
422 // 3D
423 #include "GaudiAlg/GaudiHistos_3DFixedBinning.icpp"
424 #include "GaudiAlg/GaudiHistos_3DVariableBinning.icpp"
425 // 1D Profile
426 #include "GaudiAlg/GaudiHistos_1DProfFixedBinning.icpp"
427 #include "GaudiAlg/GaudiHistos_1DProfVariableBinning.icpp"
428 // 2D Profile
429 #include "GaudiAlg/GaudiHistos_2DProfFixedBinning.icpp"
430 #include "GaudiAlg/GaudiHistos_2DProfVariableBinning.icpp"
431 // ============================================================================
432 // The END
433 // ============================================================================
434 #endif // GAUDIALG_GAUDIHISTOS_ICPP
435 // ============================================================================
GaudiHistos_1DFixedBinning.icpp
GaudiHistos_2DProfFixedBinning.icpp
MsgStream
Definition of the MsgStream class used to transmit messages.
Definition: MsgStream.h:24
Gaudi::StateMachine::INITIALIZED
Definition: StateMachine.h:15
StatusCode::SUCCESS
Definition: StatusCode.h:30
Gaudi::Utils::Histos::htitle
GAUDI_API std::string htitle(const AIDA::IBaseHistogram *histo, const std::string &title="")
get the title
Definition: Fill.cpp:138
std::string::empty
T empty(T...args)
GaudiHistos::histo2D
AIDA::IHistogram2D * histo2D(const std::string &title) const
access the EXISTING 2D histogram by title return the pointer to existing 2D histogram or NULL ...
Definition: GaudiHistos.h:2306
GaudiHistos::printHistos
int printHistos(const MSG::Level level=MSG::ALWAYS) const
perform the actual printout of histograms
Definition: GaudiHistos.icpp:185
gaudirun.c
c
Definition: gaudirun.py:391
GaudiPython.HistoUtils.path
path
Definition: HistoUtils.py:772
MsgStream.h
GaudiHistos::profile1D
AIDA::IProfile1D * profile1D(const double valueX, const double valueY, const std::string &title, const double lowX, const double highX, const unsigned long binsX=100, const std::string &opt="", const double lowY=-std::numeric_limits< double >::max(), const double highY=std::numeric_limits< double >::max(), const double weight=1.0) const
fill the 1D profile histogram (book on demand)
Definition: GaudiHistos_1DProfFixedBinning.icpp:148
GaudiHistos::noHistos
bool noHistos() const
Check if all histogram maps are empty.
Definition: GaudiHistos.icpp:284
Histos::HistoID
GaudiAlg::ID HistoID
The actual type for histogram identifier.
Definition: HistoID.h:23
GaudiHistos_3DFixedBinning.icpp
GaudiHistos::newHistoID
void newHistoID(const std::string &title, HistoID &ID) const
Create a new histogram ID using the given title.
Definition: GaudiHistos.icpp:357
Gaudi::Utils::Histos::format
GAUDI_API std::string format(const AIDA::IHistogram1D *histo, const std::string &fmt)
Make the string representation of the historgam according to the specified format.
Definition: HistoTableFormat.cpp:209
MSG::DEBUG
Definition: IMessageSvc.h:18
std::endl
T endl(T...args)
Gaudi::Utils::Histos
Collection of useful utilities for manipulations with AIDA hisgograms.
Definition: Fill.h:27
std::end
T end(T...args)
GaudiHistos_2DVariableBinning.icpp
HbookName.h
few useful function to construct names of Hbook histograms and directories functions are imported fro...
GaudiHistos_2DFixedBinning.icpp
std::map
STL class.
StatusCode::isFailure
bool isFailure() const
Test for a status code of FAILURE.
Definition: StatusCode.h:84
AIDA
GaudiKernel.
Definition: Fill.h:8
Gaudi::Utils::Histos::Table::header
const std::string & header() const
the table header
Definition: HistoTableFormat.h:471
std::string
STL class.
GaudiHistos::monitorHisto
void monitorHisto(const AIDA::IBaseHistogram *hist, const HistoID &ID) const
Declare a histogram to the monitor service.
Definition: GaudiHistos.icpp:294
MSG::Level
Level
Definition: IMessageSvc.h:15
GaudiHistos::histo1D
AIDA::IHistogram1D * histo1D(const std::string &title) const
access the EXISTING 1D histogram by title return the pointer to existing 1D histogram or NULL ...
Definition: GaudiHistos.h:2288
Containers::map
struct GAUDI_API map
Parametrisation class for map-like implementation.
Definition: KeyedObjectManager.h:25
StatusCode
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
GaudiHistos::printHistoHandler
void printHistoHandler(Gaudi::Details::PropertyBase &)
the handler for "HistoPrint" property
Definition: GaudiHistos.icpp:396
std::string::find_first_of
T find_first_of(T...args)
GaudiHistos_3DVariableBinning.icpp
GaudiHistos::totalNumberOfHistos
unsigned int totalNumberOfHistos() const
Returns the total number of histograms (of all types) currently booked.
Definition: GaudiHistos.icpp:348
Gaudi::Utils::Histos::Table
Simple class for the customizeble printout of the histogram tables.
Definition: HistoTableFormat.h:409
Print.h
collection of useful utilities to print certain objects (currently used for implementation in class G...
GaudiAlg::Print3D::toString
static std::string toString(const AIDA::IHistogram3D *aida, const GaudiAlg::HistoID &ID)
Definition: Print.cpp:107
Gaudi::Details::PropertyBase
PropertyBase base class allowing PropertyBase* collections to be "homogeneous".
Definition: Property.h:32
GaudiHistos_1DVariableBinning.icpp
GaudiHistos::histoPath
std::string histoPath() const
get the constructed histogram path
Definition: GaudiHistos.icpp:410
std::string::size
T size(T...args)
Gaudi::Functional::operator()
virtual Out operator()(const vector_of_const_< In > &inputs) const =0
GaudiHistos_1DProfVariableBinning.icpp
Fill.h
std::begin
T begin(T...args)
GaudiHistos_2DProfVariableBinning.icpp
GaudiMP.FdsRegistry.msg
msg
Definition: FdsRegistry.py:8
GaudiAlg::ID::idAsString
GAUDI_API LiteralID idAsString() const
Return ID as string, for both numeric and literal IDs.
Definition: GaudiHistoID.cpp:20
GaudiHistos.h
GaudiAlg::ID::numeric
bool numeric() const noexcept
Is this ID numeric.
Definition: GaudiHistoID.h:74
std::string::substr
T substr(T...args)
GaudiAlg::Print2D::toString
static std::string toString(const AIDA::IHistogram2D *aida, const GaudiAlg::HistoID &ID)
Definition: Print.cpp:87
gaudirun.level
level
Definition: gaudirun.py:261
GaudiHistos
Templated base class providing common histogramming methods for GaudiAlgorithm and GaudiTool like cla...
Definition: GaudiHistos.h:56
GaudiAlg::Print1DProf::toString
static std::string toString(const AIDA::IProfile1D *aida, const GaudiAlg::HistoID &ID)
Definition: Print.cpp:128
GaudiHistos::convertTitleToID
std::string convertTitleToID(std::string title) const
Create an ID string from a title string.
Definition: GaudiHistos.icpp:384
GaudiHistos_1DProfFixedBinning.icpp
GaudiHistos::profile2D
AIDA::IProfile2D * profile2D(const double valueX, const double valueY, const double valueZ, const std::string &title, const double lowX, const double highX, const double lowY, const double highY, const unsigned long binsX=50, const unsigned long binsY=50, const double weight=1.0) const
fill the 2D profile histogram (book on demand)
Definition: GaudiHistos_2DProfFixedBinning.icpp:149
GaudiAlg::Print2DProf::toString
static std::string toString(const AIDA::IProfile2D *aida, const GaudiAlg::HistoID &ID)
Definition: Print.cpp:147
MSG::ALWAYS
Definition: IMessageSvc.h:23
GaudiAlg::ID
ID class for Histogram and Ntuples.
Definition: GaudiHistoID.h:44
GaudiHistos::histo3D
AIDA::IHistogram3D * histo3D(const std::string &title) const
access the EXISTING 3D histogram by title return the pointer to existing 3D histogram or NULL ...
Definition: GaudiHistos.h:2315
endmsg
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:244
Containers::Map
KeyedObjectManager< map > Map
Forward declaration of specialized std::map-like object manager.
Definition: KeyedObjectManager.h:95
Gaudi::Utils::Histos::Table::toString
std::string toString(const AIDA::IHistogram1D *histo) const
make the string representation according to the default format
Definition: HistoTableFormat.cpp:314
IHistogramSvc.h
GaudiHistos::initGaudiHistosConstructor
void initGaudiHistosConstructor()
Constructor initialisation and job options.
Definition: GaudiHistos.icpp:80