Detailed Description

Produce graphs and histograms from KVDataQualityAudit.

This is a helper class for extracting & presenting useful informations from a KVDataQualityAudit in the form of graphs and histograms.

To initialise, open a file containing data quality audit objects and call the constructor with the name of the audit you want to use, as shown here:

kaliveda [1] .ls
TFile**     bilan_58Ni58Ni52.root
 TFile*     bilan_58Ni58Ni52.root
  KEY: KVDataQualityAudit  58Ni58Ni52;1   58Ni + 58Ni[300] 52 MeV/A
  KEY: KVDataQualityAudit  58Ni58Ni;1  58Ni + 58Ni[300]
  KEY: KVDataQualityAudit  INDRAFAZIA.E789;1 E789 (April/May 2019)
 
kaliveda [2] KVDataQualityAuditReportMaker rep("58Ni58Ni52")
(KVDataQualityAuditReportMaker &) Name: 58Ni58Ni52 Title: 58Ni + 58Ni[300] 52 MeV/A

Author: John Frankland

Date: Tue Jul 20 15:25:56 2021

Definition at line 37 of file KVDataQualityAuditReportMaker.h.

#include <KVDataQualityAuditReportMaker.h>

Inheritance diagram for KVDataQualityAuditReportMaker:

[legend]

Classes
struct	element

struct	telescope

Public Member Functions
	KVDataQualityAuditReportMaker ()

	KVDataQualityAuditReportMaker (const KVDataQualityAudit *audit)

	KVDataQualityAuditReportMaker (const TString &audit_name)

virtual	~KVDataQualityAuditReportMaker ()

template<typename TelescopeIndexFunction >
TGraph *	get_max_A_for_telescopes (TSeqCollection *idtels, TelescopeIndexFunction F, Marker_t marker_style=20) const

template<typename TelescopeIndexFunction >
TGraph *	get_max_Z_for_telescopes (TSeqCollection *idtels, TelescopeIndexFunction F, Marker_t marker_style=20) const

template<typename TelescopeIndexFunction >
TGraph *	get_max_Z_with_isotopes_for_telescopes (TSeqCollection *idtels, TelescopeIndexFunction F, Marker_t marker_style=20) const

template<typename TelescopeIndexFunction >
TGraph *	get_mean_A_for_telescopes (TSeqCollection *idtels, TelescopeIndexFunction F, Marker_t marker_style=20) const

template<typename TelescopeIndexFunction >
TGraph *	get_mean_Z_for_telescopes (TSeqCollection *idtels, TelescopeIndexFunction F, Marker_t marker_style=20) const

template<typename TelescopeIndexFunction >
TGraph *	get_min_A_for_telescopes (TSeqCollection *idtels, TelescopeIndexFunction F, Marker_t marker_style=20) const

template<typename TelescopeIndexFunction >
TGraph *	get_min_Z_for_telescopes (TSeqCollection *idtels, TelescopeIndexFunction F, Marker_t marker_style=20) const

const KVDataQualityAudit *	GetAudit () const

telescope	operator[] (const TString &name) const

Public Member Functions inherited from KVBase
	KVBase ()
	Default constructor. More...

	KVBase (const Char_t name, const Char_t title="")
	Ctor for object with given name and type. More...

	KVBase (const KVBase &)
	copy ctor More...

virtual	~ KVBase ()

virtual void	Clear (Option_t *opt="")
	Clear object properties : name, type/title, number, label. More...

virtual void	Copy (TObject &) const
	Make a copy of this object. More...

const Char_t *	GetLabel () const

UInt_t	GetNumber () const

UInt_t	GetNumberOfObjects () const

virtual TObject *	GetObject () const

virtual const Char_t *	GetType () const

Bool_t	HasLabel () const

virtual Bool_t	IsCalled (const Char_t *name) const

Bool_t	IsLabelled (const Char_t *l) const

virtual Bool_t	IsType (const Char_t *typ) const

virtual void	List ()

KVBase &	operator= (const KVBase &)
	copy assignment operator More...

virtual void	Print (Option_t *option="") const

Double_t	ProtectedGetX (const TF1 *func, Double_t val, int &status, Double_t xmin=0.0, Double_t xmax=0.0) const

void	SetLabel (const Char_t *lab)

virtual void	SetNumber (UInt_t num)

virtual void	SetType (const Char_t *str)

Public Member Functions inherited from TNamed
	TNamed ()

	TNamed (const char name, const char title)

	TNamed (const TNamed &named)

	TNamed (const TString &name, const TString &title)

virtual	~TNamed ()

TObject *	Clone (const char *newname="") const override

Int_t	Compare (const TObject *obj) const override

virtual void	FillBuffer (char *&buffer)

const char *	GetName () const override

const char *	GetTitle () const override

ULong_t	Hash () const override

TClass *	IsA () const override

Bool_t	IsSortable () const override

void	ls (Option_t *option="") const override

TNamed &	operator= (const TNamed &rhs)

virtual void	SetName (const char *name)

virtual void	SetNameTitle (const char name, const char title)

virtual void	SetTitle (const char *title="")

virtual Int_t	Sizeof () const

void	Streamer (TBuffer &) override

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TObject
	TObject ()

	TObject (const TObject &object)

virtual	~TObject ()

void	AbstractMethod (const char *method) const

virtual void	AppendPad (Option_t *option="")

virtual void	Browse (TBrowser *b)

ULong_t	CheckedHash ()

virtual const char *	ClassName () const

virtual void	Delete (Option_t *option="")

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)

virtual void	Draw (Option_t *option="")

virtual void	DrawClass () const

virtual TObject *	DrawClone (Option_t *option="") const

virtual void	Dump () const

virtual void	Error (const char method, const char msgfmt,...) const

virtual void	Execute (const char method, const char params, Int_t *error=nullptr)

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=nullptr)

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)

virtual void	Fatal (const char method, const char msgfmt,...) const

virtual TObject *	FindObject (const char *name) const

virtual TObject *	FindObject (const TObject *obj) const

virtual Option_t *	GetDrawOption () const

virtual const char *	GetIconName () const

virtual char *	GetObjectInfo (Int_t px, Int_t py) const

virtual Option_t *	GetOption () const

virtual UInt_t	GetUniqueID () const

virtual Bool_t	HandleTimer (TTimer *timer)

Bool_t	HasInconsistentHash () const

virtual void	Info (const char method, const char msgfmt,...) const

virtual Bool_t	InheritsFrom (const char *classname) const

virtual Bool_t	InheritsFrom (const TClass *cl) const

virtual void	Inspect () const

void	InvertBit (UInt_t f)

Bool_t	IsDestructed () const

virtual Bool_t	IsEqual (const TObject *obj) const

virtual Bool_t	IsFolder () const

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

void	MayNotUse (const char *method) const

virtual Bool_t	Notify ()

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const

void	operator delete (void *ptr)

void	operator delete (void ptr, void vp)

void	operator delete[] (void *ptr)

void	operator delete[] (void ptr, void vp)

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, void *vp)

TObject &	operator= (const TObject &rhs)

virtual void	Paint (Option_t *option="")

virtual void	Pop ()

virtual Int_t	Read (const char *name)

virtual void	RecursiveRemove (TObject *obj)

void	ResetBit (UInt_t f)

virtual void	SaveAs (const char filename="", Option_t option="") const

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)

virtual void	SetDrawOption (Option_t *option="")

virtual void	SetUniqueID (UInt_t uid)

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

virtual void	SysError (const char method, const char msgfmt,...) const

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

virtual void	UseCurrentStyle ()

virtual void	Warning (const char method, const char msgfmt,...) const

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const

Static Public Member Functions
static TGraph *	FormatGraph (TGraph *, Color_t=0, Marker_t=0)
	provide uniform style for all graphs More...

static TH1F *	FormatHisto (TH1F *, Color_t=0)
	provide uniform style for all histos More...

Static Public Member Functions inherited from KVBase
static Bool_t	AreEqual (Double_t x, Double_t y, Long64_t maxdif=1)
	Comparison between two 64-bit floating-point values. More...

static void	BackupFileWithDate (const Char_t *path)

static void	CombineFiles (const Char_t file1, const Char_t file2, const Char_t *newfilename, Bool_t keep=kTRUE)

static void	Deprecated (const char method, const char advice)

static Bool_t	FindClassSourceFiles (const Char_t class_name, KVString &imp_file, KVString &dec_file, const Char_t dir_name=".")

static Bool_t	FindExecutable (TString &exec, const Char_t *path="$(PATH)")

static const Char_t *	FindFile (const Char_t *search, TString &wfil)

static const Char_t *	GetBINDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetDATABASEFilePath ()

static const Char_t *	GetDATADIRFilePath (const Char_t *namefile="")

static Bool_t	GetDataSetEnv (const Char_t dataset, const Char_t type, Bool_t defval)

static const Char_t *	GetDataSetEnv (const Char_t dataset, const Char_t type, const Char_t *defval)

static Double_t	GetDataSetEnv (const Char_t dataset, const Char_t type, Double_t defval)

static const Char_t *	GetETCDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetExampleFilePath (const Char_t library, const Char_t namefile)
	Return full path to example file for given library (="KVMultiDet", "BackTrack", etc.) More...

static const Char_t *	GetINCDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetKVBuildDate ()
	Returns KaliVeda build date. More...

static const Char_t *	GetKVBuildDir ()
	Returns top-level directory used for build. More...

static const Char_t *	GetKVBuildTime ()
	Returns KaliVeda build time. More...

static const Char_t *	GetKVBuildType ()
	Returns KaliVeda build type (cmake build: Release, Debug, RelWithDebInfo, ...) More...

static const Char_t *	GetKVBuildUser ()
	Returns username of person who performed build. More...

static const Char_t *	GetKVSourceDir ()
	Returns top-level directory of source tree used for build. More...

static const Char_t *	GetKVVersion ()
	Returns KaliVeda version string. More...

static const Char_t *	GetLIBDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetListOfPlugins (const Char_t *base)

static const Char_t *	GetListOfPluginURIs (const Char_t *base)

static const Char_t *	GetPluginURI (const Char_t base, const Char_t plugin)

static void	GetTempFileName (TString &base)

static const Char_t *	GetTEMPLATEDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetWORKDIRFilePath (const Char_t *namefile="")

static const Char_t *	gitBranch ()
	Returns git branch of sources. More...

static const Char_t *	gitCommit ()
	Returns last git commit of sources. More...

static void	InitEnvironment ()

static bool	is_gnuinstall ()

static Bool_t	IsThisAPlugin (const TString &uri, TString &base)

static TPluginHandler *	LoadPlugin (const Char_t base, const Char_t uri="0")

static Bool_t	OpenContextMenu (const char method, TObject obj, const char *alt_method_name="")

static void	OpenTempFile (TString &base, std::ofstream &fp)

static void	PrintSplashScreen ()
	Prints welcome message and infos on version etc. More...

static Bool_t	SearchAndOpenKVFile (const Char_t name, KVSQLite::database &dbfile, const Char_t kvsubdir="")

static Bool_t	SearchAndOpenKVFile (const Char_t name, std::ifstream &file, const Char_t kvsubdir="", KVLockfile *locks=0)

static Bool_t	SearchAndOpenKVFile (const Char_t name, std::ofstream &file, const Char_t kvsubdir="", KVLockfile *locks=0)

static Bool_t	SearchKVFile (const Char_t name, TString &fullpath, const Char_t kvsubdir="")

static const Char_t *	WorkingDirectory ()

Static Public Member Functions inherited from TNamed
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TObject
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static Longptr_t	GetDtorOnly ()

static Bool_t	GetObjectStat ()

static void	SetDtorOnly (void *obj)

static void	SetObjectStat (Bool_t stat)

Private Member Functions
void	init_colors (int ncols=100)

Private Attributes
const KVDataQualityAudit *	fAudit {nullptr}

Additional Inherited Members
Public Types inherited from KVBase
enum	EKaliVedaBits { kIsKaliVedaObject = BIT(23) }

Public Types inherited from TObject
enum	EDeprecatedStatusBits

enum	EStatusBits

Public Attributes inherited from TObject
	kBitMask

	kCanDelete

	kCannotPick

	kHasUUID

	kInconsistent

	kInvalidObject

	kIsOnHeap

	kIsReferenced

	kMustCleanup

	kNoContextMenu

	kNotDeleted

	kObjInCanvas

	kOverwrite

	kSingleKey

	kWriteDelete

	kZombie

Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const

void	MakeZombie ()

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Protected Attributes inherited from TObject
	kOnlyPrepStep

Constructor & Destructor Documentation

◆ KVDataQualityAuditReportMaker() [1/3]

KVDataQualityAuditReportMaker::KVDataQualityAuditReportMaker ( )

inline

Definition at line 78 of file KVDataQualityAuditReportMaker.h.

◆ KVDataQualityAuditReportMaker() [2/3]

KVDataQualityAuditReportMaker::KVDataQualityAuditReportMaker ( const TString & audit_name )

inline

Open audit with given name in the current ROOT directory, gDirectory

Parameters

[in] audit_name name of KVDataQualityAudit object to open

Definition at line 83 of file KVDataQualityAuditReportMaker.h.

◆ KVDataQualityAuditReportMaker() [3/3]

KVDataQualityAuditReportMaker::KVDataQualityAuditReportMaker ( const KVDataQualityAudit * audit )

inline

Definition at line 93 of file KVDataQualityAuditReportMaker.h.

◆ ~KVDataQualityAuditReportMaker()

virtual KVDataQualityAuditReportMaker::~KVDataQualityAuditReportMaker ( )

inlinevirtual

Definition at line 98 of file KVDataQualityAuditReportMaker.h.

Member Function Documentation

◆ FormatGraph()

TGraph * KVDataQualityAuditReportMaker::FormatGraph	(	TGraph *	G,
		Color_t	col = `0`,
		Marker_t	mark = `0`
	)

static

provide uniform style for all graphs

Definition at line 218 of file KVDataQualityAuditReportMaker.cpp.

◆ FormatHisto()

TH1F * KVDataQualityAuditReportMaker::FormatHisto	(	TH1F *	G,
		Color_t	col = `0`
	)

static

provide uniform style for all histos

Definition at line 237 of file KVDataQualityAuditReportMaker.cpp.

◆ get_max_A_for_telescopes()

template<typename TelescopeIndexFunction >

TGraph* KVDataQualityAuditReportMaker::get_max_A_for_telescopes	(	TSeqCollection *	idtels,
		TelescopeIndexFunction	F,
		Marker_t	marker_style = `20`
	)		const

inline

Returns: graph of max A detected in each KVIDTelescope in the list.

F is a function with the signature: int F(const KVIDTelescope*) It should return an 'index' value which will be used to identify each telescope on the X-axis

Definition at line 204 of file KVDataQualityAuditReportMaker.h.

◆ get_max_Z_for_telescopes()

template<typename TelescopeIndexFunction >

TGraph* KVDataQualityAuditReportMaker::get_max_Z_for_telescopes	(	TSeqCollection *	idtels,
		TelescopeIndexFunction	F,
		Marker_t	marker_style = `20`
	)		const

inline

Returns: graph of max Z detected in each KVIDTelescope in the list.

F is a function with the signature: int F(const KVIDTelescope*) It should return an 'index' value which will be used to identify each telescope on the X-axis

Definition at line 132 of file KVDataQualityAuditReportMaker.h.

◆ get_max_Z_with_isotopes_for_telescopes()

template<typename TelescopeIndexFunction >

TGraph* KVDataQualityAuditReportMaker::get_max_Z_with_isotopes_for_telescopes	(	TSeqCollection *	idtels,
		TelescopeIndexFunction	F,
		Marker_t	marker_style = `20`
	)		const

inline

Returns: graph of max Z for which isotopic masses were measured in each KVIDTelescope in the list.

F is a function with the signature: int F(const KVIDTelescope*) It should return an 'index' value which will be used to identify each telescope on the X-axis

Definition at line 150 of file KVDataQualityAuditReportMaker.h.

◆ get_mean_A_for_telescopes()

template<typename TelescopeIndexFunction >

TGraph* KVDataQualityAuditReportMaker::get_mean_A_for_telescopes	(	TSeqCollection *	idtels,
		TelescopeIndexFunction	F,
		Marker_t	marker_style = `20`
	)		const

inline

Returns: graph of mean A detected in each KVIDTelescope in the list.

F is a function with the signature: int F(const KVIDTelescope*) It should return an 'index' value which will be used to identify each telescope on the X-axis

Definition at line 186 of file KVDataQualityAuditReportMaker.h.

◆ get_mean_Z_for_telescopes()

template<typename TelescopeIndexFunction >

TGraph* KVDataQualityAuditReportMaker::get_mean_Z_for_telescopes	(	TSeqCollection *	idtels,
		TelescopeIndexFunction	F,
		Marker_t	marker_style = `20`
	)		const

inline

Returns: graph of mean Z detected in each KVIDTelescope in the list.

F is a function with the signature: int F(const KVIDTelescope*) It should return an 'index' value which will be used to identify each telescope on the X-axis

Definition at line 114 of file KVDataQualityAuditReportMaker.h.

◆ get_min_A_for_telescopes()

template<typename TelescopeIndexFunction >

TGraph* KVDataQualityAuditReportMaker::get_min_A_for_telescopes	(	TSeqCollection *	idtels,
		TelescopeIndexFunction	F,
		Marker_t	marker_style = `20`
	)		const

inline

Returns: graph of smallest A detected in each KVIDTelescope in the list.

F is a function with the signature: int F(const KVIDTelescope*) It should return an 'index' value which will be used to identify each telescope on the X-axis

Definition at line 223 of file KVDataQualityAuditReportMaker.h.

◆ get_min_Z_for_telescopes()

template<typename TelescopeIndexFunction >

TGraph* KVDataQualityAuditReportMaker::get_min_Z_for_telescopes	(	TSeqCollection *	idtels,
		TelescopeIndexFunction	F,
		Marker_t	marker_style = `20`
	)		const

inline

Returns: graph of smallest Z detected in each KVIDTelescope in the list.

F is a function with the signature: int F(const KVIDTelescope*) It should return an 'index' value which will be used to identify each telescope on the X-axis

Definition at line 168 of file KVDataQualityAuditReportMaker.h.

◆ GetAudit()

const KVDataQualityAudit* KVDataQualityAuditReportMaker::GetAudit ( ) const

inline

Definition at line 108 of file KVDataQualityAuditReportMaker.h.

◆ init_colors()

void KVDataQualityAuditReportMaker::init_colors ( int ncols = 100 )

private

Definition at line 314 of file KVDataQualityAuditReportMaker.cpp.

◆ operator[]()

telescope KVDataQualityAuditReportMaker::operator[] ( const TString & name ) const

inline

Definition at line 100 of file KVDataQualityAuditReportMaker.h.

Member Data Documentation

◆ fAudit

const KVDataQualityAudit* KVDataQualityAuditReportMaker::fAudit {nullptr}

private

Definition at line 75 of file KVDataQualityAuditReportMaker.h.

Detailed Description

Classes

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ KVDataQualityAuditReportMaker() [1/3]

◆ KVDataQualityAuditReportMaker() [2/3]

◆ KVDataQualityAuditReportMaker() [3/3]

◆ ~KVDataQualityAuditReportMaker()

Member Function Documentation

◆ FormatGraph()

◆ FormatHisto()

◆ get_max_A_for_telescopes()

◆ get_max_Z_for_telescopes()

◆ get_max_Z_with_isotopes_for_telescopes()

◆ get_mean_A_for_telescopes()

◆ get_mean_Z_for_telescopes()

◆ get_min_A_for_telescopes()

◆ get_min_Z_for_telescopes()

◆ GetAudit()

◆ init_colors()

◆ operator[]()

Member Data Documentation

◆ fAudit