HistoLabels.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2025 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.                                             *
\***********************************************************************************/
#pragma once
 
#include <string>
#include <utility>
#include <vector>
 
#include <GaudiKernel/Kernel.h>
 
namespace AIDA {
  class IHistogram1D;
  class IHistogram2D;
  class IProfile1D;
  class IProfile2D;
} // namespace AIDA
 
namespace Gaudi {
  namespace Utils {
    namespace Histos {
      // --------------------------------------------------------------------------

      typedef std::vector<std::string> Labels;
      typedef std::pair<unsigned, std::string> BinLabel;
      typedef std::vector<BinLabel> BinLabels;
 
      // --------------------------------------------------------------------------

      GAUDI_API bool setBinLabels( AIDA::IHistogram1D* hist, const Labels& labels );

      GAUDI_API bool setBinLabels( AIDA::IHistogram1D* hist, const BinLabels& labels );
 
      // --------------------------------------------------------------------------

      GAUDI_API bool setBinLabels( AIDA::IProfile1D* hist, const Labels& labels );

      GAUDI_API bool setBinLabels( AIDA::IProfile1D* hist, const BinLabels& labels );
 
      // --------------------------------------------------------------------------

      GAUDI_API bool setBinLabels( AIDA::IHistogram2D* hist, const Labels& xlabels, const Labels& ylabels );

      GAUDI_API bool setBinLabels( AIDA::IHistogram2D* hist, const BinLabels& xlabels, const BinLabels& ylabels );
 
      // --------------------------------------------------------------------------

      GAUDI_API bool setBinLabels( AIDA::IProfile2D* hist, const Labels& xlabels, const Labels& ylabels );

      GAUDI_API bool setBinLabels( AIDA::IProfile2D* hist, const BinLabels& xlabels, const BinLabels& ylabels );
 
      // --------------------------------------------------------------------------

      GAUDI_API bool setAxisLabels( AIDA::IHistogram1D* hist, const std::string& xAxis, const std::string& yAxis );

      GAUDI_API bool setAxisLabels( AIDA::IProfile1D* hist, const std::string& xAxis, const std::string& yAxis );
 
      // --------------------------------------------------------------------------

      GAUDI_API bool setAxisLabels( AIDA::IHistogram2D* hist, const std::string& xAxis, const std::string& yAxis );

      GAUDI_API bool setAxisLabels( AIDA::IProfile2D* hist, const std::string& xAxis, const std::string& yAxis );
 
      // --------------------------------------------------------------------------
    } // namespace Histos
  }   // namespace Utils
} // namespace Gaudi