ROFTimeClusterFinder.h

Go to the documentation of this file.

// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
// All rights not expressly granted are reserved.
//
// This software is distributed under the terms of the GNU General Public
// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
 
 
#ifndef O2_MCH_ROFTIMECLUSTERFINDER_H_
#define O2_MCH_ROFTIMECLUSTERFINDER_H_
 
#include <cassert>
#include <cstdint>
#include <vector>
#include <gsl/span>
 
#include "DataFormatsMCH/Digit.h"
#include "DataFormatsMCH/ROFRecord.h"
#include "MCHDigitFiltering/DigitFilter.h"
 
namespace o2
{
namespace mch
{
 
class ROFTimeClusterFinder
{
 public:
  using ROFVector = std::vector<o2::mch::ROFRecord>;
 
  ROFTimeClusterFinder(gsl::span<const o2::mch::ROFRecord> rofs, gsl::span<const o2::mch::Digit> digits, uint32_t timeClusterSize, uint32_t nBins, bool improvePeakSearch, bool debug);
  ~ROFTimeClusterFinder() = default;
 
  void process();
 
  const ROFVector& getROFRecords() const { return mOutputROFs; }
 
  char* saveROFRsToBuffer(size_t& bufSize);
 
  void dumpInputROFs();
  void dumpOutputROFs();
 
 private:
  struct TimeBin {
    int32_t mFirstIdx{-1};  
    int32_t mLastIdx{-1};   
    uint32_t mNDigitsPS{0}; 
 
    TimeBin() = default;
 
    bool empty() { return mNDigitsPS == 0; }
 
    bool operator<(const TimeBin& other) { return (mNDigitsPS < other.mNDigitsPS); }
    bool operator>(const TimeBin& other) { return (mNDigitsPS > other.mNDigitsPS); }
    bool operator<=(const TimeBin& other) { return (mNDigitsPS <= other.mNDigitsPS); }
    bool operator>=(const TimeBin& other) { return (mNDigitsPS >= other.mNDigitsPS); }
  };
 
  // peak search parameters
  uint32_t mTimeClusterSize;  
  uint32_t mNbinsInOneWindow; 
  uint32_t mBinWidth;         
  uint32_t mNbinsInOneTF;     
  DigitFilter mIsGoodDigit;   
  bool mImprovePeakSearch;    
 
  void initTimeBins();
  int32_t getNextPeak();
  void storeROF(int32_t firstBin, int32_t lastBin);
 
  std::vector<TimeBin> mTimeBins; 
  int32_t mLastSavedTimeBin;      
 
  gsl::span<const o2::mch::ROFRecord> mInputROFs; 
  gsl::span<const o2::mch::Digit> mDigits;        
  ROFVector mOutputROFs{};                        
  bool mDebug{false};                             
};
 
} // namespace mch
} // namespace o2
 
#endif // O2_MCH_ROFTIMECLUSTERFINDER_H_