-/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
- * See cxx source for full Copyright notice */
-
-/** @file AliHLTPHOSClusterizer.h
- @author Ã\98ystein Djuvsland
- @date
- @brief A temporary clusterizer for PHOS
-*/
+//-*- 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 ALIHLTPHOSCLUSTERIZER_H
#define ALIHLTPHOSCLUSTERIZER_H
-#include "AliHLTPHOSBase.h"
+
+/**
+ * Class does clusterization in for PHOS on an event basis. It is intended
+ * for use in HLT, but can also be used offline
+ *
+ * @file AliHLTPHOSClusterizer.h
+ * @author Oystein Djuvsland
+ * @date
+ * @brief Clusterizer for PHOS HLT
+ */
+
+// see header file for class documentation
+// or
+// refer to README to build package
+// or
+// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
+
+//#include "AliHLTPHOSBase.h"
+#include "AliPHOSLoader.h"
+
#include "AliHLTPHOSRecPointContainerStruct.h"
+#include "AliHLTPHOSRecPointDataStruct.h"
#include "AliHLTPHOSDigitContainerDataStruct.h"
+#include "AliHLTPHOSDigitDataStruct.h"
+
#include "AliPHOSGeometry.h"
-#include "TClonesArray.h"
-#include "AliPHOSDigit.h"
-#include "AliPHOSGetter.h"
-#include "AliPHOSRecoParamEmc.h"
-class AliHLTPHOSClusterizer : public AliHLTPHOSBase
+class TClonesArray;
+class AliPHOSDigit;
+class AliPHOSRecoParamEmc;
+class AliPHOSRecoParam;
+
+/**
+ * @class AliHLTPHOSClusterizer
+ * Clusterizer for PHOS HLT. The clusterizer takes digits as input, either
+ * in the form of a container of AliHLTPHOSDigitDataStruct or a
+ * TClonesArray of AliPHOSDigit through an instance of a AliPHOSLoader
+ *
+ * @ingroup alihlt_phos
+ */
+//class AliHLTPHOSClusterizer : public AliHLTPHOSBase
+class AliHLTPHOSClusterizer
{
public:
+ /** Constructor */
AliHLTPHOSClusterizer();
+ /** Destructor */
virtual ~AliHLTPHOSClusterizer();
+
+ /** Copy constructor */
+ AliHLTPHOSClusterizer(const AliHLTPHOSClusterizer &) :
+ // AliHLTPHOSBase(),
+ fRecPointDataPtr(0),
+ fDigitDataPtr(0),
+ fEmcClusteringThreshold(0),
+ fEmcMinEnergyThreshold(0),
+ fEmcTimeGate(0),
+ fDigitsInCluster(0),
+ fDigitContainerPtr(0),
+ fMaxDigitIndexDiff(2*NZROWSMOD)
+ {
+ //Copy constructor not implemented
+ }
+
+ /** Assignment */
+ AliHLTPHOSClusterizer & operator = (const AliHLTPHOSClusterizer)
+ {
+ //Assignment
+ return *this;
+ }
- AliHLTPHOSClusterizer(const AliHLTPHOSClusterizer &);
- AliHLTPHOSClusterizer & operator = (const AliHLTPHOSClusterizer &) {return *this;}
+ /** Set digit container */
+ void SetDigitContainer(AliHLTPHOSDigitContainerDataStruct* digitContainerPtr)
+ { fDigitContainerPtr = digitContainerPtr; }
- void SetRecPointContainer(AliHLTPHOSRecPointContainerStruct *RecPointContainerPtr)
- { fRecPointContainerPtr = RecPointContainerPtr; }
+ /** Set rec point data buffer */
+ void SetRecPointDataPtr(AliHLTPHOSRecPointDataStruct* recPointDataPtr);
- void SetRecoParameters(AliPHOSRecoParamEmc*);
+ /** Set reco parameters */
+ void SetRecoParameters(AliPHOSRecoParam* recoPars);
+ /** Set emc clustering threshold */
void SetEmcClusteringThreshold(Float_t threshold) { fEmcClusteringThreshold = threshold; }
+
+ /** Set emc min energy threshold */
void SetEmcMinEnergyThreshold(Float_t threshold) { fEmcMinEnergyThreshold = threshold; }
+
+ /** Set emc time gate */
void SetEmcTimeGate(Float_t gate) { fEmcTimeGate = gate; }
- void SetLogWeight(Float_t weight) { fLogWeight = weight; }
-
- void SetOfflineMode(AliPHOSGetter*);
- virtual Int_t ClusterizeEvent();
- virtual Int_t GetEvent(Int_t);
+ /** Starts clusterization of the event */
+ virtual Int_t ClusterizeEvent(UInt_t availableSize, UInt_t& totSize);
- Int_t GetNEvents();
+ /**
+ * For a given digit this digit scans for neighbouring digits which
+ * passes the threshold for inclusion in a rec point. If one is found
+ * it is added to the current rec point
+ * @param digIndex index of the digit in the digit container
+ * @param recPoint pointer to the current rec point
+ */
+ virtual void ScanForNeighbourDigits(Int_t digIndex, AliHLTPHOSRecPointDataStruct* recPoint);
- virtual void ScanForNeighbourDigits(Int_t, AliHLTPHOSRecPointDataStruct*);
- virtual Int_t AreNeighbours(AliHLTPHOSDigitDataStruct*, AliHLTPHOSDigitDataStruct*);
- virtual void CalculateCenterOfGravity();
+ /**
+ * Checks if two digits are neighbours
+ * @param d1 first digit
+ * @param d2 second digit
+ */
+ virtual Int_t AreNeighbours(AliHLTPHOSDigitDataStruct* d1, AliHLTPHOSDigitDataStruct* d2);
-private:
-
- Float_t fEmcClusteringThreshold;
- Float_t fEmcMinEnergyThreshold;
- Float_t fEmcTimeGate;
- Float_t fLogWeight;
- Int_t fDigitsInCluster;
-
- Bool_t fOnlineMode;
-
- TClonesArray *fDigitArrayPtr;
- TObjArray *fEmcRecPointsPtr;
- AliPHOSDigit *fDigitPtr;
-
- AliHLTPHOSDigitContainerDataStruct *fDigitContainerPtr;
- AliHLTPHOSRecPointContainerStruct *fRecPointContainerPtr;
- AliPHOSGeometry *fPHOSGeometry;
-
- AliPHOSGetter *fGetterPtr;
-
- ClassDef(AliHLTPHOSClusterizer, 1);
+
+protected:
+
+ /** Pointer to the rec point output */
+ AliHLTPHOSRecPointDataStruct* fRecPointDataPtr; //! transient
+
+ /** Pointer to the digit output */
+ AliHLTPHOSDigitDataStruct* fDigitDataPtr; //! transient
+
+ /** Energy threshold for starting a cluster for the calorimeter */
+ Float_t fEmcClusteringThreshold; //COMMENT
+
+ /** Energy threshold for including a crystal in a cluster */
+ Float_t fEmcMinEnergyThreshold; //COMMENT
+
+ /** Maximum time difference for inclusion in a rec point */
+ Float_t fEmcTimeGate; //COMMENT
+
+ /** Counts the digits in a rec point */
+ Int_t fDigitsInCluster; //COMMENT
+
+ /** Contains the digits from one event */
+ AliHLTPHOSDigitContainerDataStruct *fDigitContainerPtr; //! transient
+
+ /** Maximum difference in index to be a neighbour */
+ Int_t fMaxDigitIndexDiff; //COMMENT
+
+ ClassDef(AliHLTPHOSClusterizer, 0);
};
#endif
git://git.uio.no / u / mrichter / AliRoot.git / blobdiff