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 AliHLTCaloDigitDataStruct;
44 class AliHLTCaloDigitContainerDataStruct;
45 class AliHLTCaloClusterizer;
46 class AliHLTCaloClusterAnalyser;
47 class AliHLTCaloRecPointDataStruct;
48 class AliHLTPHOSHistoProdClusterEnergy;
51 * @class AliHLTCaloClusterizerComponent
53 * Class for running clusterization for PHOS in HLT. It takes digits as input and
54 * gives reconstruction points as output.
56 * The component has the following component arguments:
57 * -clusterthreshold The energy threshold for starting a new rec point
58 * -energythreshold The energy threshold for including a digit in a
60 * @ingroup alihlt_phos
64 * @class AliHLTCaloClusterizerComponent
66 * Class for running clusterization for PHOS in HLT.
68 * <h2>General properties:</h2>
70 * Component ID: \b PhosClusterizer <br>
71 * Library: \b libAliHLTPHOS.so <br>
72 * Input Data Types: @ref AliHLTPHOSDefinitions::fgkDigitDataType<br>
73 * Output Data Types: @ref AliHLTPHOSDefinitions::fgkRecPointDataType<br>
75 * <h2>Mandatory arguments:</h2>
76 * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting -->
77 * \li No mandatory arguments for component <br>
79 * <h2>Optional arguments:</h2>
80 * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting -->
81 * \li -digitthreshold <i> value </i> <br>
82 * threshold for a digit to be added to a rec point in GeV (default value: 0.03)
83 * \li -recpointthreshold <i> value </i> <br>
84 * threshold for starting a new rec point (default value: 0.2)
86 * if we want to do clusterisation on the partition level (not available...) (defaul value: false)
88 * <h2>Configuration:</h2>
89 * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting -->
90 * \li No configuration arguments
92 * <h2>Default CDB entries:</h2>
93 * \li No CDB entry yet, will come.
95 * <h2>Performance:</h2>
96 * Pretty good (~ 3 kHz), depends on amount of data...
98 * <h2>Memory consumption:</h2>
99 * Depends on the amount of data, but pretty godd
101 * <h2>Output size:</h2>
102 * Depends on the amount of data...
104 * More detailed description. (At some point...)
106 * @ingroup alihlt_phos
109 //class AliHLTCaloClusterizerComponent : public AliHLTCaloConstantsHandler, public AliHLTCaloProcessor
110 class AliHLTCaloClusterizerComponent : public AliHLTCaloProcessor, public AliHLTCaloConstantsHandler
115 AliHLTCaloClusterizerComponent(TString det);
118 virtual ~AliHLTCaloClusterizerComponent();
120 // /** interface function, see @ref AliHLTComponent for description */
121 // void GetInputDataTypes ( std::vector<AliHLTComponentDataType>& list );
123 // /** interface function, see @ref AliHLTComponent for description */
124 // AliHLTComponentDataType GetOutputDataType();
126 // /** interface function, see @ref AliHLTComponent for description */
127 // void GetOutputDataSize ( unsigned long& constBase, double& inputMultiplier );
129 /** interface function, see @ref AliHLTComponent for description */
131 using AliHLTCaloProcessor::DoEvent;
133 int DoEvent ( const AliHLTComponentEventData& evtData, const AliHLTComponentBlockData* blocks,
134 AliHLTComponentTriggerData& trigData, AliHLTUInt8_t* outputPtr, AliHLTUInt32_t& size,
135 std::vector<AliHLTComponentBlockData>& outputBlocks );
138 * Compare two digits, used during the sorting
140 static Int_t CompareDigits(const void *dig0, const void *dig);
144 /** interface function, see @ref AliHLTComponent for
146 int DoInit ( int argc, const char** argv );
148 /** interface function, see @ref AliHLTComponent for description */
151 /** interface function, see @ref AliHLTComponent for description */
152 int Reconfigure ( const char* cdbEntry, const char* chainId );
154 /** interface function, see @ref AliHLTComponent for description */
155 int ScanConfigurationArgument ( int argc, const char** argv );
157 /** The data origin */
158 char* fDataOrigin; //COMMENT
160 /** Pointer to the cluster analyser */
161 AliHLTCaloClusterAnalyser *fAnalyserPtr; //! transient
165 /** Array of pointers to our digits */
166 AliHLTCaloDigitDataStruct **fDigitsPointerArray; //! transient
168 /** Array of pointers to our digits */
169 AliHLTCaloDigitDataStruct *fOutputDigitsArray; //! transient
171 /** Pointer to the clusterizer it self */
172 AliHLTCaloClusterizer* fClusterizerPtr; //! transient
174 /** Number of digits in event */
175 Int_t fDigitCount; //COMMENT
177 /** Default constructor, not implemented */
178 AliHLTCaloClusterizerComponent(); //COMMENT
180 /** Copy constructor not implemented */
181 AliHLTCaloClusterizerComponent ( const AliHLTCaloClusterizerComponent &); // not implemented
184 AliHLTCaloClusterizerComponent & operator = ( const AliHLTCaloClusterizerComponent &); // not implemented