CP::HistHandler_TH2 Class Reference

#include <HistHandler.h>

Inheritance diagram for CP::HistHandler_TH2:

Collaboration diagram for CP::HistHandler_TH2:

Public Member Functions
	HistHandler_TH2 (columnar::ColumnarTool<> *parent, TH1 *hist)
	The HistHandler TH2 handles 2D histograms which are not TH2Poly, since TH2 inhertis from TH1, a TH1* object is parsed avoiding the dynamic cast. More...
virtual	~HistHandler_TH2 ()
int	nBins () const override
	Return the total number of bins in the histogram -> (GetNbins() +2)**n. More...
int	nOverFlowBins () const override
	Return the number of overflow bins. More...
bool	isOverFlowBin (int b) const override
	States whether a bin is overflow or not. More...
std::string	GetBinName (unsigned int bin) const override
	Translates the bin number into the borders and return them as name. More...
CorrectionCode	FindBin (columnar::MuonId muon, int &bin) const override
	Function that changes from Implementation to implementation. More...
double	GetBinContent (int bin) const
void	SetBinContent (int bin, float val)
double	GetBinError (int bin) const
TH1 *	GetHist () const
void	SetBinError (int bin, float val)

Private Attributes
std::unique_ptr< AxisHandler >	m_x_handler
std::unique_ptr< AxisHandler >	m_y_handler
std::unique_ptr< TH1 >	m_H

Detailed Description

Definition at line 112 of file HistHandler.h.

Constructor & Destructor Documentation

HistHandler_TH2()

CP::HistHandler_TH2::HistHandler_TH2	(	columnar::ColumnarTool<> *	parent,
		TH1 *	hist
	)

The HistHandler TH2 handles 2D histograms which are not TH2Poly, since TH2 inhertis from TH1, a TH1* object is parsed avoiding the dynamic cast.

Via the GetDimension() method of the TH1 the class ensures that the histogram has actual dimension 2. No specific TH2 method is required in all considered usecases of TH1.

Definition at line 187 of file HistHandler.cxx.

                                                                            :
                HistHandler(parent, h),
                m_x_handler(h == nullptr ? 0 : AxisHandlerProvider::GetAxisHandler(parent, h->GetXaxis())),
                m_y_handler(h == nullptr ? 0 : AxisHandlerProvider::GetAxisHandler(parent, h->GetYaxis())) {
 
    }

~HistHandler_TH2()

CP::HistHandler_TH2::~HistHandler_TH2 ( )

virtual

Definition at line 219 of file HistHandler.cxx.

                                      {
    }

Member Function Documentation

FindBin()

CorrectionCode CP::HistHandler_TH2::FindBin ( columnar::MuonId  muon, int &  bin  ) const

overridevirtual

Function that changes from Implementation to implementation.

Implements CP::HistHandler.

Definition at line 202 of file HistHandler.cxx.

                                                                                {
        if (!GetHist()) return CorrectionCode::Error;
        float parx = 0;
        float pary = 0;
        if (m_x_handler->GetBinningParameter(muon, parx) == CorrectionCode::Error || 
            m_y_handler->GetBinningParameter(muon, pary) == CorrectionCode::Error) {
            return CorrectionCode::Error;
        } else {
            int binx = GetHist()->GetXaxis()->FindBin(parx);
            int biny = GetHist()->GetYaxis()->FindBin(pary);
            if (binx < 1 || binx > GetHist()->GetNbinsX() || biny < 1 || biny > GetHist()->GetNbinsY()) {
                return CorrectionCode::OutOfValidityRange;
            }
            bin = GetHist()->GetBin(binx, biny);
        }
        return CorrectionCode::Ok;
    }

GetBinContent()

double CP::HistHandler::GetBinContent ( int  bin ) const

inlineinherited

Definition at line 51 of file HistHandler.h.

                                                       {
                if (!m_H) return DBL_MAX;
                return m_H->GetBinContent(bin);
            }

GetBinError()

double CP::HistHandler::GetBinError ( int  bin ) const

inlineinherited

Definition at line 58 of file HistHandler.h.

                                                     {
                if (!m_H) return DBL_MAX;
                return m_H->GetBinError(bin);
            }

GetBinName()

std::string CP::HistHandler_TH2::GetBinName ( unsigned int  bin ) const

overridevirtual

Translates the bin number into the borders and return them as name.

Implements CP::HistHandler.

Definition at line 221 of file HistHandler.cxx.

                                                                {
        int x(0), y(0), z(0);
        GetHist()->GetBinXYZ(bin, x, y, z);
        TAxis* xAx = GetHist()->GetXaxis();
        TAxis* yAx = GetHist()->GetYaxis();
        return Form("%s_%.2f_to_%.2f_times_%s_%.2f_to_%.2f",
                //xAxis
                xAx->GetTitle(), xAx->GetBinLowEdge(x), xAx->GetBinUpEdge(x),
                //yAxis
                yAx->GetTitle(), yAx->GetBinLowEdge(y), yAx->GetBinUpEdge(y));
    }

GetHist()

TH1* CP::HistHandler::GetHist ( ) const

inlineinherited

Definition at line 63 of file HistHandler.h.

                                       {
                return m_H.get();
            }

isOverFlowBin()

bool CP::HistHandler_TH2::isOverFlowBin ( int  b ) const

overridevirtual

States whether a bin is overflow or not.

Implements CP::HistHandler.

Definition at line 197 of file HistHandler.cxx.

                                                   { 
        int x(-1),y(-1), z(-1);
        GetHist()->GetBinXYZ(b,x,y,z);
        return  x == 0 ||  x == GetHist()->GetXaxis()->GetNbins() + 1 ||  y == 0 ||  y == GetHist()->GetYaxis()->GetNbins() + 1; 
    }

nBins()

int CP::HistHandler_TH2::nBins ( ) const

overridevirtual

Return the total number of bins in the histogram -> (GetNbins() +2)**n.

Implements CP::HistHandler.

Definition at line 193 of file HistHandler.cxx.

                                     {
        return (GetHist()->GetNbinsX() + 2) * (GetHist()->GetNbinsY() + 2);
    }

nOverFlowBins()

int CP::HistHandler_TH2::nOverFlowBins ( ) const

overridevirtual

Return the number of overflow bins.

Implements CP::HistHandler.

Definition at line 196 of file HistHandler.cxx.

{return 2*GetHist()->GetNbinsX() +  2*GetHist()->GetNbinsY() + 4; }

SetBinContent()

void HistHandler::SetBinContent ( int  bin, float  val  )

inherited

Definition at line 140 of file HistHandler.cxx.

                                                      {
        if (m_H) {
            m_H->SetBinContent(bin, val);
        }
    }    

SetBinError()

void HistHandler::SetBinError ( int  bin, float  val  )

inherited

Definition at line 145 of file HistHandler.cxx.

                                                    {
        if (m_H) {
            m_H->SetBinError(bin, val);
        }
    }

Member Data Documentation

m_H

std::unique_ptr<TH1> CP::HistHandler::m_H

privateinherited

Definition at line 86 of file HistHandler.h.

m_x_handler

std::unique_ptr<AxisHandler> CP::HistHandler_TH2::m_x_handler

private

Definition at line 132 of file HistHandler.h.

m_y_handler

std::unique_ptr<AxisHandler> CP::HistHandler_TH2::m_y_handler

private

Definition at line 133 of file HistHandler.h.

---

The documentation for this class was generated from the following files:

• HistHandler.h
• HistHandler.cxx