CbmRoot
Loading...
Searching...
No Matches
CbmStsDigitizeQaReport Class Reference

#include <CbmStsDigitizeQaReport.h>

Inheritance diagram for CbmStsDigitizeQaReport:
[legend]
Collaboration diagram for CbmStsDigitizeQaReport:
[legend]

Public Member Functions

 CbmStsDigitizeQaReport (CbmStsSetup *setup, const CbmStsParSim *settings, const CbmStsParAsic *asicPar)
 
virtual ~CbmStsDigitizeQaReport ()
 
void Create (CbmHistManager *histManager, const std::string &outputDir)
 Main function which creates report data.
 
void Create (const std::string &fileName, const std::string &outputDir)
 Main function which creates report data.
 
TH1 * H1 (const std::string &name) const
 Return pointer to TH1 histogram.
 
TH2 * H2 (const std::string &name) const
 Return pointer to TH2 histogram.
 
TH3 * H3 (const std::string &name) const
 Return pointer to TH3 histogram.
 
CbmHistManagerHM () const
 Return pointer to Histogram manager.
 
void DrawH1ByPattern (const std::string &histNamePattern)
 Select by pattern TH1 histograms and draw each histogram on separate canvas.
 
void DrawH1ByPattern (const std::string &histNamePattern, std::string(*labelFormatter)(const std::string &, const CbmHistManager *))
 Select by pattern TH1 histograms and draw all histograms on the same canvas.
 
void DrawH2ByPattern (const std::string &histNamePattern, HistScale logx=kLinear, HistScale logy=kLinear, HistScale logz=kLinear, const std::string &drawOpt="")
 Select by pattern TH2 histograms and draw each histogram on separate canvas.
 
const CbmReportElementR () const
 Accessor to CbmReportElement object. User has to write the report using available tags from CbmReportElement class.
 
std::ostream & Out () const
 All text output goes to this stream.
 
void SetReportName (const std::string &name)
 
void SetReportTitle (const std::string &title)
 
void SetOutputDir (const std::string &outputDir)
 
const std::string & GetReportName () const
 
const std::string & GetReportTitle () const
 
const std::string & GetOutputDir () const
 

Protected Member Functions

void Draw (Option_t *)
 Inherited from TObject. This method is implemented in order to avoid warnings.
 
void CreateReports ()
 Create all available report types.
 
TCanvas * CreateCanvas (const char *name, const char *title, Int_t ww, Int_t wh)
 Create canvas and put it to vector of TCanvases. Canvases created with this function will be automatically saved to image and printed in the report.
 
void SaveCanvasesAsImages () const
 Save all canvases to images.
 
void WriteCanvases () const
 Write canvases to file.
 
void PrintCanvases () const
 Print images created from canvases in the report.
 

Private Member Functions

virtual void Create ()
 Inherited from CbmReport. Pure abstract function which is called from public Create() function.
 
virtual void Draw ()
 Pure abstract function which is called from public Create() function. This function has to draw all necessary histograms and graphs. It is called only once before report creation.
 
void DrawNofObjectsHistograms ()
 
void DrawLogHistograms ()
 
void DrawHistograms ()
 
void Draw2dHistograms ()
 
void ScaleHistograms ()
 
 CbmStsDigitizeQaReport (const CbmStsDigitizeQaReport &)
 
CbmStsDigitizeQaReportoperator= (const CbmStsDigitizeQaReport &)
 
void CreateReportElement (ReportType reportType)
 Create concrete CbmReportElement instance based on report type.
 
void DeleteReportElement ()
 Delete report element. Normally should be called at the end of Create function.
 

Private Attributes

CbmStsSetupfSetup = nullptr
 
const CbmStsParSimfSettings = nullptr
 
const CbmStsParAsicfAsicPar = nullptr
 
CbmHistManagerfHM
 
std::string fReportName
 
std::string fReportTitle
 
std::string fOutputDir
 
ReportType fReportType
 
CbmReportElementfR
 
std::ostream * fOut
 
std::vector< TCanvas * > fCanvases
 

Detailed Description

Definition at line 15 of file CbmStsDigitizeQaReport.h.

Constructor & Destructor Documentation

◆ CbmStsDigitizeQaReport() [1/2]

CbmStsDigitizeQaReport::CbmStsDigitizeQaReport ( CbmStsSetup * setup,
const CbmStsParSim * settings,
const CbmStsParAsic * asicPar )

Definition at line 33 of file CbmStsDigitizeQaReport.cxx.

References CbmReport::SetReportName().

◆ ~CbmStsDigitizeQaReport()

CbmStsDigitizeQaReport::~CbmStsDigitizeQaReport ( )
virtual

Definition at line 43 of file CbmStsDigitizeQaReport.cxx.

◆ CbmStsDigitizeQaReport() [2/2]

CbmStsDigitizeQaReport::CbmStsDigitizeQaReport ( const CbmStsDigitizeQaReport & )
private

Member Function Documentation

◆ Create() [1/3]

void CbmSimulationReport::Create ( CbmHistManager * histManager,
const std::string & outputDir )
inherited

Main function which creates report data.

Non virtual interface pattern is used here. User always creates simulation report using this public non virtual method. In order to configure concrete report generation class user has to implement protected Create() method.

Parameters
[in]histManagerPointer to histogram manager for which report is created.
[in]outputDirPath to directory for output results.

Referenced by CbmLitClusteringQa::Finish(), CbmLitFitQa::Finish(), CbmLitRadLengthQa::Finish(), CbmLitTofQa::Finish(), CbmLitTrackingQa::Finish(), CbmStsDigitizeQa::Finish(), CbmLitFieldApproximationQa::Init(), and CbmLitFieldQa::Init().

◆ Create() [2/3]

void CbmSimulationReport::Create ( const std::string & fileName,
const std::string & outputDir )
inherited

Main function which creates report data.

Same pattern is used here.

Parameters
[in]fileNameName of the file with histograms.
[in]outputDirPath to directory for output results.

◆ Create() [3/3]

◆ CreateCanvas()

TCanvas * CbmReport::CreateCanvas ( const char * name,
const char * title,
Int_t ww,
Int_t wh )
protectedinherited

Create canvas and put it to vector of TCanvases. Canvases created with this function will be automatically saved to image and printed in the report.

Definition at line 94 of file CbmReport.cxx.

References CbmReport::fCanvases.

Referenced by CbmAnaJpsiReport::Draw(), CbmAnaJpsiSuperEventReport::Draw(), CbmAnaJpsiReport::Draw2DCut(), Draw2dHistograms(), CbmLitTrackingQaReport::DrawAccAndRec(), CbmLitTrackingQaStudyReport::DrawAccAndRec(), CbmAnaJpsiReport::DrawAnalysisStepsH1(), CbmAnaJpsiReport::DrawAnalysisStepsH2(), CbmLitFieldApproximationQaReport::DrawApr(), CbmAnaDielectronStudyReportAll::DrawBgMinv(), CbmAnaJpsiReport::DrawBgSource2D(), CbmAnaJpsiSuperEventReport::DrawComparison(), CbmAnaJpsiReport::DrawCutH1(), CbmLitRadLengthQaReport::DrawDetector(), CbmLitTrackingQaReport::DrawEfficiency(), CbmLitTrackingQaStudyReport::DrawEfficiency(), CbmLitTrackingQaReport::DrawEfficiencyHistos(), CbmLitFieldQaReport::DrawFieldAlongZ(), CbmLitFieldQaReport::DrawFieldRichPmtPlane(), CbmLitFieldQaReport::DrawFieldSlices(), CbmSimulationReport::DrawH2ByPattern(), DrawHistograms(), CbmLitTrackingQaReport::DrawHitsHistos(), DrawLogHistograms(), CbmAnaJpsiSuperEventReport::DrawMinvDiffPtBins(), CbmAnaJpsiReport::DrawMinvMismatchesAll(), CbmAnaJpsiSuperEventReport::DrawMinvMismatchPt(), CbmAnaJpsiReport::DrawMinvSAndBgAllSteps(), CbmAnaJpsiSuperEventReport::DrawMinvSignalBg(), CbmAnaJpsiReport::DrawMomEffAllSteps(), CbmAnaJpsiReport::DrawMomMcVsRec(), CbmLitClusteringQaReport::DrawNofObjectsHistograms(), DrawNofObjectsHistograms(), CbmAnaJpsiReport::DrawPairSource(), CbmAnaJpsiSuperEventReport::DrawPairSource(), CbmLitTrackingQaReport::DrawPionSuppression(), CbmAnaJpsiReport::DrawPtYEfficiencyAll(), CbmLitFitQaReport::DrawResidualAndPullHistograms(), CbmLitClusteringQaReport::DrawResidualsAndPulls(), CbmAnaJpsiReport::DrawSignalMinv(), CbmLitFieldApproximationQaReport::DrawSlices(), CbmLitFitQaReport::DrawTrackMomentumAtVertex(), CbmLitFitQaReport::DrawTrackParams(), CbmLitFitQaReport::DrawTrackParamsAtVertex(), CbmLitFitQaStudyReport::DrawTrackParamsAtVertex(), CbmLitTrackingQaReport::DrawYPt(), CbmLitTofQaReport::FitHistograms(), CbmAnaJpsiReport::SignalOverBgAllSteps(), and CbmAnaJpsiSuperEventReport::SignalOverBgAllSteps().

◆ CreateReportElement()

void CbmReport::CreateReportElement ( ReportType reportType)
privateinherited

Create concrete CbmReportElement instance based on report type.

Parameters
[in]reportTypeType of the report to be produced.

Definition at line 42 of file CbmReport.cxx.

References CbmReport::fOut, CbmReport::fR, CbmReport::fReportName, CbmReport::fReportType, CbmReport::GetOutputDir(), kCoutReport, kHtmlReport, kLatexReport, and kTextReport.

Referenced by CbmReport::CreateReports().

◆ CreateReports()

void CbmReport::CreateReports ( )
protectedinherited

◆ DeleteReportElement()

void CbmReport::DeleteReportElement ( )
privateinherited

Delete report element. Normally should be called at the end of Create function.

Definition at line 65 of file CbmReport.cxx.

Referenced by CbmReport::CreateReports().

◆ Draw() [1/2]

void CbmReport::Draw ( Option_t * )
inlineprotectedinherited

Inherited from TObject. This method is implemented in order to avoid warnings.

Definition at line 97 of file CbmReport.h.

◆ Draw() [2/2]

void CbmStsDigitizeQaReport::Draw ( )
privatevirtual

Pure abstract function which is called from public Create() function. This function has to draw all necessary histograms and graphs. It is called only once before report creation.

Implements CbmReport.

Definition at line 86 of file CbmStsDigitizeQaReport.cxx.

References Draw2dHistograms(), CbmSimulationReport::DrawH1ByPattern(), DrawHistograms(), DrawLogHistograms(), DrawNofObjectsHistograms(), and ScaleHistograms().

◆ Draw2dHistograms()

void CbmStsDigitizeQaReport::Draw2dHistograms ( )
private

◆ DrawH1ByPattern() [1/2]

void CbmSimulationReport::DrawH1ByPattern ( const std::string & histNamePattern)
inherited

Select by pattern TH1 histograms and draw each histogram on separate canvas.

Parameters
[in]histNamePatternName pattern for histogram.

Referenced by CbmLitClusteringQaReport::Draw(), CbmLitTofQaReport::Draw(), Draw(), and CbmLitRadLengthQaReport::DrawDetectorStation().

◆ DrawH1ByPattern() [2/2]

void CbmSimulationReport::DrawH1ByPattern ( const std::string & histNamePattern,
std::string(* labelFormatter )(const std::string &, const CbmHistManager *) )
inherited

Select by pattern TH1 histograms and draw all histograms on the same canvas.

Parameters
[in]histNamePatternName pattern for histogram.

◆ DrawH2ByPattern()

void CbmSimulationReport::DrawH2ByPattern ( const std::string & histNamePattern,
HistScale logx = kLinear,
HistScale logy = kLinear,
HistScale logz = kLinear,
const std::string & drawOpt = "" )
inherited

Select by pattern TH2 histograms and draw each histogram on separate canvas.

Parameters
[in]histNamePatternName pattern for histogram.
[in]logxSpecify logarithmic or linear scale for X axis.
[in]logySpecify logarithmic or linear scale for Y axis.
[in]logzSpecify logarithmic or linear scale for Z axis.
[in]drawOptOther drawing options (see ROOT documentation for details).

Definition at line 97 of file CbmSimulationReport.cxx.

References CbmReport::CreateCanvas(), DrawH2(), CbmReport::GetReportName(), CbmHistManager::H2Vector(), and CbmSimulationReport::HM().

Referenced by CbmLitClusteringQaReport::Draw(), CbmLitTofQaReport::Draw(), CbmLitRadLengthQaReport::DrawDetectorStation(), and CbmLitClusteringQaReport::DrawResidualsAndPulls().

◆ DrawHistograms()

void CbmStsDigitizeQaReport::DrawHistograms ( )
private

◆ DrawLogHistograms()

void CbmStsDigitizeQaReport::DrawLogHistograms ( )
private

◆ DrawNofObjectsHistograms()

void CbmStsDigitizeQaReport::DrawNofObjectsHistograms ( )
private

◆ GetOutputDir()

const std::string & CbmReport::GetOutputDir ( ) const
inlineinherited

◆ GetReportName()

◆ GetReportTitle()

const std::string & CbmReport::GetReportTitle ( ) const
inlineinherited

Definition at line 75 of file CbmReport.h.

References CbmReport::fReportTitle.

◆ H1()

◆ H2()

TH2 * CbmSimulationReport::H2 ( const std::string & name) const
inlineinherited

◆ H3()

TH3 * CbmSimulationReport::H3 ( const std::string & name) const
inlineinherited

Return pointer to TH3 histogram.

Parameters
[in]nameName of histogram.
Returns
pointer to TH3 histogram.

Definition at line 91 of file CbmSimulationReport.h.

References CbmHistManager::H3(), and CbmSimulationReport::HM().

◆ HM()

CbmHistManager * CbmSimulationReport::HM ( ) const
inlineinherited

Return pointer to Histogram manager.

Definition at line 96 of file CbmSimulationReport.h.

References CbmSimulationReport::fHM.

Referenced by CbmLitClusteringQaReport::CalculateEfficiencyHistos(), CbmLitTrackingQaReport::CalculateEfficiencyHistos(), CbmLitTrackingQaReport::CalculatePionSuppressionHistos(), CbmLitClusteringQaReport::Create(), CbmLitTrackingQaReport::Create(), Create(), CbmAnaJpsiReport::Draw(), CbmLitTofQaReport::Draw(), Draw2dHistograms(), CbmLitTrackingQaReport::DrawAccAndRec(), CbmLitFieldApproximationQaReport::DrawApr(), CbmLitRadLengthQaReport::DrawDetector(), CbmLitTrackingQaReport::DrawEfficiency(), CbmLitTrackingQaReport::DrawEfficiencyHistos(), CbmLitFieldQaReport::DrawFieldAlongZ(), CbmLitFieldQaReport::DrawFieldRichPmtPlane(), CbmLitFieldQaReport::DrawFieldSlices(), CbmSimulationReport::DrawH2ByPattern(), DrawHistograms(), CbmLitTrackingQaReport::DrawHitsHistos(), CbmLitTrackingQaReport::DrawHitsHistos(), DrawLogHistograms(), CbmLitClusteringQaReport::DrawNofObjectsHistograms(), DrawNofObjectsHistograms(), CbmLitTrackingQaReport::DrawPionSuppression(), CbmLitFitQaReport::DrawResidualAndPullHistograms(), CbmLitClusteringQaReport::DrawResidualsAndPulls(), CbmLitFieldApproximationQaReport::DrawSlices(), CbmLitFitQaReport::DrawTrackMomentumAtVertex(), CbmLitFitQaReport::DrawTrackParams(), CbmLitFitQaReport::DrawTrackParamsAtVertex(), CbmLitTrackingQaReport::DrawYPt(), CbmLitTrackingQaReport::FillGlobalTrackVariants(), CbmLitTofQaReport::FitHistograms(), CbmSimulationReport::H1(), CbmSimulationReport::H2(), CbmSimulationReport::H3(), CbmLitTrackingQaReport::PrintNofGhosts(), CbmLitClusteringQaReport::PrintNofObjects(), CbmLitTrackingQaReport::PrintNofObjects(), CbmLitTrackingQaReport::PrintPionSuppression(), CbmLitFitQaReport::PrintResAndPullRow(), CbmLitTrackingQaReport::PrintTrackHits(), CbmLitTrackingQaReport::PrintTrackingEfficiency(), CbmLitClusteringQaReport::ScaleAndShrinkHistograms(), ScaleHistograms(), and CbmAnaJpsiReport::SignalOverBgAllSteps().

◆ operator=()

CbmStsDigitizeQaReport & CbmStsDigitizeQaReport::operator= ( const CbmStsDigitizeQaReport & )
private

◆ Out()

◆ PrintCanvases()

◆ R()

◆ SaveCanvasesAsImages()

void CbmReport::SaveCanvasesAsImages ( ) const
protectedinherited

Save all canvases to images.

Definition at line 101 of file CbmReport.cxx.

References CbmReport::fCanvases, CbmReport::GetOutputDir(), and Cbm::SaveCanvasAsImage().

Referenced by CbmReport::CreateReports().

◆ ScaleHistograms()

void CbmStsDigitizeQaReport::ScaleHistograms ( )
private

◆ SetOutputDir()

void CbmReport::SetOutputDir ( const std::string & outputDir)
inlineinherited

Definition at line 71 of file CbmReport.h.

References CbmReport::fOutputDir.

◆ SetReportName()

◆ SetReportTitle()

void CbmReport::SetReportTitle ( const std::string & title)
inlineinherited

◆ WriteCanvases()

void CbmReport::WriteCanvases ( ) const
protectedinherited

Write canvases to file.

Definition at line 112 of file CbmReport.cxx.

References CbmReport::fCanvases, and CbmReport::GetOutputDir().

Member Data Documentation

◆ fAsicPar

const CbmStsParAsic* CbmStsDigitizeQaReport::fAsicPar = nullptr
private

Definition at line 24 of file CbmStsDigitizeQaReport.h.

Referenced by Create().

◆ fCanvases

std::vector<TCanvas*> CbmReport::fCanvases
privateinherited

◆ fHM

CbmHistManager* CbmSimulationReport::fHM
privateinherited

Definition at line 123 of file CbmSimulationReport.h.

Referenced by CbmSimulationReport::HM().

◆ fOut

std::ostream* CbmReport::fOut
mutableprivateinherited

Definition at line 144 of file CbmReport.h.

Referenced by CbmReport::CreateReportElement(), and CbmReport::Out().

◆ fOutputDir

std::string CbmReport::fOutputDir
privateinherited

Definition at line 141 of file CbmReport.h.

Referenced by CbmReport::GetOutputDir(), and CbmReport::SetOutputDir().

◆ fR

CbmReportElement* CbmReport::fR
privateinherited

Definition at line 143 of file CbmReport.h.

Referenced by CbmReport::CreateReportElement(), and CbmReport::R().

◆ fReportName

std::string CbmReport::fReportName
privateinherited

◆ fReportTitle

std::string CbmReport::fReportTitle
privateinherited

Definition at line 140 of file CbmReport.h.

Referenced by CbmReport::GetReportTitle(), and CbmReport::SetReportTitle().

◆ fReportType

ReportType CbmReport::fReportType
privateinherited

Definition at line 142 of file CbmReport.h.

Referenced by CbmReport::CreateReportElement().

◆ fSettings

const CbmStsParSim* CbmStsDigitizeQaReport::fSettings = nullptr
private

Definition at line 23 of file CbmStsDigitizeQaReport.h.

Referenced by Create().

◆ fSetup

CbmStsSetup* CbmStsDigitizeQaReport::fSetup = nullptr
private

Definition at line 22 of file CbmStsDigitizeQaReport.h.

Referenced by Draw2dHistograms().


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