NoiseSlotCalibrator.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_ITS_NOISESLOTCALIBRATOR
#define O2_ITS_NOISESLOTCALIBRATOR
 
#include <string>
 
#include "DataFormatsITSMFT/TopologyDictionary.h"
#include "DetectorsCalibration/TimeSlotCalibration.h"
#include "DetectorsCalibration/TimeSlot.h"
 
#include "DataFormatsITSMFT/CompCluster.h"
#include "DataFormatsITSMFT/NoiseMap.h"
#include "gsl/span"
 
namespace o2
{
 
namespace itsmft
{
class ROFRecord;
} // namespace itsmft
 
namespace its
{
 
class NoiseSlotCalibrator : public o2::calibration::TimeSlotCalibration<o2::itsmft::NoiseMap>
{
  using Slot = calibration::TimeSlot<o2::itsmft::NoiseMap>;
 
 public:
  NoiseSlotCalibrator() { setUpdateAtTheEndOfRunOnly(); }
  NoiseSlotCalibrator(bool one, float prob, float relErr) : m1pix(one), mProbabilityThreshold(prob), mProbRelErr(relErr)
  {
    mMinROFs = 1.1 * o2::itsmft::NoiseMap::getMinROFs(prob, relErr);
    LOGP(info, "Expect at least {} ROFs needed to apply threshold {} with relative error {}", mMinROFs, mProbabilityThreshold, mProbRelErr);
    setUpdateAtTheEndOfRunOnly();
  }
  ~NoiseSlotCalibrator() final = default;
 
  bool processTimeFrame(gsl::span<const o2::itsmft::CompClusterExt> const& clusters,
                        gsl::span<const unsigned char> const& patterns,
                        gsl::span<const o2::itsmft::ROFRecord> const& rofs);
 
  void setMinROFs(long n) { mMinROFs = n; }
 
  void finalize()
  {
    LOG(info) << "Number of processed strobes is " << mNumberOfStrobes;
    auto& slot = getSlots().back();
    slot.getContainer()->applyProbThreshold(mProbabilityThreshold, mNumberOfStrobes);
  }
 
  void loadDictionary(std::string fname)
  {
    mDict.readFromFile(fname);
  }
  const o2::itsmft::NoiseMap& getNoiseMap(long& start, long& end)
  {
    const auto& slot = getSlots().back();
    start = slot.getTFStart();
    end = slot.getTFEnd();
    return *(slot.getContainer());
  }
 
  // Functions overloaded from the calibration framework
  bool process(const gsl::span<const o2::itsmft::CompClusterExt> data);
 
  // Functions required by the calibration framework
  void initOutput() final {}
  Slot& emplaceNewSlot(bool, calibration::TFType, calibration::TFType) final;
  void finalizeSlot(Slot& slot) final;
  bool hasEnoughData(const Slot& slot) const final;
 
 private:
  o2::itsmft::TopologyDictionary mDict;
  float mProbabilityThreshold = 3e-6f;
  float mProbRelErr = 0.2; // relative error on channel noise to apply the threshold
  long mMinROFs = 0;
  unsigned int mNumberOfStrobes = 0;
  bool m1pix = true;
};
 
} // namespace its
} // namespace o2
 
#endif /* O2_ITS_NOISESLOTCALIBRATOR */