CbmRoot
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
CbmRichGeoTestStudyReport Class Reference

Creates study report for RICH geometry testing. More...

#include <CbmRichGeoTestStudyReport.h>

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

Public Member Functions

 CbmRichGeoTestStudyReport ()
 Constructor.
 
virtual ~CbmRichGeoTestStudyReport ()
 Destructor.
 
void Create (const std::vector< CbmHistManager * > &histManagers, const std::vector< std::string > &studyNames, const std::string &outputDir)
 Main function which creates report data.
 
void Create (const std::vector< std::string > &fileNames, const std::vector< std::string > &studyNames, const std::string &outputDir)
 Main function which creates report data.
 
const std::vector< CbmHistManager * > & HM () const
 
CbmHistManager * HM (Int_t index) const
 
const std::vector< std::string > & GetStudyNames () const
 
const std::string & GetStudyName (Int_t index) const
 
const CbmReportElement * R () 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 Create ()
 Inherited from CbmLitStudyReport.
 
void Draw ()
 Inherited from CbmLitStudyReport.
 
virtual string PrintRow (const string &property, const string &name)
 Print one row in a table.
 
virtual string PrintValue (int studyId, const string &valueTitle)
 
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

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

std::vector< CbmHistManager * > fHM
 
std::vector< std::string > fStudyNames
 
std::string fReportName
 
std::string fReportTitle
 
std::string fOutputDir
 
ReportType fReportType
 
CbmReportElement * fR
 
std::ostream * fOut
 
std::vector< TCanvas * > fCanvases
 

Detailed Description

Creates study report for RICH geometry testing.

Generates report from a number of results of different simulations and reconstructions. Creates comparison tables. Very useful for studies since all numbers are automatically put in the comparison tables.

Author
Semen Lebedev s.leb.nosp@m.edev.nosp@m.@gsi..nosp@m.de
Date
2012

Definition at line 33 of file CbmRichGeoTestStudyReport.h.

Constructor & Destructor Documentation

◆ CbmRichGeoTestStudyReport()

CbmRichGeoTestStudyReport::CbmRichGeoTestStudyReport ( )

Constructor.

Definition at line 22 of file CbmRichGeoTestStudyReport.cxx.

References CbmReport::SetReportName().

◆ ~CbmRichGeoTestStudyReport()

CbmRichGeoTestStudyReport::~CbmRichGeoTestStudyReport ( )
virtual

Destructor.

Definition at line 24 of file CbmRichGeoTestStudyReport.cxx.

Member Function Documentation

◆ Create() [1/3]

void CbmRichGeoTestStudyReport::Create ( )
protectedvirtual

Inherited from CbmLitStudyReport.

Implements CbmStudyReport.

Definition at line 26 of file CbmRichGeoTestStudyReport.cxx.

References CbmReportElement::DocumentBegin(), CbmReportElement::DocumentEnd(), CbmStudyReport::GetStudyNames(), CbmReport::Out(), PrintRow(), CbmReport::R(), CbmReportElement::TableBegin(), CbmReportElement::TableEnd(), and CbmReportElement::Title().

◆ Create() [2/3]

void CbmStudyReport::Create ( const std::vector< CbmHistManager * > & histManagers,
const std::vector< std::string > & studyNames,
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 and getters for the file names.

Parameters
[in]histManagersArray of histogram managers for which report is created.
[in]studyNamesNames of studies.
[in]outputDirname of the output directory.

Referenced by CbmAnaDielectronReports::CreateStudyReport().

◆ Create() [3/3]

void CbmStudyReport::Create ( const std::vector< std::string > & fileNames,
const std::vector< std::string > & studyNames,
const std::string & outputDir )
inherited

Main function which creates report data.

Same pattern is used here.

Parameters
[in]fileNamesArray of file names for which report is created.
[in]studyNamesNames of studies.
[in]outputDirname of the output directory.

◆ 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(), CbmStsDigitizeQaReport::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(), CbmStsDigitizeQaReport::DrawHistograms(), CbmLitTrackingQaReport::DrawHitsHistos(), CbmStsDigitizeQaReport::DrawLogHistograms(), CbmAnaJpsiSuperEventReport::DrawMinvDiffPtBins(), CbmAnaJpsiReport::DrawMinvMismatchesAll(), CbmAnaJpsiSuperEventReport::DrawMinvMismatchPt(), CbmAnaJpsiReport::DrawMinvSAndBgAllSteps(), CbmAnaJpsiSuperEventReport::DrawMinvSignalBg(), CbmAnaJpsiReport::DrawMomEffAllSteps(), CbmAnaJpsiReport::DrawMomMcVsRec(), CbmLitClusteringQaReport::DrawNofObjectsHistograms(), CbmStsDigitizeQaReport::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

Create all available report types.

Definition at line 71 of file CbmReport.cxx.

References CbmReport::Create(), CbmReport::CreateReportElement(), CbmReport::DeleteReportElement(), CbmReport::Draw(), kCoutReport, kHtmlReport, kLatexReport, kTextReport, and CbmReport::SaveCanvasesAsImages().

◆ 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 CbmRichGeoTestStudyReport::Draw ( )
inlineprotectedvirtual

Inherited from CbmLitStudyReport.

Implements CbmReport.

Definition at line 54 of file CbmRichGeoTestStudyReport.h.

◆ GetOutputDir()

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

Definition at line 76 of file CbmReport.h.

References CbmReport::fOutputDir.

Referenced by CbmReport::CreateReportElement(), CbmReport::SaveCanvasesAsImages(), and CbmReport::WriteCanvases().

◆ GetReportName()

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

Definition at line 74 of file CbmReport.h.

References CbmReport::fReportName.

Referenced by CbmStsDigitizeQaReport::Draw2dHistograms(), CbmLitFieldApproximationQaReport::DrawApr(), CbmLitFieldQaReport::DrawFieldAlongZ(), CbmLitFieldQaReport::DrawFieldRichPmtPlane(), CbmLitFieldQaReport::DrawFieldSlices(), CbmSimulationReport::DrawH2ByPattern(), CbmStsDigitizeQaReport::DrawHistograms(), CbmStsDigitizeQaReport::DrawLogHistograms(), CbmLitClusteringQaReport::DrawNofObjectsHistograms(), CbmStsDigitizeQaReport::DrawNofObjectsHistograms(), CbmLitClusteringQaReport::DrawResidualsAndPulls(), and CbmLitFieldApproximationQaReport::DrawSlices().

◆ GetReportTitle()

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

Definition at line 75 of file CbmReport.h.

References CbmReport::fReportTitle.

◆ GetStudyName()

const std::string & CbmStudyReport::GetStudyName ( Int_t index) const
inlineinherited

Definition at line 79 of file CbmStudyReport.h.

References CbmStudyReport::fStudyNames.

Referenced by CbmLitTrackingQaStudyReport::DrawAccAndRec(), and CbmLitTrackingQaStudyReport::DrawEfficiency().

◆ GetStudyNames()

const std::vector< std::string > & CbmStudyReport::GetStudyNames ( ) const
inlineinherited

Definition at line 78 of file CbmStudyReport.h.

References CbmStudyReport::fStudyNames.

Referenced by Create(), CbmAnaDielectronStudyReportAll::DrawBgMinv(), CbmLitFitQaStudyReport::DrawTrackParamsAtVertex(), CbmLitTrackingQaStudyReport::PrintEfficiencyTable(), CbmLitClusteringQaStudyReport::PrintNofObjects(), PrintRow(), and CbmLitTrackingQaStudyReport::PrintTable().

◆ HM() [1/2]

const std::vector< CbmHistManager * > & CbmStudyReport::HM ( ) const
inlineinherited

Definition at line 76 of file CbmStudyReport.h.

References CbmStudyReport::fHM.

Referenced by CbmLitTrackingQaStudyReport::CalculateEfficiencyHistos(), CbmLitTrackingQaStudyReport::DrawAccAndRec(), CbmAnaDielectronStudyReportAll::DrawBgMinv(), CbmLitTrackingQaStudyReport::DrawEfficiency(), CbmLitTrackingQaStudyReport::DrawEfficiencyHistos(), CbmLitFitQaStudyReport::DrawTrackParamsAtVertex(), CbmLitTrackingQaStudyReport::PrintEfficiencyTable(), CbmLitClusteringQaStudyReport::PrintNofObjects(), and CbmLitTrackingQaStudyReport::PrintTable().

◆ HM() [2/2]

CbmHistManager * CbmStudyReport::HM ( Int_t index) const
inlineinherited

Definition at line 77 of file CbmStudyReport.h.

References CbmStudyReport::fHM.

◆ Out()

std::ostream & CbmReport::Out ( ) const
inlineinherited

All text output goes to this stream.

Definition at line 66 of file CbmReport.h.

References CbmReport::fOut.

Referenced by CbmAnaDielectronStudyReportAll::Create(), CbmAnaJpsiReport::Create(), CbmAnaJpsiSuperEventReport::Create(), CbmLitClusteringQaReport::Create(), CbmLitClusteringQaStudyReport::Create(), CbmLitFieldApproximationQaReport::Create(), CbmLitFieldQaReport::Create(), CbmLitFitQaReport::Create(), CbmLitFitQaStudyReport::Create(), CbmLitRadLengthQaReport::Create(), CbmLitTofQaReport::Create(), CbmLitTrackingQaReport::Create(), CbmLitTrackingQaStudyReport::Create(), Create(), CbmStsDigitizeQaReport::Create(), and CbmReport::PrintCanvases().

◆ PrintCanvases()

void CbmReport::PrintCanvases ( ) const
protectedinherited

Print images created from canvases in the report.

Definition at line 121 of file CbmReport.cxx.

References CbmReport::fCanvases, CbmReportElement::Image(), CbmReport::Out(), and CbmReport::R().

Referenced by CbmAnaDielectronStudyReportAll::Create(), CbmAnaJpsiReport::Create(), CbmAnaJpsiSuperEventReport::Create(), CbmLitClusteringQaReport::Create(), CbmLitFieldApproximationQaReport::Create(), CbmLitFieldQaReport::Create(), CbmLitFitQaReport::Create(), CbmLitFitQaStudyReport::Create(), CbmLitRadLengthQaReport::Create(), CbmLitTofQaReport::Create(), CbmLitTrackingQaReport::Create(), CbmLitTrackingQaStudyReport::Create(), and CbmStsDigitizeQaReport::Create().

◆ PrintRow()

string CbmRichGeoTestStudyReport::PrintRow ( const string & property,
const string & name )
protectedvirtual

Print one row in a table.

Parameters
[in]propertyName of the property in property tree.
[in]nameName of the row.
Returns
String with table row.

Definition at line 90 of file CbmRichGeoTestStudyReport.cxx.

References CbmStudyReport::GetStudyNames(), PrintValue(), CbmReport::R(), size(), and CbmReportElement::TableRow().

Referenced by Create().

◆ PrintValue()

string CbmRichGeoTestStudyReport::PrintValue ( int studyId,
const string & valueTitle )
protectedvirtual

Definition at line 99 of file CbmRichGeoTestStudyReport.cxx.

Referenced by PrintRow().

◆ R()

const CbmReportElement * CbmReport::R ( ) const
inlineinherited

Accessor to CbmReportElement object. User has to write the report using available tags from CbmReportElement class.

Definition at line 61 of file CbmReport.h.

References CbmReport::fR.

Referenced by CbmAnaDielectronStudyReportAll::Create(), CbmAnaJpsiReport::Create(), CbmAnaJpsiSuperEventReport::Create(), CbmLitClusteringQaReport::Create(), CbmLitClusteringQaStudyReport::Create(), CbmLitFieldApproximationQaReport::Create(), CbmLitFieldQaReport::Create(), CbmLitFitQaReport::Create(), CbmLitFitQaStudyReport::Create(), CbmLitRadLengthQaReport::Create(), CbmLitTofQaReport::Create(), CbmLitTrackingQaReport::Create(), CbmLitTrackingQaStudyReport::Create(), Create(), CbmStsDigitizeQaReport::Create(), CbmReport::PrintCanvases(), CbmLitTrackingQaStudyReport::PrintEfficiencyTable(), CbmLitTrackingQaReport::PrintNofGhosts(), CbmLitClusteringQaReport::PrintNofObjects(), CbmLitClusteringQaStudyReport::PrintNofObjects(), CbmLitTrackingQaReport::PrintNofObjects(), CbmLitTrackingQaReport::PrintPionSuppression(), CbmLitFitQaReport::PrintResAndPullRow(), PrintRow(), CbmLitTrackingQaStudyReport::PrintTable(), CbmLitTrackingQaReport::PrintTrackHits(), and CbmLitTrackingQaReport::PrintTrackingEfficiency().

◆ 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().

◆ SetOutputDir()

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

Definition at line 71 of file CbmReport.h.

References CbmReport::fOutputDir.

◆ SetReportName()

void CbmReport::SetReportName ( const std::string & name)
inlineinherited

Definition at line 69 of file CbmReport.h.

References CbmReport::fReportName.

Referenced by CbmAnaDielectronStudyReportAll::CbmAnaDielectronStudyReportAll(), CbmAnaJpsiReport::CbmAnaJpsiReport(), CbmAnaJpsiSuperEventReport::CbmAnaJpsiSuperEventReport(), CbmLitClusteringQaReport::CbmLitClusteringQaReport(), CbmLitClusteringQaStudyReport::CbmLitClusteringQaStudyReport(), CbmLitFieldApproximationQaReport::CbmLitFieldApproximationQaReport(), CbmLitFieldQaReport::CbmLitFieldQaReport(), CbmLitFitQaReport::CbmLitFitQaReport(), CbmLitFitQaStudyReport::CbmLitFitQaStudyReport(), CbmLitRadLengthQaReport::CbmLitRadLengthQaReport(), CbmLitTofQaReport::CbmLitTofQaReport(), CbmLitTrackingQaReport::CbmLitTrackingQaReport(), CbmLitTrackingQaStudyReport::CbmLitTrackingQaStudyReport(), CbmRichGeoTestStudyReport(), and CbmStsDigitizeQaReport::CbmStsDigitizeQaReport().

◆ SetReportTitle()

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

Definition at line 70 of file CbmReport.h.

References CbmReport::fReportTitle.

Referenced by CbmAnaDielectronStudyReportAll::CbmAnaDielectronStudyReportAll(), CbmLitFitQaStudyReport::CbmLitFitQaStudyReport(), and CbmLitTrackingQaStudyReport::CbmLitTrackingQaStudyReport().

◆ 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

◆ fCanvases

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

Definition at line 149 of file CbmReport.h.

Referenced by CbmReport::CreateCanvas(), CbmReport::PrintCanvases(), CbmReport::SaveCanvasesAsImages(), and CbmReport::WriteCanvases().

◆ fHM

std::vector<CbmHistManager*> CbmStudyReport::fHM
privateinherited

Definition at line 82 of file CbmStudyReport.h.

Referenced by CbmStudyReport::HM(), and CbmStudyReport::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

Definition at line 139 of file CbmReport.h.

Referenced by CbmReport::CreateReportElement(), CbmReport::GetReportName(), and CbmReport::SetReportName().

◆ 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().

◆ fStudyNames

std::vector<std::string> CbmStudyReport::fStudyNames
privateinherited

Definition at line 83 of file CbmStudyReport.h.

Referenced by CbmStudyReport::GetStudyName(), and CbmStudyReport::GetStudyNames().

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