//-*- Mode: C++ -*-
// $Id: AliHLTCaloClusterizerComponent.h 36636 2009-11-11 02:16:41Z odjuvsla $
/**************************************************************************
* 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 ALIHLTCALOCLUSTERIZERCOMPONENT_H
#define ALIHLTCALOCLUSTERIZERCOMPONENT_H
/**
* Clusterizer component for PHOS HLT
*
* @file AliHLTCaloClusterizerComponent.h
* @author Oystein Djuvsland
* @date
* @brief A clusterizer component for PHOS HLT
*/
// see below for class documentation
// or
// refer to README to build package
// or
// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
#include "AliHLTCaloConstantsHandler.h"
#include "AliHLTCaloProcessor.h"
class AliHLTCaloRecoParamHandler;
class AliHLTCaloDigitDataStruct;
class AliHLTCaloDigitContainerDataStruct;
class AliHLTCaloClusterizer;
class AliHLTCaloClusterAnalyser;
class AliHLTCaloRecPointDataStruct;
class AliHLTPHOSHistoProdClusterEnergy;
/**
* @class AliHLTCaloClusterizerComponent
*
* Class for running clusterization for PHOS 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 AliHLTCaloClusterizerComponent
*
* Class for running clusterization for PHOS in HLT.
*
*
General properties:
*
* Component ID: \b PhosClusterizer
* Library: \b libAliHLTPHOS.so
* Input Data Types: @ref AliHLTPHOSDefinitions::fgkDigitDataType
* Output Data Types: @ref AliHLTPHOSDefinitions::fgkRecPointDataType
*
* Mandatory arguments:
*
* \li No mandatory arguments for component
*
* Optional arguments:
*
* \li -digitthreshold value
* threshold for a digit to be added to a rec point in GeV (default value: 0.03)
* \li -recpointthreshold value
* 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)
*
* Configuration:
*
* \li No configuration arguments
*
* Default CDB entries:
* \li No CDB entry yet, will come.
*
* Performance:
* Pretty good (~ 3 kHz), depends on amount of data...
*
* Memory consumption:
* Depends on the amount of data, but pretty godd
*
* Output size:
* Depends on the amount of data...
*
* More detailed description. (At some point...)
*
* @ingroup alihlt_phos
*/
//class AliHLTCaloClusterizerComponent : public AliHLTCaloConstantsHandler, public AliHLTCaloProcessor
class AliHLTCaloClusterizerComponent : public AliHLTCaloProcessor, public AliHLTCaloConstantsHandler
{
public:
/** Constructor */
AliHLTCaloClusterizerComponent(TString det);
/** Destructor */
virtual ~AliHLTCaloClusterizerComponent();
/** interface function, see @ref AliHLTComponent for description */
using AliHLTCaloProcessor::DoEvent;
int DoEvent ( const AliHLTComponentEventData& evtData, const AliHLTComponentBlockData* blocks,
AliHLTComponentTriggerData& trigData, AliHLTUInt8_t* outputPtr, AliHLTUInt32_t& size,
std::vector& outputBlocks );
/**
* Compare two digits, used during the sorting
*/
static Int_t CompareDigits(const void *dig0, const void *dig);
protected:
/** interface function, see @ref AliHLTComponent for
description */
virtual int DoInit ( int argc, const char** argv );
/** interface function, see @ref AliHLTComponent for description */
virtual int DoDeinit();
/** Initialise geometry objects */
virtual Int_t InitialiseGeometry() = 0;
/** interface function, see @ref AliHLTComponent for description */
int Reconfigure ( const char* cdbEntry, const char* chainId );
/** interface function, see @ref AliHLTComponent for description */
int ScanConfigurationArgument ( int argc, const char** argv );
/** The data origin */
char* fDataOrigin; //COMMENT
/** Pointer to the cluster analyser */
AliHLTCaloClusterAnalyser *fAnalyserPtr; //! transient
/** Pointer to reconstruction parameters handler */
AliHLTCaloRecoParamHandler *fRecoParamsPtr; //! transient
/** Pointer to the clusterizer it self */
AliHLTCaloClusterizer* fClusterizerPtr; //! transient
private:
/** Array of pointers to our digits */
AliHLTCaloDigitDataStruct **fDigitsPointerArray; //! transient
/** Array of pointers to our digits */
AliHLTCaloDigitDataStruct *fOutputDigitsArray; //! transient
/** Number of digits in event */
Int_t fDigitCount; //COMMENT
/** Copy digits to output? */
Bool_t fCopyDigitsToOuput; //COMMENT
/** Default constructor, not implemented */
AliHLTCaloClusterizerComponent(); //COMMENT
/** Copy constructor not implemented */
AliHLTCaloClusterizerComponent ( const AliHLTCaloClusterizerComponent &); // not implemented
/** Assignment */
AliHLTCaloClusterizerComponent & operator = ( const AliHLTCaloClusterizerComponent &); // not implemented
ClassDef(AliHLTCaloClusterizerComponent, 0);
};
#endif