HistoDef.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2024 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
#ifndef GAUDIKERNEL_HISTODEF_H
#define GAUDIKERNEL_HISTODEF_H 1
// ============================================================================
// Include files
// ============================================================================
// STD & STL
// ============================================================================
#include <iosfwd>
#include <string>
// ============================================================================
// Gaudi
// ============================================================================
#include <GaudiKernel/Kernel.h>
// ============================================================================
// Forward decalrations
// ============================================================================
class IHistogramSvc; 
namespace AIDA {
  class IHistogram1D;
} // namespace AIDA
// ============================================================================
namespace Gaudi {
  // ==========================================================================
  class GAUDI_API Histo1DDef final {
  public:
    // ========================================================================
    Histo1DDef( double low, double high, int bins = 100, std::string title = "" );
    // ========================================================================
    Histo1DDef( std::string title = "", double low = 0.0, double high = 1.0, int bins = 100 );
    // ========================================================================
  public:
    // ========================================================================
    double lowEdge() const { return m_low; }
    double highEdge() const { return m_high; }
    int bins() const { return m_bins; }
    const std::string& title() const { return m_title; }
    // ========================================================================
  public:
    // ========================================================================
    void setLowEdge( double value ) { m_low = value; }
    void setHighEdge( double value ) { m_high = value; }
    void setBins( int value ) { m_bins = value; }
    void setTitle( std::string value ) { m_title = std::move( value ); }
    // ========================================================================
  public:
    // ========================================================================
    std::ostream& fillStream( std::ostream& o ) const;
    // ========================================================================
  public:
    // ========================================================================
    friend bool operator<( const Histo1DDef& left, const Histo1DDef& right );
    // ========================================================================
    friend std::ostream& operator<<( std::ostream& o, const Gaudi::Histo1DDef& histo );
    // ========================================================================
  public:
    // ========================================================================
    bool ok() const { return 0 < bins() && lowEdge() < highEdge(); }
    // ========================================================================
  private:
    // ========================================================================
    // Histogram title
    std::string m_title; 
    // Low  Edge
    double m_low; 
    // High Edge
    double m_high; 
    // Number of bins
    int m_bins; 
    // ========================================================================
  };
  // ==========================================================================
  namespace Histos {
    // ========================================================================
    GAUDI_API AIDA::IHistogram1D* book( IHistogramSvc* svc, const std::string& path, const Gaudi::Histo1DDef& hist );
    // ========================================================================
    GAUDI_API AIDA::IHistogram1D* book( IHistogramSvc* svc, const std::string& dir, const std::string& id,
                                        const Gaudi::Histo1DDef& hist );
    // ========================================================================
    GAUDI_API AIDA::IHistogram1D* book( IHistogramSvc* svc, const std::string& dir, const int id,
                                        const Gaudi::Histo1DDef& hist );
    // ========================================================================
  } // namespace Histos
  // ==========================================================================
} // end of namespace Gaudi
// ============================================================================
// The END
// ============================================================================
#endif // GAUDIKERNEL_HISTODEF_H