#ifndef ALIHLTTPCCLUSTERFINDERCOMPONENT_H
#define ALIHLTTPCCLUSTERFINDERCOMPONENT_H
-/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
- * See cxx source for full Copyright notice */
+//* This file is property of and copyright by the ALICE HLT Project *
+//* ALICE Experiment at CERN, All rights reserved. *
+//* See cxx source for full Copyright notice *
-/* AliHLTTPCClusterFinderComponent
- */
+/** @file AliHLTTPCClusterFinderComponent.h
+ @author Timm Steinbeck, Matthias Richter, Kenneth Aamodt
+ @date
+ @brief The TPC cluster finder component.
+*/
#include "AliHLTProcessor.h"
-#include "AliHLTTPCDefinitions.h"
-#include "AliHLTTPCDigitReaderPacked.h"
-#include "AliHLTTPCDigitReaderUnpacked.h"
class AliHLTTPCClusterFinder;
+class AliHLTTPCDigitReader;
+/**
+ * @class AliHLTTPCClusterFinderComponent
+ * Implementation of the cluster finder component.
+ * The component implements the interface methods of the @ref AliHLTProcessor.
+ * The actual cluster finding algorithm is implemented in @ref AliHLTTPCClusterFinder.
+ * The component can handle unpacked and packed data of different formats via the
+ * AliHLTTPCDigitReader implementations. Two components are registered, the
+ * TPCClusterFinderUnpacked and the TPCClusterFinderPacked. The latter one can
+ * instantiate different digit readers depending on the arguments.
+ *
+ * The component has the following component arguments:
+ * - adc-threshold ADC count threshold for zero suppression, if <0 the base line
+ * calculation and subtraction is switched off
+ * - pp-run set parameters specific to a pp run; currently this switches
+ * cluster deconvolution off for pp runs (not true for unsorted reading)
+ * - unsorted if 1 the data will be read unsorted in to a PadArray object. This should
+ * only be done on patch level since it use a lot of memory
+ * - patch specify on which patch to resd the data unsorted
+ *
+ * @ingroup alihlt_tpc_components
+ */
class AliHLTTPCClusterFinderComponent : public AliHLTProcessor
{
public:
- AliHLTTPCClusterFinderComponent(bool packed);
+ /**
+ * Defines for the cluster finder type.
+ * The cluster finders can work on different formats of input data,
+ * the AliHLTTPCDigitReader interface provides a transparent way to
+ * read the data.
+ */
+ enum {
+ /** real data, offline AliAltroRawStream used for data decoding */
+ kClusterFinderPacked,
+ /** Unpacked data of format AliHLTTPCUnpackedRawData */
+ kClusterFinderUnpacked,
+ /** real data, fast AliAltroDecoder used for data decoding */
+ kClusterFinderDecoder
+ };
+
+ /**
+ * constructor
+ * @param mode input type see e.g. @ref kClusterFinderUnpacked
+ */
+ AliHLTTPCClusterFinderComponent(int mode);
+ /** destructor */
virtual ~AliHLTTPCClusterFinderComponent();
// Public functions to implement AliHLTComponent's interface.
// These functions are required for the registration process
- const char* GetComponentID();
- void GetInputDataTypes( vector<AliHLTComponent_DataType>& list);
- AliHLTComponent_DataType GetOutputDataType();
- virtual void GetOutputDataSize( unsigned long& constBase, double& inputMultiplier );
- AliHLTComponent* Spawn();
-
+ /** interface function, see @ref AliHLTComponent for description */
+ const char* GetComponentID();
+ /** interface function, see @ref AliHLTComponent for description */
+ void GetInputDataTypes( vector<AliHLTComponentDataType>& list);
+ /** interface function, see @ref AliHLTComponent for description */
+ AliHLTComponentDataType GetOutputDataType();
+ /** interface function, see @ref AliHLTComponent for description */
+ int GetOutputDataTypes(AliHLTComponentDataTypeList& tgtList);
+ /** interface function, see @ref AliHLTComponent for description */
+ virtual void GetOutputDataSize( unsigned long& constBase, double& inputMultiplier );
+ /** interface function, see @ref AliHLTComponent for description */
+ AliHLTComponent* Spawn();
+
protected:
// Protected functions to implement AliHLTComponent's interface.
int DoInit( int argc, const char** argv );
int DoDeinit();
- int DoEvent( const AliHLTComponent_EventData& evtData, const AliHLTComponent_BlockData* blocks,
- AliHLTComponent_TriggerData& trigData, AliHLTUInt8_t* outputPtr,
- AliHLTUInt32_t& size, vector<AliHLTComponent_BlockData>& outputBlocks );
+ int DoEvent( const AliHLTComponentEventData& evtData, const AliHLTComponentBlockData* blocks,
+ AliHLTComponentTriggerData& trigData, AliHLTUInt8_t* outputPtr,
+ AliHLTUInt32_t& size, vector<AliHLTComponentBlockData>& outputBlocks );
+ int Reconfigure(const char* cdbEntry, const char* chainId);
+ using AliHLTProcessor::DoEvent;
+
private:
+ /** standard constructor prohibited */
+ AliHLTTPCClusterFinderComponent();
+ /** copy constructor prohibited */
+ AliHLTTPCClusterFinderComponent(const AliHLTTPCClusterFinderComponent&);
+ /** assignment operator prohibited */
+ AliHLTTPCClusterFinderComponent& operator=(const AliHLTTPCClusterFinderComponent&);
+ /** the cluster finder object */
+ AliHLTTPCClusterFinder* fClusterFinder; //!transient
+ /** the reader object for data decoding */
+ AliHLTTPCDigitReader* fReader; //!transient
- AliHLTTPCClusterFinder* fClusterFinder;
- AliHLTTPCDigitReaderPacked* fReaderPacked;
- AliHLTTPCDigitReaderUnpacked* fReaderUnpacked;
- bool fClusterDeconv;
- float fXYClusterError;
- float fZClusterError;
- Int_t fPackedSwitch;
+ bool fClusterDeconv; //!transient
+ float fXYClusterError; //!transient
+ float fZClusterError; //!transient
+ /**
+ * switch to indicated the reader
+ * use fModeSwitch = 0 for packed inputtype "gkDDLPackedRawDataType"
+ * use fModeSwitch = 1 for unpacked inputtype "gkUnpackedRawDataType"
+ * use fModeSwitch = 2 for packed inputtype "gkDDLPackedRawDataType" with new digit reader
+ */
+ Int_t fModeSwitch; // see above
- ClassDef(AliHLTTPCClusterFinderComponent, 0)
+ /*
+ * Reads the data the new unsorted way if true
+ *
+ */
+ Int_t fUnsorted; //!transient
+
+ /*
+ * Patch number to be read, currently given as component argument,
+ * will be changed later.
+ */
+ Int_t fPatch; //!transient
+
+ /*
+ * Switch to specify if one ship out a list of active pads.
+ * Used for the 2007 December run.
+ */
+ Int_t fGetActivePads; //!transient
+
+ ClassDef(AliHLTTPCClusterFinderComponent, 3)
- };
+};
#endif
git://git.uio.no / u / mrichter / AliRoot.git / blobdiff