PHOSEnergyCalibDevice.cxx

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.
 
#include "PHOSCalibWorkflow/PHOSEnergyCalibDevice.h"
#include "DataFormatsPHOS/TriggerRecord.h"
#include "DataFormatsPHOS/PHOSBlockHeader.h"
#include "Framework/ConfigParamRegistry.h"
#include "Framework/RawDeviceService.h"
#include "Framework/ControlService.h"
#include "Framework/CCDBParamSpec.h"
#include "CCDB/CcdbApi.h"
#include "CCDB/BasicCCDBManager.h"
#include "CCDB/CcdbObjectInfo.h"
#include "DetectorsCalibration/Utils.h"
 
#include <fairmq/Device.h>
#include <fairlogger/Logger.h>
#include <string>
#include <filesystem>
 
using namespace o2::phos;
 
void PHOSEnergyCalibDevice::init(o2::framework::InitContext& ic)
{
  o2::base::GRPGeomHelper::instance().setRequest(mCCDBRequest);
 
  mPtMin = ic.options().get<float>("ptminmgg");
  mEminHGTime = ic.options().get<float>("eminhgtime");
  mEminLGTime = ic.options().get<float>("eminlgtime");
  mEDigMin = ic.options().get<float>("ecalibdigitmin");
  mECluMin = ic.options().get<float>("ecalibclumin");
 
  if (mOutputDir.compare("/dev/null")) {
    mOutputDir = o2::utils::Str::rectifyDirectory(mOutputDir);
  }
  if (mMetaFileDir.compare("/dev/null")) {
    mMetaFileDir = o2::utils::Str::rectifyDirectory(mMetaFileDir);
  }
 
  LOG(info) << "Energy calibration options";
  LOG(info) << " output-dif=" << mOutputDir;
  bool toFillDigits = mOutputDir.compare("/dev/null");
  if (toFillDigits) {
    LOG(info) << " Digits tree will be created";
  } else {
    LOG(info) << " Digits tree will NOT be created";
  }
  LOG(info) << " meta-output-dir=" << mMetaFileDir;
  LOG(info) << " mgg histo ptMin=" << mPtMin;
  LOG(info) << " Emin for HG time=" << mEminHGTime;
  LOG(info) << " Emin for LG time=" << mEminLGTime;
  LOG(info) << " Emin for out digits=" << mEDigMin;
  LOG(info) << " Cluster Emin for out digits=" << mECluMin;
 
  LOG(info) << " Root output dir=" << mOutputDir;
 
  mCalibrator = std::make_unique<PHOSEnergyCalibrator>();
 
  // read calibration and bad map objects and send them to calibrator
  if (!mHasCalib && !mUseCCDB) {
    mCalibParams = std::make_unique<CalibParams>(1); // Create test calibration coefficients
    mCalibrator->setCalibration(mCalibParams.get());
    mBadMap = std::make_unique<BadChannelsMap>(); // Create empty bad map
    mCalibrator->setBadMap(mBadMap.get());
    LOG(info) << "No reading BadMap/Calibration from ccdb requested, set default";
    mHasCalib = true;
  }
  mCalibrator->setCuts(mPtMin, mEminHGTime, mEminLGTime, mEminHGTime, mEminLGTime);
  mCalibrator->setFillDigitsTree(toFillDigits);
  mCalibrator->setUpdateAtTheEndOfRunOnly();
 
  // Create geometry instance (inclusing reading mis-alignement)
  // instance will be pick up by Calibrator
  Geometry::GetInstance("Run3");
}
 
//___________________________________________________________________
void PHOSEnergyCalibDevice::updateTimeDependentParams(ProcessingContext& pc)
{
  static bool initOnceDone = false;
  if (!initOnceDone) {
    initOnceDone = true;
    mDataTakingContext = pc.services().get<DataTakingContext>();
  }
  o2::base::GRPGeomHelper::instance().checkUpdates(pc);
}
 
void PHOSEnergyCalibDevice::run(o2::framework::ProcessingContext& pc)
{
  updateTimeDependentParams(pc);
 
  // Do not use ccdb if already created
  if (!mHasCalib) { // Default map and calibration was not set, use CCDB
    LOG(info) << "Getting calib from CCDB";
    // update BadMap and calibration if necessary
    auto badMapPtr = pc.inputs().get<o2::phos::BadChannelsMap*>("bdmap");
    mCalibrator->setBadMap(badMapPtr.get());
 
    auto calibPtr = pc.inputs().get<o2::phos::CalibParams*>("clb");
    mCalibrator->setCalibration(calibPtr.get());
    mHasCalib = true;
  }
  mOutputDigits.clear();
 
  auto tfcounter = o2::header::get<o2::framework::DataProcessingHeader*>(pc.inputs().get("clusters").header)->startTime; // is this the timestamp of the current TF?
  const gsl::span<const Cluster>& clusters = pc.inputs().get<gsl::span<Cluster>>("clusters");
  const gsl::span<const CluElement>& cluelements = pc.inputs().get<gsl::span<CluElement>>("cluelements");
  const gsl::span<const TriggerRecord>& cluTR = pc.inputs().get<gsl::span<TriggerRecord>>("clusterTriggerRecords");
 
  LOG(debug) << "[PHOSEnergyCalibDevice - run]  Received " << cluTR.size() << " TRs and " << clusters.size() << " clusters, running calibration";
  if (mRunStartTime == 0) {
    const auto& tinfo = pc.services().get<o2::framework::TimingInfo>();
    mRunStartTime = tinfo.creation; // approximate time in ms
    mRunNumber = tinfo.runNumber;
 
    auto LHCPeriodStr = pc.services().get<RawDeviceService>().device()->fConfig->GetProperty<std::string>("LHCPeriod", "");
    if (!(LHCPeriodStr.empty())) {
      mLHCPeriod = LHCPeriodStr;
    } else {
      const char* months[12] = {"JAN", "FEB", "MAR", "APR", "MAY", "JUN",
                                "JUL", "AUG", "SEP", "OCT", "NOV", "DEC"};
      std::time_t tt = mRunStartTime / 1000; // ms->s
      std::tm* ltm = std::gmtime(&tt);
      mLHCPeriod = (std::string)months[ltm->tm_mon];
      LOG(warning) << "LHCPeriod is not available, using current month " << mLHCPeriod;
    }
  }
  o2::base::TFIDInfoHelper::fillTFIDInfo(pc, mCalibrator->getCurrentTFInfo());
  mCalibrator->process(tfcounter, clusters, cluelements, cluTR, mOutputDigits);
 
  fillOutputTree();
}
 
void PHOSEnergyCalibDevice::endOfStream(o2::framework::EndOfStreamContext& ec)
{
  mCalibrator->checkSlotsToFinalize(o2::calibration::INFINITE_TF);
  mCalibrator->endOfStream();
  writeOutFile();
}
 
void PHOSEnergyCalibDevice::stop()
{
  // DDS stop method: simply write the latest tree
  LOG(info) << "STOP: writing output digits file";
  writeOutFile();
}
void PHOSEnergyCalibDevice::fillOutputTree()
{
 
  if (mOutputDigits.size() < 2) { // nothing to fill, need at least 2 cluster per event
    return;
  }
 
  LOG(info) << "Filling tree with " << mOutputDigits.size() << " digits";
  if (!mFileOut) { // create file and tree
    if (mWriteRootOutput) {
      mFileName = mOutputDir + fmt::format("PHOS_CalibDigits_{}.root", mRunNumber);
      LOG(info) << "Creating new tree for PHOS calib digits, output file=" << mFileName;
      mFileOut = std::make_unique<TFile>(mFileName.c_str(), "recreate");
      mFileMetaData = std::make_unique<o2::dataformats::FileMetaData>();
      mHistoFileName = mOutputDir + fmt::format("PHOS_CalibHistos_{}.root", mRunNumber);
      mHistoFileOut = std::make_unique<TFile>(mHistoFileName.c_str(), "recreate");
      mHistoFileMetaData = std::make_unique<o2::dataformats::FileMetaData>();
      mFileOut->cd();
    }
    // else Tree will be memory resident
    if (!mTreeOut) {
      LOG(info) << "Creating new tree for PHOS calib digits";
      mTreeOut = std::make_unique<TTree>("phosCalibDig", "O2 PHOS calib tree");
    }
  }
  auto* br = mTreeOut->GetBranch("PHOSCalib");
  if (!br) {
    br = mTreeOut->Branch("PHOSCalib", &mOutputDigits);
  }
  mTreeOut->Fill();
}
 
void PHOSEnergyCalibDevice::writeOutFile()
{
  if (!mWriteRootOutput) {
    return;
  }
  // write collected vector and metadata
  if (!mTreeOut) { // nothing to write,
    return;
  }
  LOG(info) << "Writing calibration digits";
 
  int nbits = mTreeOut->Write();
  LOG(info) << "Wrote " << nbits << " bits";
  mTreeOut.reset();
  mFileOut->Close();
  mFileOut.reset();
 
  // write metaFile data
  mFileMetaData->fillFileData(mFileName);
  mFileMetaData->setDataTakingContext(mDataTakingContext);
  mFileMetaData->type = "calib";
  mFileMetaData->priority = "high";
 
  std::string metaFileNameTmp = mMetaFileDir + fmt::format("PHOS_CalibDigits_{}.tmp", mRunNumber);
  std::string metaFileName = mMetaFileDir + fmt::format("PHOS_CalibDigits_{}.done", mRunNumber);
  if (mMetaFileDir.compare("/dev/null")) {
    try {
      std::ofstream metaFileOut(metaFileNameTmp);
      metaFileOut << *mFileMetaData.get();
      metaFileOut.close();
      std::filesystem::rename(metaFileNameTmp, metaFileName);
    } catch (std::exception const& e) {
      LOG(error) << "Failed to store PHOS meta data file " << metaFileName << ", reason: " << e.what();
    }
    LOG(info) << "Stored metadate file " << mFileName << ".done";
  } else {
    LOG(info) << "Scipped storing metafile as meta-dir=" << mMetaFileDir;
  }
  mFileMetaData.reset();
 
  LOG(info) << "Writing calibration histograms";
  mHistoFileOut->cd();
  mHistoFileOut->WriteObjectAny(mCalibrator->getCollectedHistos(), "o2::phos::ETCalibHistos", "histos");
  mHistoFileOut->Close();
  mHistoFileOut.reset();
 
  // write metaFile data
  mHistoFileMetaData->fillFileData(mHistoFileName);
  mHistoFileMetaData->setDataTakingContext(mDataTakingContext);
  mHistoFileMetaData->type = "calib";
  mHistoFileMetaData->priority = "high";
 
  metaFileNameTmp = mMetaFileDir + fmt::format("PHOS_CalibHistos_{}.tmp", mRunNumber);
  metaFileName = mMetaFileDir + fmt::format("PHOS_CalibHistos_{}.done", mRunNumber);
  if (mMetaFileDir.compare("/dev/null")) {
    try {
      std::ofstream metaFileOut(metaFileNameTmp);
      metaFileOut << *mHistoFileMetaData.get();
      metaFileOut.close();
      std::filesystem::rename(metaFileNameTmp, metaFileName);
    } catch (std::exception const& e) {
      LOG(error) << "Failed to store PHOS histos meta data file " << metaFileName << ", reason: " << e.what();
    }
    LOG(info) << "Stored histos metadate file " << mHistoFileName << ".done";
  }
  mHistoFileMetaData.reset();
}
o2::framework::DataProcessorSpec o2::phos::getPHOSEnergyCalibDeviceSpec(bool useCCDB, const std::string& outputDir, const std::string& metaFileDir, bool writeRootOutput)
{
 
  std::vector<InputSpec> inputs;
  inputs.emplace_back("clusters", o2::header::gDataOriginPHS, "CLUSTERS", 0, o2::framework::Lifetime::Timeframe);
  inputs.emplace_back("cluelements", o2::header::gDataOriginPHS, "CLUELEMENTS", 0, o2::framework::Lifetime::Timeframe);
  inputs.emplace_back("clusterTriggerRecords", o2::header::gDataOriginPHS, "CLUSTERTRIGREC", 0, o2::framework::Lifetime::Timeframe);
  if (useCCDB) {
    inputs.emplace_back("bdmap", o2::header::gDataOriginPHS, "PHS_BM", 0, o2::framework::Lifetime::Condition, o2::framework::ccdbParamSpec("PHS/Calib/BadMap"));
    inputs.emplace_back("clb", o2::header::gDataOriginPHS, "PHS_Calibr", 0, o2::framework::Lifetime::Condition, o2::framework::ccdbParamSpec("PHS/Calib/CalibParams"));
  }
  auto ccdbRequest = std::make_shared<o2::base::GRPGeomRequest>(true,                           // orbitResetTime
                                                                true,                           // GRPECS=true
                                                                false,                          // GRPLHCIF
                                                                false,                          // GRPMagField
                                                                false,                          // askMatLUT
                                                                o2::base::GRPGeomRequest::None, // geometry
                                                                inputs);
  using clbUtils = o2::calibration::Utils;
  std::vector<OutputSpec> outputs;
 
  return o2::framework::DataProcessorSpec{"PHOSEnergyCalibDevice",
                                          inputs,
                                          outputs,
                                          o2::framework::adaptFromTask<PHOSEnergyCalibDevice>(useCCDB, ccdbRequest, outputDir, metaFileDir, writeRootOutput),
                                          o2::framework::Options{
                                            {"ptminmgg", o2::framework::VariantType::Float, 1.5f, {"minimal pt to fill mgg calib histos"}},
                                            {"eminhgtime", o2::framework::VariantType::Float, 1.5f, {"minimal E (GeV) to fill HG time calib histos"}},
                                            {"eminlgtime", o2::framework::VariantType::Float, 5.f, {"minimal E (GeV) to fill LG time calib histos"}},
                                            {"ecalibdigitmin", o2::framework::VariantType::Float, 0.05f, {"minimal digtit E (GeV) to keep digit for calibration"}},
                                            {"ecalibclumin", o2::framework::VariantType::Float, 0.4f, {"minimal cluster E (GeV) to keep digit for calibration"}}}};
}