//-*- Mode: C++ -*-
+// $Id$
+
+
+/**************************************************************************
+ * This file is property of and copyright by the ALICE HLT Project *
+ * All rights reserved. *
+ * *
+ * Primary Authors: Oystein Djuvsland *
+ * *
+ * Permission to use, copy, modify and distribute this software and its *
+ * documentation strictly for non-commercial purposes is hereby granted *
+ * without fee, provided that the above copyright notice appears in all *
+ * copies and that both the copyright notice and this permission notice *
+ * appear in the supporting documentation. The authors make no claims *
+ * about the suitability of this software for any purpose. It is *
+ * provided "as is" without express or implied warranty. *
+ **************************************************************************/
+
#ifndef ALIHLTEMCALCLUSTERIZERCOMPONENT_H
#define ALIHLTEMCALCLUSTERIZERCOMPONENT_H
-//* 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 */
-/** @file AliHLTEMCALClusterizerComponent.h
- @author Matthias Richter, Timm Steinbeck
- @date
- @brief A sample processing component for the HLT.
+
+/**
+ * Clusterizer component for EMCAL HLT
+ *
+ * @file AliHLTEMCALClusterizerComponent.h
+ * @author Oystein Djuvsland
+ * @date
+ * @brief A clusterizer component for EMCAL HLT
*/
-#include "AliHLTProcessor.h"
+// see below for class documentation
+// or
+// refer to README to build package
+// or
+// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
+
+#include "AliHLTCaloClusterizerComponent.h"
+
+#include <vector>
+
+// class AliHLTEMCALClusterizer;
+// class AliHLTEMCALRcuCellEnergyDataStruct;
+// class AliHLTEMCALRecPointDataStruct;
+// class AliHLTEMCALRecPointContainerStruct;
+// class AliHLTEMCALRecPointListDataStruct;
+// class AliHLTEMCALDigitContainerDataStruct;
/**
* @class AliHLTEMCALClusterizerComponent
+ *
+ * Class for running clusterization for EMCAL in HLT. It takes digits as input and
+ * gives reconstruction points as output.
+ *
+ * The component has the following component arguments:
+ * -clusterthreshold The energy threshold for starting a new rec point
+ * -energythreshold The energy threshold for including a digit in a
+ * rec point
+ * @ingroup alihlt_phos
*/
-class TFile;
-class TGeoManager;
-class AliEMCALClusterizer;
-class AliCDBManager;
-class AliRawReaderMemory;
+/**
+ * @class AliHLTEMCALClusterizerComponent
+ *
+ * Class for running clusterization for EMCAL in HLT.
+ *
+ * <h2>General properties:</h2>
+ *
+ * Component ID: \b PhosClusterizer <br>
+ * Library: \b libAliHLTEMCAL.so <br>
+ * Input Data Types: @ref AliHLTEMCALDefinitions::fgkDigitDataType<br>
+ * Output Data Types: @ref AliHLTEMCALDefinitions::fgkRecPointDataType<br>
+ *
+ * <h2>Mandatory arguments:</h2>
+ * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting -->
+ * \li No mandatory arguments for component <br>
+ *
+ * <h2>Optional arguments:</h2>
+ * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting -->
+ * \li -digitthreshold <i> value </i> <br>
+ * threshold for a digit to be added to a rec point in GeV (default value: 0.03)
+ * \li -recpointthreshold <i> value </i> <br>
+ * threshold for starting a new rec point (default value: 0.2)
+ * \li -partitionmode
+ * if we want to do clusterisation on the partition level (not available...) (defaul value: false)
+ *
+ * <h2>Configuration:</h2>
+ * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting -->
+ * \li No configuration arguments
+ *
+ * <h2>Default CDB entries:</h2>
+ * \li No CDB entry yet, will come.
+ *
+ * <h2>Performance:</h2>
+ * Pretty good (~ 3 kHz), depends on amount of data...
+ *
+ * <h2>Memory consumption:</h2>
+ * Depends on the amount of data, but pretty godd
+ *
+ * <h2>Output size:</h2>
+ * Depends on the amount of data...
+ *
+ * More detailed description. (At some point...)
+ *
+ * @ingroup alihlt_phos
+ */
-class AliHLTEMCALClusterizerComponent : public AliHLTProcessor {
-public:
+class AliHLTEMCALClusterizerComponent : public AliHLTCaloClusterizerComponent
+//class AliHLTEMCALClusterizerComponent : public AliHLTEMCALProcessor
+{
+
+ public:
+
+ /** Constructor */
AliHLTEMCALClusterizerComponent();
- AliHLTEMCALClusterizerComponent(const AliHLTEMCALClusterizerComponent& c);
- virtual ~AliHLTEMCALClusterizerComponent();
- AliHLTEMCALClusterizerComponent& operator=(const AliHLTEMCALClusterizerComponent&);
+ /** Destructor */
+ virtual ~AliHLTEMCALClusterizerComponent();
- // AliHLTComponent interface functions
+ /** interface function, see @ref AliHLTComponent for description */
const char* GetComponentID();
- void GetInputDataTypes( vector<AliHLTComponentDataType>& list);
+
+ /** interface function, see @ref AliHLTComponent for description */
+ void GetInputDataTypes(std::vector<AliHLTComponentDataType>& list);
+
+ /** interface function, see @ref AliHLTComponent for description */
AliHLTComponentDataType GetOutputDataType();
- virtual void GetOutputDataSize( unsigned long& constBase, double& inputMultiplier );
- // Spawn function, return new class instance
- AliHLTComponent* Spawn() {return new AliHLTEMCALClusterizerComponent;};
+ /** interface function, see @ref AliHLTComponent for description */
+ void GetOutputDataSize ( unsigned long& constBase, double& inputMultiplier );
- protected:
- // AliHLTComponent interface functions
- int DoInit( int argc, const char** argv );
- int DoDeinit();
- 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);
- int ReadPreprocessorValues(const char* modules);
+ /** interface function, see @ref AliHLTComponent for description */
+ AliHLTComponent* Spawn();
- using AliHLTProcessor::DoEvent;
+protected:
+ virtual int DoInit() {return 0; }
+ virtual int DoDeinit(){ return 0;}
+ virtual int Deinit() {return 0; }
private:
- /**
- * Configure the component.
- * Parse a string for the configuration arguments and set the component
- * properties.
- *
- * This function illustrates the scanning of an argument string. The string
- * was presumably fetched from the CDB.
- */
- int Configure(const char* arguments);
-
- unsigned fOutputPercentage; // Output volume in percentage of the input
- string fStorageDBpath; // Default path for OCDB
- AliCDBManager *fCDB; //! Pointer to OCDB
- string fGeometryFileName; // Path to geometry file - geom handled by the utils
+ /** Copy constructor, not implemented */
+ AliHLTEMCALClusterizerComponent(const AliHLTEMCALClusterizerComponent &);
+
+ /** Assignment operator, not implemented */
+ AliHLTEMCALClusterizerComponent & operator = (const AliHLTEMCALClusterizerComponent);
+
- ClassDef(AliHLTEMCALClusterizerComponent, 1)
};
+
#endif
git://git.uio.no / u / mrichter / AliRoot.git / blobdiff