DigitsWriteoutBuffer.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 ALICEO2_EMCAL_DIGITSWRITEOUTBUFFER_H_
#define ALICEO2_EMCAL_DIGITSWRITEOUTBUFFER_H_
 
#include <memory>
#include <unordered_map>
#include <vector>
#include <deque>
#include <list>
#include <gsl/span>
#include "DataFormatsEMCAL/Digit.h"
#include "CommonDataFormat/InteractionRecord.h"
#include "EMCALSimulation/LabeledDigit.h"
#include "EMCALSimulation/DigitsVectorStream.h"
 
namespace o2
{
namespace emcal
{
 
 
class DigitsWriteoutBuffer
{
 public:
  DigitsWriteoutBuffer(unsigned int nTimeBins = 15);
 
  ~DigitsWriteoutBuffer() = default;
 
  void clear();
 
  void flush() { mDigitStream.clear(); }
 
  void init();
 
  void reserve();
 
  void finish();
 
  double getTriggerTime() const { return mTriggerTime; }
  double getEventTime() const { return mLastEventTime; }
  bool isLive(double t) const
  {
    return ((t - mTriggerTime) < mLiveTime || (t - mTriggerTime) >= (mLiveTime + mBusyTime - mPreTriggerTime));
  }
  bool isLive() const
  {
    return ((mLastEventTime - mTriggerTime) < (mLiveTime - mPreTriggerTime) || (mLastEventTime - mTriggerTime) >= (mLiveTime + mBusyTime - mPreTriggerTime));
  }
 
  bool isCurrentEventTriggered() const
  {
    return mLastEventTime == mTriggerTime;
  }
 
  // function returns true if the collision occurs 600ns before the readout window is open
  // Look here for more details https://alice.its.cern.ch/jira/browse/EMCAL-681
  bool preTriggerCollision() const { return ((mLastEventTime - mTriggerTime) >= (mLiveTime + mBusyTime - mPreTriggerTime)); }
 
  void addDigits(unsigned int towerID, std::vector<LabeledDigit>& digList);
 
  void setSampledDigitsTime();
 
  void setBufferSize(unsigned int nsamples) { mBufferSize = nsamples; }
  unsigned int getBufferSize() const { return mBufferSize; }
 
  void forwardMarker(o2::InteractionTimeRecord record, bool trigger);
 
  void setLiveTime(unsigned int liveTime) { mLiveTime = liveTime; }
  void setBusyTime(unsigned int busyTime) { mBusyTime = busyTime; }
  void setPreTriggerTime(unsigned int pretriggerTime) { mPreTriggerTime = pretriggerTime; }
 
  unsigned int getPhase() const { return mPhase; }
 
  const std::vector<o2::emcal::Digit>& getDigits() const { return mDigitStream.getDigits(); }
  const std::vector<o2::emcal::TriggerRecord>& getTriggerRecords() const { return mDigitStream.getTriggerRecords(); }
  const o2::dataformats::MCTruthContainer<o2::emcal::MCLabel>& getMCLabels() const { return mDigitStream.getMCLabels(); }
 
 private:
  unsigned int mBufferSize = 15;                          
  unsigned int mLiveTime = 1500;                          
  unsigned int mBusyTime = 35000;                         
  unsigned int mPreTriggerTime = 600;                     
  unsigned long mTriggerTime = 0;                         
  unsigned long mLastEventTime = 0;                       
  unsigned int mPhase = 0;                                
  unsigned int mSwapPhase = 0;                            
  bool mFirstEvent = true;                                
  std::deque<o2::emcal::DigitTimebin> mTimedDigitsFuture; 
  std::deque<o2::emcal::DigitTimebin> mTimedDigitsPast;   
 
  o2::emcal::DigitsVectorStream mDigitStream; 
 
  ClassDefNV(DigitsWriteoutBuffer, 1);
};
 
} // namespace emcal
 
} // namespace o2
 
#endif /* ALICEO2_EMCAL_DIGITSWRITEOUTBUFFER_H_ */