ATLAS Offline Software
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
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 (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...
 
 HistHandler_TH2 (const HistHandler_TH2 &other)
 
virtual HistHandler_TH2operator= (const HistHandler_TH2 &other)
 
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 (const xAOD::Muon &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)
 

Protected Member Functions

void Copy (const HistHandler &other)
 

Private Attributes

std::unique_ptr< AxisHandlerm_x_handler
 
std::unique_ptr< AxisHandlerm_y_handler
 
std::unique_ptr< TH1 > m_H
 

Detailed Description

Definition at line 108 of file HistHandler.h.

Constructor & Destructor Documentation

◆ HistHandler_TH2() [1/2]

CP::HistHandler_TH2::HistHandler_TH2 ( 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 200 of file HistHandler.cxx.

200  :
201  HistHandler(h),
202  m_x_handler(h == nullptr ? 0 : AxisHandlerProvider::GetAxisHandler(h->GetXaxis())),
203  m_y_handler(h == nullptr ? 0 : AxisHandlerProvider::GetAxisHandler(h->GetYaxis())) {
204 
205  }

◆ HistHandler_TH2() [2/2]

CP::HistHandler_TH2::HistHandler_TH2 ( const HistHandler_TH2 other)

Definition at line 243 of file HistHandler.cxx.

243  :
245  m_x_handler(other.GetHist() == nullptr ? 0 : AxisHandlerProvider::GetAxisHandler(other.GetHist()->GetXaxis())),
246  m_y_handler(other.GetHist() == nullptr ? 0 : AxisHandlerProvider::GetAxisHandler(other.GetHist()->GetYaxis())) {
247  }

◆ ~HistHandler_TH2()

CP::HistHandler_TH2::~HistHandler_TH2 ( )
virtual

Definition at line 241 of file HistHandler.cxx.

241  {
242  }

Member Function Documentation

◆ Copy()

void HistHandler::Copy ( const HistHandler other)
protectedinherited

Definition at line 126 of file HistHandler.cxx.

126  {
127  if (this == &other) {
128  return;
129  }
130  if (other.m_H) {
131  m_H = clone(other.GetHist());
132  }
133  }

◆ FindBin()

CorrectionCode CP::HistHandler_TH2::FindBin ( const xAOD::Muon muon,
int &  bin 
) const
overridevirtual

Function that changes from Implementation to implementation.

Implements CP::HistHandler.

Definition at line 215 of file HistHandler.cxx.

215  {
216  if (!GetHist()) return CorrectionCode::Error;
217  float parx = 0;
218  float pary = 0;
219  if (m_x_handler->GetBinningParameter(muon, parx) == CorrectionCode::Error ||
220  m_y_handler->GetBinningParameter(muon, pary) == CorrectionCode::Error) {
221  return CorrectionCode::Error;
222  } else {
223  int binx = GetHist()->GetXaxis()->FindBin(parx);
224  int biny = GetHist()->GetYaxis()->FindBin(pary);
225  if (binx < 1 || binx > GetHist()->GetNbinsX() || biny < 1 || biny > GetHist()->GetNbinsY()) {
227  }
228  bin = GetHist()->GetBin(binx, biny);
229  }
230  return CorrectionCode::Ok;
231  }

◆ GetBinContent()

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

Definition at line 46 of file HistHandler.h.

46  {
47  if (!m_H) return DBL_MAX;
48  return m_H->GetBinContent(bin);
49  }

◆ GetBinError()

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

Definition at line 53 of file HistHandler.h.

53  {
54  if (!m_H) return DBL_MAX;
55  return m_H->GetBinError(bin);
56  }

◆ 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 248 of file HistHandler.cxx.

248  {
249  int x(0), y(0), z(0);
250  GetHist()->GetBinXYZ(bin, x, y, z);
251  TAxis* xAx = GetHist()->GetXaxis();
252  TAxis* yAx = GetHist()->GetYaxis();
253  return Form("%s_%.2f_to_%.2f_times_%s_%.2f_to_%.2f",
254  //xAxis
255  xAx->GetTitle(), xAx->GetBinLowEdge(x), xAx->GetBinUpEdge(x),
256  //yAxis
257  yAx->GetTitle(), yAx->GetBinLowEdge(y), yAx->GetBinUpEdge(y));
258  }

◆ GetHist()

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

Definition at line 58 of file HistHandler.h.

58  {
59  return m_H.get();
60  }

◆ isOverFlowBin()

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

States whether a bin is overflow or not.

Implements CP::HistHandler.

Definition at line 210 of file HistHandler.cxx.

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

◆ 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 206 of file HistHandler.cxx.

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

◆ nOverFlowBins()

int CP::HistHandler_TH2::nOverFlowBins ( ) const
overridevirtual

Return the number of overflow bins.

Implements CP::HistHandler.

Definition at line 209 of file HistHandler.cxx.

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

◆ operator=()

HistHandler_TH2 & CP::HistHandler_TH2::operator= ( const HistHandler_TH2 other)
virtual

Definition at line 232 of file HistHandler.cxx.

232  {
233  if (this == &other) {
234  return *this;
235  }
236  Copy(other);
237  m_x_handler = std::unique_ptr<AxisHandler>(GetHist() == nullptr ? 0 : AxisHandlerProvider::GetAxisHandler(GetHist()->GetXaxis()));
238  m_y_handler = std::unique_ptr<AxisHandler>(GetHist() == nullptr ? 0 : AxisHandlerProvider::GetAxisHandler(GetHist()->GetYaxis()));
239  return *this;
240  }

◆ SetBinContent()

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

Definition at line 140 of file HistHandler.cxx.

140  {
141  if (m_H) {
142  m_H->SetBinContent(bin, val);
143  }
144  }

◆ SetBinError()

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

Definition at line 145 of file HistHandler.cxx.

145  {
146  if (m_H) {
147  m_H->SetBinError(bin, val);
148  }
149  }

Member Data Documentation

◆ m_H

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

Definition at line 81 of file HistHandler.h.

◆ m_x_handler

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

Definition at line 129 of file HistHandler.h.

◆ m_y_handler

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

Definition at line 130 of file HistHandler.h.


The documentation for this class was generated from the following files:
xAOD::muon
@ muon
Definition: TrackingPrimitives.h:195
CP::HistHandler::Copy
void Copy(const HistHandler &other)
Definition: HistHandler.cxx:126
bin
Definition: BinsDiffFromStripMedian.h:43
x
#define x
CP::HistHandler::HistHandler
HistHandler(TH1 *Hist)
Definition: HistHandler.cxx:122
CP::clone
std::unique_ptr< TH1 > clone(TH1 *H)
Clones a TH1 and handles the ownership then to a unique_ptr.
Definition: PhysicsAnalysis/MuonID/MuonIDAnalysis/MuonEfficiencyCorrections/Root/UtilFunctions.cxx:43
CP::CorrectionCode::OutOfValidityRange
@ OutOfValidityRange
Input object is out of validity range.
Definition: CorrectionCode.h:37
CP::CorrectionCode::Error
@ Error
Some error happened during the object correction.
Definition: CorrectionCode.h:36
CP::HistHandler::GetHist
TH1 * GetHist() const
Definition: HistHandler.h:58
z
#define z
CP::HistHandler_TH2::m_x_handler
std::unique_ptr< AxisHandler > m_x_handler
Definition: HistHandler.h:129
plotBeamSpotMon.b
b
Definition: plotBeamSpotMon.py:77
CP::CorrectionCode::Ok
@ Ok
The correction was done successfully.
Definition: CorrectionCode.h:38
InDetDD::other
@ other
Definition: InDetDD_Defs.h:16
y
#define y
h
Pythia8_RapidityOrderMPI.val
val
Definition: Pythia8_RapidityOrderMPI.py:14
CP::AxisHandlerProvider::GetAxisHandler
static std::unique_ptr< AxisHandler > GetAxisHandler(const TAxis *axis)
Definition: HistHandler.cxx:20
CP::HistHandler_TH2::m_y_handler
std::unique_ptr< AxisHandler > m_y_handler
Definition: HistHandler.h:130
CP::HistHandler::m_H
std::unique_ptr< TH1 > m_H
Definition: HistHandler.h:81