Detailed Description

Audit of experimental data identification and calibrations.

A KVDataQualityAudit object contains many essential informations about experimental data identification and calibrations, which can be used:

to assess the quality of newly-reconstructed & calibrated data;
to implement an accurate replica of experimental identification capabilites, when filtering simulated data.

The audit is performed by reading a set of experimental data (see KVDataQualityAuditSelector). At the end, the audit contains a list of all identification telescopes (see KVIDTelescope) which contributed to the data, with for each:

the list of elements identified (with or without mass identification), with, for each element:
- the number of times it was identified;
- the minimum energy with which it was identified, $E_{min}^{Z}$, used as the threshold for $Z$ identification of this element (for calibrated particles);
- when identified only in $Z$, the mass $A$ that was attributed by default to the isotope;
- the list of isotopes, if any, identified for the element, with, for each isotope:
  - the number of times it was identified;
  - the minimum energy with which it was identified, $E_{min}^{A}$, used as the threshold for identification of the isotope (for calibrated particles).

See also: KVDataQualityAuditReportMaker

Author: John Frankland

Date: Fri Jul 9 22:37:24 2021

Definition at line 40 of file KVDataQualityAudit.h.

#include <KVDataQualityAudit.h>

Inheritance diagram for KVDataQualityAudit:

[legend]

Classes
struct	element

class	IDStatus
	Helper class used by CanIdentify() to test whether particles can be identified. More...

class	idtelescope

struct	isotope

Public Member Functions
	KVDataQualityAudit ()

	KVDataQualityAudit (const Char_t name, const Char_t title="")

virtual	~KVDataQualityAudit ()

void	Add (const KVReconstructedNucleus &N)
	Add this reconstructed nucleus to the audit. More...

IDStatus	CanIdentify (const TString &tel_name, int Z, int &A, double E) const

idtelescope *	GetTelescope (const idtelescope *idt) const

idtelescope *	GetTelescope (const TString &tel_name) const

const KVSeqCollection *	GetTelescopeList () const

Bool_t	HasTelescope (const idtelescope *idt) const

Bool_t	HasTelescope (const TString &tel_name) const

Long64_t	Merge (TCollection *)

void	Print (Option_t *opt="") const override

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

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

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

const Char_t *	GetLabel () const

UInt_t	GetNumber () 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...

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

Private Member Functions
void	add (const idtelescope *)
	Add copy of idtelescope data to this audit. More...

Long64_t	merge (KVDataQualityAudit *)

Private Attributes
KVUniqueNameList	telescopes

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

Public Types inherited from TObject
enum	EDeprecatedStatusBits

enum	EStatusBits

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 KVString &class_name, KVString &imp_file, KVString &dec_file, const KVString &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 KVString	GetDataSetEnv (const KVString &dataset, const KVString &type, const char *defval)

template<typename ValType >
static ValType	GetDataSetEnv (const KVString &dataset, const KVString &type, const ValType &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 int	GetKVMajorVersion ()

static int	GetKVMinorVersion ()

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	IsEnvInit ()

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)

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

◆ KVDataQualityAudit() [1/2]

KVDataQualityAudit::KVDataQualityAudit ( )

inline

Definition at line 47 of file KVDataQualityAudit.h.

◆ KVDataQualityAudit() [2/2]

KVDataQualityAudit::KVDataQualityAudit	(	const Char_t *	name,
		const Char_t *	title = `""`
	)

inline

Definition at line 48 of file KVDataQualityAudit.h.

◆ ~KVDataQualityAudit()

virtual KVDataQualityAudit::~KVDataQualityAudit ( )

inlinevirtual

Definition at line 53 of file KVDataQualityAudit.h.

Member Function Documentation

◆ add()

void KVDataQualityAudit::add ( const idtelescope * idt )

private

Add copy of idtelescope data to this audit.

Definition at line 186 of file KVDataQualityAudit.cpp.

◆ Add()

void KVDataQualityAudit::Add ( const KVReconstructedNucleus & N )

Add this reconstructed nucleus to the audit.

Definition at line 8 of file KVDataQualityAudit.cpp.

◆ CanIdentify()

KVDataQualityAudit::IDStatus KVDataQualityAudit::CanIdentify	(	const TString &	tel_name,
		int	Z,
		int &	A,
		double	E
	)		const

Call this method to test whether a given particle could be identified in a given identification telescope according to the data quality audit.

Parameters

[in]	tel_name	name of identification telescope
[in]	Z	atomic number $Z$ of particle
[in,out]	A	mass number $A$ of particle. May be changed by method.
[in]	E	total incident energy of particle

Returns: IDStatus object which indicates if & how well the identification would proceed

Definition at line 68 of file KVDataQualityAudit.cpp.

◆ GetTelescope() [1/2]

idtelescope* KVDataQualityAudit::GetTelescope ( const idtelescope * idt ) const

inline

Definition at line 189 of file KVDataQualityAudit.h.

◆ GetTelescope() [2/2]

idtelescope* KVDataQualityAudit::GetTelescope ( const TString & tel_name ) const

inline

Definition at line 185 of file KVDataQualityAudit.h.

◆ GetTelescopeList()

const KVSeqCollection* KVDataQualityAudit::GetTelescopeList ( ) const

inline

Definition at line 56 of file KVDataQualityAudit.h.

◆ HasTelescope() [1/2]

Bool_t KVDataQualityAudit::HasTelescope ( const idtelescope * idt ) const

inline

Definition at line 181 of file KVDataQualityAudit.h.

◆ HasTelescope() [2/2]

Bool_t KVDataQualityAudit::HasTelescope ( const TString & tel_name ) const

inline

Definition at line 60 of file KVDataQualityAudit.h.

◆ merge()

Long64_t KVDataQualityAudit::merge ( KVDataQualityAudit * other )

private

Merge other audit object with this one. Return 1 if merge is successful, 0 in case of problems.

Definition at line 198 of file KVDataQualityAudit.cpp.

◆ Merge()

Long64_t KVDataQualityAudit::Merge ( TCollection * l )

Used to merge audit objects in different ROOT files (using hadd).

This method is called for the object in the first file, the TCollection contains the objects with the same name in all the other files.

Definition at line 39 of file KVDataQualityAudit.cpp.

◆ Print()

void KVDataQualityAudit::Print ( Option_t * opt = "" ) const

overridevirtual

Reimplemented from KVBase.

Definition at line 24 of file KVDataQualityAudit.cpp.

Member Data Documentation

◆ telescopes

KVUniqueNameList KVDataQualityAudit::telescopes

private

Definition at line 42 of file KVDataQualityAudit.h.

Detailed Description

Classes

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ KVDataQualityAudit() [1/2]

◆ KVDataQualityAudit() [2/2]

◆ ~KVDataQualityAudit()

Member Function Documentation

◆ add()

◆ Add()

◆ CanIdentify()

◆ GetTelescope() [1/2]

◆ GetTelescope() [2/2]

◆ GetTelescopeList()

◆ HasTelescope() [1/2]

◆ HasTelescope() [2/2]

◆ merge()

◆ Merge()

◆ Print()

Member Data Documentation

◆ telescopes