- adding checking of sanity to raw analyzer

[u/mrichter/AliRoot.git] / HLT / PHOS / AliHLTPHOSSanityInspector.h

diff --git a/HLT/PHOS/AliHLTPHOSSanityInspector.h b/HLT/PHOS/AliHLTPHOSSanityInspector.h
index cad2037fdd41bf0f21ffc1b665f69df9b1f11e1c..9874055ca92520c5faad2d0d2f6e2955773ccb16 100644 (file)
--- a/HLT/PHOS/AliHLTPHOSSanityInspector.h
+++ b/HLT/PHOS/AliHLTPHOSSanityInspector.h
@@ -1,3 +1,6 @@
+//-*- Mode: C++ -*-
+// $Id$
+
 /**************************************************************************
  * This file is property of and copyright by the ALICE HLT Project        * 
  * All rights reserved.                                                   *
@@ -16,30 +19,79 @@
 #ifndef ALIHLTPHOSSANITYINSPECTOR_H
 #define ALIHLTPHOSSANITYINSPECTOR_H
 
-#include "AliHLTPHOSBase.h"
-//#include "AliHLTAltroData.h"
+/**
+ * Class checks data for insanity
+ * for use in HLT, but can also be used offline
+ *
+ * @file   AliHLTPHOSSanityInspector.h
+ * @author Oystein Djuvsland
+ * @date
+ * @brief  Sanity inspector for PHOS HLT
+ */
+
+//#include "AliHLTPHOSBase.h"
 #include "Rtypes.h"
 
-class AliHLTAltroData;
 
-class AliHLTPHOSSanityInspector : public AliHLTPHOSBase
+/** 
+ * @class AliHLTPHOSSanityInspector
+ * Sanity inspector for PHOS HLT. It takes raw data as input and checks it for insanity
+ * It will then flag it.
+ *
+ * @ingroup alihlt_phos
+ */
+
+//class AliHLTPHOSSanityInspector : public AliHLTPHOSBase
+class AliHLTPHOSSanityInspector
 {
   
 public:
+
+  /** Constructor */
   AliHLTPHOSSanityInspector();
   
+  /* Destructor */
   virtual ~AliHLTPHOSSanityInspector();
-   
-  Int_t CheckInsanity(UInt_t* data, Int_t nSamples);
-  Int_t CheckInsanity(Int_t* data, Int_t nSamples);
+
+  /** Copy constructor */  
+  AliHLTPHOSSanityInspector(const AliHLTPHOSSanityInspector &) : 
+    //    AliHLTPHOSBase(),
+    fMaxDifference(0)
+  {
+    //Copy constructor not implemented
+  }
+  
+  /** Assignment */
+  AliHLTPHOSSanityInspector & operator = (const AliHLTPHOSSanityInspector)
+  {
+    //Assignment
+    return *this; 
+  }
+  
+  
+  //  Int_t CheckInsanity(UInt_t* data, Int_t nSamples);
   
-  Int_t CheckAndHealInsanity(UInt_t* data, Int_t nSamples);  //Not completely reliable
-  Int_t CheckAndHealInsanity(Int_t* data, Int_t nSamples);  //Not completely reliable
+  
+  // Int_t CheckInsanity(Int_t* data, Int_t nSamples);
+  
+  
+  
+  /** Check for insanity */
+  Int_t CheckInsanity(const UShort_t* data, const Int_t nSamples) const;
+  
+  /** Check for and heal insanity */
+  Int_t CheckAndHealInsanity(UShort_t* data, Int_t nSamples);  //Not completely reliable
+
+  /** Check for and heal insanity */
+  Int_t CheckAndHealInsanity(UShort_t* data, Int_t nSamples);  //Not completely reliable
 
+  /** Set the max difference between 2 samples before flagging insanity */
   void SetMaxDifference(Int_t maxDiff) { fMaxDifference = maxDiff; }
     
 private:
-  Int_t fMaxDifference; //comment
+
+  /** The max difference between 2 samples */
+  Int_t fMaxDifference;           //COMMENT
  
   ClassDef(AliHLTPHOSSanityInspector, 1);
 };