KaliVeda
Toolkit for HIC analysis
Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
KVDataQualityAuditReporting_INDRA Class Reference
INDRA-specific Data Analysis Tools

Detailed Description

Prepare PDF report on data quality audits for INDRA experiments.

This class will produce a multi-page PDF report from the data quality audits for INDRA experiments.

To use it, open a file containing data quality audits, then generate the PDF for the required audit as follows:

kaliveda [2] KVDataQualityAuditReporting_INDRA DQA("129Xe119Sn50", "INDRA_camp1")
kaliveda [3] DQA.do_report()
KVDataQualityAuditReporting_INDRA
Prepare PDF report on data quality audits for INDRA experiments.
Definition: KVDataQualityAuditReporting_INDRA.h:28
KVDataQualityAuditReporting_INDRA::do_report
void do_report()
Definition: KVDataQualityAuditReporting_INDRA.cpp:31

Many useful informations will also be printed in the terminal as the PDF is generated, don't forget to read them.

Each page in the PDF file is given a title which appears in the 'Outline' which can be used in a PDF viewer in order to navigate within the file.

Definition at line 28 of file KVDataQualityAuditReporting_INDRA.h.

#include <KVDataQualityAuditReporting_INDRA.h>

Inheritance diagram for KVDataQualityAuditReporting_INDRA:
Inheritance graph
[legend]

Public Member Functions

 KVDataQualityAuditReporting_INDRA (const TString &audit_name, const TString &ds_name)
 
void do_report ()
 
void INDRA_ring_mean_A_vs_Z (int ring, const TString &idtype, int &pad, int nx, int ny)
 
void INDRA_ring_reporting_Z (int ring, const TString &idtype)
 
void INDRA_ring_Z_threshold_vs_Z (int ring, const TString &idtype, int &pad, int nx, int ny)
 
- 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...
 
void Error (const char *method, const char *msgfmt,...) const override
 
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...
 
void Print (Option_t *option="") const override
 
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)
 
void Warning (const char *method, const char *msgfmt,...) const override
 
- 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 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 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 Types

enum class  canvas_t { kLandscape , kPortrait }
 

Private Member Functions

void draw_sidebar_legend ()
 
void fill_list_of_telescopes (const TString &idtype, TList &tels, int ring)
 
std::pair< int, int > get_layout (size_t ntels)
 
int get_mod_set (int nmods)
 24 => 4 sets of 6, 16 => 2 sets of 8, 12 => 4 sets of 3, 8 => 1 set of 8 More...
 
void make_canvas (canvas_t style=canvas_t::kLandscape)
 Make an A4-size canvas. More...
 

Private Attributes

TString current_page
 
TString dataset_name
 
const KVDataQualityAudit * fAudit
 
KVDataQualityAuditReportMaker fReport
 
TString indra_csi_idtype = "CSI_R_L"
 
std::vector< int > markers {20, 24, 21, 25, 34, 28, 47, 46, 45, 44, 29, 30, 43, 42, 22, 26, 23, 32}
 
TCanvas * myCanvas
 

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
 

Member Enumeration Documentation

◆ canvas_t

enum KVDataQualityAuditReporting_INDRA::canvas_t
strongprivate
Enumerator
kLandscape 
kPortrait 

Definition at line 33 of file KVDataQualityAuditReporting_INDRA.h.

Constructor & Destructor Documentation

◆ KVDataQualityAuditReporting_INDRA()

KVDataQualityAuditReporting_INDRA::KVDataQualityAuditReporting_INDRA ( const TString &  audit_name,
const TString &  ds_name 
)
inline
Parameters
audit_namename of data quality audit to analyse
ds_namename of dataset

Definition at line 57 of file KVDataQualityAuditReporting_INDRA.h.

Member Function Documentation

◆ do_report()

void KVDataQualityAuditReporting_INDRA::do_report ( )

Definition at line 31 of file KVDataQualityAuditReporting_INDRA.cpp.

◆ draw_sidebar_legend()

void KVDataQualityAuditReporting_INDRA::draw_sidebar_legend ( )
private

=========Macro generated from canvas: c1/c1 ========= (Tue Jul 27 11:21:28 2021) by ROOT version 6.24/02

Definition at line 342 of file KVDataQualityAuditReporting_INDRA.cpp.

◆ fill_list_of_telescopes()

void KVDataQualityAuditReporting_INDRA::fill_list_of_telescopes ( const TString &  idtype,
TList &  tels,
int  ring 
)
private

Definition at line 147 of file KVDataQualityAuditReporting_INDRA.cpp.

◆ get_layout()

std::pair<int, int> KVDataQualityAuditReporting_INDRA::get_layout ( size_t  ntels)
inlineprivate

Definition at line 44 of file KVDataQualityAuditReporting_INDRA.h.

◆ get_mod_set()

int KVDataQualityAuditReporting_INDRA::get_mod_set ( int  nmods)
private

24 => 4 sets of 6, 16 => 2 sets of 8, 12 => 4 sets of 3, 8 => 1 set of 8

Definition at line 221 of file KVDataQualityAuditReporting_INDRA.cpp.

◆ INDRA_ring_mean_A_vs_Z()

void KVDataQualityAuditReporting_INDRA::INDRA_ring_mean_A_vs_Z ( int  ring,
const TString &  idtype,
int &  pad,
int  nx,
int  ny 
)

Definition at line 164 of file KVDataQualityAuditReporting_INDRA.cpp.

◆ INDRA_ring_reporting_Z()

void KVDataQualityAuditReporting_INDRA::INDRA_ring_reporting_Z ( int  ring,
const TString &  idtype 
)

Definition at line 117 of file KVDataQualityAuditReporting_INDRA.cpp.

◆ INDRA_ring_Z_threshold_vs_Z()

void KVDataQualityAuditReporting_INDRA::INDRA_ring_Z_threshold_vs_Z ( int  ring,
const TString &  idtype,
int &  pad,
int  nx,
int  ny 
)

Definition at line 249 of file KVDataQualityAuditReporting_INDRA.cpp.

◆ make_canvas()

void KVDataQualityAuditReporting_INDRA::make_canvas ( canvas_t  style = canvas_t::kLandscape)
private

Make an A4-size canvas.

Definition at line 17 of file KVDataQualityAuditReporting_INDRA.cpp.

Member Data Documentation

◆ current_page

TString KVDataQualityAuditReporting_INDRA::current_page
private

Definition at line 40 of file KVDataQualityAuditReporting_INDRA.h.

◆ dataset_name

TString KVDataQualityAuditReporting_INDRA::dataset_name
private

Definition at line 53 of file KVDataQualityAuditReporting_INDRA.h.

◆ fAudit

const KVDataQualityAudit* KVDataQualityAuditReporting_INDRA::fAudit
private

Definition at line 30 of file KVDataQualityAuditReporting_INDRA.h.

◆ fReport

KVDataQualityAuditReportMaker KVDataQualityAuditReporting_INDRA::fReport
private

Definition at line 29 of file KVDataQualityAuditReporting_INDRA.h.

◆ indra_csi_idtype

TString KVDataQualityAuditReporting_INDRA::indra_csi_idtype = "CSI_R_L"
private

Definition at line 53 of file KVDataQualityAuditReporting_INDRA.h.

◆ markers

std::vector<int> KVDataQualityAuditReporting_INDRA::markers {20, 24, 21, 25, 34, 28, 47, 46, 45, 44, 29, 30, 43, 42, 22, 26, 23, 32}
private

Definition at line 42 of file KVDataQualityAuditReporting_INDRA.h.

◆ myCanvas

TCanvas* KVDataQualityAuditReporting_INDRA::myCanvas
private

Definition at line 32 of file KVDataQualityAuditReporting_INDRA.h.