2 // $Id: AliHLTCaloClusterizerComponent.h 36636 2009-11-11 02:16:41Z odjuvsla $
5 /**************************************************************************
6 * This file is property of and copyright by the ALICE HLT Project *
7 * All rights reserved. *
9 * Primary Authors: Oystein Djuvsland *
11 * Permission to use, copy, modify and distribute this software and its *
12 * documentation strictly for non-commercial purposes is hereby granted *
13 * without fee, provided that the above copyright notice appears in all *
14 * copies and that both the copyright notice and this permission notice *
15 * appear in the supporting documentation. The authors make no claims *
16 * about the suitability of this software for any purpose. It is *
17 * provided "as is" without express or implied warranty. *
18 **************************************************************************/
20 #ifndef ALIHLTCALOCLUSTERIZERCOMPONENT_H
21 #define ALIHLTCALOCLUSTERIZERCOMPONENT_H
26 * Clusterizer component for PHOS HLT
28 * @file AliHLTCaloClusterizerComponent.h
29 * @author Oystein Djuvsland
31 * @brief A clusterizer component for PHOS HLT
34 // see below for class documentation
36 // refer to README to build package
38 // visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
40 #include "AliHLTCaloConstantsHandler.h"
41 #include "AliHLTCaloProcessor.h"
43 class AliHLTCaloRecoParamHandler;
44 class AliHLTCaloDigitDataStruct;
45 class AliHLTCaloDigitContainerDataStruct;
46 class AliHLTCaloClusterizer;
47 class AliHLTCaloClusterAnalyser;
48 class AliHLTCaloRecPointDataStruct;
49 class AliHLTPHOSHistoProdClusterEnergy;
52 * @class AliHLTCaloClusterizerComponent
54 * Class for running clusterization for PHOS in HLT. It takes digits as input and
55 * gives reconstruction points as output.
57 * The component has the following component arguments:
58 * -clusterthreshold The energy threshold for starting a new rec point
59 * -energythreshold The energy threshold for including a digit in a
61 * @ingroup alihlt_phos
65 * @class AliHLTCaloClusterizerComponent
67 * Class for running clusterization for PHOS in HLT.
69 * <h2>General properties:</h2>
71 * Component ID: \b PhosClusterizer <br>
72 * Library: \b libAliHLTPHOS.so <br>
73 * Input Data Types: @ref AliHLTPHOSDefinitions::fgkDigitDataType<br>
74 * Output Data Types: @ref AliHLTPHOSDefinitions::fgkRecPointDataType<br>
76 * <h2>Mandatory arguments:</h2>
77 * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting -->
78 * \li No mandatory arguments for component <br>
80 * <h2>Optional arguments:</h2>
81 * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting -->
82 * \li -digitthreshold <i> value </i> <br>
83 * threshold for a digit to be added to a rec point in GeV (default value: 0.03)
84 * \li -recpointthreshold <i> value </i> <br>
85 * threshold for starting a new rec point (default value: 0.2)
87 * if we want to do clusterisation on the partition level (not available...) (defaul value: false)
89 * <h2>Configuration:</h2>
90 * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting -->
91 * \li No configuration arguments
93 * <h2>Default CDB entries:</h2>
94 * \li No CDB entry yet, will come.
96 * <h2>Performance:</h2>
97 * Pretty good (~ 3 kHz), depends on amount of data...
99 * <h2>Memory consumption:</h2>
100 * Depends on the amount of data, but pretty godd
102 * <h2>Output size:</h2>
103 * Depends on the amount of data...
105 * More detailed description. (At some point...)
107 * @ingroup alihlt_phos
110 //class AliHLTCaloClusterizerComponent : public AliHLTCaloConstantsHandler, public AliHLTCaloProcessor
111 class AliHLTCaloClusterizerComponent : public AliHLTCaloProcessor, public AliHLTCaloConstantsHandler
116 AliHLTCaloClusterizerComponent(TString det);
119 virtual ~AliHLTCaloClusterizerComponent();
121 /** interface function, see @ref AliHLTComponent for description */
123 using AliHLTCaloProcessor::DoEvent;
125 int DoEvent ( const AliHLTComponentEventData& evtData, const AliHLTComponentBlockData* blocks,
126 AliHLTComponentTriggerData& trigData, AliHLTUInt8_t* outputPtr, AliHLTUInt32_t& size,
127 std::vector<AliHLTComponentBlockData>& outputBlocks );
130 * Compare two digits, used during the sorting
132 static Int_t CompareDigits(const void *dig0, const void *dig);
136 /** interface function, see @ref AliHLTComponent for
138 virtual int DoInit ( int argc, const char** argv );
140 /** interface function, see @ref AliHLTComponent for description */
141 virtual int DoDeinit();
143 /** Initialise geometry objects */
144 virtual Int_t InitialiseGeometry() = 0;
146 /** interface function, see @ref AliHLTComponent for description */
147 int Reconfigure ( const char* cdbEntry, const char* chainId );
149 /** interface function, see @ref AliHLTComponent for description */
150 int ScanConfigurationArgument ( int argc, const char** argv );
152 /** The data origin */
153 char* fDataOrigin; //COMMENT
155 /** Pointer to the cluster analyser */
156 AliHLTCaloClusterAnalyser *fAnalyserPtr; //! transient
158 /** Pointer to reconstruction parameters handler */
159 AliHLTCaloRecoParamHandler *fRecoParamsPtr; //! transient
163 /** Array of pointers to our digits */
164 AliHLTCaloDigitDataStruct **fDigitsPointerArray; //! transient
166 /** Array of pointers to our digits */
167 AliHLTCaloDigitDataStruct *fOutputDigitsArray; //! transient
169 /** Pointer to the clusterizer it self */
170 AliHLTCaloClusterizer* fClusterizerPtr; //! transient
172 /** Number of digits in event */
173 Int_t fDigitCount; //COMMENT
175 /** Copy digits to output? */
176 Bool_t fCopyDigitsToOuput; //COMMENT
179 /** Default constructor, not implemented */
180 AliHLTCaloClusterizerComponent(); //COMMENT
182 /** Copy constructor not implemented */
183 AliHLTCaloClusterizerComponent ( const AliHLTCaloClusterizerComponent &); // not implemented
186 AliHLTCaloClusterizerComponent & operator = ( const AliHLTCaloClusterizerComponent &); // not implemented
188 ClassDef(AliHLTCaloClusterizerComponent, 0);