d5/dfd/_histo_decorator_8h_source.html

/***********************************************************************************\

* (c) Copyright 1998-2023 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 <GaudiAlg/GaudiHistoAlg.h>

#include <GaudiPython/Vector.h>


struct GaudiHistoTool;


namespace GaudiPython {

  class GAUDI_API HistoDecorator {

  public:

    // ========================================================================

    typedef std::vector<GaudiAlg::ID>        IDs;

    typedef std::vector<AIDA::IHistogram1D*> Histos1D;

    typedef std::vector<AIDA::IHistogram2D*> Histos2D;

    typedef std::vector<AIDA::IHistogram3D*> Histos3D;

    typedef std::vector<AIDA::IProfile1D*>   Profiles1D;

    typedef std::vector<AIDA::IProfile2D*>   Profiles2D;

    // ========================================================================

  public:

    // ========================================================================

    static AIDA::IHistogram1D* plot1D( const GaudiHistoAlg& algo, const double data, const std::string& title,

                                       const double low, const double high, const unsigned long bins = 100 );

    // ========================================================================

    static AIDA::IHistogram1D* plot1D( const GaudiHistoAlg& algo, const double data, const GaudiAlg::HistoID& ID,

                                       const std::string& title, const double low, const double high,

                                       const unsigned long bins = 100 );

    // ========================================================================

    static AIDA::IHistogram1D* plot1D( const GaudiHistoAlg& algo, const double data, const long ID,

                                       const std::string& title, const double low, const double high,

                                       const unsigned long bins = 100 );

    // ========================================================================

    static AIDA::IHistogram1D* plot1D( const GaudiHistoAlg& algo, const double data, const std::string& ID,

                                       const std::string& title, const double low, const double high,

                                       const unsigned long bins = 100 );

    // ========================================================================

    static AIDA::IHistogram1D* plot1D( const GaudiHistoAlg& algo, const GaudiPython::Vector& data,

                                       const std::string& title, const double low, const double high,

                                       const unsigned long bins = 100 );

    // ========================================================================

    static AIDA::IHistogram1D* plot1D( const GaudiHistoAlg& algo, const GaudiPython::Vector& data,

                                       const GaudiAlg::HistoID& ID, const std::string& title, const double low,

                                       const double high, const unsigned long bins = 100 );

    // ========================================================================

    static AIDA::IHistogram1D* plot1D( const GaudiHistoAlg& algo, const GaudiPython::Vector& data, const long ID,

                                       const std::string& title, const double low, const double high,

                                       const unsigned long bins = 100 );

    // ========================================================================

    static AIDA::IHistogram1D* plot1D( const GaudiHistoAlg& algo, const GaudiPython::Vector& data,

                                       const std::string& ID, const std::string& title, const double low,

                                       const double high, const unsigned long bins = 100 );

    // ========================================================================

    static AIDA::IHistogram2D* plot2D( const GaudiHistoAlg& algo, 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 );

    // ========================================================================

    static AIDA::IHistogram2D* plot2D( const GaudiHistoAlg& algo, const double valueX, const double valueY,

                                       const GaudiAlg::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 );

    // ========================================================================

    static AIDA::IHistogram2D* plot2D( const GaudiHistoAlg& algo, const double valueX, const double valueY,

                                       const long 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 );

    // ========================================================================

    static AIDA::IHistogram2D* plot2D( const GaudiHistoAlg& algo, const double valueX, const double valueY,

                                       const std::string& 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 );

    // ========================================================================

    static AIDA::IHistogram3D* plot3D( const GaudiHistoAlg& algo, 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 );

    // ========================================================================

    static AIDA::IHistogram3D* plot3D( const GaudiHistoAlg& algo, const double valueX, const double valueY,

                                       const double valueZ, const GaudiAlg::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 );

    // ========================================================================

    static AIDA::IHistogram3D* plot3D( const GaudiHistoAlg& algo, const double valueX, const double valueY,

                                       const double valueZ, const long 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 );

    // ========================================================================

    static AIDA::IHistogram3D* plot3D( const GaudiHistoAlg& algo, const double valueX, const double valueY,

                                       const double valueZ, const std::string& 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 );

    // ========================================================================

    // 1D-profiles: by title

    // ========================================================================

    static AIDA::IProfile1D* profile1D( const GaudiHistoAlg& algo, 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 );

    // ========================================================================

    // 1D-profiles: by generic ID

    // ========================================================================

    static AIDA::IProfile1D*

    profile1D( const GaudiHistoAlg& algo, const double valueX, const double valueY, const GaudiAlg::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 );

    // ========================================================================

    // 1D-profiles: by numeric ID

    // ========================================================================

    static AIDA::IProfile1D* profile1D( const GaudiHistoAlg& algo, const double valueX, const double valueY,

                                        const long 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 );

    // ========================================================================

    // 1D-profiles: by string ID

    // ========================================================================

    static AIDA::IProfile1D*

    profile1D( const GaudiHistoAlg& algo, const double valueX, const double valueY, const std::string& 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 );

    // ========================================================================

    // 2D-profiles: by title

    // ========================================================================

    static AIDA::IProfile2D* profile2D( const GaudiHistoAlg& algo, 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 );

    // ========================================================================

    // 2D-profiles: by generic ID

    // ========================================================================

    static AIDA::IProfile2D* profile2D( const GaudiHistoAlg& algo, const double valueX, const double valueY,

                                        const double valueZ, const GaudiAlg::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 );

    // ========================================================================

    // 2D-profiles: by numeric ID

    // ========================================================================

    static AIDA::IProfile2D* profile2D( const GaudiHistoAlg& algo, const double valueX, const double valueY,

                                        const double valueZ, const long 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 );

    // ========================================================================

    // 2D-profiles: by string ID

    // ========================================================================

    static AIDA::IProfile2D* profile2D( const GaudiHistoAlg& algo, const double valueX, const double valueY,

                                        const double valueZ, const std::string& 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 );

    // ========================================================================

  public:

    // ========================================================================

    static size_t _histos_a_( const GaudiHistoAlg* cmp, IDs& ids, Histos1D& histos );

    static size_t _histos_t_( const GaudiHistoTool* cmp, IDs& ids, Histos1D& histos );

    static size_t _histos_a_( const IAlgorithm* cmp, IDs& ids, Histos1D& histos );

    static size_t _histos_t_( const IAlgTool* cmp, IDs& ids, Histos1D& histos );

    // ========================================================================

    static size_t _histos_a_( const GaudiHistoAlg* cmp, IDs& ids, Histos2D& histos );

    static size_t _histos_t_( const GaudiHistoTool* cmp, IDs& ids, Histos2D& histos );

    static size_t _histos_a_( const IAlgorithm* cmp, IDs& ids, Histos2D& histos );

    static size_t _histos_t_( const IAlgTool* cmp, IDs& ids, Histos2D& histos );

    // ========================================================================

    static size_t _histos_a_( const GaudiHistoAlg* cmp, IDs& ids, Histos3D& histos );

    static size_t _histos_t_( const GaudiHistoTool* cmp, IDs& ids, Histos3D& histos );

    static size_t _histos_a_( const IAlgorithm* cmp, IDs& ids, Histos3D& histos );

    static size_t _histos_t_( const IAlgTool* cmp, IDs& ids, Histos3D& histos );

    // ========================================================================

    static size_t _histos_a_( const GaudiHistoAlg* cmp, IDs& ids, Profiles1D& histos );

    static size_t _histos_t_( const GaudiHistoTool* cmp, IDs& ids, Profiles1D& histos );

    static size_t _histos_a_( const IAlgorithm* cmp, IDs& ids, Profiles1D& histos );

    static size_t _histos_t_( const IAlgTool* cmp, IDs& ids, Profiles1D& histos );

    // ========================================================================

    static size_t _histos_a_( const GaudiHistoAlg* cmp, IDs& ids, Profiles2D& histos );

    static size_t _histos_t_( const GaudiHistoTool* cmp, IDs& ids, Profiles2D& histos );

    static size_t _histos_a_( const IAlgorithm* cmp, IDs& ids, Profiles2D& histos );

    static size_t _histos_t_( const IAlgTool* cmp, IDs& ids, Profiles2D& histos );

    // ========================================================================

  };

  // ==========================================================================

} // namespace GaudiPython