TrackerLevel2/inc/TrkParams.h

/**
 * \file TrkParams.h
 * \author Elena Vannuccini
 */
#ifndef trkparams_h
#define trkparams_h

#include <TObject.h>
#include <TString.h>
#include <TSQLServer.h>
#include <TSystem.h>
#include <TROOT.h> // EMILIANO: needed to compile with ROOT > 5.16/x

#include <GLTables.h>
#include <TrkStruct.h>
#include <TrkCalib.h>

#define NTYPES 10

/**
 * \brief Class to store tracker parameter information
 * 
 * Tracker parameters include calibration parameters (PED, SIG and BAD), 
 * parameters loaded from DB (alignment, ADC-to-mip, etc. ) and some parameters 
 * to configure tracker processing (PFA, ecc...).
 *
 * Calibrations can be either those evaluated online or default values.
 * External parameter are labelled according to the DB convention:
 *
 * type  description
 * -----------------
 * 1     field
 * 2     adc-to-mip
 * 3     charge-correlation
 * 4     p.f.a. (eta)
 * 5     alignment
 * 6     VA1 mask
 * 7     default calibration
 *
 * Internal parameters are initialized to default values 
*
 * TrkParams::SetCalib(...) and TrkParams::Set(...) methods allow to set 
 * required parameters, from an input path, from the DB (for a given input 
 * run id) and from environment variable PAM_CALIB.
 * TrkParams::LoadCalib() and TrkParams::Load() methods load parameters into
 * F77 common. 
 * 
 * Tracker libraries (TrkLevel0, TrkLevel1 and TrkLevel2) implement automatic
 * setting (either from DB or from environment variables) and loading of parameters.
 * If one needs to load custom parameters, it is enough to call TrkParams::Set(...)
 * with proper arguments. All the methods are static, and can be used as standalone functions. 
 *
 * For example: 
 *
 * TrkParams::Set("/param-path/new-mip-param/",2);
 * 
 * After this instruction (to be called once), new adc-to-mip conversion parameters 
 * will be loaded automatically (once) and used until the next set instruction 
 */
class TrkParams : public TObject {

private:
        
    static Int_t GetIndex( UInt_t type );

public:

    // ---------------------------------------------
    // variables to store loaded-calibration info
    // ---------------------------------------------
    static GL_TRK_CALIB calib; 
    static TString      calibpatht; //truncated
    static TString      calibpathf; //full
    static Bool_t       calib104;
    static Bool_t       calibload;
    // ---------------------------------------------
    // variables to store loaded-parameters info
    // ---------------------------------------------
    static UInt_t    trkparamtype[NTYPES];
    static GL_PARAM  gl[NTYPES]; 
    static TString   glpath[NTYPES];
    static Bool_t    glload[NTYPES];
    // -----------------------------------------------
    // some parameters to configure tracker processing
    // -----------------------------------------------
    static int init__pfa;
    static int init__mini_trackmode;
    static int init__mini_istepmin;
    static double init__mini_fact;
    static cDbg init__dbg_mode; //debug mode (for both c++ and F77 roiutines)
    static float init__pfa_e234ax[6]; // angle intervals for eta2-3-4
    static float init__pfa_e234ay[6]; // angle intervals for eta2-3-4

    TrkParams();
    
   
    // ---------------------------------------------
    // calibration (PED-SIG-BAD)
    // ---------------------------------------------
    static Bool_t SetCalib( GL_RUN* , TSQLServer*  );
    static Bool_t LoadCalib( );
    static Bool_t CalibIsLoaded(){ return calibload; };
    static UInt_t ValidateTrkCalib( CalibTrk1Event* );
    static void FillFCalibFrom(TFile* , Int_t , Int_t );//full
    static void FillTCalibFrom(TFile* , Int_t , Int_t );//truncated
    static void FillTCalibFrom(TString path);
    static void FillACalibFrom(TFile* , Int_t , Int_t );//all
    static void FillMask(TFile* , Int_t , Int_t );

    // ---------------------------------------------
    // parameters
    // ---------------------------------------------
    static Bool_t Set( GL_RUN* glrun, TSQLServer* dbc, UInt_t type);
    static Bool_t Set( GL_RUN* glrun, TSQLServer* dbc){ 
        for(Int_t i=0; i<NTYPES; i++) 
            if( !TrkParams::Set(glrun,dbc,trkparamtype[i]) )return false; 
        return true; 
    };
    static Bool_t Set( TString, UInt_t );
    static Bool_t Set( UInt_t );
    static Bool_t Set( );
    static Bool_t Load( UInt_t );
    static Bool_t Load( );
    static Bool_t IsLoaded( UInt_t type ){return glload[TrkParams::GetIndex(type)];};
    static Bool_t IsLoaded( );

    // ---------------------------------------------
    // retrieve parameters
    // ---------------------------------------------
    static float GetBX(float*);
    static float GetBY(float*);
    static float GetBZ(float*);
    static float GetResolution(int,float);
    static int   GetPFA(){return sw_.pfaid;};

    // ---------------------------------------------
    // debug mode 
    // ---------------------------------------------

    static void SetDebugMode()  {init__dbg_mode.SetDebug();   dbg_=init__dbg_mode;};
    static void SetVerboseMode(){init__dbg_mode.SetVerbose(); dbg_=init__dbg_mode;};
    static void SetWarningMode(){init__dbg_mode.SetWarning(); dbg_=init__dbg_mode;};    
    static void SetQuietMode()  {init__dbg_mode.SetNone();    dbg_=init__dbg_mode;};    
    static Bool_t DebugMode(){return init__dbg_mode.debug;};
    static Bool_t WarningMode(){return init__dbg_mode.warning;};
    static Bool_t VerboseMode(){return init__dbg_mode.verbose;};

    // ------------------------------------------------
    // alcuni metodi che non sapevo dove mettere 
    // per inizializzare alcune variabili in F77 common
    // ------------------------------------------------     
    // set to default values
    static void SetTrackingMode()   {track_.trackmode = init__mini_trackmode;};
    static void SetPrecisionFactor(){track_.fact      = init__mini_fact;     };
    static void SetStepMin()        {track_.istepmin  = init__mini_istepmin; };
    // set to custom values
    static void SetTrackingMode(int);
    static void SetPrecisionFactor(double);
    static void SetStepMin(int);
    static void SetPFA(int);
    static void SetPFA(float *);
    static void SetPFA(void);
    
    // ---------------------------------------------
    // varie ed eventuali...
    // ---------------------------------------------
    static TSQLServer* SetDBConnection();


    ClassDef(TrkParams,2);

};

#endif

1	pam-fi	1.1	/**
2			* \file TrkParams.h
3			* \author Elena Vannuccini
4			*/
5			#ifndef trkparams_h
6			#define trkparams_h
7
8			#include <TObject.h>
9			#include <TString.h>
10			#include <TSQLServer.h>
11			#include <TSystem.h>
12	mocchiut	1.9	#include <TROOT.h> // EMILIANO: needed to compile with ROOT > 5.16/x
13	pam-fi	1.1
14			#include <GLTables.h>
15			#include <TrkStruct.h>
16			#include <TrkCalib.h>
17
18			#define NTYPES 10
19
20			/**
21			* \brief Class to store tracker parameter information
22			*
23	pam-fi	1.5	* Tracker parameters include calibration parameters (PED, SIG and BAD),
24			* parameters loaded from DB (alignment, ADC-to-mip, etc. ) and some parameters
25			* to configure tracker processing (PFA, ecc...).
26			*
27			* Calibrations can be either those evaluated online or default values.
28			* External parameter are labelled according to the DB convention:
29	pam-fi	1.2	*
30			* type description
31			* -----------------
32			* 1 field
33			* 2 adc-to-mip
34			* 3 charge-correlation
35			* 4 p.f.a. (eta)
36			* 5 alignment
37			* 6 VA1 mask
38			* 7 default calibration
39			*
40	pam-fi	1.5	* Internal parameters are initialized to default values
41	pam-fi	1.7	*
42	pam-fi	1.2	* TrkParams::SetCalib(...) and TrkParams::Set(...) methods allow to set
43			* required parameters, from an input path, from the DB (for a given input
44			* run id) and from environment variable PAM_CALIB.
45			* TrkParams::LoadCalib() and TrkParams::Load() methods load parameters into
46			* F77 common.
47			*
48			* Tracker libraries (TrkLevel0, TrkLevel1 and TrkLevel2) implement automatic
49	pam-fi	1.4	* setting (either from DB or from environment variables) and loading of parameters.
50	pam-fi	1.2	* If one needs to load custom parameters, it is enough to call TrkParams::Set(...)
51			* with proper arguments. All the methods are static, and can be used as standalone functions.
52			*
53			* For example:
54			*
55			* TrkParams::Set("/param-path/new-mip-param/",2);
56			*
57			* After this instruction (to be called once), new adc-to-mip conversion parameters
58			* will be loaded automatically (once) and used until the next set instruction
59	pam-fi	1.1	*/
60			class TrkParams : public TObject {
61
62			private:
63
64			static Int_t GetIndex( UInt_t type );
65
66			public:
67
68			// ---------------------------------------------
69			// variables to store loaded-calibration info
70			// ---------------------------------------------
71			static GL_TRK_CALIB calib;
72			static TString calibpatht; //truncated
73			static TString calibpathf; //full
74			static Bool_t calib104;
75			static Bool_t calibload;
76			// ---------------------------------------------
77			// variables to store loaded-parameters info
78			// ---------------------------------------------
79			static UInt_t trkparamtype[NTYPES];
80			static GL_PARAM gl[NTYPES];
81			static TString glpath[NTYPES];
82			static Bool_t glload[NTYPES];
83	pam-fi	1.5	// -----------------------------------------------
84			// some parameters to configure tracker processing
85			// -----------------------------------------------
86			static int init__pfa;
87			static int init__mini_trackmode;
88			static int init__mini_istepmin;
89			static double init__mini_fact;
90	pam-fi	1.7	static cDbg init__dbg_mode; //debug mode (for both c++ and F77 roiutines)
91	pam-fi	1.8	static float init__pfa_e234ax[6]; // angle intervals for eta2-3-4
92			static float init__pfa_e234ay[6]; // angle intervals for eta2-3-4
93
94	pam-fi	1.1	TrkParams();
95
96	pam-fi	1.10
97	pam-fi	1.1	// ---------------------------------------------
98			// calibration (PED-SIG-BAD)
99			// ---------------------------------------------
100			static Bool_t SetCalib( GL_RUN* , TSQLServer* );
101			static Bool_t LoadCalib( );
102			static Bool_t CalibIsLoaded(){ return calibload; };
103	pam-fi	1.3	static UInt_t ValidateTrkCalib( CalibTrk1Event* );
104	pam-fi	1.1	static void FillFCalibFrom(TFile* , Int_t , Int_t );//full
105			static void FillTCalibFrom(TFile* , Int_t , Int_t );//truncated
106			static void FillTCalibFrom(TString path);
107			static void FillACalibFrom(TFile* , Int_t , Int_t );//all
108			static void FillMask(TFile* , Int_t , Int_t );
109
110			// ---------------------------------------------
111			// parameters
112			// ---------------------------------------------
113			static Bool_t Set( GL_RUN* glrun, TSQLServer* dbc, UInt_t type);
114			static Bool_t Set( GL_RUN* glrun, TSQLServer* dbc){
115			for(Int_t i=0; i<NTYPES; i++)
116			if( !TrkParams::Set(glrun,dbc,trkparamtype[i]) )return false;
117			return true;
118			};
119			static Bool_t Set( TString, UInt_t );
120			static Bool_t Set( UInt_t );
121			static Bool_t Set( );
122			static Bool_t Load( UInt_t );
123			static Bool_t Load( );
124			static Bool_t IsLoaded( UInt_t type ){return glload[TrkParams::GetIndex(type)];};
125			static Bool_t IsLoaded( );
126
127	pam-fi	1.5	// ---------------------------------------------
128			// retrieve parameters
129			// ---------------------------------------------
130			static float GetBX(float*);
131			static float GetBY(float*);
132			static float GetBZ(float*);
133	pam-fi	1.6	static float GetResolution(int,float);
134	pam-fi	1.8	static int GetPFA(){return sw_.pfaid;};
135	pam-fi	1.4
136			// ---------------------------------------------
137			// debug mode
138			// ---------------------------------------------
139
140	pam-fi	1.7	static void SetDebugMode() {init__dbg_mode.SetDebug(); dbg_=init__dbg_mode;};
141			static void SetVerboseMode(){init__dbg_mode.SetVerbose(); dbg_=init__dbg_mode;};
142			static void SetWarningMode(){init__dbg_mode.SetWarning(); dbg_=init__dbg_mode;};
143			static void SetQuietMode() {init__dbg_mode.SetNone(); dbg_=init__dbg_mode;};
144			static Bool_t DebugMode(){return init__dbg_mode.debug;};
145			static Bool_t WarningMode(){return init__dbg_mode.warning;};
146			static Bool_t VerboseMode(){return init__dbg_mode.verbose;};
147	pam-fi	1.4
148	pam-fi	1.5	// ------------------------------------------------
149			// alcuni metodi che non sapevo dove mettere
150			// per inizializzare alcune variabili in F77 common
151			// ------------------------------------------------
152			// set to default values
153			static void SetTrackingMode() {track_.trackmode = init__mini_trackmode;};
154			static void SetPrecisionFactor(){track_.fact = init__mini_fact; };
155			static void SetStepMin() {track_.istepmin = init__mini_istepmin; };
156			// set to custom values
157			static void SetTrackingMode(int);
158			static void SetPrecisionFactor(double);
159			static void SetStepMin(int);
160			static void SetPFA(int);
161	pam-fi	1.8	static void SetPFA(float *);
162			static void SetPFA(void);
163	pam-fi	1.5
164	pam-fi	1.10	// ---------------------------------------------
165			// varie ed eventuali...
166			// ---------------------------------------------
167			static TSQLServer* SetDBConnection();
168
169
170	pam-fi	1.4	ClassDef(TrkParams,2);
171	pam-fi	1.1
172			};
173
174			#endif
175