InDetPlotBase Class Reference

Mixin class to give extra capabilities to plots such as ATH_MSG and an easier booking interface, as well as access to the HistogramDefinitionSvc which allows an external configuration file (txt or xml) to define the plot limits and titles. More...

#include <InDetPlotBase.h>

Inherits PlotBase, and AthMessaging.

Inherited by InDetBasicPlot, InDetPerfNtuple, InDetPerfPlot_Duplicate, InDetPerfPlot_Efficiency, InDetPerfPlot_FakeRate, InDetPerfPlot_HitEfficiency, InDetPerfPlot_HitResidual, InDetPerfPlot_Hits, InDetPerfPlot_Resolution, InDetPerfPlot_TRTExtension, InDetPerfPlot_TrackParameters, InDetPerfPlot_TrkInJet, InDetPerfPlot_Vertex, InDetPerfPlot_VertexTruthMatching, InDetPerfPlot_VerticesVsMu, InDetPerfPlot_nTracks, and InDetRttPlots.

Collaboration diagram for InDetPlotBase:

Public Member Functions
	InDetPlotBase (InDetPlotBase *pParent, const std::string &dirName)
	Constructor taking parent node and directory name for plots.
SingleHistogramDefinition	retrieveDefinition (const std::string &histoIdentifier, const std::string &folder="default", const std::string &nameOverride="")
	Retrieve a single histogram definition, given the unique string identifier.
template<class Htype>
void	book (Htype *&pHisto, const std::string &histoIdentifier, const std::string &nameOverride="", const std::string &folder="default")
	Helper method to book histograms using an identifier string.
void	book (TH1 *&pHisto, const SingleHistogramDefinition &hd)
	Book a TH1 histogram.
void	book (TProfile *&pHisto, const SingleHistogramDefinition &hd)
	Book a TProfile histogram.
void	book (TProfile2D *&pHisto, const SingleHistogramDefinition &hd)
	Book a TProfile2D histogram.
void	book (TH2 *&pHisto, const SingleHistogramDefinition &hd)
	Book a 2D histogram (TH2)
void	book (TEfficiency *&pHisto, const SingleHistogramDefinition &hd)
	Book a (1-D) TEfficiency.
void	initialize ()
void	finalize ()
void	setDetailLevel (int iDetailLevel)
void	RegisterSubPlot (PlotBase *pPlotBase)
std::vector< HistData >	retrieveBookedHistograms ()
	Retrieve all booked histograms.
std::vector< TreeData >	retrieveBookedTrees ()
	Retrieve all booked trees.
std::vector< EfficiencyData >	retrieveBookedEfficiencies ()
	Retrieve all booked efficiency objects.
TTree *	BookTree (const std::string &name, bool prependDir=true)
	Book a TTree.
const std::string &	getDirectory ()
bool	msgLvl (const MSG::Level lvl) const
	Test the output level.
MsgStream &	msg () const
	The standard message stream.
MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream.
void	setLevel (MSG::Level lvl)
	Change the current logging level.
Methods to book monitoring histograms
Note: methods starting with capitals should be deprecated in favour of camel-cased methods
TH1D *	Book1D (const std::string &name, const std::string &labels, int nBins, float start, float end, bool prependDir=true)
	Book a TH1D histogram.
TH1D *	Book1D (const std::string &name, TH1 *refHist, const std::string &labels, bool prependDir=true)
	Book a TH1D histogram using refHist as reference for number of bins and axis range.
TH2F *	Book2D (const std::string &name, const std::string &labels, int nBinsX, float startX, float endX, int nBinsY, float startY, float endY, bool prependDir=true)
	Book a TH2F histogram.
TH2F *	Book2D (const std::string &name, TH2 *refHist, const std::string &labels, bool prependDir=true)
	Book a TH2D histogram using refHist as reference for number of bins and axis range.
TH2F *	Book2D (const std::string &name, const std::string &labels, int nBinsX, Double_t *binsX, int nBinsY, Double_t startY, Double_t endY, bool prependDir=true)
	Book a TH2F histogram with variable x axis binning.
TH3F *	Book3D (const std::string &name, const std::string &labels, int nBinsX, float startX, float endX, int nBinsY, float startY, float endY, int nBinsZ, float startZ, float endZ, bool prependDir=true)
	Book a TH3F histogram.
TH3F *	Book3D (const std::string &name, TH3 *refHist, const std::string &labels, bool prependDir=true)
	Book a TH3F histogram using refHist as reference for number of bins and axis range.
TProfile *	BookTProfile (const std::string &name, const std::string &labels, int nBinsX, float startX, float endX, float startY=-1, float endY=-1, bool prependDir=true, bool useRMS=false)
	Book a TProfile histogram.
TProfile *	BookTProfile (const std::string &name, const std::string &labels, int nBinsX, float *binsX, bool prependDir=true)
	Book a TProfile histogram with variable binning in x-axis.
TProfile *	BookTProfileRangeY (const std::string &name, const std::string &labels, int nBinsX, double *binsX, double startY, double endY, bool prependDir=true)
	Book a TProfile histogram with variable binning in x-axis and limits in y-values.
TProfile2D *	BookTProfile2D (const std::string &name, const std::string &labels, const int nBinsX, const double xlo, const double xhi, const int nBinsY, const double ylo, const double yhi, bool prependDir=true, bool useRMS=false)
	Book a TProfile 2D histogram with variable binning in x-axis and limits in y-values.
TProfile2D *	BookTProfile2D (const std::string &name, const std::string &labels, const int nBinsX, double *binsX, const int nBinsY, double *binsY, bool prependDir=true, bool useRMS=false)
	Book a TProfile 2D histogram with variable binning in x-axis and limits in y-values.
TEfficiency *	BookTEfficiency (const std::string &name, const std::string &labels, const int nBinsX, const float xlo, const float xhi, const bool prependDir=true)
	Book a (1-D) TEfficiency histogram.
TEfficiency *	BookTEfficiency (const std::string &name, const std::string &labels, const int nBinsX, const float xlo, const float xhi, const int nBinsy, const float ylo, const float yhi, const bool prependDir=true)
	Book a (2-D) TEfficiency histogram.

Static Public Member Functions
static void	fillHisto (TProfile *pTprofile, const float bin, const float weight, const float weight2=1.0)
static void	fillHisto (TProfile2D *pTprofile, const float xval, const float yval, const float weight, const float weight2=1.0)
static void	fillHisto (TH1 *pTh1, const float value)
static void	fillHisto (TH1 *pTh1, const float value, const float weight)
static void	fillHisto (TH2 *pTh2, const float xval, const float yval)
static void	fillHisto (TH2 *pTh2, const float xval, const float yval, const float weight)
static void	fillHisto (TH3 *pTh3, const float xval, const float yval, const float zval)
static void	fillHisto (TEfficiency *pTeff, const float value, const bool accepted, float weight)
static void	fillHisto (TEfficiency *eff2d, const float xvalue, const float yvalue, const bool accepted, const float weight)

Protected Member Functions
template<class T>
void	mBook (T &pHisto, const std::string &histoIdentifier)
	book, for use by macro

Protected Attributes
std::vector< PlotBase * >	m_vSubNodes
std::vector< HistData >	m_vBookedHistograms
std::vector< TreeData >	m_vBookedTrees
std::vector< EfficiencyData >	m_vBookedEfficiencies
std::string	m_sDirectory
int	m_iDetailLevel

Private Member Functions
virtual void	initializePlots ()
virtual void	finalizePlots ()
void	initMessaging () const
	Initialize our message level and MessageSvc.

Static Private Member Functions
static std::string	constructPrefix (std::string dir, bool prependDir)

Private Attributes
ServiceHandle< IHistogramDefinitionSvc >	m_histoDefSvc
std::string	m_nm
	Message source name.
boost::thread_specific_ptr< MsgStream >	m_msg_tls
	MsgStream instance (a std::cout like with print-out levels)
std::atomic< IMessageSvc * >	m_imsg { nullptr }
	MessageSvc pointer.
std::atomic< MSG::Level >	m_lvl { MSG::NIL }
	Current logging level.
std::atomic_flag m_initialized	ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
	Messaging initialized (initMessaging)

Detailed Description

Mixin class to give extra capabilities to plots such as ATH_MSG and an easier booking interface, as well as access to the HistogramDefinitionSvc which allows an external configuration file (txt or xml) to define the plot limits and titles.

Definition at line 33 of file InDetPlotBase.h.

Constructor & Destructor Documentation

InDetPlotBase()

InDetPlotBase::InDetPlotBase	(	InDetPlotBase *	pParent,
		const std::string &	dirName )

Constructor taking parent node and directory name for plots.

Definition at line 35 of file InDetPlotBase.cxx.

                                                                             :
  PlotBase(pParent, dirName),
  AthMessaging("InDetPlotBase"),
  m_histoDefSvc("HistogramDefinitionSvc", "InDetPlotBase")
{
}

Member Function Documentation

book() [1/6]

template<class Htype>

void InDetPlotBase::book	(	Htype *&	pHisto,
		const std::string &	histoIdentifier,
		const std::string &	nameOverride = "",
		const std::string &	folder = "default" )

Helper method to book histograms using an identifier string.

Parameters

pHisto	Pointer to the histogram to be booked (assumed to be initialized to nullptr)
histoIdentifier	Identifier (looked up in the XML file)
nameOverride	Allows to override the histo name w.r.t the identifier. Leave empty for no override. This can be used to instantiate multiple, identically binned plots from a single entry in the XML.
folder	Folder to place the plot (if any)

book() [2/6]

void InDetPlotBase::book	(	TEfficiency *&	pHisto,
		const SingleHistogramDefinition &	hd )

Book a (1-D) TEfficiency.

Definition at line 71 of file InDetPlotBase.cxx.

                                                                             {
  if (hd.isValid()) {
    if(hd.nBinsY==0) {
      pHisto = BookTEfficiency(hd.name, hd.allTitles, hd.nBinsX, hd.xAxis.first, hd.xAxis.second, false);
    } else {
      pHisto = BookTEfficiency(hd.name, hd.allTitles, hd.nBinsX, hd.xAxis.first, hd.xAxis.second, hd.nBinsY, hd.yAxis.first, hd.yAxis.second, false);
    }
  }
  }

book() [3/6]

void InDetPlotBase::book	(	TH1 *&	pHisto,
		const SingleHistogramDefinition &	hd )

Book a TH1 histogram.

Definition at line 43 of file InDetPlotBase.cxx.

                                                                     {
  if (hd.isValid()) {
    pHisto = Book1D(hd.name, hd.allTitles, hd.nBinsX, hd.xAxis.first, hd.xAxis.second, false);
  }
  }

book() [4/6]

void InDetPlotBase::book	(	TH2 *&	pHisto,
		const SingleHistogramDefinition &	hd )

Book a 2D histogram (TH2)

Definition at line 63 of file InDetPlotBase.cxx.

                                                                     {
  if (hd.isValid()) {
    pHisto = Book2D(hd.name, hd.allTitles, hd.nBinsX, hd.xAxis.first, hd.xAxis.second, hd.nBinsY, hd.yAxis.first,
                    hd.yAxis.second, false);
  }
  }

book() [5/6]

void InDetPlotBase::book	(	TProfile *&	pHisto,
		const SingleHistogramDefinition &	hd )

Book a TProfile histogram.

Definition at line 49 of file InDetPlotBase.cxx.

                                                                          {
  if (hd.isValid()) {
    pHisto = BookTProfile(hd.name, hd.allTitles, hd.nBinsX, hd.xAxis.first, hd.xAxis.second, hd.yAxis.first,
                          hd.yAxis.second, false);
  }
  }

book() [6/6]

void InDetPlotBase::book	(	TProfile2D *&	pHisto,
		const SingleHistogramDefinition &	hd )

Book a TProfile2D histogram.

Definition at line 56 of file InDetPlotBase.cxx.

                                                                            {
  if (hd.isValid()) {
    pHisto = BookTProfile2D(hd.name, hd.allTitles, hd.nBinsX, hd.xAxis.first, hd.xAxis.second, hd.nBinsY, hd.yAxis.first,
                          hd.yAxis.second, false);
  }
  }

Book1D() [1/2]

TH1D * PlotBase::Book1D ( const std::string & name, const std::string & labels, int nBins, float start, float end, bool prependDir = true )

inherited

Book a TH1D histogram.

Definition at line 94 of file PlotBase.cxx.

                                  {
  std::string prefix = constructPrefix(m_sDirectory, prependDir);
  Bool_t oldstat = TH1::AddDirectoryStatus();
  TH1::AddDirectory(false);
  TH1D *hist = new TH1D((prefix + name).c_str(), labels.c_str(), nBins, start, end);
  TH1::AddDirectory(oldstat);
 
  hist->Sumw2();
  m_vBookedHistograms.emplace_back(hist, m_sDirectory);
  return hist;
}

Book1D() [2/2]

TH1D * PlotBase::Book1D ( const std::string & name, TH1 * refHist, const std::string & labels, bool prependDir = true )

inherited

Book a TH1D histogram using refHist as reference for number of bins and axis range.

Definition at line 108 of file PlotBase.cxx.

                                                                                              {
  std::string prefix = constructPrefix(m_sDirectory, prependDir);
  Bool_t oldstat = TH1::AddDirectoryStatus();
  TH1::AddDirectory(false);
  TH1D *hist = new TH1D((prefix + name).c_str(), labels.c_str(), refHist->GetNbinsX(),
                        refHist->GetXaxis()->GetXbins()->GetArray());
  hist->Sumw2();
  TH1::AddDirectory(oldstat);
 
 
  m_vBookedHistograms.emplace_back(hist, m_sDirectory);
  return hist;
}

Book2D() [1/3]

TH2F * PlotBase::Book2D ( const std::string & name, const std::string & labels, int nBinsX, Double_t * binsX, int nBinsY, Double_t startY, Double_t endY, bool prependDir = true )

inherited

Book a TH2F histogram with variable x axis binning.

Definition at line 144 of file PlotBase.cxx.

                                                                  {
  std::string prefix = constructPrefix(m_sDirectory, prependDir);
  Bool_t oldstat = TH2::AddDirectoryStatus();
  TH2::AddDirectory(false);
  TH2F *hist = new TH2F((prefix + name).c_str(), labels.c_str(), nBinsX, binsX, nBinsY, startY, endY);
  hist->Sumw2();
  TH2::AddDirectory(oldstat);
  m_vBookedHistograms.emplace_back(hist, m_sDirectory);
  return hist;
}

Book2D() [2/3]

TH2F * PlotBase::Book2D ( const std::string & name, const std::string & labels, int nBinsX, float startX, float endX, int nBinsY, float startY, float endY, bool prependDir = true )

inherited

Book a TH2F histogram.

Definition at line 123 of file PlotBase.cxx.

                                                            {
  std::string prefix = constructPrefix(m_sDirectory, prependDir);
  Bool_t oldstat = TH2::AddDirectoryStatus();
  TH2::AddDirectory(false);
  TH2F *hist = new TH2F((prefix + name).c_str(), labels.c_str(), nBinsX, startX, endX, nBinsY, startY, endY);
  hist->Sumw2();
  TH2::AddDirectory(oldstat);
 
 
  m_vBookedHistograms.emplace_back(hist, m_sDirectory);
  return hist;
}

Book2D() [3/3]

TH2F * PlotBase::Book2D ( const std::string & name, TH2 * refHist, const std::string & labels, bool prependDir = true )

inherited

Book a TH2D histogram using refHist as reference for number of bins and axis range.

Definition at line 138 of file PlotBase.cxx.

                                                                                              {
  return Book2D(name, labels, refHist->GetNbinsX(), refHist->GetXaxis()->GetXmin(), refHist->GetXaxis()->GetXmax(),
                refHist->GetNbinsY(), refHist->GetYaxis()->GetXmin(), refHist->GetYaxis()->GetXmax(), prependDir);
}

Book3D() [1/2]

TH3F * PlotBase::Book3D ( const std::string & name, const std::string & labels, int nBinsX, float startX, float endX, int nBinsY, float startY, float endY, int nBinsZ, float startZ, float endZ, bool prependDir = true )

inherited

Book a TH3F histogram.

Definition at line 157 of file PlotBase.cxx.

                                                                                                  {
  std::string prefix = constructPrefix(m_sDirectory, prependDir);
  Bool_t oldstat = TH3::AddDirectoryStatus();
  TH3::AddDirectory(false);
  TH3F *hist = new TH3F((prefix + name).c_str(),
                        labels.c_str(), nBinsX, startX, endX, nBinsY, startY, endY, nBinsZ, startZ, endZ);
  hist->Sumw2();
  TH3::AddDirectory(oldstat);
  m_vBookedHistograms.emplace_back(hist, m_sDirectory);
  return hist;
}

Book3D() [2/2]

TH3F * PlotBase::Book3D ( const std::string & name, TH3 * refHist, const std::string & labels, bool prependDir = true )

inherited

Book a TH3F histogram using refHist as reference for number of bins and axis range.

Definition at line 171 of file PlotBase.cxx.

                                                                                              {
  std::string prefix = constructPrefix(m_sDirectory, prependDir);
  Bool_t oldstat = TH3::AddDirectoryStatus();
  TH3::AddDirectory(false);
  TH3F *hist = new TH3F((prefix + name).c_str(), labels.c_str(), refHist->GetNbinsX(),
                        refHist->GetXaxis()->GetXbins()->GetArray(), refHist->GetNbinsY(),
                        refHist->GetYaxis()->GetXbins()->GetArray(), refHist->GetNbinsZ(),
                        refHist->GetZaxis()->GetXbins()->GetArray());
  TH3::AddDirectory(oldstat);
 
  m_vBookedHistograms.emplace_back(hist, m_sDirectory);
  return hist;
}

BookTEfficiency() [1/2]

TEfficiency * PlotBase::BookTEfficiency ( const std::string & name, const std::string & labels, const int nBinsX, const float xlo, const float xhi, const bool prependDir = true )

inherited

Book a (1-D) TEfficiency histogram.

Definition at line 257 of file PlotBase.cxx.

                                                                                                                                                   {
  std::string prefix = constructPrefix(m_sDirectory, prependDir);
  //Bool_t oldstat = TEfficiency::AddDirectoryStatus();
  TEfficiency *hist = new TEfficiency((prefix + name).c_str(), labels.c_str(), nBinsX, xlo, xhi);
  //hist->SetAutoSave(0);
  //hist->SetAtoFlush(0);
  hist->SetDirectory(nullptr);
  m_vBookedEfficiencies.emplace_back(hist, m_sDirectory);
  //TEfficiency::AddDirectory(oldstat);
  return hist;
}

BookTEfficiency() [2/2]

TEfficiency * PlotBase::BookTEfficiency ( const std::string & name, const std::string & labels, const int nBinsX, const float xlo, const float xhi, const int nBinsy, const float ylo, const float yhi, const bool prependDir = true )

inherited

Book a (2-D) TEfficiency histogram.

Definition at line 270 of file PlotBase.cxx.

                                                                                                                                                                                                       {
  std::string prefix = constructPrefix(m_sDirectory, prependDir);
 
  TEfficiency *hist = new TEfficiency((prefix + name).c_str(), labels.c_str(), nBinsX, xlo, xhi, nBinsY, ylo, yhi);
  hist->SetDirectory(nullptr);
  m_vBookedEfficiencies.emplace_back(hist, m_sDirectory);
 
  return hist;
}

BookTProfile() [1/2]

TProfile * PlotBase::BookTProfile ( const std::string & name, const std::string & labels, int nBinsX, float * binsX, bool prependDir = true )

inherited

Book a TProfile histogram with variable binning in x-axis.

Definition at line 204 of file PlotBase.cxx.

                                                                                                                {
  std::string prefix = constructPrefix(m_sDirectory, prependDir);
  TProfile *hist(nullptr);
  Bool_t oldstat = TProfile::AddDirectoryStatus();
  TProfile::AddDirectory(false);
 
  hist = new TProfile((prefix + name).c_str(), labels.c_str(), nBinsX, binsX);
  TProfile::AddDirectory(oldstat);
  m_vBookedHistograms.emplace_back(hist, m_sDirectory);
  return hist;
}

BookTProfile() [2/2]

TProfile * PlotBase::BookTProfile ( const std::string & name, const std::string & labels, int nBinsX, float startX, float endX, float startY = -1, float endY = -1, bool prependDir = true, bool useRMS = false )

inherited

Book a TProfile histogram.

Definition at line 186 of file PlotBase.cxx.

                                                                               {
  std::string prefix = constructPrefix(m_sDirectory, prependDir);
  TProfile *hist(nullptr);
  Bool_t oldstat = TProfile::AddDirectoryStatus();
  TProfile::AddDirectory(false);
  std::string opt = useRMS ? "S" : "";
  if ((startY == -1) and (endY == -1)) {
    hist = new TProfile((prefix + name).c_str(), labels.c_str(), nBinsX, startX, endX, opt.c_str());
  } else {
    hist = new TProfile((prefix + name).c_str(), labels.c_str(), nBinsX, startX, endX, startY, endY, opt.c_str());
  }
  TProfile::AddDirectory(oldstat);
  m_vBookedHistograms.emplace_back(hist, m_sDirectory);
  return hist;
}

BookTProfile2D() [1/2]

TProfile2D * PlotBase::BookTProfile2D ( const std::string & name, const std::string & labels, const int nBinsX, const double xlo, const double xhi, const int nBinsY, const double ylo, const double yhi, bool prependDir = true, bool useRMS = false )

inherited

Book a TProfile 2D histogram with variable binning in x-axis and limits in y-values.

Definition at line 231 of file PlotBase.cxx.

                                                       {
  std::string prefix = constructPrefix(m_sDirectory, prependDir);
  Bool_t oldstat = TProfile2D::AddDirectoryStatus();
  TProfile2D::AddDirectory(false);
  std::string opt = useRMS ? "S" : "";
  TProfile2D *hist = new TProfile2D((prefix + name).c_str(), labels.c_str(), nBinsX, xlo, xhi, nBinsY, ylo, yhi, opt.c_str());
  TProfile2D::AddDirectory(oldstat);
  m_vBookedHistograms.emplace_back(hist, m_sDirectory);
  return hist;
}

BookTProfile2D() [2/2]

TProfile2D * PlotBase::BookTProfile2D ( const std::string & name, const std::string & labels, const int nBinsX, double * binsX, const int nBinsY, double * binsY, bool prependDir = true, bool useRMS = false )

inherited

Book a TProfile 2D histogram with variable binning in x-axis and limits in y-values.

Definition at line 245 of file PlotBase.cxx.

                                                                                                                                                                       {
  std::string prefix = constructPrefix(m_sDirectory, prependDir);
  Bool_t oldstat = TProfile2D::AddDirectoryStatus();
  TProfile2D::AddDirectory(false);
  std::string opt = useRMS ? "S" : "";
  TProfile2D *hist = new TProfile2D((prefix + name).c_str(), labels.c_str(), nBinsX, binsX, nBinsY, binsY, opt.c_str());
  TProfile2D::AddDirectory(oldstat);
  m_vBookedHistograms.emplace_back(hist, m_sDirectory);
  return hist;
}

BookTProfileRangeY()

TProfile * PlotBase::BookTProfileRangeY ( const std::string & name, const std::string & labels, int nBinsX, double * binsX, double startY, double endY, bool prependDir = true )

inherited

Book a TProfile histogram with variable binning in x-axis and limits in y-values.

Definition at line 217 of file PlotBase.cxx.

                                                                          {
  std::string prefix = constructPrefix(m_sDirectory, prependDir);
  TProfile *hist(nullptr);
  Bool_t oldstat = TProfile::AddDirectoryStatus();
  TProfile::AddDirectory(false);
 
  hist = new TProfile((prefix + name).c_str(), labels.c_str(), (Int_t) nBinsX, binsX, startY, endY);
  TProfile::AddDirectory(oldstat);
  m_vBookedHistograms.emplace_back(hist, m_sDirectory);
  return hist;
}

BookTree()

TTree * PlotBase::BookTree ( const std::string & name, bool prependDir = true )

inherited

Book a TTree.

Definition at line 281 of file PlotBase.cxx.

                                                         {
  std::string prefix = constructPrefix(m_sDirectory, prependDir);
  TTree *tree = new TTree((prefix + name).c_str(), "");
 
  tree->SetAutoSave(0);
  tree->SetAutoFlush(0);
  tree->SetDirectory(nullptr);
  m_vBookedTrees.emplace_back(tree, m_sDirectory);
  return tree;
}

constructPrefix()

std::string PlotBase::constructPrefix ( std::string dir, bool prependDir )

staticprivateinherited

Definition at line 293 of file PlotBase.cxx.

                                                        {
  if (!prependDir) {
    return "";
  }
  std::replace(dir.begin(), dir.end(), '/', '_');
  return dir;
}

fillHisto() [1/9]

void InDetPlotBase::fillHisto ( TEfficiency * eff2d, const float xvalue, const float yvalue, const bool accepted, const float weight )

static

Definition at line 142 of file InDetPlotBase.cxx.

                                                                                                                            {
  if (eff2d and validArguments(xvalue, yvalue)) {
    if(weight==1.) eff2d->Fill(accepted, xvalue, yvalue);
    else eff2d->FillWeighted(accepted, weight, xvalue, yvalue);
  }
}

fillHisto() [2/9]

void InDetPlotBase::fillHisto ( TEfficiency * pTeff, const float value, const bool accepted, float weight )

static

Definition at line 134 of file InDetPlotBase.cxx.

                                                                                                  {
  if (pTeff and validArguments(value)) {
    if(weight==1.) pTeff->Fill(accepted, value); // To get proper error estimate when possible
    else pTeff->FillWeighted(accepted, weight, value);
  }
}

fillHisto() [3/9]

void InDetPlotBase::fillHisto ( TH1 * pTh1, const float value )

static

Definition at line 97 of file InDetPlotBase.cxx.

                                                     {
  if (pTh1 and validArguments(value)) {
    pTh1->Fill(value);
  }
}

fillHisto() [4/9]

void InDetPlotBase::fillHisto ( TH1 * pTh1, const float value, const float weight )

static

Definition at line 104 of file InDetPlotBase.cxx.

                                                                         {
  if (pTh1 and validArguments(value)) {
    pTh1->Fill(value, weight);
  }
}

fillHisto() [5/9]

void InDetPlotBase::fillHisto ( TH2 * pTh2, const float xval, const float yval )

static

Definition at line 112 of file InDetPlotBase.cxx.

                                                                      {
  if (pTh2 and validArguments(xval, yval)) {
    pTh2->Fill(xval, yval);
  }
}

fillHisto() [6/9]

void InDetPlotBase::fillHisto ( TH2 * pTh2, const float xval, const float yval, const float weight )

static

Definition at line 120 of file InDetPlotBase.cxx.

                                                                                          {
  if (pTh2 and validArguments(xval, yval)) {
    pTh2->Fill(xval, yval, weight);
  }
}

fillHisto() [7/9]

void InDetPlotBase::fillHisto ( TH3 * pTh3, const float xval, const float yval, const float zval )

static

Definition at line 127 of file InDetPlotBase.cxx.

                                                                                        {
  if (pTh3 and validArguments(xval, yval, zval)) {
    pTh3->Fill(xval, yval, zval);
  }
}

fillHisto() [8/9]

void InDetPlotBase::fillHisto ( TProfile * pTprofile, const float bin, const float weight, const float weight2 = 1.0 )

static

Definition at line 82 of file InDetPlotBase.cxx.

                                                                                                      {
  if (pTprofile and validArguments(bin, weight)) {
    pTprofile->Fill(bin, weight,weight2);
  }
}

fillHisto() [9/9]

void InDetPlotBase::fillHisto ( TProfile2D * pTprofile, const float xval, const float yval, const float weight, const float weight2 = 1.0 )

static

Definition at line 89 of file InDetPlotBase.cxx.

                                                                                                                           {
  if (pTprofile and validArguments(xval,yval, weight) and validArguments(weight2)) {
    pTprofile->Fill(xval,yval, weight,weight2);
  }
}

finalize()

void PlotBase::finalize ( )

inherited

Definition at line 47 of file PlotBase.cxx.

                   {
  for (auto *subNode: m_vSubNodes) {
    subNode->finalize();
  }
  finalizePlots();
}

finalizePlots()

virtual void PlotBase::finalizePlots ( )

inlineprivatevirtualinherited

Reimplemented in IDTPM::DuplicateRatePlots, IDTPM::EfficiencyPlots, IDTPM::FakeRatePlots, IDTPM::HitsOnTracksPlots, IDTPM::NtracksPlots, IDTPM::OfflineElectronPlots, IDTPM::ResolutionPlots, IDTPM::SummaryPlots, IDTPM::TrackParametersPlots, IDTPM::VertexParametersPlots, InDetBasicPlot, InDetPerfPlot_Duplicate, InDetPerfPlot_Efficiency, InDetPerfPlot_FakeRate, InDetPerfPlot_Resolution, InDetPerfPlot_TrackParameters, InDetPerfPlot_TRTExtension, InDetPerfPlot_VertexTruthMatching, JetTagDQA::BTaggingValidationPlots, TCCPlots, Trk::EfficiencyPlots, ZeeValidation::ReconElectronsPlots, ZeeValidation::TrueElectronsPlots, and ZeeValidation::TrueFwdElectronsPlots.

Definition at line 92 of file PlotBase.h.

{;}

getDirectory()

const std::string & PlotBase::getDirectory ( )

inlineinherited

Definition at line 88 of file PlotBase.h.

{return m_sDirectory;}

initialize()

void PlotBase::initialize ( )

inherited

Definition at line 39 of file PlotBase.cxx.

                     {
  for (auto *subNode: m_vSubNodes) {
    subNode->initialize();
  }
  initializePlots();
}

initializePlots()

virtual void PlotBase::initializePlots ( )

inlineprivatevirtualinherited

Reimplemented in DiTau::CorePlots, DiTau::ResolutionPlots, Egamma::ClusMomentumPlots, Egamma::ElectronFrwdPlots, Egamma::ElectronPlots, Egamma::IsolationPlots, Egamma::KinematicsPlots, Egamma::LRTElectronPlots, Egamma::PhotonAmbPlots, Egamma::PhotonCnvPlots, Egamma::PhotonConversionPlots, Egamma::PhotonPlots, Egamma::ShowerShapesPlots, Egamma::TrackPlots, ElectronValidationPlots, IDTPM::DuplicateRatePlots, IDTPM::EfficiencyPlots, IDTPM::FakeRatePlots, IDTPM::HitsOnTracksPlots, IDTPM::NtracksPlots, IDTPM::OfflineElectronPlots, IDTPM::ResolutionPlots, IDTPM::SummaryPlots, IDTPM::TrackParametersPlots, IDTPM::VertexParametersPlots, InDetBasicPlot, InDetPerfNtuple, InDetPerfPlot_Duplicate, InDetPerfPlot_Efficiency, InDetPerfPlot_FakeRate, InDetPerfPlot_HitEfficiency, InDetPerfPlot_HitResidual, InDetPerfPlot_Hits, InDetPerfPlot_nTracks, InDetPerfPlot_Resolution, InDetPerfPlot_TrackParameters, InDetPerfPlot_TrkInJet, InDetPerfPlot_TRTExtension, InDetPerfPlot_Vertex, InDetPerfPlot_VertexTruthMatching, InDetPerfPlot_VerticesVsMu, JetTagDQA::BTaggingValidationPlots, LRTElectronValidationPlots, Muon::BetaPlots, Muon::ChargeDepParamPlots, Muon::HitFracTypePlots, Muon::IsoCorrPlots, Muon::IsoPlots, Muon::MomentumPullPlots, Muon::MomentumTruthPullPlots, Muon::MuonParamElossPlots, Muon::MuonParamPlots, Muon::MuonTree, Muon::RecoInfoPlots, Muon::SlowMuonParamPlots, PFO::ClusterMomentPlots, PFO::ClusterPlots, PFO::FlowElement_LinkerPlots, PFO::LeptonFELinkerPlots, PFO::PFOAlgPropertyPlots, PFO::PFOAttributePlots, PFO::PFOCalibHitClusterMomentPlots, PFO::PFOClusterMomentPlots, PFO::PFOPlots, PFO::PFOPVMatchedPlots, PhotonValidationPlots, PhysVal::BTagPlots, PhysVal::EventInfoPlots, PhysVal::KinematicsPlots, PhysVal::METPlots, PhysVal::TrkAndVtxPlots, RecoLumiPlots, RecoMuonIDTrackPlots, RecoMuonPlots, RecoMuonSegmentPlots, RecoMuonTrackPlots, RecoPhysPlots, RecoVertexPlots, Tau::CorePlots, Tau::DecayModeMigration, Tau::EfficiencyPlots, Tau::EVetoPlots, Tau::GeneralTauPlots, Tau::ResolutionPlots, Tau::TauIDVariablesPlots, Tau::TauKinematicPlots, Tau::TauParticleFlowPlots, TCCPlots, Trk::DefParamPullPlots, Trk::EfficiencyPlots, Trk::ExtrLayerPlots, Trk::ExtrRegionPlots, Trk::HitResidualPlots, Trk::HitTypePlots, Trk::IDHitPlots, Trk::ImpactPlots, Trk::ParamPlots, Trk::RecoInfoPlots, Trk::ResolutionPlots, Trk::TruthInfoPlots, ZeeValidation::FWDZeePlots, ZeeValidation::ReconElectronsPlots, ZeeValidation::TrueElectronsPlots, ZeeValidation::TrueFwdElectronsPlots, and ZeeValidation::ZeePlots.

Definition at line 91 of file PlotBase.h.

{;}

initMessaging()

void AthMessaging::initMessaging ( ) const

privateinherited

Initialize our message level and MessageSvc.

This method should only be called once.

Definition at line 39 of file AthMessaging.cxx.

{
  m_imsg = Athena::getMessageSvc();
  // If user did not set an explicit level, set a default
  if (m_lvl == MSG::NIL) {
    m_lvl = m_imsg ?
      static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
      MSG::INFO;
  }
}

mBook()

template<class T>

void InDetPlotBase::mBook ( T & pHisto, const std::string & histoIdentifier )

inlineprotected

book, for use by macro

Definition at line 83 of file InDetPlotBase.h.

                                                     {
    return book(pHisto, histoIdentifier.substr(2));
  }

msg() [1/2]

MsgStream & AthMessaging::msg ( ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 163 of file AthMessaging.h.

{
  MsgStream* ms = m_msg_tls.get();
  if (!ms) {
    if (!m_initialized.test_and_set()) initMessaging();
    ms = new MsgStream(m_imsg,m_nm);
    m_msg_tls.reset( ms );
  }
 
  ms->setLevel (m_lvl);
  return *ms;
}

msg() [2/2]

MsgStream & AthMessaging::msg ( const MSG::Level lvl ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 178 of file AthMessaging.h.

{ return msg() << lvl; }

msgLvl()

bool AthMessaging::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Test the output level.

Parameters

lvl	The message level to test against

Returns

boolean Indicating if messages at given level will be printed

Return values

true	Messages at level "lvl" will be printed

Definition at line 151 of file AthMessaging.h.

{
  if (m_lvl <= lvl) {
    msg() << lvl;
    return true;
  } else {
    return false;
  }
}

RegisterSubPlot()

void PlotBase::RegisterSubPlot ( PlotBase * pPlotBase )

inlineinherited

Definition at line 41 of file PlotBase.h.

{m_vSubNodes.push_back(pPlotBase);}

retrieveBookedEfficiencies()

std::vector< EfficiencyData > PlotBase::retrieveBookedEfficiencies ( )

inherited

Retrieve all booked efficiency objects.

Definition at line 83 of file PlotBase.cxx.

                                     {
  std::vector<EfficiencyData> vBookedEfficiencies = m_vBookedEfficiencies;
  for (const auto &subNode: m_vSubNodes) {
    std::vector<EfficiencyData> subNodeHists = subNode->retrieveBookedEfficiencies();
    vBookedEfficiencies.insert(vBookedEfficiencies.end(), subNodeHists.begin(), subNodeHists.end());
  }
  return vBookedEfficiencies;
}

retrieveBookedHistograms()

std::vector< HistData > PlotBase::retrieveBookedHistograms ( )

inherited

Retrieve all booked histograms.

Definition at line 63 of file PlotBase.cxx.

                                   {
  std::vector<HistData> vBookedHistograms = m_vBookedHistograms;
  for (const auto &subNode: m_vSubNodes) {
    std::vector<HistData> subNodeHists = subNode->retrieveBookedHistograms();
    vBookedHistograms.insert(vBookedHistograms.end(), subNodeHists.begin(), subNodeHists.end());
  }
  return vBookedHistograms;
}

retrieveBookedTrees()

std::vector< TreeData > PlotBase::retrieveBookedTrees ( )

inherited

Retrieve all booked trees.

Definition at line 73 of file PlotBase.cxx.

                              {
  std::vector<TreeData> vBookedTrees = m_vBookedTrees;
  for (auto *subNode: m_vSubNodes) {
    std::vector<TreeData> subNodeTrees = subNode->retrieveBookedTrees();
    vBookedTrees.insert(vBookedTrees.end(), subNodeTrees.begin(), subNodeTrees.end());
  }
  return vBookedTrees;
}

retrieveDefinition()

SingleHistogramDefinition InDetPlotBase::retrieveDefinition	(	const std::string &	histoIdentifier,
		const std::string &	folder = "default",
		const std::string &	nameOverride = "" )

Retrieve a single histogram definition, given the unique string identifier.

Definition at line 151 of file InDetPlotBase.cxx.

                                                                                                                           {
 
  ATH_CHECK( m_histoDefSvc.retrieve(), {} );
 
  bool folderDefault = (folder.empty() or folder == "default");
  SingleHistogramDefinition s = m_histoDefSvc->definition(histoIdentifier, folder);
  // "default" and empty string should be equivalent
  if (folderDefault and s.empty()) {
    const std::string otherDefault = (folder.empty()) ? ("default") : "";
    s = m_histoDefSvc->definition(histoIdentifier, otherDefault);
  }
  if (s.empty()) {
    ATH_MSG_WARNING("Histogram definition is empty for identifier " << histoIdentifier);
  }
  if (!nameOverride.empty()){
    s.name = nameOverride; 
  }
  return s;
}

setDetailLevel()

void PlotBase::setDetailLevel ( int iDetailLevel )

inherited

Definition at line 55 of file PlotBase.cxx.

                                         {
  for (auto *subNode: m_vSubNodes) {
    subNode->setDetailLevel(iDetailLevel);
  }
  m_iDetailLevel = iDetailLevel;
}

setLevel()

void AthMessaging::setLevel ( MSG::Level lvl )

inherited

Change the current logging level.

Use this rather than msg().setLevel() for proper operation with MT.

Definition at line 28 of file AthMessaging.cxx.

{
  m_lvl = lvl;
}

Member Data Documentation

ATLAS_THREAD_SAFE

std::atomic_flag m_initialized AthMessaging::ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT

mutableprivateinherited

Messaging initialized (initMessaging)

Definition at line 141 of file AthMessaging.h.

m_histoDefSvc

ServiceHandle<IHistogramDefinitionSvc> InDetPlotBase::m_histoDefSvc

private

Definition at line 88 of file InDetPlotBase.h.

m_iDetailLevel

int PlotBase::m_iDetailLevel

protectedinherited

Definition at line 101 of file PlotBase.h.

m_imsg

std::atomic<IMessageSvc*> AthMessaging::m_imsg { nullptr }

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

{ nullptr };

m_lvl

std::atomic<MSG::Level> AthMessaging::m_lvl { MSG::NIL }

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

{ MSG::NIL };

m_msg_tls

boost::thread_specific_ptr<MsgStream> AthMessaging::m_msg_tls

mutableprivateinherited

MsgStream instance (a std::cout like with print-out levels)

Definition at line 132 of file AthMessaging.h.

m_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

m_sDirectory

std::string PlotBase::m_sDirectory

protectedinherited

Definition at line 100 of file PlotBase.h.

m_vBookedEfficiencies

std::vector<EfficiencyData> PlotBase::m_vBookedEfficiencies

protectedinherited

Definition at line 99 of file PlotBase.h.

m_vBookedHistograms

std::vector<HistData> PlotBase::m_vBookedHistograms

protectedinherited

Definition at line 97 of file PlotBase.h.

m_vBookedTrees

std::vector<TreeData> PlotBase::m_vBookedTrees

protectedinherited

Definition at line 98 of file PlotBase.h.

m_vSubNodes

std::vector<PlotBase*> PlotBase::m_vSubNodes

protectedinherited

Definition at line 96 of file PlotBase.h.

---

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

• InDetPlotBase.h
• InDetPlotBase.cxx