SdPMTQualityChecker.cc

Go to the documentation of this file.

#include "SdPMTQualityChecker.h"

#include <fwk/CentralConfig.h>
#include <det/VManager.h>
#include <utl/Branch.h>
#include <evt/Event.h>
#include <sevt/SEvent.h>
#include <sevt/Station.h>
#include <utl/TimeStamp.h>
#include <sevt/PMT.h>
#include <sevt/PMTQuality.h>
#include <sdet/PMTConstants.h>

using namespace std;

using namespace fwk;
using namespace det;
using namespace utl;
using namespace evt;
using namespace sevt;


namespace SdPMTQualityCheckerKG {

  inline
  bool
  IsInRange(const double x, const pair<double, double>& r)
  {
    return r.first <= x && x <= r.second;
  }


  inline
  bool
  IsValidPositiveRange(const pair<double, double>& r)
  {
    return r.first >= 0 && r.second >= 0 && r.first < r.second;
  }


  VModule::ResultFlag
  SdPMTQualityChecker::Init()
  {
    const auto topB = CentralConfig::GetInstance()->GetTopBranch("SdPMTQualityChecker");

    topB.GetChild("verbose").GetData(fVerbose);

    const auto calibratorBranch = topB.GetChild("calibratorBranch").Get<string>();
    const auto calibTopB = CentralConfig::GetInstance()->GetTopBranch(calibratorBranch);
    calibTopB.GetChild("peakOnlineToVEMFactor").GetData(fPeakOnlineToVEMFactor);

    topB.GetChild("validGainRatioRange").GetData(fValidGainRatioRange);
    topB.GetChild("validVEMPeakRange").GetData(fValidVEMPeakRange);
    topB.GetChild("maxSigmaBaseline").GetData(fMaxSigmaBaseline);

    if (!IsValidPositiveRange(fValidGainRatioRange)) {
      ERROR("error in <validGainRatioRange>");
      return eFailure;
    }

    if (!IsValidPositiveRange(fValidVEMPeakRange)) {
      ERROR("error in <validVEMPeakRange>");
      return eFailure;
    }

    if (fMaxSigmaBaseline < 0) {
      ERROR("error in <maxSigmaBaseline>");
      return eFailure;
    }

    return eSuccess;
  }


  VModule::ResultFlag
  SdPMTQualityChecker::Run(Event& event)
  {
    if (!event.HasSEvent())
      return eSuccess;

    PMTChecks(event);

    return eSuccess;
  }


  VModule::ResultFlag
  SdPMTQualityChecker::PMTChecks(evt::Event& event)
  {
    auto& sEvent = event.GetSEvent();

    ostringstream info;

    for (auto& station : sEvent.StationsRange()) {

      /* Information related to PMTQuality and on-line values is missing
         for upgraded (UUB) stations and for the SSD. Quality checks should
         be implemented once this information is available. */
      if (station.IsUUB())
        continue;

      const unsigned int sId = station.GetId();
      bool allbad = true;
      int hasCalib = 0;

      for (auto& pmt : station.PMTsRange()) {

        if (!pmt.HasCalibData())
          continue;
        auto& pmtCalib = pmt.GetCalibData();

        ++hasCalib;

        const unsigned int pmtId = pmt.GetId();

        // transferring cuts specified in Auger event
        if (pmt.HasQuality()) {
          const auto& pmtQuality = pmt.GetQuality();
          if (!pmtQuality.IsTubeOk()) {
            pmtCalib.SetIsTubeOk(false);
            info << "\nFlagging whole PMT " << pmtId << " of station " << sId
                 << " as bad (reason: Auger event PMT quality flag).";
          }
          if (!pmtQuality.HasAnode()) {
            pmtCalib.SetIsLowGainOk(false);
            info << "\nFlagging anode (LG) of PMT " << pmtId << " of station " << sId
                 << " as bad (reason: Auger event PMT quality flag).";
          }
        }

        double daRatio = 0;
        if (pmt.HasRecData())
          daRatio = pmt.GetRecData().GetGainRatio();
        if (!daRatio) {
          const int calibVersion = station.GetCalibData().GetVersion();
          // other cuts as implemented in CDAS/Es.cc/MoreQualityCuts()
          // this is in SdCalibrator and also in TCalibStation::Calibrate() of CDAS/EcOff.cc
          daRatio = pmtCalib.GetGainRatio() / (calibVersion == 12 ? 1.07 : 1);
        }

        if (!IsInRange(daRatio, fValidGainRatioRange)) {
          info << "\nFlagging anode (LG) of PMT " << pmtId << " of station " << sId
               << " as bad (reason: D/A out of allowed range).";
          pmtCalib.SetIsLowGainOk(false);
        }

        const double vemPeak = pmtCalib.GetOnlinePeak() * fPeakOnlineToVEMFactor;

        if (!IsInRange(vemPeak, fValidVEMPeakRange)) {
          info << "\nFlagging whole PMT " << pmtId << " of station " << sId
               << " as bad (reason: vemPeak out of allowed range).";
          pmtCalib.SetIsTubeOk(false);
        }

        if (pmtCalib.GetBaselineRMS() > fMaxSigmaBaseline) {
          info << "\nFlagging whole PMT " << pmtId << " of station " << sId
               << " as bad (reason: sigma baseline above allowed limit).";
          pmtCalib.SetIsTubeOk(false);
        }

        if (pmtCalib.IsTubeOk())
          allbad = false;
      }

      if (allbad && hasCalib > 0) {
        info << "\nRejecting station " << sId << " because all PMTs are flagged as bad.";
        station.SetRejected(StationConstants::eAllPMTsBad);
      }

    }

    if (fVerbose) {
      const string mess = info.str();
      if (!mess.empty())
        INFO("Applying PMT quality flags according to information in the raw event:" + mess);
    }

    return eSuccess;
  }

}