[u/mrichter/AliRoot.git] / TPC / TPCmon / macros / TPCMonitorReadMe.txt

////////////// "Usage of the program" ///////////////////////////////////////////////////////////////////////////////

Start of the program:

1. Start aliroot in graphical mode 

2. If monitoring library is not linked to aliroot 
   
       - Load monitoring library from $ALICE_ROOT/lib directory
         gSystem->Load("./lib/tgt_linux/libTPCmon.so")

   Exectute TPCMonitor macro
   .x ${ALICE_ROOT}/Monitor/macros/TPCMonitor.C   	 

// Features of the program /////////////////////////////////////////////////////////////////////////////////////////

1. 'Select Format' Only DATE File and ROOT raw data format are supported by default 
                   If DATE is installed on this machine also online monitoring of raw data is supported
2. 'Select File'   Type filename to be processed.
3. 'Next Event'   (Second last Button): Next EventId to be processed (can be changed to access specific EventId)
                                        The first few events in a file might not be readable --> Go to next event


////////////// "Global view"

Two canvases will pop up showing a global pitcure of the Max adc values for each pad.


Double clicking on one of the sectors in the global canvases will make the corresponding 
IROC and OROC views pop up for the same event.
This can also be achieved by clicking on the corresponding sector button.

'Sector 0' - 'Sector 17'

////////////// "ROC view"

In addition, a pad view for the "Max Adc" for IROC and OROC will pop up.

-Moving with the mouse over a pad in those canvases will make a the 
 time distribution for the pad pop up.

-Double clicking on one of the pads will make a row profile pop up.
 1. Row profile showing Max adc values.
 2. Y-profile for the given position of the pad.
 3  Pad vs. time for all pads in the row.


////////////// "Further options"
 
For a single channel :

'FFT'              : Shows Fourier Transformation.
'Write Channel '   : Writes adc values for channel to ASCII and ROOT (Histogramm) file.

For a sector:

'Show Component'   : Shows only selected components in the "Max Adc" view for a sector.
'Show RMS map'     : Shows pad view for Baseline RMS for IROC and OROC and further distributions.


The Ranges for the calculation of the max adc value and the determination of the baseline can be configured with 

'Conf. Ranges'

The Pedestal calculation is done online by a truncated mean and can be disabled

'Calc BSL (onl)'
'No BSL sub.'

By default a Gamma4 fit is performed to peaks in the time profile for a channel. This can be disabled.

'Disable G4-fit'

For debugging purposes the payload (10bit words format) for each equipment can be written to a file 

'Write 10bit'

The main window size which also determines the canvas sizes can be changed in

${ALICE_ROOT}/TPC/Monitor/AliTPCMonitorConfig.txt
Commit	Line	Data
48265b32	1	////////////// "Usage of the program" ///////////////////////////////////////////////////////////////////////////////
	2
	3	Start of the program:
	4
	5	1. Start aliroot in graphical mode
	6
	7	2. If monitoring library is not linked to aliroot
	8
	9	- Load monitoring library from $ALICE_ROOT/lib directory
	10	gSystem->Load("./lib/tgt_linux/libTPCmon.so")
	11
	12	Exectute TPCMonitor macro
01300a18	13	.x ${ALICE_ROOT}/Monitor/macros/TPCMonitor.C
48265b32	14
	15	// Features of the program /////////////////////////////////////////////////////////////////////////////////////////
	16
	17	1. 'Select Format' Only DATE File and ROOT raw data format are supported by default
	18	If DATE is installed on this machine also online monitoring of raw data is supported
	19	2. 'Select File' Type filename to be processed.
	20	3. 'Next Event' (Second last Button): Next EventId to be processed (can be changed to access specific EventId)
	21	The first few events in a file might not be readable --> Go to next event
	22
	23
	24	////////////// "Global view"
	25
	26	Two canvases will pop up showing a global pitcure of the Max adc values for each pad.
	27
	28
	29	Double clicking on one of the sectors in the global canvases will make the corresponding
	30	IROC and OROC views pop up for the same event.
	31	This can also be achieved by clicking on the corresponding sector button.
	32
	33	'Sector 0' - 'Sector 17'
	34
	35	////////////// "ROC view"
	36
	37	In addition, a pad view for the "Max Adc" for IROC and OROC will pop up.
	38
	39	-Moving with the mouse over a pad in those canvases will make a the
	40	time distribution for the pad pop up.
	41
	42	-Double clicking on one of the pads will make a row profile pop up.
	43	1. Row profile showing Max adc values.
	44	2. Y-profile for the given position of the pad.
	45	3 Pad vs. time for all pads in the row.
	46
	47
	48	////////////// "Further options"
	49
	50	For a single channel :
	51
	52	'FFT' : Shows Fourier Transformation.
	53	'Write Channel ' : Writes adc values for channel to ASCII and ROOT (Histogramm) file.
	54
	55	For a sector:
	56
	57	'Show Component' : Shows only selected components in the "Max Adc" view for a sector.
	58	'Show RMS map' : Shows pad view for Baseline RMS for IROC and OROC and further distributions.
	59
	60
	61	The Ranges for the calculation of the max adc value and the determination of the baseline can be configured with
	62
	63	'Conf. Ranges'
	64
	65	The Pedestal calculation is done online by a truncated mean and can be disabled
	66
	67	'Calc BSL (onl)'
	68	'No BSL sub.'
	69
	70	By default a Gamma4 fit is performed to peaks in the time profile for a channel. This can be disabled.
	71
	72	'Disable G4-fit'
	73
	74	For debugging purposes the payload (10bit words format) for each equipment can be written to a file
	75
	76	'Write 10bit'
	77
78	The main window size which also determines the canvas sizes can be changed in
79
01300a18	80	${ALICE_ROOT}/TPC/Monitor/AliTPCMonitorConfig.txt