Base class for simulation reports. More...

#include <CbmSimulationReport.h>

Inheritance diagram for CbmSimulationReport:

Collaboration diagram for CbmSimulationReport:

Public Member Functions
	CbmSimulationReport ()
	Constructor.

virtual	~CbmSimulationReport ()
	Destructor.

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.

virtual void	Create ()=0
	Inherited from CbmReport. Pure abstract function which is called from public Create() function.

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.

CbmHistManager *	HM () 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 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
virtual void	Draw ()=0
	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	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
	CbmSimulationReport (const CbmSimulationReport &)

CbmSimulationReport &	operator= (const CbmSimulationReport &)

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
CbmHistManager *	fHM

std::string	fReportName

std::string	fReportTitle

std::string	fOutputDir

ReportType	fReportType

CbmReportElement *	fR

std::ostream *	fOut

std::vector< TCanvas * >	fCanvases

Detailed Description

Base class for simulation reports.

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

Date: 2011

Definition at line 32 of file CbmSimulationReport.h.

Constructor & Destructor Documentation

◆ CbmSimulationReport() [1/2]

CbmSimulationReport::CbmSimulationReport ( )

Constructor.

Definition at line 31 of file CbmSimulationReport.cxx.

◆ ~CbmSimulationReport()

CbmSimulationReport::~CbmSimulationReport ( )

virtual

Destructor.

Definition at line 33 of file CbmSimulationReport.cxx.

◆ CbmSimulationReport() [2/2]

CbmSimulationReport::CbmSimulationReport ( const CbmSimulationReport & )

private

Member Function Documentation

◆ Create() [1/3]

virtual void CbmSimulationReport::Create ( )

pure virtual

Inherited from CbmReport. Pure abstract function which is called from public Create() function.

Implements CbmReport.

Implemented in CbmAnaJpsiReport, CbmAnaJpsiSuperEventReport, CbmLitClusteringQaReport, CbmLitFieldApproximationQaReport, CbmLitFieldQaReport, CbmLitFitQaReport, CbmLitRadLengthQaReport, CbmLitTofQaReport, CbmLitTrackingQaReport, and CbmStsDigitizeQaReport.

◆ Create() [2/3]

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

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]	histManager	Pointer to histogram manager for which report is created.
[in]	outputDir	Path 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() [3/3]

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

Main function which creates report data.

Same pattern is used here.

Parameters

[in]	fileName	Name of the file with histograms.
[in]	outputDir	Path to directory for output results.

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

◆ CreateReportElement()

void CbmReport::CreateReportElement ( ReportType reportType )

privateinherited

Create concrete CbmReportElement instance based on report type.

Parameters

[in] reportType Type 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]

virtual void CbmReport::Draw ( )

protectedpure virtualinherited

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.

Implemented in CbmAnaDielectronStudyReportAll, CbmAnaJpsiReport, CbmAnaJpsiSuperEventReport, CbmLitClusteringQaReport, CbmLitClusteringQaStudyReport, CbmLitFieldApproximationQaReport, CbmLitFieldQaReport, CbmLitFitQaReport, CbmLitFitQaStudyReport, CbmLitRadLengthQaReport, CbmLitTofQaReport, CbmLitTrackingQaReport, CbmLitTrackingQaStudyReport, CbmRichGeoTestStudyReport, and CbmStsDigitizeQaReport.

Referenced by CbmReport::CreateReports().

◆ Draw() [2/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.

◆ DrawH1ByPattern() [1/2]

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

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

Parameters

[in] histNamePattern Name pattern for histogram.

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

◆ DrawH1ByPattern() [2/2]

void CbmSimulationReport::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.

Parameters

[in] histNamePattern Name pattern for histogram.

◆ DrawH2ByPattern()

void CbmSimulationReport::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.

Parameters

[in]	histNamePattern	Name pattern for histogram.
[in]	logx	Specify logarithmic or linear scale for X axis.
[in]	logy	Specify logarithmic or linear scale for Y axis.
[in]	logz	Specify logarithmic or linear scale for Z axis.
[in]	drawOpt	Other drawing options (see ROOT documentation for details).