The Gaudi Framework: GaudiHistos< PBASE > Class Template Reference

bool m_checkForNaN

flag to control check for Nan/Finite while filling the histogram

Definition: GaudiHistos.h:3068

template<class PBASE>

bool GaudiHistos< PBASE >::checkForNaN ( ) const

inline

get the flag for NaN checks (property "HistoCheckForNan")

Definition at line 2695 of file GaudiHistos.h.

2695 { return m_checkForNaN ; }

bool m_checkForNaN

flag to control check for Nan/Finite while filling the histogram

Definition: GaudiHistos.h:3068

template<class PBASE >

std::string GaudiHistos< PBASE >::convertTitleToID ( std::string title ) const

protected

Create an ID string from a title string.

Definition at line 485 of file GaudiHistos.icpp.

 {
   // clean up the ID string for all unwanted characters
   for ( const auto& i : m_idReplaceInfo )
   {
     stringSearchReplace( title, i.first, i.second );
   }
   return title;
 }

template<class PBASE>

std::string GaudiHistos< PBASE >::convertTitleToID ( std::string title ) const

protected

Create an ID string from a title string.

template<class PBASE >

AIDA::IHistogram1D * GaudiHistos< PBASE >::fill	(	AIDA::IHistogram1D *	histo,
		const double	value,
		const double	weight,
		const std::string &	title = `""`
	)		const

fill the 1D histogram with the value and weight

Parameters

histo	1D histogram to be filled
value	value to be put into the histogram
weight	weight to be used
title	histogram title (to be used for error report)

Returns: pointer to AIDA 1D histogram

Definition at line 105 of file GaudiHistos_1DFixedBinning.icpp.

 {
   if ( !histo     ) { return nullptr ; }                          // RETURN
   //
   if ( !checkForNaN() )
   { Gaudi::Utils::Histos::fill ( histo , value , weight ) ; }
   else if  ( std::isfinite ( value ) && std::isfinite ( weight ) )
   { Gaudi::Utils::Histos::fill ( histo , value , weight ) ; }
   else if  ( std::isnan ( value ) || std::isnan ( weight ) )
   {
     this -> Warning
       ("fill():: 'NaN'      value is skipped from the histogram '"
        + Gaudi::Utils::Histos::htitle ( histo , title ) + "'" ) ;
   }
   else
   {
     this -> Warning
       ("fill():: 'Infinite' value is skipped from the histogram '"
        + Gaudi::Utils::Histos::htitle ( histo , title ) + "'" ) ;
   }
   // return
   return histo ;
 }

template<class PBASE>

AIDA::IHistogram1D* GaudiHistos< PBASE >::fill	(	AIDA::IHistogram1D *	histo,
		const double	value,
		const double	weight,
		const std::string &	title = `""`
	)		const

fill the 1D histogram with the value and weight

Parameters

histo	1D histogram to be filled
value	value to be put into the histogram
weight	weight to be used
title	histogram title (to be used for error report)

Returns: pointer to AIDA 1D histogram

template<class PBASE>

AIDA::IHistogram2D* GaudiHistos< PBASE >::fill	(	AIDA::IHistogram2D *	histo,
		const double	valueX,
		const double	valueY,
		const double	weight,
		const std::string &	title = `""`
	)		const

fill the 2D histogram with the value and weight

Parameters

histo	2D histogram to be filled
valueX	x value to be put into the histogram
valueY	y value to be put into the histogram
weight	weight to be used
title	histogram title (to be used for error report)

Returns: pointer to AIDA 2D histogram

template<class PBASE >

AIDA::IHistogram2D * GaudiHistos< PBASE >::fill	(	AIDA::IHistogram2D *	histo,
		const double	valueX,
		const double	valueY,
		const double	weight,
		const std::string &	title = `""`
	)		const

fill the 2D histogram with the value and weight

Parameters

histo	2D histogram to be filled
valueX	x value to be put into the histogram
valueY	y value to be put into the histogram
weight	weight to be used
title	histogram title (to be used for error report)

Returns: pointer to AIDA 2D histogram

Definition at line 117 of file GaudiHistos_2DFixedBinning.icpp.

 {
   //
   if ( !histo ) { return nullptr ; } // RETURN
   //
   if ( !checkForNaN() )
   { Gaudi::Utils::Histos::fill ( histo , valueX , valueY , weight ) ; }
   else if  ( std::isfinite ( valueX ) && std::isfinite ( valueY ) && std::isfinite ( weight ) )
   { Gaudi::Utils::Histos::fill ( histo , valueX , valueY , weight ) ; }
   else if  ( std::isnan ( valueX ) || std::isnan ( valueY ) || std::isnan ( weight ) )
   {
     this -> Warning
       ("fill():: 'NaN'      value is skipped from the histogram '"
        + Gaudi::Utils::Histos::htitle ( histo , title ) + "'" ) ;
   }
   else
   {
     this -> Warning
       ("fill():: 'Infinite' value is skipped from the histogram '"
        + Gaudi::Utils::Histos::htitle ( histo , title ) + "'" ) ;
   }
   // return
   return histo ;
 }

template<class PBASE>

AIDA::IHistogram3D* GaudiHistos< PBASE >::fill	(	AIDA::IHistogram3D *	histo,
		const double	valueX,
		const double	valueY,
		const double	valueZ,
		const double	weight,
		const std::string &	title = `""`
	)		const

fill the 3D histogram with the value and weight

Parameters

histo	3D histogram to be filled
valueX	x value to be put into the histogram
valueY	y value to be put into the histogram
valueZ	z value to be put into the histogram
weight	weight to be used
title	histogram title (to be used for error report)

Returns: pointer to AIDA 3D histogram

template<class PBASE >

AIDA::IHistogram3D * GaudiHistos< PBASE >::fill	(	AIDA::IHistogram3D *	histo,
		const double	valueX,
		const double	valueY,
		const double	valueZ,
		const double	weight,
		const std::string &	title = `""`
	)		const

fill the 3D histogram with the value and weight

Parameters

histo	3D histogram to be filled
valueX	x value to be put into the histogram
valueY	y value to be put into the histogram
valueZ	z value to be put into the histogram
weight	weight to be used
title	histogram title (to be used for error report)

Returns: pointer to AIDA 3D histogram

Definition at line 131 of file GaudiHistos_3DFixedBinning.icpp.

 {
   if ( !histo ) { return nullptr ; } // RETURN
   //
   if ( !checkForNaN() )
   { Gaudi::Utils::Histos::fill ( histo , valueX , valueY , valueZ , weight ) ; }
   else if  ( std::isfinite ( valueX ) && std::isfinite ( valueY ) &&
              std::isfinite ( valueZ ) && std::isfinite ( weight ) )
   { Gaudi::Utils::Histos::fill ( histo , valueX , valueY , valueZ , weight ) ; }
   else if  ( std::isnan ( valueX ) || std::isnan ( valueY ) ||
              std::isnan ( valueZ ) || std::isnan ( weight ) )
   {
     this -> Warning
       ("fill():: 'NaN'      value is skipped from the histogram '"
        + Gaudi::Utils::Histos::htitle ( histo , title  ) + "'" ) ;
   }
   else
   {
     this -> Warning
       ("fill():: 'Infinite' value is skipped from the histogram '"
        + Gaudi::Utils::Histos::htitle ( histo , title  ) + "'" ) ;
   }
   // return
   return histo ;
 }

template<class PBASE>

AIDA::IProfile1D* GaudiHistos< PBASE >::fill	(	AIDA::IProfile1D *	histo,
		const double	valueX,
		const double	valueY,
		const double	weight,
		const std::string &	title = `""`
	)		const

fill the 1D profile histogram with the values and weight

Parameters

histo	1D profile histogram to be filled
valueX	x value to be put into the histogram
valueY	y value to be put into the histogram
weight	weight to be used
title	histogram title (to be used for error report)

Returns: pointer to AIDA 1D histogram

template<class PBASE >

AIDA::IProfile1D * GaudiHistos< PBASE >::fill	(	AIDA::IProfile1D *	histo,
		const double	valueX,
		const double	valueY,
		const double	weight,
		const std::string &	title = `""`
	)		const

fill the 1D profile histogram with the values and weight

Parameters

histo	1D profile histogram to be filled
valueX	x value to be put into the histogram
valueY	y value to be put into the histogram
weight	weight to be used
title	histogram title (to be used for error report)

Returns: pointer to AIDA 1D histogram

Definition at line 115 of file GaudiHistos_1DProfFixedBinning.icpp.

 {
   //
   if ( !histo ) { return nullptr ; }   // RETURN
   //
   if ( !checkForNaN() )
   { Gaudi::Utils::Histos::fill ( histo , valueX , valueY , weight ); }
   else if  ( std::isfinite ( valueX ) && std::isfinite ( valueY ) && std::isfinite ( weight ) )
   { Gaudi::Utils::Histos::fill ( histo , valueX , valueY , weight ); }
   else if  ( std::isnan ( valueX ) || std::isnan ( valueY ) || std::isnan ( weight ) )
   {
     this -> Warning
       ("fill():: 'NaN'      value is skipped from the histogram '"
        + Gaudi::Utils::Histos::htitle ( histo , title  ) + "'" ) ;
   }
   else
   {
     this -> Warning
       ("fill():: 'Infinite' value is skipped from the histogram '"
        + Gaudi::Utils::Histos::htitle ( histo , title  ) + "'" ) ;
   }
   // return
   return histo ;
 }

template<class PBASE>

AIDA::IProfile2D* GaudiHistos< PBASE >::fill	(	AIDA::IProfile2D *	histo,
		const double	valueX,
		const double	valueY,
		const double	valueZ,
		const double	weight,
		const std::string &	title = `""`
	)		const

fill the 2D profile histogram with the values and weight

Parameters

histo	2D profile histogram to be filled
valueX	x value to be put into the histogram
valueY	y value to be put into the histogram
valueZ	z value to be put into the histogram
weight	weight to be used
title	histogram title (to be used for error report)

Returns: pointer to AIDA 1D histogram

template<class PBASE >

AIDA::IProfile2D * GaudiHistos< PBASE >::fill	(	AIDA::IProfile2D *	histo,
		const double	valueX,
		const double	valueY,
		const double	valueZ,
		const double	weight,
		const std::string &	title = `""`
	)		const

fill the 2D profile histogram with the values and weight

Parameters

histo	2D profile histogram to be filled
valueX	x value to be put into the histogram
valueY	y value to be put into the histogram
valueZ	z value to be put into the histogram
weight	weight to be used
title	histogram title (to be used for error report)

Returns: pointer to AIDA 1D histogram

Definition at line 114 of file GaudiHistos_2DProfFixedBinning.icpp.

 {
   if ( 0 == histo ) { return 0 ; } // RETURN
   //
   if ( !checkForNaN() )
   { Gaudi::Utils::Histos::fill ( histo , valueX , valueY , valueZ , weight ); }
   else if  ( std::isfinite ( valueX ) && std::isfinite ( valueY ) &&
              std::isfinite ( valueZ ) && std::isfinite ( weight ) )
   { Gaudi::Utils::Histos::fill ( histo , valueX , valueY , valueZ , weight ); }
   else if  ( std::isnan ( valueX ) || std::isnan ( valueY ) ||
              std::isnan ( valueZ ) || std::isnan ( weight ) )
   {
     this -> Warning
       ("fill():: 'NaN'      value is skipped from the histogram '"
        + Gaudi::Utils::Histos::htitle ( histo , title ) + "'" ) ;
   }
   else
   {
     this -> Warning
       ("fill():: 'Infinite' value is skipped from the histogram '"
        + Gaudi::Utils::Histos::htitle ( histo , title ) + "'" ) ;
   }
   // return
   return histo ;
 }

template<class PBASE >

StatusCode GaudiHistos< PBASE >::finalize ( )

overrideprotected

standard finalization method

Returns: status code

Definition at line 208 of file GaudiHistos.icpp.

 {
 
   if ( produceHistos() )
   {
 
     // Count how many histos of each type
     if ( (!noHistos()) && histoCountersPrint() )
     {
       const unsigned int n1D  = histo1DMapID   () . size () ;
       const unsigned int n2D  = histo2DMapID   () . size () ;
       const unsigned int n3D  = histo3DMapID   () . size () ;
       const unsigned int n1DP = profile1DMapID () . size () ;
       const unsigned int n2DP = profile2DMapID () . size () ;
       const unsigned int total = n1D+n2D+n3D+n1DP+n2DP;
       if ( total>0 )
       {
         this->always() << "Booked " << total << " Histogram(s) : ";
         if ( n1D>0  ) this->always() << "1D=" << n1D << " ";
         if ( n2D>0  ) this->always() << "2D=" << n2D << " ";
         if ( n3D>0  ) this->always() << "3D=" << n3D << " ";
         if ( n1DP>0 ) this->always() << "1DProf=" << n1DP << " ";
         if ( n2DP>0 ) this->always() << "2DProf=" << n2DP << " ";
         this->always() << endmsg;
       }
     }
 
     // detailed printing
     if ( histosPrint() ) { printHistos() ; }
 
   }
 
   // clear all maps
   m_histo1DMapTitle   . clear () ;
   m_histo2DMapTitle   . clear () ;
   m_histo3DMapTitle   . clear () ;
   m_histo1DMapID      . clear () ;
   m_histo2DMapID      . clear () ;
   m_histo3DMapID      . clear () ;
   m_profile1DMapTitle . clear () ;
   m_profile2DMapTitle . clear () ;
   m_profile1DMapID    . clear () ;
   m_profile2DMapID    . clear () ;
 
   // finalize base class
   return PBASE::finalize();
 }

template<class PBASE>

StatusCode GaudiHistos< PBASE >::finalize ( )

overrideprotected

standard finalization method

Returns: status code

template<class PBASE>

bool GaudiHistos< PBASE >::fullDetail ( ) const

inline

get flag to control output level of histograms

Definition at line 2693 of file GaudiHistos.h.

2693 { return m_fullDetail ; }

bool m_fullDetail

flag to control output level of histograms

Definition: GaudiHistos.h:3066

template<class PBASE>

bool GaudiHistos< PBASE >::fullDetail ( ) const

inline

get flag to control output level of histograms

Definition at line 2693 of file GaudiHistos.h.

2693 { return m_fullDetail ; }

GaudiHistos::m_histo1DMapID

bool m_fullDetail

flag to control output level of histograms

Definition: GaudiHistos.h:3066

template<class PBASE>

AIDA::IHistogram1D* GaudiHistos< PBASE >::histo ( const std::string & title ) const

inline

access the EXISTING 1D histogram by title

Wrapper method for the equivalent histo1D method. Retained for backwards compatibility, please use histo1D instead.

return the pointer to existing 1D histogram or NULL

Definition at line 2582 of file GaudiHistos.h.

   {
     return histo1D( title );
   }

template<class PBASE>

AIDA::IHistogram1D* GaudiHistos< PBASE >::histo ( const std::string & title ) const

inline

access the EXISTING 1D histogram by title

Wrapper method for the equivalent histo1D method. Retained for backwards compatibility, please use histo1D instead.

return the pointer to existing 1D histogram or NULL

Definition at line 2582 of file GaudiHistos.h.

   {
     return histo1D( title );
   }

template<class PBASE>

AIDA::IHistogram1D* GaudiHistos< PBASE >::histo ( const HistoID & ID ) const

inline

access the EXISTING 1D histogram by ID

Wrapper method for the equivalent histo1D method. Retained for backwards compatibility, please use histo1D instead.

return the pointer to existing 1D histogram or NULL

Definition at line 2637 of file GaudiHistos.h.

   {
     return histo1D( ID );
   }

template<class PBASE>

AIDA::IHistogram1D* GaudiHistos< PBASE >::histo ( const HistoID & ID ) const

inline

access the EXISTING 1D histogram by ID

Wrapper method for the equivalent histo1D method. Retained for backwards compatibility, please use histo1D instead.

return the pointer to existing 1D histogram or NULL

Definition at line 2637 of file GaudiHistos.h.

   {
     return histo1D( ID );
   }

template<class PBASE>

AIDA::IHistogram1D* GaudiHistos< PBASE >::histo1D ( const std::string & title ) const

inline

access the EXISTING 1D histogram by title return the pointer to existing 1D histogram or NULL

Definition at line 2569 of file GaudiHistos.h.

   {
     auto found = histo1DMapTitle().find( title ) ;
     return found != histo1DMapTitle().end() ? found->second : nullptr;
   }

template<class PBASE>

AIDA::IHistogram1D* GaudiHistos< PBASE >::histo1D ( const std::string & title ) const

inline

access the EXISTING 1D histogram by title return the pointer to existing 1D histogram or NULL

Definition at line 2569 of file GaudiHistos.h.

   {
     auto found = histo1DMapTitle().find( title ) ;
     return found != histo1DMapTitle().end() ? found->second : nullptr;
   }

template<class PBASE >

AIDA::IHistogram1D * GaudiHistos< PBASE >::histo1D ( const HistoID & ID ) const

access the EXISTING 1D histogram by ID return the pointer to existing 1D histogram or NULL

Definition at line 404 of file GaudiHistos.icpp.

 {
   return lookup_( histo1DMapID(), ID );
 }

template<class PBASE>

AIDA::IHistogram1D* GaudiHistos< PBASE >::histo1D ( const HistoID & ID ) const

access the EXISTING 1D histogram by ID return the pointer to existing 1D histogram or NULL

template<class PBASE>

const Histo1DMapID& GaudiHistos< PBASE >::histo1DMapID ( ) const

inline

get access to the map of all 1D histograms index via ID

// iterate over the map!
for ( const auto& entry : histo1DMapID() )
   {
      // histogram ID
      const HistoID        ID = entry.first ;
      // histogram itself
      AIDA::IHistogram1D* h  = entry.second ;
      if ( 0 == h ) { continue ;}
      std::cout << " Histogram ID    " << ID
                << " Histogram title " << h->title() << std::endl ;
   }

Definition at line 2768 of file GaudiHistos.h.

2768 { return m_histo1DMapID ; }

Histo1DMapID m_histo1DMapID

the actual storage/access of 1D histograms by unique ID

Definition: GaudiHistos.h:3087

template<class PBASE>

const Histo1DMapID& GaudiHistos< PBASE >::histo1DMapID ( ) const

inline

get access to the map of all 1D histograms index via ID

// iterate over the map!
for ( const auto& entry : histo1DMapID() )
   {
      // histogram ID
      const HistoID        ID = entry.first ;
      // histogram itself
      AIDA::IHistogram1D* h  = entry.second ;
      if ( 0 == h ) { continue ;}
      std::cout << " Histogram ID    " << ID
                << " Histogram title " << h->title() << std::endl ;
   }

Definition at line 2768 of file GaudiHistos.h.

2768 { return m_histo1DMapID ; }

GaudiHistos::m_histo1DMapID

Histo1DMapID m_histo1DMapID

the actual storage/access of 1D histograms by unique ID

Definition: GaudiHistos.h:3087

template<class PBASE>

const Histo1DMapTitle& GaudiHistos< PBASE >::histo1DMapTitle ( ) const

inline

get access to the map of all 1D histograms indexed via their title

Using this method one can inspect e.g. a list of active histograms

// iterate over the map!
for ( const auto& entry :histo1DMapTitle()  )
   {
      // histogram title
      const std::string&   title = entry.first ;
      // histogram itself
      AIDA::IHistogram1D* hist  = entry.second ;
      if( !hist )  { continue ; }                // ATTENTION!
      std::cout << " Histogram title " << title << std::endl ;
   }

Attention: The map COULD contains NULL pointers, the check before use is mandatory!

Definition at line 2744 of file GaudiHistos.h.

2744 { return m_histo1DMapTitle; }

GaudiHistos::m_histo1DMapTitle

Histo1DMapTitle m_histo1DMapTitle

the actual storage/access of 1D histograms by unique title

Definition: GaudiHistos.h:3085

template<class PBASE>

const Histo1DMapTitle& GaudiHistos< PBASE >::histo1DMapTitle ( ) const

inline

get access to the map of all 1D histograms indexed via their title

Using this method one can inspect e.g. a list of active histograms

// iterate over the map!
for ( const auto& entry :histo1DMapTitle()  )
   {
      // histogram title
      const std::string&   title = entry.first ;
      // histogram itself
      AIDA::IHistogram1D* hist  = entry.second ;
      if( !hist )  { continue ; }                // ATTENTION!
      std::cout << " Histogram title " << title << std::endl ;
   }

Attention: The map COULD contains NULL pointers, the check before use is mandatory!

Definition at line 2744 of file GaudiHistos.h.

2744 { return m_histo1DMapTitle; }

GaudiHistos::m_histo1DMapTitle

Histo1DMapTitle m_histo1DMapTitle

the actual storage/access of 1D histograms by unique title

Definition: GaudiHistos.h:3085

template<class PBASE>

AIDA::IHistogram2D* GaudiHistos< PBASE >::histo2D ( const std::string & title ) const

inline

access the EXISTING 2D histogram by title return the pointer to existing 2D histogram or NULL

Definition at line 2590 of file GaudiHistos.h.

   {
     auto found = histo2DMapTitle().find( title ) ;
     return histo2DMapTitle().end() != found ? found->second : nullptr;
   }

template<class PBASE>

AIDA::IHistogram2D* GaudiHistos< PBASE >::histo2D ( const std::string & title ) const

inline

access the EXISTING 2D histogram by title return the pointer to existing 2D histogram or NULL

Definition at line 2590 of file GaudiHistos.h.

   {
     auto found = histo2DMapTitle().find( title ) ;
     return histo2DMapTitle().end() != found ? found->second : nullptr;
   }

template<class PBASE >

AIDA::IHistogram2D * GaudiHistos< PBASE >::histo2D ( const HistoID & ID ) const

access the EXISTING 2D histogram by ID return the pointer to existing 2D histogram or NULL

Definition at line 412 of file GaudiHistos.icpp.

 {
   return lookup_( histo2DMapID(), ID );
 }

template<class PBASE>

AIDA::IHistogram2D* GaudiHistos< PBASE >::histo2D ( const HistoID & ID ) const

access the EXISTING 2D histogram by ID return the pointer to existing 2D histogram or NULL

template<class PBASE>

const Histo2DMapID& GaudiHistos< PBASE >::histo2DMapID ( ) const

inline

get access to the map of 2D histograms index via ID

// iterate over the map!
for ( const auto& entry : histo2DMapID() )
   {
      // histogram ID
      const HistoID        ID = entry.first ;
      // histogram itself
      AIDA::IHistogram2D* h  = entry.second ;
      if ( 0 == h ) { continue ;}
      std::cout << " Histogram ID    " << ID
                << " Histogram title " << h->title() << std::endl ;
   }

Definition at line 2818 of file GaudiHistos.h.

2818 { return m_histo2DMapID ; }

GaudiHistos::m_histo2DMapID

Histo2DMapID m_histo2DMapID

the actual storage/access of 2D histograms by unique ID

Definition: GaudiHistos.h:3092

template<class PBASE>

const Histo2DMapID& GaudiHistos< PBASE >::histo2DMapID ( ) const

inline

get access to the map of 2D histograms index via ID

// iterate over the map!
for ( const auto& entry : histo2DMapID() )
   {
      // histogram ID
      const HistoID        ID = entry.first ;
      // histogram itself
      AIDA::IHistogram2D* h  = entry.second ;
      if ( 0 == h ) { continue ;}
      std::cout << " Histogram ID    " << ID
                << " Histogram title " << h->title() << std::endl ;
   }

Definition at line 2818 of file GaudiHistos.h.

2818 { return m_histo2DMapID ; }

GaudiHistos::m_histo2DMapID

Histo2DMapID m_histo2DMapID

the actual storage/access of 2D histograms by unique ID

Definition: GaudiHistos.h:3092

template<class PBASE>

const Histo2DMapTitle& GaudiHistos< PBASE >::histo2DMapTitle ( ) const

inline

get access to the map of all 2D histograms indexed via their title

Using this method one can inspect e.g. a list of active histograms

// iterate over the map!
for ( const auto& entry : histo2DMapTitle() )
   {
      // histogram title
      const std::string&   title = entry.first ;
      // histogram itself
      AIDA::IHistogram2D* hist  = entry.second ;
      if( 0 == hist )  { continue ; }                // ATTENTION!
      std::cout << " Histogram title " << title << std::endl ;
   }

Attention: The map COULD contains NULL pointers, the check before use is mandatory!

Definition at line 2795 of file GaudiHistos.h.

2795 { return m_histo2DMapTitle ; }

GaudiHistos::m_histo2DMapTitle

Histo2DMapTitle m_histo2DMapTitle

the actual storage/access of 2D histograms by unique title

Definition: GaudiHistos.h:3090

template<class PBASE>

const Histo2DMapTitle& GaudiHistos< PBASE >::histo2DMapTitle ( ) const

inline

get access to the map of all 2D histograms indexed via their title

Using this method one can inspect e.g. a list of active histograms

// iterate over the map!
for ( const auto& entry : histo2DMapTitle() )
   {
      // histogram title
      const std::string&   title = entry.first ;
      // histogram itself
      AIDA::IHistogram2D* hist  = entry.second ;
      if( 0 == hist )  { continue ; }                // ATTENTION!
      std::cout << " Histogram title " << title << std::endl ;
   }

Attention: The map COULD contains NULL pointers, the check before use is mandatory!

Definition at line 2795 of file GaudiHistos.h.

2795 { return m_histo2DMapTitle ; }

GaudiHistos::m_histo2DMapTitle

Histo2DMapTitle m_histo2DMapTitle

the actual storage/access of 2D histograms by unique title

Definition: GaudiHistos.h:3090

template<class PBASE>

AIDA::IHistogram3D* GaudiHistos< PBASE >::histo3D ( const std::string & title ) const

inline

access the EXISTING 3D histogram by title return the pointer to existing 3D histogram or NULL

Definition at line 2599 of file GaudiHistos.h.

   {
     auto found = histo3DMapTitle().find( title ) ;
     return histo3DMapTitle().end() != found ? found->second : nullptr;
   }

template<class PBASE>

AIDA::IHistogram3D* GaudiHistos< PBASE >::histo3D ( const std::string & title ) const

inline

access the EXISTING 3D histogram by title return the pointer to existing 3D histogram or NULL

Definition at line 2599 of file GaudiHistos.h.

   {
     auto found = histo3DMapTitle().find( title ) ;
     return histo3DMapTitle().end() != found ? found->second : nullptr;
   }

template<class PBASE >

AIDA::IHistogram3D * GaudiHistos< PBASE >::histo3D ( const HistoID & ID ) const

access the EXISTING 3D histogram by ID return the pointer to existing 3D histogram or NULL

Definition at line 420 of file GaudiHistos.icpp.

 {
   return lookup_( histo3DMapID(), ID );
 }

template<class PBASE>

AIDA::IHistogram3D* GaudiHistos< PBASE >::histo3D ( const HistoID & ID ) const

access the EXISTING 3D histogram by ID return the pointer to existing 3D histogram or NULL

template<class PBASE>

const Histo3DMapID& GaudiHistos< PBASE >::histo3DMapID ( ) const

inline

get access to the map of all 3D histograms index via a ID

// iterate over the map!
for ( const auto&  entry :  histo3DMapID() )
   {
      // histogram ID
      const HistoID        ID = entry.first ;
      // histogram itself
      AIDA::IHistogram3D* h  = entry.second ;
      if ( 0 == h ) { continue ;}
      std::cout << " Histogram ID    " << ID
                << " Histogram title " << h->title() << std::endl ;
   }

Definition at line 2868 of file GaudiHistos.h.

2868 { return m_histo3DMapID; }

GaudiHistos::m_histo3DMapID

Histo3DMapID m_histo3DMapID

the actual storage/access of 3D histograms by unique ID

Definition: GaudiHistos.h:3097

template<class PBASE>

const Histo3DMapID& GaudiHistos< PBASE >::histo3DMapID ( ) const

inline

get access to the map of all 3D histograms index via a ID

// iterate over the map!
for ( const auto&  entry :  histo3DMapID() )
   {
      // histogram ID
      const HistoID        ID = entry.first ;
      // histogram itself
      AIDA::IHistogram3D* h  = entry.second ;
      if ( 0 == h ) { continue ;}
      std::cout << " Histogram ID    " << ID
                << " Histogram title " << h->title() << std::endl ;
   }

Definition at line 2868 of file GaudiHistos.h.

2868 { return m_histo3DMapID; }

GaudiHistos::m_histo3DMapID

Histo3DMapID m_histo3DMapID

the actual storage/access of 3D histograms by unique ID

Definition: GaudiHistos.h:3097

template<class PBASE>

const Histo3DMapTitle& GaudiHistos< PBASE >::histo3DMapTitle ( ) const

inline

get access to the map of all 3D histograms indexed via their title

Using this method one can inspect e.g. a list of active histograms

// iterate over the map!
for ( const auto& entry : histo3DMapTitle() )
   {
      // histogram title
      const std::string&   title = entry.first ;
      // histogram itself
      AIDA::IHistogram3D* hist  = entry.second ;
      if( 0 == hist )  { continue ; }                // ATTENTION!
      std::cout << " Histogram title " << title << std::endl ;
   }

Attention: The map COULD contains NULL pointers, the check before use is mandatory!

Definition at line 2845 of file GaudiHistos.h.

2845 { return m_histo3DMapTitle ; }

GaudiHistos::m_histo3DMapTitle

Histo3DMapTitle m_histo3DMapTitle

the actual storage/access of 3D histograms by unique title

Definition: GaudiHistos.h:3095

template<class PBASE>

const Histo3DMapTitle& GaudiHistos< PBASE >::histo3DMapTitle ( ) const

inline

get access to the map of all 3D histograms indexed via their title

Using this method one can inspect e.g. a list of active histograms

// iterate over the map!
for ( const auto& entry : histo3DMapTitle() )
   {
      // histogram title
      const std::string&   title = entry.first ;
      // histogram itself
      AIDA::IHistogram3D* hist  = entry.second ;
      if( 0 == hist )  { continue ; }                // ATTENTION!
      std::cout << " Histogram title " << title << std::endl ;
   }

Attention: The map COULD contains NULL pointers, the check before use is mandatory!

Definition at line 2845 of file GaudiHistos.h.

2845 { return m_histo3DMapTitle ; }

GaudiHistos::m_histo3DMapTitle

Histo3DMapTitle m_histo3DMapTitle

the actual storage/access of 3D histograms by unique title

Definition: GaudiHistos.h:3095

template<class PBASE>

bool GaudiHistos< PBASE >::histoCountersPrint ( ) const

inline

print histogram counters at finalization ?

Definition at line 2709 of file GaudiHistos.h.

2709 { return m_histoCountersPrint ; }

GaudiHistos::m_histoCountersPrint

bool m_histoCountersPrint

print histogram counters at finalization

Definition: GaudiHistos.h:3080

template<class PBASE>

bool GaudiHistos< PBASE >::histoCountersPrint ( ) const

inline

print histogram counters at finalization ?

Definition at line 2709 of file GaudiHistos.h.

2709 { return m_histoCountersPrint ; }

GaudiHistos::m_histoCountersPrint

bool m_histoCountersPrint

print histogram counters at finalization

Definition: GaudiHistos.h:3080

template<class PBASE>

const std::string& GaudiHistos< PBASE >::histoDir ( ) const

inline

get histogram directory (property "HistoDir")

Definition at line 2703 of file GaudiHistos.h.

2703 { return m_histoDir ; }

std::string m_histoDir

histogram directory

Definition: GaudiHistos.h:3076

template<class PBASE>

const std::string& GaudiHistos< PBASE >::histoDir ( ) const

inline

get histogram directory (property "HistoDir")

Definition at line 2703 of file GaudiHistos.h.

2703 { return m_histoDir ; }

std::string m_histoDir

histogram directory

Definition: GaudiHistos.h:3076

template<class PBASE>

bool GaudiHistos< PBASE >::histoExists ( const std::string & title ) const

inline

check the existence AND validity of the histogram with given title

Definition at line 2665 of file GaudiHistos.h.

   {
     return
       ( 0 != histo     ( title ) ||
         0 != histo2D   ( title ) ||
         0 != histo3D   ( title ) ||
         0 != profile1D ( title ) ||
         0 != profile2D ( title ) );
   }

template<class PBASE>

bool GaudiHistos< PBASE >::histoExists ( const std::string & title ) const

inline

check the existence AND validity of the histogram with given title

Definition at line 2665 of file GaudiHistos.h.

   {
     return
       ( 0 != histo     ( title ) ||
         0 != histo2D   ( title ) ||
         0 != histo3D   ( title ) ||
         0 != profile1D ( title ) ||
         0 != profile2D ( title ) );
   }

template<class PBASE>

bool GaudiHistos< PBASE >::histoExists ( const HistoID & ID ) const

inline

check the existence AND validity of the histogram with given title

Definition at line 2676 of file GaudiHistos.h.

   {
     return
       ( 0 != histo     ( ID ) ||
         0 != histo2D   ( ID ) ||
         0 != histo3D   ( ID ) ||
         0 != profile1D ( ID ) ||
         0 != profile2D ( ID ) );
   }

template<class PBASE>

bool GaudiHistos< PBASE >::histoExists ( const HistoID & ID ) const

inline

check the existence AND validity of the histogram with given title

Definition at line 2676 of file GaudiHistos.h.

   {
     return
       ( 0 != histo     ( ID ) ||
         0 != histo2D   ( ID ) ||
         0 != histo3D   ( ID ) ||
         0 != profile1D ( ID ) ||
         0 != profile2D ( ID ) );
   }

template<class PBASE>

HistoID::NumericID GaudiHistos< PBASE >::histoOffSet ( ) const

inline

get the value for histogram offset (property "HistoOffSet")

Definition at line 2699 of file GaudiHistos.h.

2699 { return m_histoOffSet ; }

HistoID::NumericID m_histoOffSet

general histogram ID offset (only works for automatically assigned numeric IDs)

Definition: GaudiHistos.h:3072

template<class PBASE>

HistoID::NumericID GaudiHistos< PBASE >::histoOffSet ( ) const

inline

get the value for histogram offset (property "HistoOffSet")

Definition at line 2699 of file GaudiHistos.h.

2699 { return m_histoOffSet ; }

GaudiHistos::m_histosPrint

HistoID::NumericID m_histoOffSet

general histogram ID offset (only works for automatically assigned numeric IDs)

Definition: GaudiHistos.h:3072

template<class PBASE >

std::string GaudiHistos< PBASE >::histoPath ( ) const

get the constructed histogram path

Definition at line 508 of file GaudiHistos.icpp.

 {
   std::string path = histoTopDir() + histoDir();
   return splitHistoDir() ? dirHbookName(path) : path;
 }

template<class PBASE>

std::string GaudiHistos< PBASE >::histoPath ( ) const

get the constructed histogram path

template<class PBASE>

bool GaudiHistos< PBASE >::histosPrint ( ) const

inline

print histograms at finalization ?

Definition at line 2707 of file GaudiHistos.h.

2707 { return m_histosPrint ; }

bool m_histosPrint

print histograms at finalization

Definition: GaudiHistos.h:3078

template<class PBASE>

bool GaudiHistos< PBASE >::histosPrint ( ) const

inline

print histograms at finalization ?

Definition at line 2707 of file GaudiHistos.h.

2707 { return m_histosPrint ; }

GaudiHistos::m_histosPrint

bool m_histosPrint

print histograms at finalization

Definition: GaudiHistos.h:3078

template<class PBASE>

const std::string& GaudiHistos< PBASE >::histoTopDir ( ) const

inline

get top-level histogram directory (property "HistoTopDir")

Definition at line 2701 of file GaudiHistos.h.

2701 { return m_histoTopDir ; }

std::string m_histoTopDir

histogram top level directory

Definition: GaudiHistos.h:3074

template<class PBASE>

const std::string& GaudiHistos< PBASE >::histoTopDir ( ) const

inline

get top-level histogram directory (property "HistoTopDir")

Definition at line 2701 of file GaudiHistos.h.

2701 { return m_histoTopDir ; }

std::string m_histoTopDir

histogram top level directory

Definition: GaudiHistos.h:3074

template<class PBASE >

void GaudiHistos< PBASE >::initGaudiHistosConstructor ( )

private

Constructor initialisation and job options.

Definition at line 88 of file GaudiHistos.icpp.

 {
   // SWITCH ON/OFF the histograms
   this->declareProperty
     ( "HistoProduce"          ,
       m_produceHistos = true  ,
       "Switch on/off the production of histograms" ) ;
   // print the histograms at finalization
   this->declareProperty
     ( "HistoPrint"            ,
       m_histosPrint   = false ,
       "Switch on/off the printout of histograms at finalization" )
     -> declareUpdateHandler ( &GaudiHistos<PBASE>::printHistoHandler, this ) ;
   this->declareProperty
     ( "HistoCountersPrint"         ,
       m_histoCountersPrint = true ,
       "Switch on/off the printout of histogram counters at finalization" ) ;
   // check for NaN/Finite
   this->declareProperty
     ( "HistoCheckForNaN"      ,
       m_checkForNaN   = true  ,
       "Switch on/off the checks for NaN and Infinity for histogram fill" ) ;
   // for HBOOK persistency, 'true' can be useful
   this->declareProperty
     ( "HistoSplitDir"         ,
       m_splitHistoDir = false ,
       "Split long directory names into short pieces (suitable for HBOOK)" );
   // general OffSet for histogram ID
   this->declareProperty
     ( "HistoOffSet"           ,
       m_histoOffSet   =   0   ,
       "OffSet for automatically assigned histogram numerical identifiers " ) ;
   // top level histogram directory
   this->declareProperty
     ( "HistoTopDir"           ,
       m_histoTopDir   =   ""  ,
       "Top level histogram directory (take care that it ends with '/')" ) ;
   // histogram directory
   this->declareProperty
     ( "HistoDir"             ,
       m_histoDir      = boost::algorithm::replace_all_copy( this->name(), ":", "_" ) ,
       "Histogram Directory" ) ;
   // control output level of histograms
   this->declareProperty ( "FullDetail"            , m_fullDetail    = false ) ;
   // monitor histograms
   this->declareProperty ( "MonitorHistograms"     , m_declareMoniHists = true ) ;
   // format for 1D-histograms printout
   this->declareProperty
     ( "FormatFor1DHistoTable" ,
       m_histo1DTableFormat   = Gaudi::Utils::Histos::Formats::format () ,
       "Format string for printout of 1D histograms"      ) ;
   // "short" format for 1D-histograms printout
   this->declareProperty
     ( "ShortFormatFor1DHistoTable" ,
       m_histo1DTableFormatShort   = " | %1$-25.25s %2%"  ,
       "Format string for printout of 1D histograms"      ) ;
   // the header for 1D-histogram table
   this->declareProperty
     ( "HeaderFor1DHistoTable" ,
       m_histo1DTableHeader   = Gaudi::Utils::Histos::Formats::header () ,
       "The table header for printout of 1D histograms "  ) ;
   this->declareProperty
     ( "UseSequencialNumericAutoIDs", m_useNumericAutoIDs = false,
       "Flag to allow users to switch back to the old style of creating numerical automatic IDs" );
   this->declareProperty
     ( "AutoStringIDPurgeMap", m_idReplaceInfo = { { "/", "=SLASH=" } } ,
       "Map of strings to search and replace when using the title as the basis of automatically generated literal IDs" );
 }

template<class PBASE>

void GaudiHistos< PBASE >::initGaudiHistosConstructor ( )

private

Constructor initialisation and job options.

template<class PBASE >

StatusCode GaudiHistos< PBASE >::initialize ( )

overrideprotected

standard initialization method

Returns: status code

Definition at line 166 of file GaudiHistos.icpp.

 {
   // initialize base class
   const StatusCode sc = PBASE::initialize();
   if ( sc.isFailure() ) return sc;
 
   // produce histograms?
   if ( !produceHistos() )
   {
     this->debug() << "Histogram production is switched OFF" << endmsg;
     return sc;
   }
 
   // check the validity of histogram service
   if ( !this->histoSvc() )
   { return this->Error("initialize():: IHistogramSvc* is invalid"); }
 
   // Warn if the user has decided to use numerical automatic IDs
   if ( useNumericAutoIDs() )
   {
     this ->
       Warning( "Using numerical automatic IDs. These are not guaranteed to be totally deterministic. Use with care...",
                StatusCode::SUCCESS ).ignore();
   }
 
   // Finally, print the location histogram will be written to
   this->Print
     ( "The histogram path is set to be '" + histoPath() + "'",
       StatusCode( StatusCode::SUCCESS, true )  , MSG::DEBUG ).ignore();
 
   return sc;
 }

template<class PBASE>

StatusCode GaudiHistos< PBASE >::initialize ( )

overrideprotected

standard initialization method

Returns: status code

template<class PBASE>

void GaudiHistos< PBASE >::monitorHisto	(	const AIDA::IBaseHistogram *	hist,
		const HistoID &	ID
	)		const

private

Declare a histogram to the monitor service.

Uses the histogram ID as the 'name' sent to the monitor service and the histogram title as the long description

template<class PBASE >

void GaudiHistos< PBASE >::monitorHisto	(	const AIDA::IBaseHistogram *	hist,
		const HistoID &	ID
	)		const

private

Declare a histogram to the monitor service.

Uses the histogram ID as the 'name' sent to the monitor service and the histogram title as the long description

Definition at line 384 of file GaudiHistos.icpp.

 {
   if ( hist && m_declareMoniHists )
   {
     if ( this->msgLevel(MSG::DEBUG) )
     {
       this->debug() << "Monitoring histogram '"
                     << ID.idAsString() << "' desc = '"
                     << Gaudi::Utils::Histos::htitle(hist) << "'" << endmsg;
     }
     this->declareInfo ( histoPath()+"/"+ID.idAsString() ,
                         hist            ,
                         Gaudi::Utils::Histos::htitle(hist) ) ;
   }
 }

template<class PBASE >

void GaudiHistos< PBASE >::newHistoID	(	const std::string &	title,
		HistoID &	ID
	)		const

private

Create a new histogram ID using the given title.

Parameters

[in]	title	Histogram title
[out]	ID	The ID to use for the new histogram

Definition at line 458 of file GaudiHistos.icpp.

 {
   if ( useNumericAutoIDs() || title.empty() )
   {
     if ( !useNumericAutoIDs() )
     {
       this -> Warning( "Cannot generate automatic literal ID from an empty title ! Using numeric ID instead for histogram ID",
                        StatusCode::SUCCESS );
     }
     // propose the histogram ID (always numeric)
     ID = HistoID( totalNumberOfHistos() + 1 + histoOffSet() );
     // adjust the proposed ID
     while ( histoExists( ID ) ) { ID = HistoID ( ID.numeric() + 1 ) ; }
   }
   else
   {
     // use the title to create a unique literal ID
     ID = HistoID( this->convertTitleToID(title) );
     // Just in case ...
     while ( histoExists( ID ) ) { ID = HistoID(ID.idAsString()+"_"); }
   }
 }

template<class PBASE>

void GaudiHistos< PBASE >::newHistoID	(	const std::string &	title,
		HistoID &	ID
	)		const

private

Create a new histogram ID using the given title.

Parameters

[in]	title	Histogram title
[out]	ID	The ID to use for the new histogram

template<class PBASE >

bool GaudiHistos< PBASE >::noHistos ( ) const

private

Check if all histogram maps are empty.

Definition at line 366 of file GaudiHistos.icpp.

 {
   return ( histo1DMapTitle   () . empty() &&
            histo2DMapTitle   () . empty() &&
            histo3DMapTitle   () . empty() &&
            profile1DMapTitle () . empty() &&
            profile2DMapTitle () . empty() &&
            histo1DMapID      () . empty() &&
            histo2DMapID      () . empty() &&
            histo3DMapID      () . empty() &&
            profile1DMapID    () . empty() &&
            profile2DMapID    () . empty() );
 }

template<class PBASE>

bool GaudiHistos< PBASE >::noHistos ( ) const

private

Check if all histogram maps are empty.

template<class PBASE>

AIDA::IHistogram1D* GaudiHistos< PBASE >::plot	(	const double	value,
		const std::string &	title,
		const double	low,
		const double	high,
		const unsigned long	bins = `100`,
		const double	weight = `1.0`
	)		const

inline

fill the 1D histogram (book on demand)

Wrapper method for the equivalent plot1D method. Retained for backwards compatibility, please use plot1D instead.

Parameters

value	value to be filled
title	histogram title (must be unique within the algorithm)
low	low limit for histogram
high	high limit for histogram
bins	number of bins
weight	weight

Returns: pointer to AIDA 1D histogram

Definition at line 152 of file GaudiHistos.h.

   {
     return plot1D ( value, title, low, high, bins, weight );
   }

template<class PBASE>

AIDA::IHistogram1D* GaudiHistos< PBASE >::plot	(	const double	value,
		const std::string &	title,
		const double	low,
		const double	high,
		const unsigned long	bins = `100`,
		const double	weight = `1.0`
	)		const

inline

fill the 1D histogram (book on demand)

Wrapper method for the equivalent plot1D method. Retained for backwards compatibility, please use plot1D instead.

Parameters

value	value to be filled
title	histogram title (must be unique within the algorithm)
low	low limit for histogram
high	high limit for histogram
bins	number of bins
weight	weight

Returns: pointer to AIDA 1D histogram

Definition at line 152 of file GaudiHistos.h.

   {
     return plot1D ( value, title, low, high, bins, weight );
   }

template<class PBASE>

AIDA::IHistogram1D* GaudiHistos< PBASE >::plot	(	const double	value,
		const Gaudi::Histo1DDef &	hdef,
		const double	weight = `1.0`
	)		const

inline

fill the 1D histogram (book on demand)

Wrapper method for the equivalent plot1D method. Retained for backwards compatibility, please use plot1D instead.

Parameters

value	value to be filled
hdef	histogram descriptor
weight	weight

Returns: pointer to AIDA 1D histogram

Definition at line 202 of file GaudiHistos.h.

   {
     return plot1D ( value, hdef, weight );
   }

template<class PBASE>

AIDA::IHistogram1D* GaudiHistos< PBASE >::plot	(	const double	value,
		const Gaudi::Histo1DDef &	hdef,
		const double	weight = `1.0`
	)		const

inline

fill the 1D histogram (book on demand)

Wrapper method for the equivalent plot1D method. Retained for backwards compatibility, please use plot1D instead.

Parameters

value	value to be filled
hdef	histogram descriptor
weight	weight

Returns: pointer to AIDA 1D histogram

Definition at line 202 of file GaudiHistos.h.

   {
     return plot1D ( value, hdef, weight );
   }

template<class PBASE>

AIDA::IHistogram1D* GaudiHistos< PBASE >::plot	(	const double	value,
		const HistoID &	ID,
		const std::string &	title,
		const double	low,
		const double	high,
		const unsigned long	bins = `100`,
		const double	weight = `1.0`
	)		const

inline

fill the 1D histogram with forced ID assignment (book on demand)

Wrapper method for the equivalent plot1D method. Retained for backwards compatibility, please use plot1D instead.

Parameters

value	value to be filled
ID	histogram identifier
title	histogram title (must be unique within the algorithm)
low	low limit for histogram
high	high limit for histogram
bins	number of bins
weight	weight

Returns: pointer to AIDA 1D histogram

Definition at line 298 of file GaudiHistos.h.

   {
     return plot1D ( value, ID, title, low, high, bins, weight );
   }

template<class PBASE>

AIDA::IHistogram1D* GaudiHistos< PBASE >::plot	(	const double	value,
		const HistoID &	ID,
		const std::string &	title,
		const double	low,
		const double	high,
		const unsigned long	bins = `100`,
		const double	weight = `1.0`
	)		const

inline

fill the 1D histogram with forced ID assignment (book on demand)

Wrapper method for the equivalent plot1D method. Retained for backwards compatibility, please use plot1D instead.

Parameters

value	value to be filled
ID	histogram identifier
title	histogram title (must be unique within the algorithm)
low	low limit for histogram
high	high limit for histogram
bins	number of bins
weight	weight

Returns: pointer to AIDA 1D histogram

Definition at line 298 of file GaudiHistos.h.

   {
     return plot1D ( value, ID, title, low, high, bins, weight );
   }

template<class PBASE>

AIDA::IHistogram1D* GaudiHistos< PBASE >::plot	(	const double	value,
		const HistoID &	ID,
		const Gaudi::Histo1DDef &	hdef,
		const double	weight = `1.0`
	)		const

inline

fill the 1D histogram (book on demand)

Wrapper method for the equivalent plot1D method. Retained for backwards compatibility, please use plot1D instead.

Parameters

value	value to be filled
ID	histogram identifier
hdef	histogram descriptor
weight	weight

Returns: pointer to AIDA 1D histogram

Definition at line 352 of file GaudiHistos.h.

   {
     return plot1D ( value, ID, hdef, weight );
   }

template<class PBASE>

AIDA::IHistogram1D* GaudiHistos< PBASE >::plot	(	const double	value,
		const HistoID &	ID,
		const Gaudi::Histo1DDef &	hdef,
		const double	weight = `1.0`
	)		const

inline

fill the 1D histogram (book on demand)

Wrapper method for the equivalent plot1D method. Retained for backwards compatibility, please use plot1D instead.

Parameters

value	value to be filled
ID	histogram identifier
hdef	histogram descriptor
weight	weight

Returns: pointer to AIDA 1D histogram

Definition at line 352 of file GaudiHistos.h.

   {
     return plot1D ( value, ID, hdef, weight );
   }

template<class PBASE>

template<class FUNCTION , class OBJECT >

AIDA::IHistogram1D* GaudiHistos< PBASE >::plot	(	const FUNCTION &	func,
		OBJECT	first,
		OBJECT	last,
		const std::string &	title,
		const double	low,
		const double	high,
		const unsigned long	bins = `100`
	)		const

inline

fill the 1D histogram with information from [first,last) sequence

std::vector<double> v = ... ;
plot( sin                 , // function
      v.begin() , v.end() , // sequence
      " bla-bla "         , // title
      -1. , 1.0           , // low and high limits
      100                 ) // number of bins

Attention: The histogram will get a unique identifier automatically assigned which by default will be equal to the histogram title. An option exists to instead use numerical IDs. In this case the first histogram booked will be ID=1 the next ID=2 and so on. Note though this scheme is not recommended as it does NOT guarantee predictability of the ID a given histogram will be given when filled under conditional statements, since in these circumstances the order in which the histograms are first filled, and thus booked, will depend on the nature of the first few events read. This is particularly problematic when users submit many parallel 'sub-jobs' and then attempt to merge the final output ROOT (or HBOOK) files, since a given histogram could have different IDs in each of the sub-jobs. Consequently it is strongly recommended that users do not use numerical automatic IDs unless they are sure they understand what they are doing.

Sequence, objects and function can be non-trivial:

Particles* p = ... ;
plot( PT                  , // function
      p->begin()  , p->end() , // sequence
      " bla-bla "         , // title
      -1. , 1.0           , // low and high limits
      100                 ) ; // number of bins

where PT can be any function or function object for which the expression PT(p) , with p of type Particle* have some sense and can be evaluated to the values, which is convertible to double

Attention: These plot methods using iterator ranges are more efficient than the simplier "value" only methods, since the associated histogram only requires locating from internal storage once per loop, as opposed to once per fill for the simplier functions. It is recommended to use these whenever possible.

See also: AIDA::IHistogram1D

Parameters

func	function to be plotted
first	begin of the sequence
last	end of the sequence
title	histogram title
low	low limit for histogram
high	high limit for histogram
bins	number of bins for histogram

Definition at line 424 of file GaudiHistos.h.

   {
     AIDA::IHistogram1D* h = nullptr;
     if ( produceHistos() )
     {
       // retrieve or book the histogram
       h = histo1D ( title ) ;
       if ( !h )     { h = book1D  ( title , low , high , bins ); }
       // fill histogram
       while( first != last && h  )
       { h = fill ( h , func( *first ) , 1.0 , title  ) ; ++first ; }
     }
     return h ;
   }

template<class PBASE>

template<class FUNCTION , class OBJECT >

AIDA::IHistogram1D* GaudiHistos< PBASE >::plot	(	const FUNCTION &	func,
		OBJECT	first,
		OBJECT	last,
		const std::string &	title,
		const double	low,
		const double	high,
		const unsigned long	bins = `100`
	)		const

inline

fill the 1D histogram with information from [first,last) sequence

std::vector<double> v = ... ;
plot( sin                 , // function
      v.begin() , v.end() , // sequence
      " bla-bla "         , // title
      -1. , 1.0           , // low and high limits
      100                 ) // number of bins

Attention: The histogram will get a unique identifier automatically assigned which by default will be equal to the histogram title. An option exists to instead use numerical IDs. In this case the first histogram booked will be ID=1 the next ID=2 and so on. Note though this scheme is not recommended as it does NOT guarantee predictability of the ID a given histogram will be given when filled under conditional statements, since in these circumstances the order in which the histograms are first filled, and thus booked, will depend on the nature of the first few events read. This is particularly problematic when users submit many parallel 'sub-jobs' and then attempt to merge the final output ROOT (or HBOOK) files, since a given histogram could have different IDs in each of the sub-jobs. Consequently it is strongly recommended that users do not use numerical automatic IDs unless they are sure they understand what they are doing.

Sequence, objects and function can be non-trivial:

Particles* p = ... ;
plot( PT                  , // function
      p->begin()  , p->end() , // sequence
      " bla-bla "         , // title
      -1. , 1.0           , // low and high limits
      100                 ) ; // number of bins

where PT can be any function or function object for which the expression PT(p) , with p of type Particle* have some sense and can be evaluated to the values, which is convertible to double

Attention: These plot methods using iterator ranges are more efficient than the simplier "value" only methods, since the associated histogram only requires locating from internal storage once per loop, as opposed to once per fill for the simplier functions. It is recommended to use these whenever possible.

See also: AIDA::IHistogram1D

Parameters

func	function to be plotted
first	begin of the sequence
last	end of the sequence
title	histogram title
low	low limit for histogram
high	high limit for histogram
bins	number of bins for histogram

Definition at line 424 of file GaudiHistos.h.

   {
     AIDA::IHistogram1D* h = nullptr;
     if ( produceHistos() )
     {
       // retrieve or book the histogram
       h = histo1D ( title ) ;
       if ( !h )     { h = book1D  ( title , low , high , bins ); }
       // fill histogram
       while( first != last && h  )
       { h = fill ( h , func( *first ) , 1.0 , title  ) ; ++first ; }
     }
     return h ;
   }

template<class PBASE>

template<class FUNCTION , class OBJECT >

AIDA::IHistogram1D* GaudiHistos< PBASE >::plot	(	const FUNCTION &	func,
		OBJECT	first,
		OBJECT	last,
		const HistoID &	ID,
		const std::string &	title,
		const double	low,
		const double	high,
		const unsigned long	bins = `100`
	)		const

inline

fill the 1D histogram with forced ID and information from [first,last) sequence

std::vector<double> v = ... ;
// Example with numeric ID
plot( sin                 ,   // function
      v.begin() , v.end() ,   // sequence
      100 , " bla-bla "   ,   // ID and title
      -1. , 1.0           ,   // low and high limits
      100                 );  // number of bins
// Example with literal ID
plot( sin                 ,   // function
      v.begin() , v.end() ,   // sequence
      "sin" , " bla-bla " ,   // ID and title
      -1. , 1.0           ,   // low and high limits
      100                 );  // number of bins

Sequence, objects and function can be non-trivial:

Particles* p = ... ;
plot( PT                  ,   // function
      p->begin()   , p->end() , // sequence
      100 , " bla-bla "   ,   // ID and title
      -1. , 1.0           ,   // low and high limits
      100                 ) ; // number of bins

Attention: These plot methods using iterator ranges are more efficient than the simplier "value" only methods, since the associated histogram only requires locating from internal storage once per loop, as opposed to once per fill for the simplier functions. It is recommended to use these whenever possible.

See also: AIDA::IHistogram1D

Parameters

func	function to be plotted
first	begin of the sequence
last	end of the sequence
ID	histogram identifier
title	histogram title
low	low limit for histogram
high	high limit for histogram
bins	number of bins for histogram

Definition at line 502 of file GaudiHistos.h.

   {
     AIDA::IHistogram1D* h(0);
     if ( produceHistos() )
     {
       // retrieve or book the histogram
       h = histo1D ( ID ) ;
       if ( !h )     { h = book1D  ( ID , title , low , high , bins ); }
       // fill histogram
       while( first != last && h )
       { h = fill( h , func( *first ) , 1.0 , title  ) ; ++first ; }
     }
     return h;
   }

template<class PBASE>

template<class FUNCTION , class OBJECT >

AIDA::IHistogram1D* GaudiHistos< PBASE >::plot	(	const FUNCTION &	func,
		OBJECT	first,
		OBJECT	last,
		const HistoID &	ID,
		const std::string &	title,
		const double	low,
		const double	high,
		const unsigned long	bins = `100`
	)		const

inline

fill the 1D histogram with forced ID and information from [first,last) sequence

std::vector<double> v = ... ;
// Example with numeric ID
plot( sin                 ,   // function
      v.begin() , v.end() ,   // sequence
      100 , " bla-bla "   ,   // ID and title
      -1. , 1.0           ,   // low and high limits
      100                 );  // number of bins
// Example with literal ID
plot( sin                 ,   // function
      v.begin() , v.end() ,   // sequence
      "sin" , " bla-bla " ,   // ID and title
      -1. , 1.0           ,   // low and high limits
      100                 );  // number of bins

Sequence, objects and function can be non-trivial:

Particles* p = ... ;
plot( PT                  ,   // function
      p->begin()   , p->end() , // sequence
      100 , " bla-bla "   ,   // ID and title
      -1. , 1.0           ,   // low and high limits
      100                 ) ; // number of bins

Attention: These plot methods using iterator ranges are more efficient than the simplier "value" only methods, since the associated histogram only requires locating from internal storage once per loop, as opposed to once per fill for the simplier functions. It is recommended to use these whenever possible.

See also: AIDA::IHistogram1D

Parameters

func	function to be plotted
first	begin of the sequence
last	end of the sequence
ID	histogram identifier
title	histogram title
low	low limit for histogram
high	high limit for histogram
bins	number of bins for histogram

Definition at line 502 of file GaudiHistos.h.

   {
     AIDA::IHistogram1D* h(0);
     if ( produceHistos() )
     {
       // retrieve or book the histogram
       h = histo1D ( ID ) ;
       if ( !h )     { h = book1D  ( ID , title , low , high , bins ); }
       // fill histogram
       while( first != last && h )
       { h = fill( h , func( *first ) , 1.0 , title  ) ; ++first ; }
     }
     return h;
   }

template<class PBASE>

template<class FUNCTION , class OBJECT , class WEIGHT >

AIDA::IHistogram1D* GaudiHistos< PBASE >::plot	(	const FUNCTION &	func,
		OBJECT	first,
		OBJECT	last,
		const std::string &	title,
		const double	low,
		const double	high,
		const unsigned long	bins,
		const WEIGHT &	weight
	)		const

inline

book and fill the 1D histogram with information from [first,last) sequence with given weight

std::vector<double> v = ... ;
plot( sin                 ,   // function
      v.begin() , v.end() ,   // sequence
      " bla-bla "         ,   // title
      -1. , 1.0           ,   // low and high limits
      100                 ,   // number of bins
      tanh                );  // weight function

Attention: The histogram will get a unique identifier automatically assigned which by default will be equal to the histogram title. An option exists to instead use numerical IDs. In this case the first histogram booked will be ID=1 the next ID=2 and so on. Note though this scheme is not recommended as it does NOT guarantee predictability of the ID a given histogram will be given when filled under conditional statements, since in these circumstances the order in which the histograms are first filled, and thus booked, will depend on the nature of the first few events read. This is particularly problematic when users submit many parallel 'sub-jobs' and then attempt to merge the final output ROOT (or HBOOK) files, since a given histogram could have different IDs in each of the sub-jobs. Consequently it is strongly recommended that users do not use numerical automatic IDs unless they are sure they understand what they are doing.

Sequence, objects and function can be non-trivial:

Particles* p = ... ;
plot( PT                  ,  // function
      p->begin()  , p->end() , // sequence
      " bla-bla "         ,   // title
      -1. , 1.0           ,   // low and high limits
      100                 ,   // number of bins
      MASS                ) ; // weight function

where PT and MASS can be any function or function object for which the expressions PT(p) and MASS with p of type Particle* have some sense and can be evaluated to the values, which is convertible to double

Attention: These plot methods using iterator ranges are more efficient than the simplier "value" only methods, since the associated histogram only requires locating from internal storage once per loop, as opposed to once per fill for the simplier functions. It is recommended to use these whenever possible.

See also: AIDA::IHistogram1D

Parameters

first	begin of the sequence
last	end of the sequence
title	histogram title
func	function to be plotted
low	low limit for histogram
high	high limit for histogram
bins	number of bins for histogram
weight	weight function

Definition at line 594 of file GaudiHistos.h.

   {
     AIDA::IHistogram1D* h = nullptr;
     if ( produceHistos() )
     {
       // retrieve or book the histogram
       h = histo1D ( title ) ;
       if ( !h ) { h = book1D  ( title , low , high , bins ); }
       // fill histogram
       while ( first != last && h )
       { h = fill ( h                 ,
                    func   ( *first ) ,
                    weight ( *first ) , title  ) ; ++first ; }
     }
     return h;
   }

template<class PBASE>

template<class FUNCTION , class OBJECT , class WEIGHT >

AIDA::IHistogram1D* GaudiHistos< PBASE >::plot	(	const FUNCTION &	func,
		OBJECT	first,
		OBJECT	last,
		const std::string &	title,
		const double	low,
		const double	high,
		const unsigned long	bins,
		const WEIGHT &	weight
	)		const

inline

book and fill the 1D histogram with information from [first,last) sequence with given weight

std::vector<double> v = ... ;
plot( sin                 ,   // function
      v.begin() , v.end() ,   // sequence
      " bla-bla "         ,   // title
      -1. , 1.0           ,   // low and high limits
      100                 ,   // number of bins
      tanh                );  // weight function

Attention: The histogram will get a unique identifier automatically assigned which by default will be equal to the histogram title. An option exists to instead use numerical IDs. In this case the first histogram booked will be ID=1 the next ID=2 and so on. Note though this scheme is not recommended as it does NOT guarantee predictability of the ID a given histogram will be given when filled under conditional statements, since in these circumstances the order in which the histograms are first filled, and thus booked, will depend on the nature of the first few events read. This is particularly problematic when users submit many parallel 'sub-jobs' and then attempt to merge the final output ROOT (or HBOOK) files, since a given histogram could have different IDs in each of the sub-jobs. Consequently it is strongly recommended that users do not use numerical automatic IDs unless they are sure they understand what they are doing.

Sequence, objects and function can be non-trivial:

Particles* p = ... ;
plot( PT                  ,  // function
      p->begin()  , p->end() , // sequence
      " bla-bla "         ,   // title
      -1. , 1.0           ,   // low and high limits
      100                 ,   // number of bins
      MASS                ) ; // weight function

where PT and MASS can be any function or function object for which the expressions PT(p) and MASS with p of type Particle* have some sense and can be evaluated to the values, which is convertible to double

Attention: These plot methods using iterator ranges are more efficient than the simplier "value" only methods, since the associated histogram only requires locating from internal storage once per loop, as opposed to once per fill for the simplier functions. It is recommended to use these whenever possible.

See also: AIDA::IHistogram1D

Parameters

first	begin of the sequence
last	end of the sequence
title	histogram title
func	function to be plotted
low	low limit for histogram
high	high limit for histogram
bins	number of bins for histogram
weight	weight function

Definition at line 594 of file GaudiHistos.h.

   {
     AIDA::IHistogram1D* h = nullptr;
     if ( produceHistos() )
     {
       // retrieve or book the histogram
       h = histo1D ( title ) ;
       if ( !h ) { h = book1D  ( title , low , high , bins ); }
       // fill histogram
       while ( first != last && h )
       { h = fill ( h                 ,
                    func   ( *first ) ,
                    weight ( *first ) , title  ) ; ++first ; }
     }
     return h;
   }

template<class PBASE>

template<class FUNCTION , class OBJECT , class WEIGHT >

AIDA::IHistogram1D* GaudiHistos< PBASE >::plot	(	const FUNCTION &	func,
		OBJECT	first,
		OBJECT	last,
		const HistoID &	ID,
		const std::string &	title,
		const double	low,
		const double	high,
		const unsigned long	bins,
		const WEIGHT &	weight
	)		const

inline

book and fill the 1D histogram with forced ID and information from [first,last) sequence with given weight

std::vector<double> v = ... ;
// example with numerical ID
plot( sin                 ,   // function
      v.begin() , v.end() ,   // sequence
      100 , " bla-bla "   ,   // ID and title
      -1. , 1.0           ,   // low and high limits
      100                 ,   // number of bins
      sinh                );  // weight function
// example with literal ID
plot( sin                 ,   // function
      v.begin() , v.end() ,   // sequence
      "sin" , " bla-bla "   ,   // ID and title
      -1. , 1.0           ,   // low and high limits
      100                 ,   // number of bins
      sinh                );  // weight function

Attention: no checks for NaN or Finite are performed!

Sequence, objects and function can be non-trivial:

Particles* p = ... ;
plot( PT                  ,   // function
      p->begin()   , p->end() , // sequence
      100 , " bla-bla "   ,   // ID and title
      -1. , 1.0           ,   // low and high limits
      100                 ,   // number of bins
      MASS                ) ; // weight function

where PT and MASS can be any function or function object for which the expressions PT(p) and MASS with p of type Particle* have some sense and can be evaluated to the values, which is convertible to double

Attention: These plot methods using iterator ranges are more efficient than the simplier "value" only methods, since the associated histogram only requires locating from internal storage once per loop, as opposed to once per fill for the simplier functions. It is recommended to use these whenever possible.

See also: AIDA::IHistogram1D

Parameters

first	begin of the sequence
last	end of the sequence
ID	histogram identifier
title	histogram title
func	function to be plotted
low	low limit for histogram
high	high limit for histogram
bins	number of bins for histogram
weight	weight function

Definition at line 686 of file GaudiHistos.h.

   {
     AIDA::IHistogram1D* h = nullptr;
     if ( produceHistos() )
     {
       // retrieve or book the histogram
       h = histo1D ( ID ) ;
       if ( !h ) { h = book1D  ( ID , title , low , high , bins ); }
       // fill histogram
       while( first != last && h )
       { h  = fill ( h                 ,
                     func   ( *first ) ,
                     weight ( *first ) , title  ) ; ++first ; }
     }
     return h ;
   }

template<class PBASE>

template<class FUNCTION , class OBJECT , class WEIGHT >

AIDA::IHistogram1D* GaudiHistos< PBASE >::plot	(	const FUNCTION &	func,
		OBJECT	first,
		OBJECT	last,
		const HistoID &	ID,
		const std::string &	title,
		const double	low,
		const double	high,
		const unsigned long	bins,
		const WEIGHT &	weight
	)		const

inline

book and fill the 1D histogram with forced ID and information from [first,last) sequence with given weight

std::vector<double> v = ... ;
// example with numerical ID
plot( sin                 ,   // function
      v.begin() , v.end() ,   // sequence
      100 , " bla-bla "   ,   // ID and title
      -1. , 1.0           ,   // low and high limits
      100                 ,   // number of bins
      sinh                );  // weight function
// example with literal ID
plot( sin                 ,   // function
      v.begin() , v.end() ,   // sequence
      "sin" , " bla-bla "   ,   // ID and title
      -1. , 1.0           ,   // low and high limits
      100                 ,   // number of bins
      sinh                );  // weight function

Attention: no checks for NaN or Finite are performed!

Sequence, objects and function can be non-trivial:

Particles* p = ... ;
plot( PT                  ,   // function
      p->begin()   , p->end() , // sequence
      100 , " bla-bla "   ,   // ID and title
      -1. , 1.0           ,   // low and high limits
      100                 ,   // number of bins
      MASS                ) ; // weight function

where PT and MASS can be any function or function object for which the expressions PT(p) and MASS with p of type Particle* have some sense and can be evaluated to the values, which is convertible to double

Attention: These plot methods using iterator ranges are more efficient than the simplier "value" only methods, since the associated histogram only requires locating from internal storage once per loop, as opposed to once per fill for the simplier functions. It is recommended to use these whenever possible.

See also: AIDA::IHistogram1D

Parameters

first	begin of the sequence
last	end of the sequence
ID	histogram identifier
title	histogram title
func	function to be plotted
low	low limit for histogram
high	high limit for histogram
bins	number of bins for histogram
weight	weight function

Definition at line 686 of file GaudiHistos.h.

   {
     AIDA::IHistogram1D* h = nullptr;
     if ( produceHistos() )
     {
       // retrieve or book the histogram
       h = histo1D ( ID ) ;
       if ( !h ) { h = book1D  ( ID , title , low , high , bins ); }
       // fill histogram
       while( first != last && h )
       { h  = fill ( h                 ,
                     func   ( *first ) ,
                     weight ( *first ) , title  ) ; ++first ; }
     }
     return h ;
   }

template<class PBASE >

AIDA::IHistogram1D * GaudiHistos< PBASE >::plot1D	(	const double	value,
		const std::string &	title,
		const double	low,
		const double	high,
		const unsigned long	bins = `100`,
		const double	weight = `1.0`
	)		const

fill the 1D histogram (book on demand)

const double mass = ... ;

plot1D( mass , "Invariant Mass" , 2.5 , 3.5 , 100 )

This example illustrates the filling of the histogram titled "InvariantMass" with value mass .

If the histogram with given title does not exist yet it will be automatically booked with parameters low equal to 2.5, parameters high equal to 3.5 and bins equal to 100.

Attention: The histogram will get a unique identifier automatically assigned which by default will be equal to the histogram title. An option exists to instead use numerical IDs. In this case the first histogram booked will be ID=1 the next ID=2 and so on. Note though this scheme is not recommended as it does NOT guarantee predictability of the ID a given histogram will be given when filled under conditional statements, since in these circumstances the order in which the histograms are first filled, and thus booked, will depend on the nature of the first few events read. This is particularly problematic when users submit many parallel 'sub-jobs' and then attempt to merge the final output ROOT (or HBOOK) files, since a given histogram could have different IDs in each of the sub-jobs. Consequently it is strongly recommended that users do not use numerical automatic IDs unless they are sure they understand what they are doing.

See also: AIDA::IHistogram1D

Parameters

value	value to be filled
title	histogram title (must be unique within the algorithm)
low	low limit for histogram
high	high limit for histogram
bins	number of bins
weight	weight

Returns: pointer to AIDA 1D histogram

Definition at line 137 of file GaudiHistos_1DFixedBinning.icpp.

 {
   AIDA::IHistogram1D * h(nullptr);
   if ( produceHistos() )
   {
     // retrieve or book the histogram
     h = histo1D ( title ) ;
     if ( !h ) { h = book1D  ( title , low , high , bins ) ; }
     // fill the histogram
     h = fill ( h , value , weight , title );
   }
   return h;
 }

template<class PBASE>

AIDA::IHistogram1D* GaudiHistos< PBASE >::plot1D	(	const double	value,
		const std::string &	title,
		const double	low,
		const double	high,
		const unsigned long	bins = `100`,
		const double	weight = `1.0`
	)		const

fill the 1D histogram (book on demand)

const double mass = ... ;

plot1D( mass , "Invariant Mass" , 2.5 , 3.5 , 100 )

This example illustrates the filling of the histogram titled "InvariantMass" with value mass .

If the histogram with given title does not exist yet it will be automatically booked with parameters low equal to 2.5, parameters high equal to 3.5 and bins equal to 100.

Attention: The histogram will get a unique identifier automatically assigned which by default will be equal to the histogram title. An option exists to instead use numerical IDs. In this case the first histogram booked will be ID=1 the next ID=2 and so on. Note though this scheme is not recommended as it does NOT guarantee predictability of the ID a given histogram will be given when filled under conditional statements, since in these circumstances the order in which the histograms are first filled, and thus booked, will depend on the nature of the first few events read. This is particularly problematic when users submit many parallel 'sub-jobs' and then attempt to merge the final output ROOT (or HBOOK) files, since a given histogram could have different IDs in each of the sub-jobs. Consequently it is strongly recommended that users do not use numerical automatic IDs unless they are sure they understand what they are doing.

See also: AIDA::IHistogram1D

Parameters

value	value to be filled
title	histogram title (must be unique within the algorithm)
low	low limit for histogram
high	high limit for histogram
bins	number of bins
weight	weight

Returns: pointer to AIDA 1D histogram

template<class PBASE >

AIDA::IHistogram1D * GaudiHistos< PBASE >::plot1D	(	const double	value,
		const Gaudi::Histo1DDef &	hdef,
		const double	weight = `1.0`
	)		const

fill the 1D histogram (book on demand)

const Gaudi::Histo1DDef& hdef = ... ;
const double mass = ... ;
plot1D ( mass , hdef ) ;

The histogram will get a unique identifier automatically assigned which by default will be equal to the histogram title.

The histogram descriptor comes e.g. from the component properties.

See also: AIDA::IHistogram1D

Parameters

value	value to be filled
hdef	histogram descriptor
weight	weight

Returns: pointer to AIDA 1D histogram

Definition at line 214 of file GaudiHistos_1DFixedBinning.icpp.

 {
   return plot1D
     ( value  ,
       hdef.title() , hdef.lowEdge() , hdef.highEdge() , hdef.bins() ,
       weight ) ;
 }

template<class PBASE>

AIDA::IHistogram1D* GaudiHistos< PBASE >::plot1D	(	const double	value,
		const Gaudi::Histo1DDef &	hdef,
		const double	weight = `1.0`
	)		const

fill the 1D histogram (book on demand)

const Gaudi::Histo1DDef& hdef = ... ;
const double mass = ... ;
plot1D ( mass , hdef ) ;

The histogram will get a unique identifier automatically assigned which by default will be equal to the histogram title.

The histogram descriptor comes e.g. from the component properties.

See also: AIDA::IHistogram1D

Parameters

value	value to be filled
hdef	histogram descriptor
weight	weight

Returns: pointer to AIDA 1D histogram

template<class PBASE>

AIDA::IHistogram1D* GaudiHistos< PBASE >::plot1D	(	const double	value,
		const HistoID &	ID,
		const std::string &	title,
		const double	low,
		const double	high,
		const unsigned long	bins = `100`,
		const double	weight = `1.0`
	)		const

fill the 1D histogram with forced ID assignment (book on demand)

const double mass = ... ;

plot1D( mass , 15 , "Invariant Mass" , 2.5 , 3.5 , 100 )

This example illustrates the filling of the 1D histogram ID=15 titled "Invariant Mass" with value mass .

If the histogram with given ID does not exist yet it will be automatically booked with parameters low equal to 2.5, parameters high equal to 3.5 and bins equal to 100.

It is also possible to use literal IDs. For example :-

const double mass = ... ;

plot1D( mass , "mass" , "Invariant Mass" , 2.5 , 3.5 , 100 )

Will book the same histogram, using the id "mass".

It is also possible using literal IDs, to place histograms in sub-directories from the main histogram directory, using for example :-

const double mass = ... ;

plot1D( mass , "subdir/mass" , "Invariant Mass" , 2.5 , 3.5 , 100 )

Which will create the histogram "mass" in the sub-directory "subdir". Histograms can also be created in sub-directories with numeric IDs if IDs such as "subdir/1" are used.

Attention: If the histogram with given ID is already booked through automatic assignment of histogram ID, the error will not be detected. Therefore it is recommended to use non-trivial histogram ID offset (property "HistoOffSet") if one need to combine these techniques together. It is still desirable to use the unique histogram title to avoid a bad interference.

See also: AIDA::IHistogram1D

Parameters

value	value to be filled
ID	histogram identifier
title	histogram title (must be unique within the algorithm)
low	low limit for histogram
high	high limit for histogram
bins	number of bins
weight	weight

Returns: pointer to AIDA 1D histogram

template<class PBASE >

AIDA::IHistogram1D * GaudiHistos< PBASE >::plot1D	(	const double	value,
		const HistoID &	ID,
		const std::string &	title,
		const double	low,
		const double	high,
		const unsigned long	bins = `100`,
		const double	weight = `1.0`
	)		const

fill the 1D histogram with forced ID assignment (book on demand)

const double mass = ... ;

plot1D( mass , 15 , "Invariant Mass" , 2.5 , 3.5 , 100 )

This example illustrates the filling of the 1D histogram ID=15 titled "Invariant Mass" with value mass .

If the histogram with given ID does not exist yet it will be automatically booked with parameters low equal to 2.5, parameters high equal to 3.5 and bins equal to 100.

It is also possible to use literal IDs. For example :-

const double mass = ... ;

plot1D( mass , "mass" , "Invariant Mass" , 2.5 , 3.5 , 100 )

Will book the same histogram, using the id "mass".

It is also possible using literal IDs, to place histograms in sub-directories from the main histogram directory, using for example :-

const double mass = ... ;

plot1D( mass , "subdir/mass" , "Invariant Mass" , 2.5 , 3.5 , 100 )

Which will create the histogram "mass" in the sub-directory "subdir". Histograms can also be created in sub-directories with numeric IDs if IDs such as "subdir/1" are used.

Attention: If the histogram with given ID is already booked through automatic assignment of histogram ID, the error will not be detected. Therefore it is recommended to use non-trivial histogram ID offset (property "HistoOffSet") if one need to combine these techniques together. It is still desirable to use the unique histogram title to avoid a bad interference.

See also: AIDA::IHistogram1D

Parameters

value	value to be filled
ID	histogram identifier
title	histogram title (must be unique within the algorithm)
low	low limit for histogram
high	high limit for histogram
bins	number of bins
weight	weight

Returns: pointer to AIDA 1D histogram

Definition at line 161 of file GaudiHistos_1DFixedBinning.icpp.

 {
   AIDA::IHistogram1D* h(nullptr);
   if ( produceHistos() )
   {
     // retrieve or book the histogram
     h = histo1D ( ID ) ;
     if ( !h ) {  h = book1D ( ID , title , low , high , bins ) ; }
     // fill
     h = fill ( h , value , weight , title ) ;
   }
   return h;
 }

template<class PBASE >

AIDA::IHistogram1D * GaudiHistos< PBASE >::plot1D	(	const double	value,
		const HistoID &	ID,
		const Gaudi::Histo1DDef &	hdef,
		const double	weight = `1.0`
	)		const

fill the 1D histogram with forced ID assignment (book on demand)

// get the histogram descriptor
const Gaudi::Histo1DDef& hdef = ... ;
// get the histogram ID
const HistoID ID = ... ;
const double mass = ... ;
plot1D ( mass , ID , hdef  )

See also: AIDA::IHistogram1D

The histogram descriptor comes e.g. from component properties

Parameters

value	value to be filled
ID	histogram identifier
hdef	histogram descriptor
weight	weight

Returns: pointer to AIDA 1D histogram

Definition at line 229 of file GaudiHistos_1DFixedBinning.icpp.

 {
   return plot1D
     ( value  , ID ,
       hdef.title() , hdef.lowEdge() , hdef.highEdge() , hdef.bins() ,
       weight ) ;
 }

template<class PBASE>

AIDA::IHistogram1D* GaudiHistos< PBASE >::plot1D	(	const double	value,
		const HistoID &	ID,
		const Gaudi::Histo1DDef &	hdef,
		const double	weight = `1.0`
	)		const

fill the 1D histogram with forced ID assignment (book on demand)

// get the histogram descriptor
const Gaudi::Histo1DDef& hdef = ... ;
// get the histogram ID
const HistoID ID = ... ;
const double mass = ... ;
plot1D ( mass , ID , hdef  )

See also: AIDA::IHistogram1D

The histogram descriptor comes e.g. from component properties

Parameters

value	value to be filled
ID	histogram identifier
hdef	histogram descriptor
weight	weight

Returns: pointer to AIDA 1D histogram

template<class PBASE >

AIDA::IHistogram1D * GaudiHistos< PBASE >::plot1D	(	const double	value,
		const std::string &	title,
		const HistoBinEdges &	edges,
		const double	weight = `1.0`
	)		const

Fill the 1D variable binning histogram (book on demand)

const GaudiAlg::HistoBinEdges edges = ...;
const double mass = ... ;
plot1D( mass , "Invariant Mass" , edges )

This example illustrates the filling of the histogram titled "InvariantMass" with value mass.

If the histogram with given title does not exist yet it will be automatically booked with the given histogram bin edges.

Attention: The histogram will get a unique identifier automatically assigned which by default will be equal to the histogram title. An option exists to instead use numerical IDs. In this case the first histogram booked will be ID=1 the next ID=2 and so on. Note though this scheme is not recommended as it does NOT guarantee predictability of the ID a given histogram will be given when filled under conditional statements, since in these circumstances the order in which the histograms are first filled, and thus booked, will depend on the nature of the first few events read. This is particularly problematic when users submit many parallel 'sub-jobs' and then attempt to merge the final output ROOT (or HBOOK) files, since a given histogram could have different IDs in each of the sub-jobs. Consequently it is strongly recommended that users do not use numerical automatic IDs unless they are sure they understand what they are doing.

See also: AIDA::IHistogram1D

Parameters

value	value to be filled
title	histogram title (must be unique within the algorithm)
edges	The histogram bin edges
weight	weight

Returns: pointer to AIDA 1D histogram

Definition at line 97 of file GaudiHistos_1DVariableBinning.icpp.

 {
   AIDA::IHistogram1D * h(nullptr);
   if ( produceHistos() )
   {
     // retrieve or book the histogram
     h = histo1D ( title ) ;
     if ( !h ) { h = book1D ( title , edges ) ; }
     // fill the histogram
     h = fill ( h , value , weight , title );
   }
   return h;
 }

template<class PBASE>

AIDA::IHistogram1D* GaudiHistos< PBASE >::plot1D	(	const double	value,
		const std::string &	title,
		const HistoBinEdges &	edges,
		const double	weight = `1.0`
	)		const

Fill the 1D variable binning histogram (book on demand)

const GaudiAlg::HistoBinEdges edges = ...;
const double mass = ... ;
plot1D( mass , "Invariant Mass" , edges )

This example illustrates the filling of the histogram titled "InvariantMass" with value mass.

If the histogram with given title does not exist yet it will be automatically booked with the given histogram bin edges.

Attention: The histogram will get a unique identifier automatically assigned which by default will be equal to the histogram title. An option exists to instead use numerical IDs. In this case the first histogram booked will be ID=1 the next ID=2 and so on. Note though this scheme is not recommended as it does NOT guarantee predictability of the ID a given histogram will be given when filled under conditional statements, since in these circumstances the order in which the histograms are first filled, and thus booked, will depend on the nature of the first few events read. This is particularly problematic when users submit many parallel 'sub-jobs' and then attempt to merge the final output ROOT (or HBOOK) files, since a given histogram could have different IDs in each of the sub-jobs. Consequently it is strongly recommended that users do not use numerical automatic IDs unless they are sure they understand what they are doing.

See also: AIDA::IHistogram1D

Parameters

value	value to be filled
title	histogram title (must be unique within the algorithm)
edges	The histogram bin edges
weight	weight

Returns: pointer to AIDA 1D histogram

template<class PBASE >

AIDA::IHistogram1D * GaudiHistos< PBASE >::plot1D	(	const double	value,
		const HistoID &	ID,
		const std::string &	title,
		const HistoBinEdges &	edges,
		const double	weight = `1.0`
	)		const

fill the 1D variable binning histogram with forced ID assignment (book on demand)

const GaudiAlg::HistoBinEdges edges = ...;
const double mass = ... ;
plot1D( mass , 15 , "Invariant Mass" , edges )

This example illustrates the filling of the 1D histogram ID=15 titled "Invariant Mass" with value mass.

If the histogram with given ID does not exist yet it will be automatically booked with the given histogram bin edges.

It is also possible to use literal IDs. For example :-

const GaudiAlg::HistoBinEdges edges = ...;
const double mass = ... ;
plot1D( mass , "mass" , "Invariant Mass" , edges )

Will book the same histogram, using the id "mass".

It is also possible using literal IDs, to place histograms in sub-directories from the main histogram directory, using for example :-

const GaudiAlg::HistoBinEdges edges = ...;
const double mass = ... ;
plot1D( mass , "subdir/mass" , "Invariant Mass" , edges )

Which will create the histogram "mass" in the sub-directory "subdir". Histograms can also be created in sub-directories with numeric IDs if IDs such as "subdir/1" are used.

Attention: If the histogram with given ID is already booked through automatic assignment of histogram ID, the error will not be detected. Therefore it is recommended to use non-trivial histogram ID offset (property "HistoOffSet") if one need to combine these techniques together. It is still desirable to use the unique histogram title to avoid a bad interference.

See also: AIDA::IHistogram1D

Parameters

value	value to be filled
ID	histogram identifier
title	histogram title (must be unique within the algorithm)
edges	The histogram bin edges
weight	weight

Returns: pointer to AIDA 1D histogram

Definition at line 119 of file GaudiHistos_1DVariableBinning.icpp.

 {
   AIDA::IHistogram1D* h(nullptr);
   if ( produceHistos() )
   {
     // retrieve or book the histogram
     h = histo1D ( ID ) ;
     if ( !h ) {  h = book1D ( ID , title , edges ) ; }
     // fill
     h = fill ( h , value , weight , title ) ;
   }
   return h;
 }

template<class PBASE>

AIDA::IHistogram1D* GaudiHistos< PBASE >::plot1D	(	const double	value,
		const HistoID &	ID,
		const std::string &	title,
		const HistoBinEdges &	edges,
		const double	weight = `1.0`
	)		const

fill the 1D variable binning histogram with forced ID assignment (book on demand)

const GaudiAlg::HistoBinEdges edges = ...;
const double mass = ... ;
plot1D( mass , 15 , "Invariant Mass" , edges )

This example illustrates the filling of the 1D histogram ID=15 titled "Invariant Mass" with value mass.

If the histogram with given ID does not exist yet it will be automatically booked with the given histogram bin edges.

It is also possible to use literal IDs. For example :-

const GaudiAlg::HistoBinEdges edges = ...;
const double mass = ... ;
plot1D( mass , "mass" , "Invariant Mass" , edges )

Will book the same histogram, using the id "mass".

It is also possible using literal IDs, to place histograms in sub-directories from the main histogram directory, using for example :-

const GaudiAlg::HistoBinEdges edges = ...;
const double mass = ... ;
plot1D( mass , "subdir/mass" , "Invariant Mass" , edges )

Which will create the histogram "mass" in the sub-directory "subdir". Histograms can also be created in sub-directories with numeric IDs if IDs such as "subdir/1" are used.

Attention: If the histogram with given ID is already booked through automatic assignment of histogram ID, the error will not be detected. Therefore it is recommended to use non-trivial histogram ID offset (property "HistoOffSet") if one need to combine these techniques together. It is still desirable to use the unique histogram title to avoid a bad interference.

See also: AIDA::IHistogram1D

Parameters

value	value to be filled
ID	histogram identifier
title	histogram title (must be unique within the algorithm)
edges	The histogram bin edges
weight	weight

Returns: pointer to AIDA 1D histogram

template<class PBASE >

AIDA::IHistogram2D * GaudiHistos< PBASE >::plot2D	(	const double	valueX,
		const double	valueY,
		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 histogram (book on demand)

const double mass1 = ... ;
const double mass2 = ... ;
plot2D( mass1, mass2,
       "Invariant Mass2 versus Mass1" ,2.5 ,3.5, 4.5, 5.5, 100, 200 );

This example illustrates the filling of the 2D histogram titled "Invariant Mass2 versus Mass1" with values mass1 and mass2 .

If the histogram with given title does not exist yet it will be automatically booked with parameters lowX equal to 2.5, highX equal to 3.5, lowY equal to 4.5, highY equal to 5.5, binsX equal to 100 and binsY equal to 200.

Attention: The histogram will get a unique identifier automatically assigned which by default will be equal to the histogram title. An option exists to instead use numerical IDs. In this case the first histogram booked will be ID=1 the next ID=2 and so on. Note though this scheme is not recommended as it does NOT guarantee predictability of the ID a given histogram will be given when filled under conditional statements, since in these circumstances the order in which the histograms are first filled, and thus booked, will depend on the nature of the first few events read. This is particularly problematic when users submit many parallel 'sub-jobs' and then attempt to merge the final output ROOT (or HBOOK) files, since a given histogram could have different IDs in each of the sub-jobs. Consequently it is strongly recommended that users do not use numerical automatic IDs unless they are sure they understand what they are doing.

See also: AIDA::IHistogram2D

Parameters

valueX	x value to be filled
valueY	y value to be filled
title	histogram title (must be unique within the algorithm)
lowX	low x limit for histogram
highX	high x limit for histogram
lowY	low y limit for histogram
highY	high y limit for histogram
binsX	number of bins in x
binsY	number of bins in y
weight	weight

Returns: pointer to AIDA 2D histogram

Definition at line 150 of file GaudiHistos_2DFixedBinning.icpp.

 {
   AIDA::IHistogram2D * h(nullptr);
   if ( produceHistos() )
   {
     // retrieve or book the histogram
     h = histo2D ( title ) ;
     if ( !h )
     { h = book2D ( title , lowX , highX , binsX , lowY , highY , binsY ) ; }
     // fill the histogram
     h = fill ( h , valueX , valueY , weight , title ) ;
   }
   return h;
 }

template<class PBASE>

AIDA::IHistogram2D* GaudiHistos< PBASE >::plot2D	(	const double	valueX,
		const double	valueY,
		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 histogram (book on demand)

const double mass1 = ... ;
const double mass2 = ... ;
plot2D( mass1, mass2,
       "Invariant Mass2 versus Mass1" ,2.5 ,3.5, 4.5, 5.5, 100, 200 );

This example illustrates the filling of the 2D histogram titled "Invariant Mass2 versus Mass1" with values mass1 and mass2 .

If the histogram with given title does not exist yet it will be automatically booked with parameters lowX equal to 2.5, highX equal to 3.5, lowY equal to 4.5, highY equal to 5.5, binsX equal to 100 and binsY equal to 200.

Attention: The histogram will get a unique identifier automatically assigned which by default will be equal to the histogram title. An option exists to instead use numerical IDs. In this case the first histogram booked will be ID=1 the next ID=2 and so on. Note though this scheme is not recommended as it does NOT guarantee predictability of the ID a given histogram will be given when filled under conditional statements, since in these circumstances the order in which the histograms are first filled, and thus booked, will depend on the nature of the first few events read. This is particularly problematic when users submit many parallel 'sub-jobs' and then attempt to merge the final output ROOT (or HBOOK) files, since a given histogram could have different IDs in each of the sub-jobs. Consequently it is strongly recommended that users do not use numerical automatic IDs unless they are sure they understand what they are doing.

See also: AIDA::IHistogram2D

Parameters

valueX	x value to be filled
valueY	y value to be filled
title	histogram title (must be unique within the algorithm)
lowX	low x limit for histogram
highX	high x limit for histogram
lowY	low y limit for histogram
highY	high y limit for histogram
binsX	number of bins in x
binsY	number of bins in y
weight	weight

Returns: pointer to AIDA 2D histogram

template<class PBASE >

AIDA::IHistogram2D * GaudiHistos< PBASE >::plot2D	(	const double	valueX,
		const double	valueY,
		const HistoID &	ID,
		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 histogram with forced ID assignment (book on demand)

const double mass1 = ... ;
const double mass2 = ... ;
plot2D( mass1, mass2, 15,
        "Invariant Mass2 versus Mass1" ,2.5 ,3.5, 4.5, 5.5, 100, 200 );

This example illustrates the filling of the 2D histogram ID=15 titled "Invariant Mass2 versus Mass1" with values mass1 and mass2 .

If the histogram with given title does not exist yet it will be automatically booked with parameters lowX equal to 2.5, highX equal to 3.5, lowY equal to 4.5, highY equal to 5.5, binsX equal to 100 and binsY equal to 200.

It is also possible to use literal IDs. For example :-

const double mass1 = ... ;
const double mass2 = ... ;
plot2D( mass1, mass2, "mass",
        "Invariant Mass2 versus Mass1" ,2.5 ,3.5, 4.5, 5.5, 100, 200 );

Will book the same histogram, using the id "mass".

It is also possible using literal IDs, to place histograms in sub-directories from the main histogram directory, using for example :-

const double mass1 = ... ;
const double mass2 = ... ;
plot2D( mass1, mass2, "subdir/mass",
        "Invariant Mass2 versus Mass1" ,2.5 ,3.5, 4.5, 5.5, 100, 200 );

Which will create the histogram "mass" in the sub-directory "subdir". Histograms can also be created in sub-directories with numeric IDs if IDs such as "subdir/1" are used.

Attention: If the histogram with given ID is already booked through automatic assignment of histogram ID, the error will not be detected. Therefore it is recommended to use non-trivial histogram ID offset (property "HistoOffSet") if one need to combine these techniques together It is still desirable to use the unique histogram title to avoid a bad interference

See also: AIDA::IHistogram2D

Parameters

valueX	x value to be filled
valueY	y value to be filled
ID	Histogram ID to use
title	histogram title (must be unique within the algorithm)
lowX	low x limit for histogram
highX	high x limit for histogram
lowY	low y limit for histogram
highY	high y limit for histogram
binsX	number of bins in x
binsY	number of bins in y
weight	weight

Returns: pointer to AIDA 2D histogram

Definition at line 178 of file GaudiHistos_2DFixedBinning.icpp.

 {
   AIDA::IHistogram2D * h(nullptr);
   // produce histograms ?
   if ( produceHistos() )
   {
     // retrieve or book the histogram
     h = histo2D ( ID ) ;
     if ( !h ) { h = book2D ( ID   , title ,
                                  lowX , highX , binsX ,
                                  lowY , highY , binsY ) ; }
     // fill the histogram
     h = fill ( h , valueX , valueY , weight , title ) ;
   }
   return h;
 }

template<class PBASE>

AIDA::IHistogram2D* GaudiHistos< PBASE >::plot2D	(	const double	valueX,
		const double	valueY,
		const HistoID &	ID,
		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 histogram with forced ID assignment (book on demand)

const double mass1 = ... ;
const double mass2 = ... ;
plot2D( mass1, mass2, 15,
        "Invariant Mass2 versus Mass1" ,2.5 ,3.5, 4.5, 5.5, 100, 200 );

This example illustrates the filling of the 2D histogram ID=15 titled "Invariant Mass2 versus Mass1" with values mass1 and mass2 .

If the histogram with given title does not exist yet it will be automatically booked with parameters lowX equal to 2.5, highX equal to 3.5, lowY equal to 4.5, highY equal to 5.5, binsX equal to 100 and binsY equal to 200.

It is also possible to use literal IDs. For example :-

const double mass1 = ... ;
const double mass2 = ... ;
plot2D( mass1, mass2, "mass",
        "Invariant Mass2 versus Mass1" ,2.5 ,3.5, 4.5, 5.5, 100, 200 );

Will book the same histogram, using the id "mass".

It is also possible using literal IDs, to place histograms in sub-directories from the main histogram directory, using for example :-

const double mass1 = ... ;
const double mass2 = ... ;
plot2D( mass1, mass2, "subdir/mass",
        "Invariant Mass2 versus Mass1" ,2.5 ,3.5, 4.5, 5.5, 100, 200 );

Which will create the histogram "mass" in the sub-directory "subdir". Histograms can also be created in sub-directories with numeric IDs if IDs such as "subdir/1" are used.

Attention: If the histogram with given ID is already booked through automatic assignment of histogram ID, the error will not be detected. Therefore it is recommended to use non-trivial histogram ID offset (property "HistoOffSet") if one need to combine these techniques together It is still desirable to use the unique histogram title to avoid a bad interference

See also: AIDA::IHistogram2D

Parameters

valueX	x value to be filled
valueY	y value to be filled
ID	Histogram ID to use
title	histogram title (must be unique within the algorithm)
lowX	low x limit for histogram
highX	high x limit for histogram
lowY	low y limit for histogram
highY	high y limit for histogram
binsX	number of bins in x
binsY	number of bins in y
weight	weight

Returns: pointer to AIDA 2D histogram

template<class PBASE>

AIDA::IHistogram2D* GaudiHistos< PBASE >::plot2D	(	const double	valueX,
		const double	valueY,
		const std::string &	title,
		const HistoBinEdges &	edgesX,
		const HistoBinEdges &	edgesY,
		const double	weight = `1.0`
	)		const

Fill the 2D variable binning histogram (book on demand)

const GaudiAlg::HistoBinEdges edgesX = ...;
const GaudiAlg::HistoBinEdges edgesY = ...;
const double mass1 = ... ;
const double mass2 = ... ;
plot2D( mass1, mass2,
       "Invariant Mass2 versus Mass1" , edgesX, edgesY );

This example illustrates the filling of the 2D histogram titled "Invariant Mass2 versus Mass1" with values mass1 and mass2 .

If the histogram with given title does not exist yet it will be automatically booked with the given histogram bin edges.

Attention: The histogram will get a unique identifier automatically assigned which by default will be equal to the histogram title. An option exists to instead use numerical IDs. In this case the first histogram booked will be ID=1 the next ID=2 and so on. Note though this scheme is not recommended as it does NOT guarantee predictability of the ID a given histogram will be given when filled under conditional statements, since in these circumstances the order in which the histograms are first filled, and thus booked, will depend on the nature of the first few events read. This is particularly problematic when users submit many parallel 'sub-jobs' and then attempt to merge the final output ROOT (or HBOOK) files, since a given histogram could have different IDs in each of the sub-jobs. Consequently it is strongly recommended that users do not use numerical automatic IDs unless they are sure they understand what they are doing.

See also: AIDA::IHistogram2D

Parameters

valueX	x value to be filled
valueY	y value to be filled
title	histogram title (must be unique within the algorithm)
edgesX	The histogram x bin edges
edgesY	The histogram y bin edges
weight	weight

Returns: pointer to AIDA 2D histogram

template<class PBASE >

AIDA::IHistogram2D * GaudiHistos< PBASE >::plot2D	(	const double	valueX,
		const double	valueY,
		const std::string &	title,
		const HistoBinEdges &	edgesX,
		const HistoBinEdges &	edgesY,
		const double	weight = `1.0`
	)		const

Fill the 2D variable binning histogram (book on demand)

const GaudiAlg::HistoBinEdges edgesX = ...;
const GaudiAlg::HistoBinEdges edgesY = ...;
const double mass1 = ... ;
const double mass2 = ... ;
plot2D( mass1, mass2,
       "Invariant Mass2 versus Mass1" , edgesX, edgesY );

This example illustrates the filling of the 2D histogram titled "Invariant Mass2 versus Mass1" with values mass1 and mass2 .

If the histogram with given title does not exist yet it will be automatically booked with the given histogram bin edges.

Attention: The histogram will get a unique identifier automatically assigned which by default will be equal to the histogram title. An option exists to instead use numerical IDs. In this case the first histogram booked will be ID=1 the next ID=2 and so on. Note though this scheme is not recommended as it does NOT guarantee predictability of the ID a given histogram will be given when filled under conditional statements, since in these circumstances the order in which the histograms are first filled, and thus booked, will depend on the nature of the first few events read. This is particularly problematic when users submit many parallel 'sub-jobs' and then attempt to merge the final output ROOT (or HBOOK) files, since a given histogram could have different IDs in each of the sub-jobs. Consequently it is strongly recommended that users do not use numerical automatic IDs unless they are sure they understand what they are doing.

See also: AIDA::IHistogram2D

Parameters

valueX	x value to be filled
valueY	y value to be filled
title	histogram title (must be unique within the algorithm)
edgesX	The histogram x bin edges
edgesY	The histogram y bin edges
weight	weight

Returns: pointer to AIDA 2D histogram

Definition at line 101 of file GaudiHistos_2DVariableBinning.icpp.

 {
   AIDA::IHistogram2D * h(nullptr);
   if ( produceHistos() )
   {
     // retrieve or book the histogram
     h = histo2D ( title ) ;
     if ( !h ) { h = book2D ( title , edgesX , edgesY ) ; }
     // fill the histogram
     h = fill ( h , valueX , valueY , weight , title );
   }
   return h;
 }

template<class PBASE>

AIDA::IHistogram2D* GaudiHistos< PBASE >::plot2D	(	const double	valueX,
		const double	valueY,
		const HistoID &	ID,
		const std::string &	title,
		const HistoBinEdges &	edgesX,
		const HistoBinEdges &	edgesY,
		const double	weight = `1.0`
	)		const

fill the 2D variable histogram with forced ID assignment (book on demand)

const GaudiAlg::HistoBinEdges edgesX = ...;
const GaudiAlg::HistoBinEdges edgesY = ...;
const double mass1 = ... ;
const double mass2 = ... ;
plot2D( mass1, mass2, 15,
        "Invariant Mass2 versus Mass1", edgesX, edgesY );

This example illustrates the filling of the 2D histogram ID=15 titled "Invariant Mass2 versus Mass1" with values mass1 and mass2 .

If the histogram with given title does not exist yet it will be automatically booked with the given histogram bin edges.

It is also possible to use literal IDs. For example :-

const GaudiAlg::HistoBinEdges edgesX = ...;
const GaudiAlg::HistoBinEdges edgesY = ...;
const double mass1 = ... ;
const double mass2 = ... ;
plot2D( mass1, mass2, "mass",
        "Invariant Mass2 versus Mass1", edgesX, edgesY );

Will book the same histogram, using the id "mass".

It is also possible using literal IDs, to place histograms in sub-directories from the main histogram directory, using for example :-

const GaudiAlg::HistoBinEdges edgesX = ...;
const GaudiAlg::HistoBinEdges edgesY = ...;
const double mass1 = ... ;
const double mass2 = ... ;
plot2D( mass1, mass2, "subdir/mass",
        "Invariant Mass2 versus Mass1", edgesX, edgesY );

Which will create the histogram "mass" in the sub-directory "subdir". Histograms can also be created in sub-directories with numeric IDs if IDs such as "subdir/1" are used.

Attention: If the histogram with given ID is already booked through automatic assignment of histogram ID, the error will not be detected. Therefore it is recommended to use non-trivial histogram ID offset (property "HistoOffSet") if one need to combine these techniques together It is still desirable to use the unique histogram title to avoid a bad interference

See also: AIDA::IHistogram2D

Parameters

valueX	x value to be filled
valueY	y value to be filled
ID	Histogram ID to use
title	histogram title (must be unique within the algorithm)
edgesX	The histogram x bin edges
edgesY	The histogram y bin edges
weight	weight

Returns: pointer to AIDA 2D histogram

template<class PBASE >

AIDA::IHistogram2D * GaudiHistos< PBASE >::plot2D	(	const double	valueX,
		const double	valueY,
		const HistoID &	ID,
		const std::string &	title,
		const HistoBinEdges &	edgesX,
		const HistoBinEdges &	edgesY,
		const double	weight = `1.0`
	)		const

fill the 2D variable histogram with forced ID assignment (book on demand)

const GaudiAlg::HistoBinEdges edgesX = ...;
const GaudiAlg::HistoBinEdges edgesY = ...;
const double mass1 = ... ;
const double mass2 = ... ;
plot2D( mass1, mass2, 15,
        "Invariant Mass2 versus Mass1", edgesX, edgesY );

This example illustrates the filling of the 2D histogram ID=15 titled "Invariant Mass2 versus Mass1" with values mass1 and mass2 .

If the histogram with given title does not exist yet it will be automatically booked with the given histogram bin edges.

It is also possible to use literal IDs. For example :-

const GaudiAlg::HistoBinEdges edgesX = ...;
const GaudiAlg::HistoBinEdges edgesY = ...;
const double mass1 = ... ;
const double mass2 = ... ;
plot2D( mass1, mass2, "mass",
        "Invariant Mass2 versus Mass1", edgesX, edgesY );

Will book the same histogram, using the id "mass".

It is also possible using literal IDs, to place histograms in sub-directories from the main histogram directory, using for example :-

const GaudiAlg::HistoBinEdges edgesX = ...;
const GaudiAlg::HistoBinEdges edgesY = ...;
const double mass1 = ... ;
const double mass2 = ... ;
plot2D( mass1, mass2, "subdir/mass",
        "Invariant Mass2 versus Mass1", edgesX, edgesY );

Which will create the histogram "mass" in the sub-directory "subdir". Histograms can also be created in sub-directories with numeric IDs if IDs such as "subdir/1" are used.

Attention: If the histogram with given ID is already booked through automatic assignment of histogram ID, the error will not be detected. Therefore it is recommended to use non-trivial histogram ID offset (property "HistoOffSet") if one need to combine these techniques together It is still desirable to use the unique histogram title to avoid a bad interference

See also: AIDA::IHistogram2D

Parameters

valueX	x value to be filled
valueY	y value to be filled
ID	Histogram ID to use
title	histogram title (must be unique within the algorithm)
edgesX	The histogram x bin edges
edgesY	The histogram y bin edges
weight	weight

Returns: pointer to AIDA 2D histogram

Definition at line 125 of file GaudiHistos_2DVariableBinning.icpp.

 {
   AIDA::IHistogram2D * h(nullptr);
   if ( produceHistos() )
   {
     // retrieve or book the histogram
     h = histo2D ( ID ) ;
     if ( !h ) {  h = book2D ( ID , title , edgesX , edgesY ) ; }
     // fill
     h = fill ( h , valueX , valueY , weight , title ) ;
   }
   return h;
 }

template<class PBASE>

AIDA::IHistogram3D* GaudiHistos< PBASE >::plot3D	(	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 double	lowZ,
		const double	highZ,
		const unsigned long	binsX = `10`,
		const unsigned long	binsY = `10`,
		const unsigned long	binsZ = `10`,
		const double	weight = `1.0`
	)		const

fill the 3D histogram (book on demand)

const double X = ... ;
const double Y = ... ;
const double Z = ... ;
plot3D( X, Y, Z, "Space Points" ,
       2.5 , 3.5 ,
       4.5 , 5.5 ,
       6.5 , 7.5 ,
       10, 20, 30 );

This example illustrates the filling of the 3D histogram titled "Space Points" with values X, Y and Z.

If the histogram with given title does not exist yet it will be automatically booked with parameters lowX equal to 2.5, highX equal to 3.5, lowY equal to 4.5, highY equal to 5.5, lowZ equal to 6.5, highZ equal to 7.5, binsX equal to 10, binsY equal to 20 and binsZ equal to 30.

Attention: The histogram will get a unique identifier automatically assigned which by default will be equal to the histogram title. An option exists to instead use numerical IDs. In this case the first histogram booked will be ID=1 the next ID=2 and so on. Note though this scheme is not recommended as it does NOT guarantee predictability of the ID a given histogram will be given when filled under conditional statements, since in these circumstances the order in which the histograms are first filled, and thus booked, will depend on the nature of the first few events read. This is particularly problematic when users submit many parallel 'sub-jobs' and then attempt to merge the final output ROOT (or HBOOK) files, since a given histogram could have different IDs in each of the sub-jobs. Consequently it is strongly recommended that users do not use numerical automatic IDs unless they are sure they understand what they are doing.

See also: AIDA::IHistogram3D

Parameters

valueX	x value to be filled
valueY	y value to be filled
valueZ	z value to be filled
title	histogram title (must be unique within the algorithm)
lowX	low x limit for histogram
highX	high x limit for histogram
lowY	low y limit for histogram
highY	high y limit for histogram
lowZ	low z limit for histogram
highZ	high z limit for histogram
binsX	number of bins in x
binsY	number of bins in y
binsZ	number of bins in z
weight	weight

Returns: pointer to AIDA 3D histogram

template<class PBASE >

AIDA::IHistogram3D * GaudiHistos< PBASE >::plot3D	(	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 double	lowZ,
		const double	highZ,
		const unsigned long	binsX = `10`,
		const unsigned long	binsY = `10`,
		const unsigned long	binsZ = `10`,
		const double	weight = `1.0`
	)		const

fill the 3D histogram (book on demand)

const double X = ... ;
const double Y = ... ;
const double Z = ... ;
plot3D( X, Y, Z, "Space Points" ,
       2.5 , 3.5 ,
       4.5 , 5.5 ,
       6.5 , 7.5 ,
       10, 20, 30 );

This example illustrates the filling of the 3D histogram titled "Space Points" with values X, Y and Z.

If the histogram with given title does not exist yet it will be automatically booked with parameters lowX equal to 2.5, highX equal to 3.5, lowY equal to 4.5, highY equal to 5.5, lowZ equal to 6.5, highZ equal to 7.5, binsX equal to 10, binsY equal to 20 and binsZ equal to 30.

Attention: The histogram will get a unique identifier automatically assigned which by default will be equal to the histogram title. An option exists to instead use numerical IDs. In this case the first histogram booked will be ID=1 the next ID=2 and so on. Note though this scheme is not recommended as it does NOT guarantee predictability of the ID a given histogram will be given when filled under conditional statements, since in these circumstances the order in which the histograms are first filled, and thus booked, will depend on the nature of the first few events read. This is particularly problematic when users submit many parallel 'sub-jobs' and then attempt to merge the final output ROOT (or HBOOK) files, since a given histogram could have different IDs in each of the sub-jobs. Consequently it is strongly recommended that users do not use numerical automatic IDs unless they are sure they understand what they are doing.

See also: AIDA::IHistogram3D

Parameters

valueX	x value to be filled
valueY	y value to be filled
valueZ	z value to be filled
title	histogram title (must be unique within the algorithm)
lowX	low x limit for histogram
highX	high x limit for histogram
lowY	low y limit for histogram
highY	high y limit for histogram
lowZ	low z limit for histogram
highZ	high z limit for histogram
binsX	number of bins in x
binsY	number of bins in y
binsZ	number of bins in z
weight	weight

Returns: pointer to AIDA 3D histogram

Definition at line 166 of file GaudiHistos_3DFixedBinning.icpp.

 {
   AIDA::IHistogram3D * h(nullptr);
   if ( produceHistos() )
   {
     // retrieve or book the histogram
     h = histo3D ( title ) ;
     if ( !h ) { h = book3D ( title ,
                                  lowX , highX , binsX ,
                                  lowY , highY , binsY ,
                                  lowZ , highZ , binsZ ) ; }
     // fill the histogram
     h = fill ( h , valueX , valueY , valueZ , weight , title ) ;
   }
   return h;
 }

template<class PBASE >

AIDA::IHistogram3D * GaudiHistos< PBASE >::plot3D	(	const double	valueX,
		const double	valueY,
		const double	valueZ,
		const HistoID &	ID,
		const std::string &	title,
		const double	lowX,
		const double	highX,
		const double	lowY,
		const double	highY,
		const double	lowZ,
		const double	highZ,
		const unsigned long	binsX = `10`,
		const unsigned long	binsY = `10`,
		const unsigned long	binsZ = `10`,
		const double	weight = `1.0`
	)		const

fill the 3D histogram with forced ID assignment (book on demand)

const double X = ... ;
const double Y = ... ;
const double Z = ... ;
plot3D( X, Y, Z,
       15 , "Space Points" ,
        2.5 ,3.5, 4.5, 5.5, 6.5, 7.5, 10, 20, 30 );

This example illustrates the filling of the 3D histogram ID=15 titled "Space Points" with values X, Y and Z.

If the histogram with given title does not exist yet it will be automatically booked with parameters lowX equal to 2.5, highX equal to 3.5, lowY equal to 4.5, highY equal to 5.5, lowZ equal to 6.5, highZ equal to 7.5, binsX equal to 10, binsY equal to 20 and binsZ equal to 30.

It is also possible to use literal IDs. For example :-

const double X = ... ;
const double Y = ... ;
const double Z = ... ;
plot3D( X, Y, Z,
       "space", "Space Points" ,
         2.5 ,3.5, 4.5, 5.5, 6.5, 7.5, 10, 20, 30 );

Will book the same histogram, using the id "space".

It is also possible using literal IDs, to place histograms in sub-directories from the main histogram directory, using for example :-

const double X = ... ;
const double Y = ... ;
const double Z = ... ;
plot3D( X, Y, Z,
        "subdir/space", "Space Points" ,
        2.5 ,3.5, 4.5, 5.5, 6.5, 7.5, 10, 20, 30 );

Which will create the histogram "space" in the sub-directory "subdir". Histograms can also be created in sub-directories with numeric IDs if IDs such as "subdir/1" are used.

Attention: If the histogram with given ID is already booked through automatic assignment of histogram ID, the error will not be detected. Therefore it is recommended to use non-trivial histogram ID offset (property "HistoOffSet") if one need to combine these techniques together It is still desirable to use the unique histogram title to avoid a bad interference

See also: AIDA::IHistogram3D

Parameters

valueX	x value to be filled
valueY	y value to be filled
valueZ	z value to be filled
ID	Histogram ID to use
title	histogram title (must be unique within the algorithm)
lowX	low x limit for histogram
highX	high x limit for histogram
lowY	low y limit for histogram
highY	high y limit for histogram
lowZ	low z limit for histogram
highZ	high z limit for histogram
binsX	number of bins in x
binsY	number of bins in y
binsZ	number of bins in z
weight	weight

Returns: pointer to AIDA 3D histogram

Definition at line 200 of file GaudiHistos_3DFixedBinning.icpp.

 {
   AIDA::IHistogram3D * h(nullptr);
   if ( produceHistos() )
   {
     // retrieve or book the histogram
     h = histo3D ( ID ) ;
     if ( !h ) { h = book3D ( ID , title ,
                                  lowX , highX , binsX ,
                                  lowY , highY , binsY ,
                                  lowZ , highZ , binsZ ) ; }
     // fill the histogram
     h = fill ( h , valueX , valueY , valueZ , weight , title ) ;
   }
   return h;
 }

template<class PBASE>

AIDA::IHistogram3D* GaudiHistos< PBASE >::plot3D	(	const double	valueX,
		const double	valueY,
		const double	valueZ,
		const HistoID &	ID,
		const std::string &	title,
		const double	lowX,
		const double	highX,
		const double	lowY,
		const double	highY,
		const double	lowZ,
		const double	highZ,
		const unsigned long	binsX = `10`,
		const unsigned long	binsY = `10`,
		const unsigned long	binsZ = `10`,
		const double	weight = `1.0`
	)		const

fill the 3D histogram with forced ID assignment (book on demand)

const double X = ... ;
const double Y = ... ;
const double Z = ... ;
plot3D( X, Y, Z,
       15 , "Space Points" ,
        2.5 ,3.5, 4.5, 5.5, 6.5, 7.5, 10, 20, 30 );

This example illustrates the filling of the 3D histogram ID=15 titled "Space Points" with values X, Y and Z.

If the histogram with given title does not exist yet it will be automatically booked with parameters lowX equal to 2.5, highX equal to 3.5, lowY equal to 4.5, highY equal to 5.5, lowZ equal to 6.5, highZ equal to 7.5, binsX equal to 10, binsY equal to 20 and binsZ equal to 30.

It is also possible to use literal IDs. For example :-

const double X = ... ;
const double Y = ... ;
const double Z = ... ;
plot3D( X, Y, Z,
       "space", "Space Points" ,
         2.5 ,3.5, 4.5, 5.5, 6.5, 7.5, 10, 20, 30 );

Will book the same histogram, using the id "space".

It is also possible using literal IDs, to place histograms in sub-directories from the main histogram directory, using for example :-

const double X = ... ;
const double Y = ... ;
const double Z = ... ;
plot3D( X, Y, Z,
        "subdir/space", "Space Points" ,
        2.5 ,3.5, 4.5, 5.5, 6.5, 7.5, 10, 20, 30 );

Which will create the histogram "space" in the sub-directory "subdir". Histograms can also be created in sub-directories with numeric IDs if IDs such as "subdir/1" are used.

Attention: If the histogram with given ID is already booked through automatic assignment of histogram ID, the error will not be detected. Therefore it is recommended to use non-trivial histogram ID offset (property "HistoOffSet") if one need to combine these techniques together It is still desirable to use the unique histogram title to avoid a bad interference

See also: AIDA::IHistogram3D

Parameters

valueX	x value to be filled
valueY	y value to be filled
valueZ	z value to be filled
ID	Histogram ID to use
title	histogram title (must be unique within the algorithm)
lowX	low x limit for histogram
highX	high x limit for histogram
lowY	low y limit for histogram
highY	high y limit for histogram
lowZ	low z limit for histogram
highZ	high z limit for histogram
binsX	number of bins in x
binsY	number of bins in y
binsZ	number of bins in z
weight	weight

Returns: pointer to AIDA 3D histogram

template<class PBASE>

AIDA::IHistogram3D* GaudiHistos< PBASE >::plot3D	(	const double	valueX,
		const double	valueY,
		const double	valueZ,
		const std::string &	title,
		const HistoBinEdges &	edgesX,
		const HistoBinEdges &	edgesY,
		const HistoBinEdges &	edgesZ,
		const double	weight = `1.0`
	)		const

Fill the 3D variable binning histogram (book on demand)

const GaudiAlg::HistoBinEdges edgesX = ...;
const GaudiAlg::HistoBinEdges edgesY = ...;
const GaudiAlg::HistoBinEdges edgesZ = ...;
const double X = ... ;
const double Y = ... ;
const double Z = ... ;
plot3D( X, Y, Z, "Space Points", edgesX, edgesY, edgesZ );

This example illustrates the filling of the 3D histogram titled "Space Points" with values X, Y and Z.

If the histogram with given title does not exist yet it will be automatically booked with the given histogram bin edges.

Attention: The histogram will get a unique identifier automatically assigned which by default will be equal to the histogram title. An option exists to instead use numerical IDs. In this case the first histogram booked will be ID=1 the next ID=2 and so on. Note though this scheme is not recommended as it does NOT guarantee predictability of the ID a given histogram will be given when filled under conditional statements, since in these circumstances the order in which the histograms are first filled, and thus booked, will depend on the nature of the first few events read. This is particularly problematic when users submit many parallel 'sub-jobs' and then attempt to merge the final output ROOT (or HBOOK) files, since a given histogram could have different IDs in each of the sub-jobs. Consequently it is strongly recommended that users do not use numerical automatic IDs unless they are sure they understand what they are doing.

See also: AIDA::IHistogram3D

Parameters

valueX	x value to be filled
valueY	y value to be filled
valueZ	z value to be filled
title	histogram title (must be unique within the algorithm)
edgesX	The histogram x bin edges
edgesY	The histogram y bin edges
edgesZ	The histogram z bin edges
weight	weight

Returns: pointer to AIDA 3D histogram

template<class PBASE >

AIDA::IHistogram3D * GaudiHistos< PBASE >::plot3D	(	const double	valueX,
		const double	valueY,
		const double	valueZ,
		const std::string &	title,
		const HistoBinEdges &	edgesX,
		const HistoBinEdges &	edgesY,
		const HistoBinEdges &	edgesZ,
		const double	weight = `1.0`
	)		const

Fill the 3D variable binning histogram (book on demand)

const GaudiAlg::HistoBinEdges edgesX = ...;
const GaudiAlg::HistoBinEdges edgesY = ...;
const GaudiAlg::HistoBinEdges edgesZ = ...;
const double X = ... ;
const double Y = ... ;
const double Z = ... ;
plot3D( X, Y, Z, "Space Points", edgesX, edgesY, edgesZ );

This example illustrates the filling of the 3D histogram titled "Space Points" with values X, Y and Z.

If the histogram with given title does not exist yet it will be automatically booked with the given histogram bin edges.

Attention: The histogram will get a unique identifier automatically assigned which by default will be equal to the histogram title. An option exists to instead use numerical IDs. In this case the first histogram booked will be ID=1 the next ID=2 and so on. Note though this scheme is not recommended as it does NOT guarantee predictability of the ID a given histogram will be given when filled under conditional statements, since in these circumstances the order in which the histograms are first filled, and thus booked, will depend on the nature of the first few events read. This is particularly problematic when users submit many parallel 'sub-jobs' and then attempt to merge the final output ROOT (or HBOOK) files, since a given histogram could have different IDs in each of the sub-jobs. Consequently it is strongly recommended that users do not use numerical automatic IDs unless they are sure they understand what they are doing.

See also: AIDA::IHistogram3D

Parameters

valueX	x value to be filled
valueY	y value to be filled
valueZ	z value to be filled
title	histogram title (must be unique within the algorithm)
edgesX	The histogram x bin edges
edgesY	The histogram y bin edges
edgesZ	The histogram z bin edges
weight	weight

Returns: pointer to AIDA 3D histogram

Definition at line 105 of file GaudiHistos_3DVariableBinning.icpp.

 {
   AIDA::IHistogram3D * h(nullptr);
   if ( produceHistos() )
   {
     // retrieve or book the histogram
     h = histo3D ( title ) ;
     if ( !h ) { h = book3D ( title , edgesX , edgesY , edgesZ ) ; }
     // fill the histogram
     h = fill ( h , valueX , valueY , valueZ , weight , title );
   }
   return h;
 }

template<class PBASE >

AIDA::IHistogram3D * GaudiHistos< PBASE >::plot3D	(	const double	valueX,
		const double	valueY,
		const double	valueZ,
		const HistoID &	ID,
		const std::string &	title,
		const HistoBinEdges &	edgesX,
		const HistoBinEdges &	edgesY,
		const HistoBinEdges &	edgesZ,
		const double	weight = `1.0`
	)		const

fill the 3D histogram with forced ID assignment (book on demand)

const GaudiAlg::HistoBinEdges edgesX = ...;
const GaudiAlg::HistoBinEdges edgesY = ...;
const GaudiAlg::HistoBinEdges edgesZ = ...;
const double X = ... ;
const double Y = ... ;
const double Z = ... ;
plot3D( X, Y, Z, "Space Points", edgesX, edgesY, edgesZ );

This example illustrates the filling of the 3D histogram ID=15 titled "Space Points" with values X, Y and Z.

If the histogram with given title does not exist yet it will be automatically booked with the given histogram bin edges and histogram ID.

It is also possible to use literal IDs. For example :-

const GaudiAlg::HistoBinEdges edgesX = ...;
const GaudiAlg::HistoBinEdges edgesY = ...;
const GaudiAlg::HistoBinEdges edgesZ = ...;
const double X = ... ;
const double Y = ... ;
const double Z = ... ;
plot3D( X, Y, Z,
        "space", "Space Points" ,
        edgesX, edgesY, edgesZ );

Will book the same histogram, using the id "space".

It is also possible using literal IDs, to place histograms in sub-directories from the main histogram directory, using for example :-

const GaudiAlg::HistoBinEdges edgesX = ...;
const GaudiAlg::HistoBinEdges edgesY = ...;
const GaudiAlg::HistoBinEdges edgesZ = ...;
const double X = ... ;
const double Y = ... ;
const double Z = ... ;
plot3D( X, Y, Z,
        "subdir/space", "Space Points" ,
        edgesX, edgesY, edgesZ );

Which will create the histogram "space" in the sub-directory "subdir". Histograms can also be created in sub-directories with numeric IDs if IDs such as "subdir/1" are used.

Attention: If the histogram with given ID is already booked through automatic assignment of histogram ID, the error will not be detected. Therefore it is recommended to use non-trivial histogram ID offset (property "HistoOffSet") if one need to combine these techniques together It is still desirable to use the unique histogram title to avoid a bad interference

See also: AIDA::IHistogram3D

Parameters

valueX	x value to be filled
valueY	y value to be filled
valueZ	z value to be filled
ID	Histogram ID to use
title	histogram title (must be unique within the algorithm)
edgesX	The histogram x bin edges
edgesY	The histogram y bin edges
edgesZ	The histogram z bin edges
weight	weight

Returns: pointer to AIDA 3D histogram

Definition at line 131 of file GaudiHistos_3DVariableBinning.icpp.

 {
   AIDA::IHistogram3D * h(nullptr);
   if ( produceHistos() )
   {
     // retrieve or book the histogram
     h = histo3D ( ID ) ;
     if ( !h ) {  h = book3D ( ID , title , edgesX , edgesY , edgesZ ) ; }
     // fill
     h = fill ( h , valueX , valueY , valueZ , weight , title ) ;
   }
   return h;
 }

template<class PBASE>

AIDA::IHistogram3D* GaudiHistos< PBASE >::plot3D	(	const double	valueX,
		const double	valueY,
		const double	valueZ,
		const HistoID &	ID,
		const std::string &	title,
		const HistoBinEdges &	edgesX,
		const HistoBinEdges &	edgesY,
		const HistoBinEdges &	edgesZ,
		const double	weight = `1.0`
	)		const

fill the 3D histogram with forced ID assignment (book on demand)

const GaudiAlg::HistoBinEdges edgesX = ...;
const GaudiAlg::HistoBinEdges edgesY = ...;
const GaudiAlg::HistoBinEdges edgesZ = ...;
const double X = ... ;
const double Y = ... ;
const double Z = ... ;
plot3D( X, Y, Z, "Space Points", edgesX, edgesY, edgesZ );

This example illustrates the filling of the 3D histogram ID=15 titled "Space Points" with values X, Y and Z.

If the histogram with given title does not exist yet it will be automatically booked with the given histogram bin edges and histogram ID.

It is also possible to use literal IDs. For example :-

const GaudiAlg::HistoBinEdges edgesX = ...;
const GaudiAlg::HistoBinEdges edgesY = ...;
const GaudiAlg::HistoBinEdges edgesZ = ...;
const double X = ... ;
const double Y = ... ;
const double Z = ... ;
plot3D( X, Y, Z,
        "space", "Space Points" ,
        edgesX, edgesY, edgesZ );

Will book the same histogram, using the id "space".

It is also possible using literal IDs, to place histograms in sub-directories from the main histogram directory, using for example :-

const GaudiAlg::HistoBinEdges edgesX = ...;
const GaudiAlg::HistoBinEdges edgesY = ...;
const GaudiAlg::HistoBinEdges edgesZ = ...;
const double X = ... ;
const double Y = ... ;
const double Z = ... ;
plot3D( X, Y, Z,
        "subdir/space", "Space Points" ,
        edgesX, edgesY, edgesZ );

Which will create the histogram "space" in the sub-directory "subdir". Histograms can also be created in sub-directories with numeric IDs if IDs such as "subdir/1" are used.

Attention: If the histogram with given ID is already booked through automatic assignment of histogram ID, the error will not be detected. Therefore it is recommended to use non-trivial histogram ID offset (property "HistoOffSet") if one need to combine these techniques together It is still desirable to use the unique histogram title to avoid a bad interference

See also: AIDA::IHistogram3D

Parameters

valueX	x value to be filled
valueY	y value to be filled
valueZ	z value to be filled
ID	Histogram ID to use
title	histogram title (must be unique within the algorithm)
edgesX	The histogram x bin edges
edgesY	The histogram y bin edges
edgesZ	The histogram z bin edges
weight	weight

Returns: pointer to AIDA 3D histogram

template<class PBASE>

void GaudiHistos< PBASE >::printHistoHandler ( Property & )

private

the handler for "HistoPrint" property

template<class PBASE >

void GaudiHistos< PBASE >::printHistoHandler ( Property & )

private

the handler for "HistoPrint" property

Definition at line 498 of file GaudiHistos.icpp.

 {
   // no action if not yet initialized
   if ( this -> FSMState() < Gaudi::StateMachine::INITIALIZED ) { return ; }
   if ( this -> histosPrint() ) { this -> printHistos ( MSG::ALWAYS ) ; }
 }

template<class PBASE >

int GaudiHistos< PBASE >::printHistos ( const MSG::Level level = MSG::ALWAYS ) const

perform the actual printout of histograms

Parameters

level The message level to print at

Returns: number of active histograms

Definition at line 259 of file GaudiHistos.icpp.

 {
   using namespace Gaudi::Utils::Histos ;
 
   if ( noHistos() )
   {
     if ( this->msgLevel(MSG::DEBUG) )
     { this->msgStream(level) << "No histograms are booked" << endmsg ; }
     return 0 ;                                                        // RETURN
   }
 
   MsgStream & msg = this->msgStream(level);
 
   // Printout all histograms
 
   Gaudi::Utils::Histos::Table table
     ( m_histo1DTableFormat ,
       m_histo1DTableHeader ) ;
 
   if ( !histo1DMapID().empty() )
   {
     msg << "List of booked 1D histograms in directory         "
         << "\"" << histoPath() << "\" :-"  ;
 
     if ( !table.header().empty() )
     {
       msg << std::endl << Gaudi::Utils::Histos::format
         ( "ID" , table.header() , m_histo1DTableFormatShort ) ;
     }
     for ( const auto& entry : ordered( histo1DMapID() ))
     {
       const auto* aida = entry.second ;
       if ( !aida )
       { this->error() << "IHistogram1D points to NULL" << endmsg ; continue ; }
       // format and print the row
       msg << std::endl << table.toString
         ( aida                      ,
           HistoID ( entry.first )  ,
           m_histo1DTableFormatShort ) ;
     }
     msg << endmsg ;
   }
   // ==========================================================================
   if ( !histo2DMapID().empty() )
   {
     msg << "List of booked 2D histograms in directory         "
         << "\"" << histoPath() << "\" :-" ;
 
     for ( const auto& entry : ordered( histo2DMapID() ) )
     {
       const auto* aida = entry.second ;
       if ( !aida )
       { this->error() << "IHistogram2D points to NULL" << endmsg ; continue ; }
       msg << std::endl
           << GaudiAlg::Print2D::toString ( aida , entry.first );
     }
     msg << endmsg ;
   }
   // ==========================================================================
   if ( !histo3DMapID().empty() )
   {
     msg << "List of booked 3D histograms in directory         "
         << "\"" << histoPath() << "\" :-" ;
     for ( const auto& entry : ordered( histo3DMapID() ) )
     {
       const auto* aida = entry.second ;
       if ( !aida )
       { this->error() << "IHistogram3D points to NULL" << endmsg ; continue ; }
       msg << std::endl << GaudiAlg::Print3D::toString ( aida , entry.first );
     }
     msg << endmsg ;
   }
   // ==========================================================================
   if ( !profile1DMapID().empty() )
   {
     msg << "List of booked 1D profile histograms in directory "
         << "\"" << histoPath() << "\" :-" ;
     for ( const auto& entry : ordered(  profile1DMapID() ) )
     {
       const auto*   aida = entry.second ;
       if ( !aida )
       { this->error() << "IProfile1D points to NULL" << endmsg ; continue ; }
       msg << std::endl << GaudiAlg::Print1DProf::toString  ( aida , entry.first );
     }
     msg << endmsg ;
   }
   // ==========================================================================
   if ( !profile2DMapID().empty() )
   {
     msg << "List of booked 2D profile histograms in directory "
         << "\"" << histoPath() << "\" :-" ;
     for ( const auto& entry : ordered(profile2DMapID() ) )
     {
       const auto*   aida = entry.second ;
       if ( !aida )
       { this->error() << "IProfile2D points to NULL" << endmsg ; continue ; }
       msg << std::endl << GaudiAlg::Print2DProf::toString ( aida , entry.first );
     }
     msg << endmsg ;
   }
   //
   return this->totalNumberOfHistos() ;
 }

template<class PBASE>

int GaudiHistos< PBASE >::printHistos ( const MSG::Level level = MSG::ALWAYS ) const

perform the actual printout of histograms

Parameters

level The message level to print at

Returns: number of active histograms

template<class PBASE>

bool GaudiHistos< PBASE >::produceHistos ( ) const

inline

get the flag for histogram production (property "HistoProduce")

Definition at line 2691 of file GaudiHistos.h.

2691 { return m_produceHistos ; }

bool m_produceHistos

flag to SWITCH ON/SWITCH OFF the histogrm fillling and booking

Definition: GaudiHistos.h:3064

template<class PBASE>

bool GaudiHistos< PBASE >::produceHistos ( ) const

inline

get the flag for histogram production (property "HistoProduce")

Definition at line 2691 of file GaudiHistos.h.

2691 { return m_produceHistos ; }

GaudiHistos::m_profile1DMapID

bool m_produceHistos

flag to SWITCH ON/SWITCH OFF the histogrm fillling and booking

Definition: GaudiHistos.h:3064

template<class PBASE>

AIDA::IProfile1D* GaudiHistos< PBASE >::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)

const double mass1 = ... ;
const double mass2 = ... ;
profile1D( mass1, mass2, "Invariant Mass2 versus Mass1" ,2.5 ,3.5, 100 );

This example illustrates the filling of the 1D profile histogram titled "Invariant Mass2 versus Mass1" with values mass1 and mass2 .

If the histogram with given title does not exist yet it will be automatically booked with parameters lowX equal to 2.5, highX equal to 3.5, binsX equal to 100

Attention: The histogram will get a unique identifier automatically assigned which by default will be equal to the histogram title. An option exists to instead use numerical IDs. In this case the first histogram booked will be ID=1 the next ID=2 and so on. Note though this scheme is not recommended as it does NOT guarantee predictability of the ID a given histogram will be given when filled under conditional statements, since in these circumstances the order in which the histograms are first filled, and thus booked, will depend on the nature of the first few events read. This is particularly problematic when users submit many parallel 'sub-jobs' and then attempt to merge the final output ROOT (or HBOOK) files, since a given histogram could have different IDs in each of the sub-jobs. Consequently it is strongly recommended that users do not use numerical automatic IDs unless they are sure they understand what they are doing.

See also: AIDA::IProfile1D

Parameters

valueX	x value to be filled
valueY	y value to be filled
title	histogram title (must be unique within the algorithm)
lowX	low x limit for histogram
highX	high x limit for histogram
binsX	number of bins in x
opt	the options, used for evaluation of errors
lowY	the min cut-off for y-values
highY	the max cut-off for y-values
weight	weight

Returns: pointer to AIDA 1D profile histogram

template<class PBASE >

AIDA::IProfile1D * GaudiHistos< PBASE >::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)

const double mass1 = ... ;
const double mass2 = ... ;
profile1D( mass1, mass2, "Invariant Mass2 versus Mass1" ,2.5 ,3.5, 100 );

This example illustrates the filling of the 1D profile histogram titled "Invariant Mass2 versus Mass1" with values mass1 and mass2 .

If the histogram with given title does not exist yet it will be automatically booked with parameters lowX equal to 2.5, highX equal to 3.5, binsX equal to 100

Attention: The histogram will get a unique identifier automatically assigned which by default will be equal to the histogram title. An option exists to instead use numerical IDs. In this case the first histogram booked will be ID=1 the next ID=2 and so on. Note though this scheme is not recommended as it does NOT guarantee predictability of the ID a given histogram will be given when filled under conditional statements, since in these circumstances the order in which the histograms are first filled, and thus booked, will depend on the nature of the first few events read. This is particularly problematic when users submit many parallel 'sub-jobs' and then attempt to merge the final output ROOT (or HBOOK) files, since a given histogram could have different IDs in each of the sub-jobs. Consequently it is strongly recommended that users do not use numerical automatic IDs unless they are sure they understand what they are doing.

See also: AIDA::IProfile1D

Parameters

valueX	x value to be filled
valueY	y value to be filled
title	histogram title (must be unique within the algorithm)
lowX	low x limit for histogram
highX	high x limit for histogram
binsX	number of bins in x
opt	the options, used for evaluation of errors
lowY	the min cut-off for y-values
highY	the max cut-off for y-values
weight	weight

Returns: pointer to AIDA 1D profile histogram

Definition at line 148 of file GaudiHistos_1DProfFixedBinning.icpp.

 {
   AIDA::IProfile1D * h = nullptr;
   if ( produceHistos() )
   {
     // retrieve or book the histogram
     h = profile1D ( title ) ;
     if ( !h )
     { h = bookProfile1D ( title , lowX , highX , binsX , opt , lowY , highY ) ; }
     // fill the histogram
     h = fill ( h , valueX , valueY , weight , title ) ;
   }
   return h;
 }

template<class PBASE >

AIDA::IProfile1D * GaudiHistos< PBASE >::profile1D	(	const double	valueX,
		const double	valueY,
		const HistoID &	ID,
		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 with forced ID assignment (book on demand)

const double mass1 = ... ;
const double mass2 = ... ;
profile1D( mass1, mass2,
        15, "Invariant Mass2 versus Mass1" ,2.5 ,3.5, 100 );

This example illustrates the filling of the 1D profile histogram with ID=15 titled "Invariant Mass2 versus Mass1" with values mass1 and mass2 .

If the histogram with given title does not exist yet it will be automatically booked with parameters lowX equal to 2.5, highX equal to 3.5, binsX equal to 100

It is also possible to use literal IDs. For example :-

const double mass1 = ... ;
const double mass2 = ... ;
profile1D( mass1, mass2,
        "mass", "Invariant Mass2 versus Mass1" ,2.5 ,3.5, 100 );

Will book the same histogram, using the id "mass".

It is also possible using literal IDs, to place histograms in sub-directories from the main histogram directory, using for example :-

const double mass1 = ... ;
const double mass2 = ... ;
profile1D( mass1, mass2,
   "subdir/mass", "Invariant Mass2 versus Mass1" ,2.5 ,3.5, 100 );

Which will create the histogram "mass" in the sub-directory "subdir". Histograms can also be created in sub-directories with numeric IDs if IDs such as "subdir/1" are used.

See also: AIDA::IProfile1D

Parameters

valueX	x value to be filled
valueY	y value to be filled
ID	histogram identifier
title	histogram title (must be unique within the algorithm)
lowX	low x limit for histogram
highX	high x limit for histogram
binsX	number of bins in x
opt	the options, used for evaluation of errors
lowY	the min cut-off for y-values
highY	the max cut-off for y-values
weight	weight

Returns: pointer to AIDA 1D profile histogram

Definition at line 176 of file GaudiHistos_1DProfFixedBinning.icpp.

 {
   AIDA::IProfile1D * h = nullptr;
   if ( produceHistos() )
   {
     // retrieve or book the histogram
     h = profile1D ( ID ) ;
     if ( !h )
     { h = bookProfile1D ( ID , title , lowX , highX , binsX , opt , lowY , highY ) ; }
     // fill the histogram
     h = fill ( h , valueX , valueY , weight , title ) ;
   }
   return h;
 }

template<class PBASE>

AIDA::IProfile1D* GaudiHistos< PBASE >::profile1D	(	const double	valueX,
		const double	valueY,
		const HistoID &	ID,
		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 with forced ID assignment (book on demand)

const double mass1 = ... ;
const double mass2 = ... ;
profile1D( mass1, mass2,
        15, "Invariant Mass2 versus Mass1" ,2.5 ,3.5, 100 );

This example illustrates the filling of the 1D profile histogram with ID=15 titled "Invariant Mass2 versus Mass1" with values mass1 and mass2 .

If the histogram with given title does not exist yet it will be automatically booked with parameters lowX equal to 2.5, highX equal to 3.5, binsX equal to 100

It is also possible to use literal IDs. For example :-

const double mass1 = ... ;
const double mass2 = ... ;
profile1D( mass1, mass2,
        "mass", "Invariant Mass2 versus Mass1" ,2.5 ,3.5, 100 );

Will book the same histogram, using the id "mass".

It is also possible using literal IDs, to place histograms in sub-directories from the main histogram directory, using for example :-

const double mass1 = ... ;
const double mass2 = ... ;
profile1D( mass1, mass2,
   "subdir/mass", "Invariant Mass2 versus Mass1" ,2.5 ,3.5, 100 );

Which will create the histogram "mass" in the sub-directory "subdir". Histograms can also be created in sub-directories with numeric IDs if IDs such as "subdir/1" are used.

See also: AIDA::IProfile1D

Parameters

valueX	x value to be filled
valueY	y value to be filled
ID	histogram identifier
title	histogram title (must be unique within the algorithm)
lowX	low x limit for histogram
highX	high x limit for histogram
binsX	number of bins in x
opt	the options, used for evaluation of errors
lowY	the min cut-off for y-values
highY	the max cut-off for y-values
weight	weight

Returns: pointer to AIDA 1D profile histogram

template<class PBASE>

AIDA::IProfile1D* GaudiHistos< PBASE >::profile1D	(	const double	valueX,
		const double	valueY,
		const std::string &	title,
		const HistoBinEdges &	edges,
		const double	weight = `1.0`
	)		const

fill the 1D variable binning profile histogram (book on demand)

const GaudiAlg::HistoBinEdges edges = ...;
const double mass1 = ... ;
const double mass2 = ... ;
profile1D( mass1, mass2, "Invariant Mass2 versus Mass1", edges );

This example illustrates the filling of the 1D profile histogram titled "Invariant Mass2 versus Mass1" with values mass1 and mass2 .

If the histogram with given title does not exist yet it will be automatically booked with the given histogram bin edges.

Attention: The histogram will get a unique identifier automatically assigned which by default will be equal to the histogram title. An option exists to instead use numerical IDs. In this case the first histogram booked will be ID=1 the next ID=2 and so on. Note though this scheme is not recommended as it does NOT guarantee predictability of the ID a given histogram will be given when filled under conditional statements, since in these circumstances the order in which the histograms are first filled, and thus booked, will depend on the nature of the first few events read. This is particularly problematic when users submit many parallel 'sub-jobs' and then attempt to merge the final output ROOT (or HBOOK) files, since a given histogram could have different IDs in each of the sub-jobs. Consequently it is strongly recommended that users do not use numerical automatic IDs unless they are sure they understand what they are doing.

See also: AIDA::IProfile1D

Parameters

valueX	x value to be filled
valueY	y value to be filled
title	histogram title (must be unique within the algorithm)
edges	The histogram bin edges
weight	weight

Returns: pointer to AIDA 1D profile histogram

template<class PBASE >

AIDA::IProfile1D * GaudiHistos< PBASE >::profile1D	(	const double	valueX,
		const double	valueY,
		const std::string &	title,
		const HistoBinEdges &	edges,
		const double	weight = `1.0`
	)		const

fill the 1D variable binning profile histogram (book on demand)

const GaudiAlg::HistoBinEdges edges = ...;
const double mass1 = ... ;
const double mass2 = ... ;
profile1D( mass1, mass2, "Invariant Mass2 versus Mass1", edges );

This example illustrates the filling of the 1D profile histogram titled "Invariant Mass2 versus Mass1" with values mass1 and mass2 .

If the histogram with given title does not exist yet it will be automatically booked with the given histogram bin edges.

Attention: The histogram will get a unique identifier automatically assigned which by default will be equal to the histogram title. An option exists to instead use numerical IDs. In this case the first histogram booked will be ID=1 the next ID=2 and so on. Note though this scheme is not recommended as it does NOT guarantee predictability of the ID a given histogram will be given when filled under conditional statements, since in these circumstances the order in which the histograms are first filled, and thus booked, will depend on the nature of the first few events read. This is particularly problematic when users submit many parallel 'sub-jobs' and then attempt to merge the final output ROOT (or HBOOK) files, since a given histogram could have different IDs in each of the sub-jobs. Consequently it is strongly recommended that users do not use numerical automatic IDs unless they are sure they understand what they are doing.

See also: AIDA::IProfile1D

Parameters

valueX	x value to be filled
valueY	y value to be filled
title	histogram title (must be unique within the algorithm)
edges	The histogram bin edges
weight	weight

Returns: pointer to AIDA 1D profile histogram

Definition at line 95 of file GaudiHistos_1DProfVariableBinning.icpp.

 {
   AIDA::IProfile1D * h(nullptr);
   if ( produceHistos() )
   {
     // retrieve or book the histogram
     h = profile1D ( title ) ;
     if ( !h ) { h = bookProfile1D ( title , edges ) ; }
     // fill the histogram
     h = fill ( h , valueX , valueY , weight , title ) ;
   }
   return h;
 }

template<class PBASE >

AIDA::IProfile1D * GaudiHistos< PBASE >::profile1D	(	const double	valueX,
		const double	valueY,
		const HistoID &	ID,
		const std::string &	title,
		const HistoBinEdges &	edges,
		const double	weight = `1.0`
	)		const

fill the 1D variable binning profile histogram with forced ID assignment (book on demand)

const GaudiAlg::HistoBinEdges edges = ...;
const double mass1 = ... ;
const double mass2 = ... ;
profile1D( mass1, mass2,
        15, "Invariant Mass2 versus Mass1", edges );

This example illustrates the filling of the 1D profile histogram with ID=15 titled "Invariant Mass2 versus Mass1" with values mass1 and mass2 .

If the histogram with given ID does not exist yet it will be automatically booked with the given histogram bin edges.

It is also possible to use literal IDs. For example :-

const GaudiAlg::HistoBinEdges edges = ...;
const double mass1 = ... ;
const double mass2 = ... ;
profile1D( mass1, mass2,
        "mass", "Invariant Mass2 versus Mass1", edges );

Will book the same histogram, using the id "mass".

It is also possible using literal IDs, to place histograms in sub-directories from the main histogram directory, using for example :-

const GaudiAlg::HistoBinEdges edges = ...;
const double mass1 = ... ;
const double mass2 = ... ;
profile1D( mass1, mass2,
   "subdir/mass", "Invariant Mass2 versus Mass1", edges );

Which will create the histogram "mass" in the sub-directory "subdir". Histograms can also be created in sub-directories with numeric IDs if IDs such as "subdir/1" are used.

See also: AIDA::IProfile1D

Parameters

valueX	x value to be filled
valueY	y value to be filled
ID	histogram identifier
title	histogram title (must be unique within the algorithm)
edges	The histogram bin edges
weight	weight

Returns: pointer to AIDA 1D profile histogram

Definition at line 117 of file GaudiHistos_1DProfVariableBinning.icpp.

 {
   AIDA::IProfile1D * h(nullptr);
   if ( produceHistos() )
   {
     // retrieve or book the histogram
     h = profile1D ( ID ) ;
     if ( !h ) { h = bookProfile1D ( ID , title , edges ) ; }
     // fill the histogram
     h = fill ( h , valueX , valueY , weight , title ) ;
   }
   return h;
 }

template<class PBASE>

AIDA::IProfile1D* GaudiHistos< PBASE >::profile1D	(	const double	valueX,
		const double	valueY,
		const HistoID &	ID,
		const std::string &	title,
		const HistoBinEdges &	edges,
		const double	weight = `1.0`
	)		const

fill the 1D variable binning profile histogram with forced ID assignment (book on demand)

const GaudiAlg::HistoBinEdges edges = ...;
const double mass1 = ... ;
const double mass2 = ... ;
profile1D( mass1, mass2,
        15, "Invariant Mass2 versus Mass1", edges );

This example illustrates the filling of the 1D profile histogram with ID=15 titled "Invariant Mass2 versus Mass1" with values mass1 and mass2 .

If the histogram with given ID does not exist yet it will be automatically booked with the given histogram bin edges.

It is also possible to use literal IDs. For example :-

const GaudiAlg::HistoBinEdges edges = ...;
const double mass1 = ... ;
const double mass2 = ... ;
profile1D( mass1, mass2,
        "mass", "Invariant Mass2 versus Mass1", edges );

Will book the same histogram, using the id "mass".

It is also possible using literal IDs, to place histograms in sub-directories from the main histogram directory, using for example :-

const GaudiAlg::HistoBinEdges edges = ...;
const double mass1 = ... ;
const double mass2 = ... ;
profile1D( mass1, mass2,
   "subdir/mass", "Invariant Mass2 versus Mass1", edges );

Which will create the histogram "mass" in the sub-directory "subdir". Histograms can also be created in sub-directories with numeric IDs if IDs such as "subdir/1" are used.

See also: AIDA::IProfile1D

Parameters

valueX	x value to be filled
valueY	y value to be filled
ID	histogram identifier
title	histogram title (must be unique within the algorithm)
edges	The histogram bin edges
weight	weight

Returns: pointer to AIDA 1D profile histogram

template<class PBASE>

AIDA::IProfile1D* GaudiHistos< PBASE >::profile1D ( const std::string & title ) const

inline

access the EXISTING 1D profile histogram by title return the pointer to existing 1D profile histogram or NULL

Definition at line 2608 of file GaudiHistos.h.

   {
     auto found = profile1DMapTitle().find( title ) ;
     return profile1DMapTitle().end() != found ? found->second : nullptr;
   }

template<class PBASE>

AIDA::IProfile1D* GaudiHistos< PBASE >::profile1D ( const std::string & title ) const

inline

access the EXISTING 1D profile histogram by title return the pointer to existing 1D profile histogram or NULL

Definition at line 2608 of file GaudiHistos.h.

   {
     auto found = profile1DMapTitle().find( title ) ;
     return profile1DMapTitle().end() != found ? found->second : nullptr;
   }

template<class PBASE >

AIDA::IProfile1D * GaudiHistos< PBASE >::profile1D ( const HistoID & ID ) const

access the EXISTING 1D profile histogram by ID return the pointer to existing 1D profile histogram or NULL

Definition at line 428 of file GaudiHistos.icpp.

 {
   return lookup_( profile1DMapID(), ID );
 }

template<class PBASE>

AIDA::IProfile1D* GaudiHistos< PBASE >::profile1D ( const HistoID & ID ) const

access the EXISTING 1D profile histogram by ID return the pointer to existing 1D profile histogram or NULL

template<class PBASE>

const Profile1DMapID& GaudiHistos< PBASE >::profile1DMapID ( ) const

inline

get access to the map of 1D profile histograms index via a ID

// iterate over the map!
for ( const auto& entry : profile1DMapID() )
   {
      // histogram ID
      const HistoID        ID = entry.first ;
      // histogram itself
      AIDA::IProfile1D* h  = entry.second ;
      if ( 0 == h ) { continue ;}
      std::cout << " Histogram ID    " << ID
                << " Histogram title " << h->title() << std::endl ;
   }

Definition at line 2920 of file GaudiHistos.h.

2920 { return m_profile1DMapID; }

Profile1DMapID m_profile1DMapID

the actual storage/access of 1D profile histograms by unique ID

Definition: GaudiHistos.h:3102

template<class PBASE>

const Profile1DMapID& GaudiHistos< PBASE >::profile1DMapID ( ) const

inline

get access to the map of 1D profile histograms index via a ID

// iterate over the map!
for ( const auto& entry : profile1DMapID() )
   {
      // histogram ID
      const HistoID        ID = entry.first ;
      // histogram itself
      AIDA::IProfile1D* h  = entry.second ;
      if ( 0 == h ) { continue ;}
      std::cout << " Histogram ID    " << ID
                << " Histogram title " << h->title() << std::endl ;
   }

Definition at line 2920 of file GaudiHistos.h.

2920 { return m_profile1DMapID; }

GaudiHistos::m_profile1DMapID

Profile1DMapID m_profile1DMapID

the actual storage/access of 1D profile histograms by unique ID

Definition: GaudiHistos.h:3102

template<class PBASE>

const Profile1DMapTitle& GaudiHistos< PBASE >::profile1DMapTitle ( ) const

inline

get access to the map of all 1D profile histograms indexed via their title

Using this method one can inspect e.g. a list of active histograms

const Profile1DMapTitle& histos = profile1DMapTitle() ;
// iterate over the map!
for ( Profile1DMapTitle::const_iterator entry = histos.begin() ;
      histos.end() != entry ; ++entry  )
   {
      // histogram title
      const std::string&   title = entry->first ;
      // histogram itself
      AIDA::IProfile1D* hist  = entry->second ;
      if( 0 == hist )  { continue ; }                // ATTENTION!
      std::cout << " Histogram title " << title << std::endl ;
   }

Attention: The map COULD contains NULL pointers, the check before use is mandatory!

Definition at line 2897 of file GaudiHistos.h.

2897 { return m_profile1DMapTitle; }

GaudiHistos::m_profile1DMapTitle

Profile1DMapTitle m_profile1DMapTitle

the actual storage/access of 1D profile histograms by unique title

Definition: GaudiHistos.h:3100

template<class PBASE>

const Profile1DMapTitle& GaudiHistos< PBASE >::profile1DMapTitle ( ) const

inline

get access to the map of all 1D profile histograms indexed via their title

Using this method one can inspect e.g. a list of active histograms

const Profile1DMapTitle& histos = profile1DMapTitle() ;
// iterate over the map!
for ( Profile1DMapTitle::const_iterator entry = histos.begin() ;
      histos.end() != entry ; ++entry  )
   {
      // histogram title
      const std::string&   title = entry->first ;
      // histogram itself
      AIDA::IProfile1D* hist  = entry->second ;
      if( 0 == hist )  { continue ; }                // ATTENTION!
      std::cout << " Histogram title " << title << std::endl ;
   }

Attention: The map COULD contains NULL pointers, the check before use is mandatory!

Definition at line 2897 of file GaudiHistos.h.

2897 { return m_profile1DMapTitle; }

GaudiHistos::m_profile1DMapTitle

Profile1DMapTitle m_profile1DMapTitle

the actual storage/access of 1D profile histograms by unique title

Definition: GaudiHistos.h:3100

template<class PBASE>

AIDA::IProfile2D* GaudiHistos< PBASE >::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)

const double X = ... ;
const double Y = ... ;
const double Z = ... ;
profile2( X, Y, Z, "Space Points" ,2.5 ,3.5, 4.5, 5.5, 10, 20 );

This example illustrates the filling of the 2D profile histogram titled "Space Points" with values X, Y and Z.

If the histogram with given title does not exist yet it will be automatically booked with parameters lowX equal to 2.5, highX equal to 3.5, lowY equal to 4.5, highY equal to 5.5, binsX equal to 10, binsY equal to 20.

Attention: The histogram will get a unique identifier automatically assigned which by default will be equal to the histogram title. An option exists to instead use numerical IDs. In this case the first histogram booked will be ID=1 the next ID=2 and so on. Note though this scheme is not recommended as it does NOT guarantee predictability of the ID a given histogram will be given when filled under conditional statements, since in these circumstances the order in which the histograms are first filled, and thus booked, will depend on the nature of the first few events read. This is particularly problematic when users submit many parallel 'sub-jobs' and then attempt to merge the final output ROOT (or HBOOK) files, since a given histogram could have different IDs in each of the sub-jobs. Consequently it is strongly recommended that users do not use numerical automatic IDs unless they are sure they understand what they are doing.

See also: AIDA::IProfile2D

Parameters

valueX	x value to be filled
valueY	y value to be filled
valueZ	z value to be filled
title	histogram title (must be unique within the algorithm)
lowX	low x limit for histogram
highX	high x limit for histogram
lowY	low y limit for histogram
highY	high y limit for histogram
binsX	number of bins in x
binsY	number of bins in y
weight	weight

Returns: pointer to AIDA 2D profile histogram

template<class PBASE >

AIDA::IProfile2D * GaudiHistos< PBASE >::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)

const double X = ... ;
const double Y = ... ;
const double Z = ... ;
profile2( X, Y, Z, "Space Points" ,2.5 ,3.5, 4.5, 5.5, 10, 20 );

This example illustrates the filling of the 2D profile histogram titled "Space Points" with values X, Y and Z.

If the histogram with given title does not exist yet it will be automatically booked with parameters lowX equal to 2.5, highX equal to 3.5, lowY equal to 4.5, highY equal to 5.5, binsX equal to 10, binsY equal to 20.

Attention: The histogram will get a unique identifier automatically assigned which by default will be equal to the histogram title. An option exists to instead use numerical IDs. In this case the first histogram booked will be ID=1 the next ID=2 and so on. Note though this scheme is not recommended as it does NOT guarantee predictability of the ID a given histogram will be given when filled under conditional statements, since in these circumstances the order in which the histograms are first filled, and thus booked, will depend on the nature of the first few events read. This is particularly problematic when users submit many parallel 'sub-jobs' and then attempt to merge the final output ROOT (or HBOOK) files, since a given histogram could have different IDs in each of the sub-jobs. Consequently it is strongly recommended that users do not use numerical automatic IDs unless they are sure they understand what they are doing.

See also: AIDA::IProfile2D

Parameters

valueX	x value to be filled
valueY	y value to be filled
valueZ	z value to be filled
title	histogram title (must be unique within the algorithm)
lowX	low x limit for histogram
highX	high x limit for histogram
lowY	low y limit for histogram
highY	high y limit for histogram
binsX	number of bins in x
binsY	number of bins in y
weight	weight

Returns: pointer to AIDA 2D profile histogram

Definition at line 149 of file GaudiHistos_2DProfFixedBinning.icpp.

 {
   AIDA::IProfile2D * h = nullptr;
   if ( produceHistos() )
   {
     // retrieve or book the histogram
     h = profile2D ( title ) ;
     if ( 0 == h ) { h = bookProfile2D ( title ,
                                         lowX , highX , binsX ,
                                         lowY , highY , binsY ) ; }
     // fill the histogram
     h = fill ( h , valueX , valueY , valueZ , weight , title ) ;
   }
   return h;
 }

template<class PBASE>

AIDA::IProfile2D* GaudiHistos< PBASE >::profile2D	(	const double	valueX,
		const double	valueY,
		const double	valueZ,
		const HistoID &	ID,
		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 with forced ID assignment (book on demand)

const double X = ... ;
const double Y = ... ;
const double Z = ... ;
profile2D( X, Y, Z, 15, "Space Points" ,2.5 ,3.5, 4.5, 5.5, 10, 20 );

This example illustrates the filling of the 2D profile histogram with ID=15 titled "Space Points" with values X, Y and Z.

If the histogram with given title does not exist yet it will be automatically booked with parameters lowX equal to 2.5, highX equal to 3.5, lowY equal to 4.5, highY equal to 5.5, binsX equal to 10, binsY equal to 20.

It is also possible to use literal IDs. For example :-

const double X = ... ;
const double Y = ... ;
const double Z = ... ;
profile2D( X, Y, Z, "space", "Space Points" ,2.5 ,3.5, 4.5, 5.5, 10, 20 );

Will book the same histogram, using the id "space".

It is also possible using literal IDs, to place histograms in sub-directories from the main histogram directory, using for example :-

const double X = ... ;
const double Y = ... ;
const double Z = ... ;
profile2D( X, Y, Z,
           "subdir/space", "Space Points" ,2.5 ,3.5, 4.5, 5.5, 10, 20 );

Which will create the histogram "space" in the sub-directory "subdir". Histograms can also be created in sub-directories with numeric IDs if IDs such as "subdir/1" are used.

See also: AIDA::IProfile2D

Parameters

valueX	x value to be filled
valueY	y value to be filled
valueZ	z value to be filled
ID	histogram identifier
title	histogram title (must be unique within the algorithm)
lowX	low x limit for histogram
highX	high x limit for histogram
lowY	low y limit for histogram
highY	high y limit for histogram
binsX	number of bins in x
binsY	number of bins in y
weight	weight

Returns: pointer to AIDA 2D profile histogram

template<class PBASE >

AIDA::IProfile2D * GaudiHistos< PBASE >::profile2D	(	const double	valueX,
		const double	valueY,
		const double	valueZ,
		const HistoID &	ID,
		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 with forced ID assignment (book on demand)

const double X = ... ;
const double Y = ... ;
const double Z = ... ;
profile2D( X, Y, Z, 15, "Space Points" ,2.5 ,3.5, 4.5, 5.5, 10, 20 );

This example illustrates the filling of the 2D profile histogram with ID=15 titled "Space Points" with values X, Y and Z.

If the histogram with given title does not exist yet it will be automatically booked with parameters lowX equal to 2.5, highX equal to 3.5, lowY equal to 4.5, highY equal to 5.5, binsX equal to 10, binsY equal to 20.

It is also possible to use literal IDs. For example :-

const double X = ... ;
const double Y = ... ;
const double Z = ... ;
profile2D( X, Y, Z, "space", "Space Points" ,2.5 ,3.5, 4.5, 5.5, 10, 20 );

Will book the same histogram, using the id "space".

It is also possible using literal IDs, to place histograms in sub-directories from the main histogram directory, using for example :-

const double X = ... ;
const double Y = ... ;
const double Z = ... ;
profile2D( X, Y, Z,
           "subdir/space", "Space Points" ,2.5 ,3.5, 4.5, 5.5, 10, 20 );

Which will create the histogram "space" in the sub-directory "subdir". Histograms can also be created in sub-directories with numeric IDs if IDs such as "subdir/1" are used.

See also: AIDA::IProfile2D

Parameters

valueX	x value to be filled
valueY	y value to be filled
valueZ	z value to be filled
ID	histogram identifier
title	histogram title (must be unique within the algorithm)
lowX	low x limit for histogram
highX	high x limit for histogram
lowY	low y limit for histogram
highY	high y limit for histogram
binsX	number of bins in x
binsY	number of bins in y
weight	weight

Returns: pointer to AIDA 2D profile histogram

Definition at line 179 of file GaudiHistos_2DProfFixedBinning.icpp.

 {
   AIDA::IProfile2D * h = nullptr;
   if ( produceHistos() )
   {
     // retrieve or book the histogram
     h = profile2D ( ID ) ;
     if ( 0 == h ) { h = bookProfile2D ( ID , title ,
                                         lowX , highX , binsX ,
                                         lowY , highY , binsY ) ; }
     // fill the histogram
     h = fill ( h , valueX , valueY , valueZ , weight , title ) ;
   }
   return h;
 }

template<class PBASE>

AIDA::IProfile2D* GaudiHistos< PBASE >::profile2D	(	const double	valueX,
		const double	valueY,
		const double	valueZ,
		const std::string &	title,
		const HistoBinEdges &	edgesX,
		const HistoBinEdges &	edgesY,
		const double	weight = `1.0`
	)		const

fill the 2D variable binning profile histogram (book on demand)

const GaudiAlg::HistoBinEdges edgesX = ...;
const GaudiAlg::HistoBinEdges edgesY = ...;
const double X = ... ;
const double Y = ... ;
const double Z = ... ;
profile2D( X, Y, Z, "Space Points", edgesX, edgesY );

This example illustrates the filling of the 2D profile histogram titled "Space Points" with values X, Y and Z.

If the histogram with given title does not exist yet it will be automatically booked with the given histogram bin edges.

Attention: The histogram will get a unique identifier automatically assigned which by default will be equal to the histogram title. An option exists to instead use numerical IDs. In this case the first histogram booked will be ID=1 the next ID=2 and so on. Note though this scheme is not recommended as it does NOT guarantee predictability of the ID a given histogram will be given when filled under conditional statements, since in these circumstances the order in which the histograms are first filled, and thus booked, will depend on the nature of the first few events read. This is particularly problematic when users submit many parallel 'sub-jobs' and then attempt to merge the final output ROOT (or HBOOK) files, since a given histogram could have different IDs in each of the sub-jobs. Consequently it is strongly recommended that users do not use numerical automatic IDs unless they are sure they understand what they are doing.

See also: AIDA::IProfile2D

Parameters

valueX	x value to be filled
valueY	y value to be filled
valueZ	z value to be filled
title	histogram title (must be unique within the algorithm)
edgesX	The histogram x bin edges
edgesY	The histogram x bin edges
weight	weight

Returns: pointer to AIDA 1D profile histogram

template<class PBASE >

AIDA::IProfile2D * GaudiHistos< PBASE >::profile2D	(	const double	valueX,
		const double	valueY,
		const double	valueZ,
		const std::string &	title,
		const HistoBinEdges &	edgesX,
		const HistoBinEdges &	edgesY,
		const double	weight = `1.0`
	)		const

fill the 2D variable binning profile histogram (book on demand)

const GaudiAlg::HistoBinEdges edgesX = ...;
const GaudiAlg::HistoBinEdges edgesY = ...;
const double X = ... ;
const double Y = ... ;
const double Z = ... ;
profile2D( X, Y, Z, "Space Points", edgesX, edgesY );

This example illustrates the filling of the 2D profile histogram titled "Space Points" with values X, Y and Z.

If the histogram with given title does not exist yet it will be automatically booked with the given histogram bin edges.

Attention: The histogram will get a unique identifier automatically assigned which by default will be equal to the histogram title. An option exists to instead use numerical IDs. In this case the first histogram booked will be ID=1 the next ID=2 and so on. Note though this scheme is not recommended as it does NOT guarantee predictability of the ID a given histogram will be given when filled under conditional statements, since in these circumstances the order in which the histograms are first filled, and thus booked, will depend on the nature of the first few events read. This is particularly problematic when users submit many parallel 'sub-jobs' and then attempt to merge the final output ROOT (or HBOOK) files, since a given histogram could have different IDs in each of the sub-jobs. Consequently it is strongly recommended that users do not use numerical automatic IDs unless they are sure they understand what they are doing.

See also: AIDA::IProfile2D

Parameters

valueX	x value to be filled
valueY	y value to be filled
valueZ	z value to be filled
title	histogram title (must be unique within the algorithm)
edgesX	The histogram x bin edges
edgesY	The histogram x bin edges
weight	weight

Returns: pointer to AIDA 1D profile histogram

Definition at line 98 of file GaudiHistos_2DProfVariableBinning.icpp.

 {
   AIDA::IProfile2D * h(nullptr);
   if ( produceHistos() )
   {
     // retrieve or book the histogram
     h = profile2D ( title ) ;
     if ( !h ) { h = bookProfile2D ( title, edgesX, edgesY ) ; }
     // fill the histogram
     h = fill ( h , valueX , valueY , valueZ , weight , title ) ;
   }
   return h;
 }

template<class PBASE>

AIDA::IProfile2D* GaudiHistos< PBASE >::profile2D	(	const double	valueX,
		const double	valueY,
		const double	valueZ,
		const HistoID &	ID,
		const std::string &	title,
		const HistoBinEdges &	edgesX,
		const HistoBinEdges &	edgesY,
		const double	weight = `1.0`
	)		const

fill the 2D variable binning profile histogram with forced ID assignment (book on demand)

const GaudiAlg::HistoBinEdges edgesX = ...;
const GaudiAlg::HistoBinEdges edgesY = ...;
const double X = ... ;
const double Y = ... ;
const double Z = ... ;
profile2( X, Y, Z, "Space Points", edgesX, edgesY );

This example illustrates the filling of the 2D profile histogram titled "Space Points" with values X, Y and Z.

If the histogram with given ID does not exist yet it will be automatically booked with the given histogram bin edges.

It is also possible to use literal IDs. For example :-

const double X = ... ;
const double Y = ... ;
const double Z = ... ;
profile2D( X, Y, Z, "space", "Space Points", edgesX, edgesY );

Will book the same histogram, using the id "mass".

It is also possible using literal IDs, to place histograms in sub-directories from the main histogram directory, using for example :-

const double X = ... ;
const double Y = ... ;
const double Z = ... ;
profile2D( X, Y, Z,
           "subdir/space", "Space Points", edgesX, edgesY );

Which will create the histogram "mass" in the sub-directory "subdir". Histograms can also be created in sub-directories with numeric IDs if IDs such as "subdir/1" are used.

See also: AIDA::IProfile2D

Parameters

valueX	x value to be filled
valueY	y value to be filled
valueZ	z value to be filled
ID	histogram identifier
title	histogram title (must be unique within the algorithm)
edgesX	The histogram x bin edges
edgesY	The histogram y bin edges
weight	weight

Returns: pointer to AIDA 1D profile histogram

template<class PBASE >

AIDA::IProfile2D * GaudiHistos< PBASE >::profile2D	(	const double	valueX,
		const double	valueY,
		const double	valueZ,
		const HistoID &	ID,
		const std::string &	title,
		const HistoBinEdges &	edgesX,
		const HistoBinEdges &	edgesY,
		const double	weight = `1.0`
	)		const

fill the 2D variable binning profile histogram with forced ID assignment (book on demand)

const GaudiAlg::HistoBinEdges edgesX = ...;
const GaudiAlg::HistoBinEdges edgesY = ...;
const double X = ... ;
const double Y = ... ;
const double Z = ... ;
profile2( X, Y, Z, "Space Points", edgesX, edgesY );

This example illustrates the filling of the 2D profile histogram titled "Space Points" with values X, Y and Z.

If the histogram with given ID does not exist yet it will be automatically booked with the given histogram bin edges.

It is also possible to use literal IDs. For example :-

const double X = ... ;
const double Y = ... ;
const double Z = ... ;
profile2D( X, Y, Z, "space", "Space Points", edgesX, edgesY );

Will book the same histogram, using the id "mass".

It is also possible using literal IDs, to place histograms in sub-directories from the main histogram directory, using for example :-

const double X = ... ;
const double Y = ... ;
const double Z = ... ;
profile2D( X, Y, Z,
           "subdir/space", "Space Points", edgesX, edgesY );

Which will create the histogram "mass" in the sub-directory "subdir". Histograms can also be created in sub-directories with numeric IDs if IDs such as "subdir/1" are used.

See also: AIDA::IProfile2D

Parameters

valueX	x value to be filled
valueY	y value to be filled
valueZ	z value to be filled
ID	histogram identifier
title	histogram title (must be unique within the algorithm)
edgesX	The histogram x bin edges
edgesY	The histogram y bin edges
weight	weight

Returns: pointer to AIDA 1D profile histogram

Definition at line 122 of file GaudiHistos_2DProfVariableBinning.icpp.

 {
   AIDA::IProfile2D * h(nullptr);
   if ( produceHistos() )
   {
     // retrieve or book the histogram
     h = profile2D ( ID ) ;
     if ( !h ) { h = bookProfile2D ( ID , title , edgesX , edgesY ) ; }
 
     // fill the histogram
     h = fill ( h , valueX , valueY , valueZ , weight , title ) ;
   }
   return h;
 }

template<class PBASE>

AIDA::IProfile2D* GaudiHistos< PBASE >::profile2D ( const std::string & title ) const

inline

access the EXISTING 2D profile histogram by title return the pointer to existing 2D profile histogram or NULL

Definition at line 2617 of file GaudiHistos.h.

   {
     auto found = profile2DMapTitle().find( title ) ;
     return profile2DMapTitle().end() != found ? found->second : nullptr;
   }

template<class PBASE>

AIDA::IProfile2D* GaudiHistos< PBASE >::profile2D ( const std::string & title ) const

inline

access the EXISTING 2D profile histogram by title return the pointer to existing 2D profile histogram or NULL

Definition at line 2617 of file GaudiHistos.h.

   {
     auto found = profile2DMapTitle().find( title ) ;
     return profile2DMapTitle().end() != found ? found->second : nullptr;
   }

template<class PBASE >

AIDA::IProfile2D * GaudiHistos< PBASE >::profile2D ( const HistoID & ID ) const

access the EXISTING 2D profile histogram by ID return the pointer to existing 2D profile histogram or NULL

Definition at line 436 of file GaudiHistos.icpp.

 {
   return lookup_( profile2DMapID(), ID );
 }

template<class PBASE>

AIDA::IProfile2D* GaudiHistos< PBASE >::profile2D ( const HistoID & ID ) const

access the EXISTING 2D profile histogram by ID return the pointer to existing 2D profile histogram or NULL

template<class PBASE>

const Profile2DMapID& GaudiHistos< PBASE >::profile2DMapID ( ) const

inline

get access to the map of 2D profile histograms index via a ID

// iterate over the map!
for ( const auto& entry : profile2DMapID() )
   {
      // histogram ID
      const HistoID        ID = entry.first ;
      // histogram itself
      AIDA::IProfile2D* h  = entry.second ;
      if ( 0 == h ) { continue ;}
      std::cout << " Histogram ID    " << ID
                << " Histogram title " << h->title() << std::endl ;
   }

Definition at line 2970 of file GaudiHistos.h.

2970 { return m_profile2DMapID; }

GaudiHistos::m_profile2DMapID

Profile2DMapID m_profile2DMapID

the actual storage/access of 2D profile histograms by unique ID

Definition: GaudiHistos.h:3107

template<class PBASE>

const Profile2DMapID& GaudiHistos< PBASE >::profile2DMapID ( ) const

inline

get access to the map of 2D profile histograms index via a ID

// iterate over the map!
for ( const auto& entry : profile2DMapID() )
   {
      // histogram ID
      const HistoID        ID = entry.first ;
      // histogram itself
      AIDA::IProfile2D* h  = entry.second ;
      if ( 0 == h ) { continue ;}
      std::cout << " Histogram ID    " << ID
                << " Histogram title " << h->title() << std::endl ;
   }

Definition at line 2970 of file GaudiHistos.h.

2970 { return m_profile2DMapID; }

GaudiHistos::m_profile2DMapID

Profile2DMapID m_profile2DMapID

the actual storage/access of 2D profile histograms by unique ID

Definition: GaudiHistos.h:3107

template<class PBASE>

const Profile2DMapTitle& GaudiHistos< PBASE >::profile2DMapTitle ( ) const

inline

get access to the map of all 2D profile histograms indexed via their title

Using this method one can inspect e.g. a list of active histograms

// iterate over the map!
for ( const auto& entry : profile2DMapTitle() )
   {
      // histogram title
      const std::string&   title = entry.first ;
      // histogram itself
      AIDA::IProfile2D* hist  = entry.second ;
      if( 0 == hist )  { continue ; }                // ATTENTION!
      std::cout << " Histogram title " << title << std::endl ;
   }

Attention: The map COULD contains NULL pointers, the check before use is mandatory!

Definition at line 2947 of file GaudiHistos.h.

2947 { return m_profile2DMapTitle; }

GaudiHistos::m_profile2DMapTitle

Profile2DMapTitle m_profile2DMapTitle

the actual storage/access of 2D profile histograms by unique title

Definition: GaudiHistos.h:3105

template<class PBASE>

const Profile2DMapTitle& GaudiHistos< PBASE >::profile2DMapTitle ( ) const

inline

get access to the map of all 2D profile histograms indexed via their title

Using this method one can inspect e.g. a list of active histograms

// iterate over the map!
for ( const auto& entry : profile2DMapTitle() )
   {
      // histogram title
      const std::string&   title = entry.first ;
      // histogram itself
      AIDA::IProfile2D* hist  = entry.second ;
      if( 0 == hist )  { continue ; }                // ATTENTION!
      std::cout << " Histogram title " << title << std::endl ;
   }

Attention: The map COULD contains NULL pointers, the check before use is mandatory!

Definition at line 2947 of file GaudiHistos.h.

2947 { return m_profile2DMapTitle; }

GaudiHistos::m_profile2DMapTitle

Profile2DMapTitle m_profile2DMapTitle

the actual storage/access of 2D profile histograms by unique title

Definition: GaudiHistos.h:3105

template<class PBASE>

void GaudiHistos< PBASE >::setCheckForNaN ( const bool val )

inline

set the flag for NaN checks (property "HistoCheckForNan")

Definition at line 2979 of file GaudiHistos.h.

2979 { m_checkForNaN = val ; }

bool m_checkForNaN

flag to control check for Nan/Finite while filling the histogram

Definition: GaudiHistos.h:3068

template<class PBASE>

void GaudiHistos< PBASE >::setCheckForNaN ( const bool val )

inline

set the flag for NaN checks (property "HistoCheckForNan")

Definition at line 2979 of file GaudiHistos.h.

2979 { m_checkForNaN = val ; }

bool m_checkForNaN

flag to control check for Nan/Finite while filling the histogram

Definition: GaudiHistos.h:3068

template<class PBASE>

void GaudiHistos< PBASE >::setFullDetail ( const bool val )

inline

set flag to control output level of histograms

Definition at line 2977 of file GaudiHistos.h.

2977 { m_fullDetail = val ; }

bool m_fullDetail

flag to control output level of histograms

Definition: GaudiHistos.h:3066

template<class PBASE>

void GaudiHistos< PBASE >::setFullDetail ( const bool val )

inline

set flag to control output level of histograms

Definition at line 2977 of file GaudiHistos.h.

2977 { m_fullDetail = val ; }

bool m_fullDetail

flag to control output level of histograms

Definition: GaudiHistos.h:3066

template<class PBASE>

void GaudiHistos< PBASE >::setHistoDir ( const std::string & val )

inline

set histogram directory (property "HistoDir")

Definition at line 2990 of file GaudiHistos.h.

2990 { m_histoDir = val ; }

std::string m_histoDir

histogram directory

Definition: GaudiHistos.h:3076

template<class PBASE>

void GaudiHistos< PBASE >::setHistoDir ( const std::string & val )

inline

set histogram directory (property "HistoDir")

Definition at line 2990 of file GaudiHistos.h.

2990 { m_histoDir = val ; }

std::string m_histoDir

histogram directory

Definition: GaudiHistos.h:3076

template<class PBASE>

void GaudiHistos< PBASE >::setHistoOffSet ( const HistoID::NumericID val )

inline

set a value for histogram offset (property "HistoOffSet"

Definition at line 2983 of file GaudiHistos.h.

2984 { m_histoOffSet = val ; }

HistoID::NumericID m_histoOffSet

general histogram ID offset (only works for automatically assigned numeric IDs)

Definition: GaudiHistos.h:3072

template<class PBASE>

void GaudiHistos< PBASE >::setHistoOffSet ( const HistoID::NumericID val )

inline

set a value for histogram offset (property "HistoOffSet"

Definition at line 2983 of file GaudiHistos.h.

2984 { m_histoOffSet = val ; }

HistoID::NumericID m_histoOffSet

general histogram ID offset (only works for automatically assigned numeric IDs)

Definition: GaudiHistos.h:3072

template<class PBASE>

void GaudiHistos< PBASE >::setHistoTopDir ( const std::string & val )

inline

set top-level histogram directory (property "HistoTopDir")

Definition at line 2987 of file GaudiHistos.h.

2987 { m_histoTopDir = val ; }

std::string m_histoTopDir

histogram top level directory

Definition: GaudiHistos.h:3074

template<class PBASE>

void GaudiHistos< PBASE >::setHistoTopDir ( const std::string & val )

inline

set top-level histogram directory (property "HistoTopDir")

Definition at line 2987 of file GaudiHistos.h.

2987 { m_histoTopDir = val ; }

std::string m_histoTopDir

histogram top level directory

Definition: GaudiHistos.h:3074

template<class PBASE>

void GaudiHistos< PBASE >::setProduceHistos ( const bool val )

inline

set the flag for histogram production (property "HistoProduce")

Definition at line 2975 of file GaudiHistos.h.

2975 { m_produceHistos = val ; }

bool m_produceHistos

flag to SWITCH ON/SWITCH OFF the histogrm fillling and booking

Definition: GaudiHistos.h:3064

template<class PBASE>

void GaudiHistos< PBASE >::setProduceHistos ( const bool val )

inline

set the flag for histogram production (property "HistoProduce")

Definition at line 2975 of file GaudiHistos.h.

2975 { m_produceHistos = val ; }

bool m_produceHistos

flag to SWITCH ON/SWITCH OFF the histogrm fillling and booking

Definition: GaudiHistos.h:3064

template<class PBASE>

void GaudiHistos< PBASE >::setSplitHistoDir ( const bool val )

inline

set the flag for histogram path split (property "HistoSplitDir")

Definition at line 2981 of file GaudiHistos.h.

2981 { m_splitHistoDir = val ; }

bool m_splitHistoDir

split histogram directory name (very useful for Hbook)

Definition: GaudiHistos.h:3070

template<class PBASE>

void GaudiHistos< PBASE >::setSplitHistoDir ( const bool val )

inline

set the flag for histogram path split (property "HistoSplitDir")

Definition at line 2981 of file GaudiHistos.h.

2981 { m_splitHistoDir = val ; }

bool m_splitHistoDir

split histogram directory name (very useful for Hbook)

Definition: GaudiHistos.h:3070

template<class PBASE>

bool GaudiHistos< PBASE >::splitHistoDir ( ) const

inline

get the flag for histogram path split (property "HistoSplitDir")

Definition at line 2697 of file GaudiHistos.h.

2697 { return m_splitHistoDir ; }

bool m_splitHistoDir

split histogram directory name (very useful for Hbook)

Definition: GaudiHistos.h:3070

template<class PBASE>

bool GaudiHistos< PBASE >::splitHistoDir ( ) const

inline

get the flag for histogram path split (property "HistoSplitDir")

Definition at line 2697 of file GaudiHistos.h.

2697 { return m_splitHistoDir ; }