3 #ifndef ALIHLTTPCCLUSTERFINDERCOMPONENT_H
4 #define ALIHLTTPCCLUSTERFINDERCOMPONENT_H
6 //* This file is property of and copyright by the ALICE HLT Project *
7 //* ALICE Experiment at CERN, All rights reserved. *
8 //* See cxx source for full Copyright notice *
10 /** @file AliHLTTPCClusterFinderComponent.h
11 @author Timm Steinbeck, Matthias Richter, Kenneth Aamodt
13 @brief The TPC cluster finder component.
16 #include "AliHLTProcessor.h"
18 class AliHLTTPCClusterFinder;
19 class AliHLTTPCDigitReader;
22 * @class AliHLTTPCClusterFinderComponent
23 * Implementation of the cluster finder component.
24 * The component implements the interface methods of the @ref AliHLTProcessor.
25 * The actual cluster finding algorithm is implemented in @ref AliHLTTPCClusterFinder.
26 * Two components are registered, TPCClusterFinderPacked and TPCClusterFinderDecoder.
27 * TPCClusterFinderDecoder use the AliTPCRawStream class for decoding of the data, while TPCClusterFinderDecoder
28 * use the AliAltroDecoder for decoding the data.
30 * TPCClusterFinderDecoder is the fastest of the two, this is due to that the AliAltroDecoder
31 * returns data in a bunch format. A bunch consist of consecutive signals.
32 * TPCClusterFinderPacked first have to read the data one by one, which means that row, pad and
33 * time signals have to be compared between each new digit, which leads to a slower alorithm.
36 * The clusterfinder is now using the AliTPCTransform instead of the AliHLTTPCTransform for
37 * transformations from row, pad time -> x,y,z.
39 * <h2>General properties:</h2>
41 * Component ID: \b TPCClusterFinderDecoder and TPCClusterFinderPacked <br>
42 * Library: \b libAliHLTTPC
43 * Input Data Types: @ref kAliHLTDataTypeDDLRaw <br>
44 * Output Data Types: @ref AliHLTTPCDefinitions::fgkClustersDataType and/or kAliHLTDataTypeHwAddr16 <br>
47 * Mandatory arguments: <br>
48 * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting -->
50 * Optional arguments: <br>
51 * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting -->
52 * \li -deconvolute-time <br>
53 * Turns on deconvolution in the time direction.
54 * \li -deconvolute-pad <br>
55 * Turns on deconvolution in the pad direction.
57 * Sets the number of timebins (446 for simulated data, and 1024 for real data) Default:1024
58 * \li -first-timebin <br>
59 * First timebin taken into consideration when reading the data.
60 * \li -last-timebin <br>
61 * Last timebin taken into consideration when reading the data.
63 * Switch off unsorted reading of data. Equivalent to the old argument unsorted 0.
64 * \li -active-pads <br>
65 * Switch off unsorted reading of data. Equivalent to the old argument unsorted 0.
66 * \li -occupancy-limit <br>
67 * Set the occupancy limit for the sorted clusterfinding.
70 * Obsolete arguments: <br>
71 * \li occupancy-limit <br>
72 * \li rawreadermode <br>
74 * \li adc-threshold <br>
75 * \li oldrcuformat <br>
77 * \li nsigma-threshold <br>
79 * <h2>Default CDB entries:</h2>
80 * The component has two default CDB entries
81 * \li <tt>TPC/Calib/PadTime0</tt>.
82 * \li <tt>TPC/Calib/Parameters</tt>.
84 * These entries are used by the AliTPCTransform class to correct for T0 and drift.
85 * @ingroup alihlt_tpc_components
87 class AliHLTTPCClusterFinderComponent : public AliHLTProcessor
91 * Defines for the cluster finder type.
92 * The cluster finders can work on different formats of input data,
93 * the AliHLTTPCDigitReader interface provides a transparent way to
97 /** real data, offline AliAltroRawStream used for data decoding */
99 /** Unpacked data of format AliHLTTPCUnpackedRawData */
100 kClusterFinderUnpacked,
101 /** real data, fast AliAltroDecoder used for data decoding */
102 kClusterFinderDecoder,
103 /** real data, offline altro decoder 32 bit format*/
109 * @param mode input type see e.g. @ref kClusterFinderUnpacked
111 AliHLTTPCClusterFinderComponent(int mode);
113 virtual ~AliHLTTPCClusterFinderComponent();
115 // Public functions to implement AliHLTComponent's interface.
116 // These functions are required for the registration process
118 /** interface function, see AliHLTComponent for description */
119 const char* GetComponentID();
120 /** interface function, see AliHLTComponent for description */
121 void GetInputDataTypes( vector<AliHLTComponentDataType>& list);
122 /** interface function, see AliHLTComponent for description */
123 AliHLTComponentDataType GetOutputDataType();
124 /** interface function, see AliHLTComponent for description */
125 int GetOutputDataTypes(AliHLTComponentDataTypeList& tgtList);
126 /** interface function, see AliHLTComponent for description */
127 virtual void GetOutputDataSize( unsigned long& constBase, double& inputMultiplier );
128 /** interface function, see AliHLTComponent for description */
129 AliHLTComponent* Spawn();
133 // Protected functions to implement AliHLTComponent's interface.
134 // These functions provide initialization as well as the actual processing
135 // capabilities of the component.
137 int DoInit( int argc, const char** argv );
139 int DoEvent( const AliHLTComponentEventData& evtData, const AliHLTComponentBlockData* blocks,
140 AliHLTComponentTriggerData& trigData, AliHLTUInt8_t* outputPtr,
141 AliHLTUInt32_t& size, vector<AliHLTComponentBlockData>& outputBlocks );
142 int Configure(const char* arguments);
143 int Reconfigure(const char* cdbEntry, const char* chainId);
145 using AliHLTProcessor::DoEvent;
148 /** standard constructor prohibited */
149 AliHLTTPCClusterFinderComponent();
150 /** copy constructor prohibited */
151 AliHLTTPCClusterFinderComponent(const AliHLTTPCClusterFinderComponent&);
152 /** assignment operator prohibited */
153 AliHLTTPCClusterFinderComponent& operator=(const AliHLTTPCClusterFinderComponent&);
154 /** the cluster finder object */
155 AliHLTTPCClusterFinder* fClusterFinder; //!transient
156 /** the reader object for data decoding */
157 AliHLTTPCDigitReader* fReader; //!transient
159 /** flag to deconvolute in time direction */
160 Bool_t fDeconvTime; //!transient
162 /** flag to deconvolute in pad direction */
163 Bool_t fDeconvPad; //!transient
164 /** flag to switch on/off deconvolution in pad and time directions (used by sorted clusterfinding method) */
165 bool fClusterDeconv; //!transient
166 /** Error in xy of cluster */
167 float fXYClusterError; //!transient
168 /** Error in Z direction of cluster */
169 float fZClusterError; //!transient
171 * switch to indicated the reader
172 * use fModeSwitch = 0 for packed inputtype "gkDDLPackedRawDataType"
173 * use fModeSwitch = 1 for unpacked inputtype "gkUnpackedRawDataType"
174 * use fModeSwitch = 2 for packed inputtype "gkDDLPackedRawDataType" with new digit reader
175 * use fModeSwitch = 3 for packed inputtype "gkDDLPackedRawDataType" with 32bit digit reader
177 Int_t fModeSwitch; // see above
180 * Reads the data the new unsorted way if true
183 Int_t fUnsorted; //!transient
186 * Patch number to be read, currently given as component argument,
187 * will be changed later.
189 Int_t fPatch; //!transient
192 * Switch to specify if one ship out a list of active pads (pads conected to a cluster).
194 Int_t fGetActivePads; //!transient
196 /** First timebin taken into account when reading the data */
197 Int_t fFirstTimeBin; //!transient
199 /** Last timebin taken in to account when reading the data */
200 Int_t fLastTimeBin; //!transient
204 ClassDef(AliHLTTPCClusterFinderComponent, 6)