[u/mrichter/AliRoot.git] / TOF / README

    README file for ALICE Time Of Flight Detector Oflfine Code
    ==========================================================

Intorduction
------------

This is a short overview of the TOF code within the AliROOT framework.


Structure
---------

There are 3 libraries build for the TOF. These are 

* libTOFbase:
  This contains the basic stuff, like data classes and managers. 

* libTOFsim: 
  This contains code used by the simulation only. This includes the
  detector class, AliTOF, and its derivatives. It also contains the
  code for building the geometry, as well as the (s)digitisers, raw
  data writer, QA checker and data containers.

* libTOFrec:
  Code needed for the reconstruction. This includes the reconstruction
  code itself, as well as cluster and track containers and QA checker.

The content of these libraries is detailed more below. 

libTOFbase:
-----------

Till today (February 6th 2008), it contains the following classes

  AliTOFGeometry:
	Manager of TOF geometry data. All code queries this manager
	for geometry parameters, so that the data are always consistent. 
  
  AliTOFdigit
  AliTOFrawData
  AliTOFHitData
  AliTOFHitDataBuffer
	Base classes for digits and real digits. They are all data
        classes that hold the TOT and TOF values for a single sensitive
        TOF element.

  AliTOFChannelOffline
  AliTOFChannelOnline
  AliTOFChannelOnlineStatus
  AliTOFcalib
  AliTOFDataDCS
  AliTOFFormatDCS:
	Calibration data classes.

  AliTOFRawMap:
	A map of (AliTOFrawData) indices.
        The AliTOFRawStream class uses this map to store raw data
        before making digits or clusters.

  AliTOFDecoder
  AliTOFRawStream:
	Classes to read raw data files.

  AliTOFAlignment:

  AliTOFPreprocessor
  AliTOFPreprocessorFDR:

libTOFsim:
----------

Till today (February 6th 2008), it contains the following classes

  AliTOF:
	Manager for all TOF simulation code.

  AliTOFv5T0
  AliTOFv6T0:
	Simulation drivers for the TOF detector.
	AliTOFv5T0 corresponds to a simulation where services are not
        completly described
        AliTOFv6T0 contains a more detailed description of all TOF
        detector components.

  AliTOFhit
  AliTOFhitT0:
	Base classes for hits. They hold the geometrical and physical
        informations of a single sensitive TOF element, like the ALICE
        coordinates, the detector indices, i.e. 5 integer numbers
        (sector, module, strip, par-row and pad numbers), the hit
        coordinates in the pad reference system and the
        time-of-flight measurement. Moreover, they hold also some
        additional measurements, like the momentum components, the
        energy loss in the sensitive TOF element and the track incident
        angle on the pad. Only the AliTOFhitT0 object contains also
        the track length measurement.

  AliTOFSDigit:
	Base classes for sdigits. They hold the TOF detector informations,
        like the detector indices, i.e. 5 integer numbers
        (sector, module, strip, par-row and pad numbers), the
        time-of-flight and the time-over-threshold informations
        according to the test beam results.
	Each detector element can record more than one sdigit (but
        not more than 3).

  AliTOFSDigitizer
  AliTOFDigitizer:
	Base class for the (s)digitiser. AliTOFSDigitizer makes
	summable digits (AliTOFSDigit) from hits, and AliTOFDigitizer
        makes digits (quasi real data) from summable digits.

  AliTOFHitMap
	A map of (AliTOFSDigit) indices.
        The AliTOFSDigitizer uses this map to store simulation data
        (i.e. hits) before making sdigits.

  AliTOFDigitMap:
	A map of (AliTOFdigit) indices.
        The AliDDLRawData uses this map to store the TOF digits indices
        before making real digits (i.e. raw data).

  AliTOFDDLRawData:
	Base class for digit-to-raw_data transformation.
        It makes raw data from digits: practically, it transforms the
        5 detector indices (sector, module, strip, pad-row and pad numbers)
	in hardware address, consisting of 5 induces (TOF readout
        module, slot, chain, TDC and channel numbers).

  AliTOFT0:

  AliTOFTrigger:

  AliTOFQAChecker
  AliTOFQADataMakerSim


libTOFrec:
----------

Till today (February 6th 2008), it contains the following classes

  AliTOFRecoParam:

  AliTOFReconstructor:

  AliTOFcluster:
	Reconstructed point in the TOF. These objects are made
	AliTOFReconstructor. 

  AliTOFClusterFinder:

  AliTOFtrack:
	Base classe for TOF tracks. It holds ...

  AliTOFtracker
  AliTOFtrackerMI
  AliTOFtrackerV1:
        

  AliTOFpidESD:

  AliTOFQADataMakerRec:


Authors:
--------

       Annalisa De Caro      <decaro@sa.infn.it>

----------------------------------------------------------------------
Local Variables:
	mode: text
End:
Commit	Line	Data
	1	README file for ALICE Time Of Flight Detector Oflfine Code
	2	==========================================================
	3
	4	Intorduction
	5	------------
	6
	7	This is a short overview of the TOF code within the AliROOT framework.
	8
	9
	10	Structure
	11	---------
	12
	13	There are 3 libraries build for the TOF. These are
	14
	15	* libTOFbase:
	16	This contains the basic stuff, like data classes and managers.
	17
	18	* libTOFsim:
	19	This contains code used by the simulation only. This includes the
	20	detector class, AliTOF, and its derivatives. It also contains the
	21	code for building the geometry, as well as the (s)digitisers, raw
	22	data writer, QA checker and data containers.
	23
	24	* libTOFrec:
	25	Code needed for the reconstruction. This includes the reconstruction
	26	code itself, as well as cluster and track containers and QA checker.
	27
	28	The content of these libraries is detailed more below.
	29
	30	libTOFbase:
	31	-----------
	32
	33	Till today (February 6th 2008), it contains the following classes
	34
	35	AliTOFGeometry:
	36	Manager of TOF geometry data. All code queries this manager
	37	for geometry parameters, so that the data are always consistent.
	38
	39	AliTOFdigit
	40	AliTOFrawData
	41	AliTOFHitData
	42	AliTOFHitDataBuffer
	43	Base classes for digits and real digits. They are all data
	44	classes that hold the TOT and TOF values for a single sensitive
	45	TOF element.
	46
	47	AliTOFChannelOffline
	48	AliTOFChannelOnline
	49	AliTOFChannelOnlineStatus
	50	AliTOFcalib
	51	AliTOFDataDCS
	52	AliTOFFormatDCS:
	53	Calibration data classes.
	54
	55	AliTOFRawMap:
	56	A map of (AliTOFrawData) indices.
	57	The AliTOFRawStream class uses this map to store raw data
	58	before making digits or clusters.
	59
	60	AliTOFDecoder
	61	AliTOFRawStream:
	62	Classes to read raw data files.
	63
	64	AliTOFAlignment:
	65
	66	AliTOFPreprocessor
	67	AliTOFPreprocessorFDR:
	68
	69	libTOFsim:
	70	----------
	71
	72	Till today (February 6th 2008), it contains the following classes
	73
	74	AliTOF:
	75	Manager for all TOF simulation code.
	76
	77	AliTOFv5T0
	78	AliTOFv6T0:
	79	Simulation drivers for the TOF detector.
	80	AliTOFv5T0 corresponds to a simulation where services are not
	81	completly described
	82	AliTOFv6T0 contains a more detailed description of all TOF
	83	detector components.
	84
	85	AliTOFhit
	86	AliTOFhitT0:
	87	Base classes for hits. They hold the geometrical and physical
	88	informations of a single sensitive TOF element, like the ALICE
	89	coordinates, the detector indices, i.e. 5 integer numbers
	90	(sector, module, strip, par-row and pad numbers), the hit
	91	coordinates in the pad reference system and the
	92	time-of-flight measurement. Moreover, they hold also some
	93	additional measurements, like the momentum components, the
	94	energy loss in the sensitive TOF element and the track incident
	95	angle on the pad. Only the AliTOFhitT0 object contains also
	96	the track length measurement.
	97
	98	AliTOFSDigit:
	99	Base classes for sdigits. They hold the TOF detector informations,
	100	like the detector indices, i.e. 5 integer numbers
	101	(sector, module, strip, par-row and pad numbers), the
	102	time-of-flight and the time-over-threshold informations
	103	according to the test beam results.
	104	Each detector element can record more than one sdigit (but
	105	not more than 3).
	106
	107	AliTOFSDigitizer
	108	AliTOFDigitizer:
	109	Base class for the (s)digitiser. AliTOFSDigitizer makes
	110	summable digits (AliTOFSDigit) from hits, and AliTOFDigitizer
	111	makes digits (quasi real data) from summable digits.
	112
	113	AliTOFHitMap
	114	A map of (AliTOFSDigit) indices.
	115	The AliTOFSDigitizer uses this map to store simulation data
	116	(i.e. hits) before making sdigits.
	117
	118	AliTOFDigitMap:
	119	A map of (AliTOFdigit) indices.
	120	The AliDDLRawData uses this map to store the TOF digits indices
	121	before making real digits (i.e. raw data).
	122
	123	AliTOFDDLRawData:
	124	Base class for digit-to-raw_data transformation.
	125	It makes raw data from digits: practically, it transforms the
	126	5 detector indices (sector, module, strip, pad-row and pad numbers)
	127	in hardware address, consisting of 5 induces (TOF readout
	128	module, slot, chain, TDC and channel numbers).
	129
	130	AliTOFT0:
	131
	132	AliTOFTrigger:
	133
	134	AliTOFQAChecker
	135	AliTOFQADataMakerSim
	136
	137
	138	libTOFrec:
	139	----------
	140
	141	Till today (February 6th 2008), it contains the following classes
	142
	143	AliTOFRecoParam:
	144
	145	AliTOFReconstructor:
	146
	147	AliTOFcluster:
	148	Reconstructed point in the TOF. These objects are made
	149	AliTOFReconstructor.
	150
	151	AliTOFClusterFinder:
	152
	153	AliTOFtrack:
	154	Base classe for TOF tracks. It holds ...
	155
	156	AliTOFtracker
	157	AliTOFtrackerMI
	158	AliTOFtrackerV1:
	159
	160
	161	AliTOFpidESD:
	162
	163	AliTOFQADataMakerRec:
	164
	165
	166	Authors:
	167	--------
	168
	169	Annalisa De Caro <decaro@sa.infn.it>
	170
	171	----------------------------------------------------------------------
	172	Local Variables:
	173	mode: text
	174	End: