//-*- 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 ALIHLTEMCALDIGITMAKERCOMPONENT_H
#define ALIHLTEMCALDIGITMAKERCOMPONENT_H
/** @file AliHLTEMCALDigitMakerComponent.h
@author Oystein Djuvsland
@date
@brief A digit maker component for EMCAL 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 "AliHLTCaloProcessor.h"
//#include "AliHLTCaloConstantsHandler.h"
class AliEMCALCalibData;
class AliCaloCalibPedestal;
class AliHLTCaloDigitMaker;
class AliHLTCaloDigitContainerDataStruct;
/**
* @class AliHLTEMCALDigitMakerComponent
*
* Creates the digit used for the clusterizer. Digits are equivalent to the ones in
* offline reconstruction
*
*
General properties:
*
* Component ID: \b PhosDigitMaker
* Library: \b libAliHLTEMCAL.so
* Input Data Types: @ref AliHLTEMCALDefinitions::fkgChannelDataType
* Output Data Types: @ref AliHLTEMCALDefinitions::fgkDigitDataType
*
* Mandatory arguments:
*
* \li No mandatory arguments for component
*
* Optional arguments:
*
* \li -lowgainfactor value
* sets a global low gain factor
* \li -highgainfactor value
* sets a global high gain factor
* \li -reverseorder
* set if one expects the low gain channels to come before the high gain ones
*
* Configuration:
*
* \li No configuration arguments
*
* Default CDB entries:
* \li No CDB entry yet, will come.
*
* Performance:
* Pretty good
*
* Memory consumption:
* Pretty low
*
* Output size:
* Depends on the event...
*
* More detailed description. (Soon)
*
* @ingroup alihlt_emcal
*/
//class AliHLTEMCALDigitMakerComponent : public AliHLTCaloProcessor, public AliHLTCaloConstantsHandler
class AliHLTEMCALDigitMakerComponent : public AliHLTCaloProcessor
{
public:
/** Constructor */
AliHLTEMCALDigitMakerComponent();
/** Destructor */
virtual ~AliHLTEMCALDigitMakerComponent();
/** interface function, see @ref AliHLTComponent for description */
const char* GetComponentID();
/** interface function, see @ref AliHLTComponent for description */
void GetInputDataTypes(std::vector& list);
/** interface function, see @ref AliHLTComponent for description */
AliHLTComponentDataType GetOutputDataType();
/** interface function, see @ref AliHLTComponent for description */
void GetOutputDataSize(unsigned long& constBase, double& inputMultiplier);
/// inherited from AliHLTComponent, scan one argument and
/// its parameters
// int ScanConfigurationArgument(int argc, const char** argv);
/** interface function, see @ref AliHLTComponent for description */
int DoEvent(const AliHLTComponentEventData& evtData, const AliHLTComponentBlockData* blocks,
AliHLTComponentTriggerData& trigData, AliHLTUInt8_t* outputPtr, AliHLTUInt32_t& size,
std::vector& outputBlocks);
/** interface function, see @ref AliHLTComponent for description */
AliHLTComponent* Spawn();
protected:
/** interface function, see @ref AliHLTComponent for description */
virtual int DoInit(int argc, const char** argv);
using AliHLTCaloProcessor::DoEvent;
/** interface function, see @ref AliHLTComponent for description */
virtual int Deinit(); ////////// PTH WARNING you should Define a class AliHLTEMCALModuleProcessor
// virtual int DoInit(int, const char**) {;}
virtual int DoDeinit(){return 0;}
/** Get bad channel map from CDB */
virtual int GetBCMFromCDB();
/** Get the ADC <-> Energy (GeV) gain factors */
virtual int GetGainsFromCDB();
private:
/** Copy constructor, prohibited */
AliHLTEMCALDigitMakerComponent(const AliHLTEMCALDigitMakerComponent &);
/** Assignment operator, prohibited */
AliHLTEMCALDigitMakerComponent & operator = (const AliHLTEMCALDigitMakerComponent);
/** Pointer to the digit maker itself */
AliHLTCaloDigitMaker *fDigitMakerPtr; //! transient
/** The output of the component, digits in a container */
AliHLTCaloDigitContainerDataStruct *fDigitContainerPtr; //! transient
/** Pedestal data (contains BCM) */
AliCaloCalibPedestal *fPedestalData;
/** Calib data (contains gain factors) */
AliEMCALCalibData *fCalibData;
/** Is the bad map initialised? */
Bool_t fBCMInitialised; //! transient
/** Are the gains initialised? */
Bool_t fGainsInitialised; //! transient
ClassDef(AliHLTEMCALDigitMakerComponent, 1);
};
#endif