ClustersReaderSpec.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 "HMPIDWorkflow/ClustersReaderSpec.h"
 
#include <random>
#include <iostream>
#include <fstream>
#include <stdexcept>
#include <array>
#include <functional>
#include <vector>
 
#include "CommonUtils/StringUtils.h" // o2::utils::Str
 
#include "Framework/CallbackService.h"
#include "Framework/ConfigParamRegistry.h"
#include "Framework/ControlService.h"
#include "Framework/Lifetime.h"
#include "Framework/Output.h"
#include "Framework/Logger.h"
#include "Framework/DataRefUtils.h"
#include "Framework/InputRecordWalker.h"
 
#include "Headers/RAWDataHeader.h"
#include "DetectorsRaw/RDHUtils.h"
#include "DPLUtils/DPLRawParser.h"
 
namespace o2
{
namespace hmpid
{
 
using namespace o2;
using namespace o2::framework;
using RDH = o2::header::RDHAny;
 
//
void ClusterReaderTask::init(framework::InitContext& ic)
{
  LOG(info) << "[HMPID Cluster reader - init() ] ";
  mClustersReceived = 0;
  // Build the file name
  const auto filename = o2::utils::Str::concat_string(
    o2::utils::Str::rectifyDirectory(
      ic.options().get<std::string>("input-dir")),
    ic.options().get<std::string>("hmpid-cluster-infile" /*"qc-hmpid-clusters"*/));
  initFileIn(filename);
}
 
void ClusterReaderTask::run(ProcessingContext& pc)
{
 
  auto ent = mTree->GetReadEntry() + 1;
  // A timeframe holds no collision at all whenever the interaction rate is low enough, and
  // the tree then has no entry to read. Publish empty containers instead of reading past the
  // end and pushing branch addresses that GetEntry has not filled, so that the consumers
  // downstream still see the timeframe. (This used to be an assert, which is compiled out of
  // every production build since ENABLE_CASSERT defaults to OFF.)
  const bool noEntry = ent >= mTree->GetEntries();
  if (noEntry) {
    LOG(info) << "no entry to read, publishing empty output";
  } else {
    mTree->GetEntry(ent);
  }
 
  pc.outputs().snapshot(Output{"HMP", "CLUSTERS", 0}, mClustersFromFile);
  pc.outputs().snapshot(Output{"HMP", "INTRECORDS1", 0}, mClusterTriggersFromFile);
  mClustersReceived += mClustersFromFile.size();
  LOG(info) << "[HMPID ClusterReader - run() ] clusters  = " << mClustersFromFile.size();
 
  if (noEntry || mTree->GetReadEntry() + 1 >= mTree->GetEntries()) {
    pc.services().get<ControlService>().endOfStream();
    pc.services().get<ControlService>().readyToQuit(QuitRequest::Me);
    mExTimer.stop();
    mExTimer.logMes("End ClusterReader !  clusters = " +
                    std::to_string(mClustersReceived));
  }
}
 
void ClusterReaderTask::initFileIn(const std::string& filename)
{
  // Create the TFIle
  mTree.reset(nullptr);
  mFile = std::make_unique<TFile>(filename.c_str(), "OLD");
  assert(mFile && !mFile->IsZombie());
 
  if (!mFile->IsOpen() || mFile == nullptr) {
    LOG(error) << "HMPID ClusterReaderTask::init() : Did not find any Clusters file " << filename.c_str() << " file !";
    throw std::runtime_error("cannot open input clusters file");
  } else {
    LOG(info) << "HMPID ClusterReaderTask::init() : Found Clusters file " << filename.c_str();
  }
 
  if ((TTree*)mFile->Get("o2hmp")) {
    mTree.reset((TTree*)mFile->Get("o2hmp"));
  } else if ((TTree*)mFile->Get("o2sim")) {
    mTree.reset((TTree*)mFile->Get("o2sim"));
  } else {
    LOG(error)
      << "HMPID ClusterReaderTask::init() : Did not find either Tree o2sim or o2hmp tree in "
      << filename.c_str();
    throw std::runtime_error(
      "HMPID ClusterReaderTask::init() : Did not find "
      "o2sim file in clusters tree");
  }
 
  if (mTree->GetBranchStatus("HMPIDClusters") == 1) {
    mTree->SetBranchAddress("HMPIDClusters", &mClustersFromFilePtr);
  } else if (mTree->GetBranchStatus("HMPIDclusters") == 1) {
    mTree->SetBranchAddress("HMPIDclusters", &mClustersFromFilePtr);
  } else {
    LOG(error)
      << "HMPID ClusterReaderTask::init() : Did not find Branch in "
      << filename.c_str();
    throw std::runtime_error(
      "HMPID ClusterReaderTask::init() : Did not find Branch HMPIDClusters in clusters tree");
  }
 
  mTree->SetBranchAddress("InteractionRecords", &mClusterTriggersFromFilePtr);
  mTree->Print("toponly");
}
 
//_________________________________________________________________________________________________
 
o2::framework::DataProcessorSpec getClusterReaderSpec()
{
 
  std::vector<o2::framework::OutputSpec> outputs;
  outputs.emplace_back("HMP", "CLUSTERS", 0, o2::framework::Lifetime::Timeframe);
  outputs.emplace_back("HMP", "INTRECORDS1", 0, o2::framework::Lifetime::Timeframe);
 
  return DataProcessorSpec{
    "HMP-ClusterReader",
    Inputs{},
    outputs,
    AlgorithmSpec{adaptFromTask<ClusterReaderTask>()},
    Options{{"hmpid-cluster-infile" /*"qc-hmpid-clusters"*/, VariantType::String, "hmpidclusters.root", {"Name of the input file with clusters"}},
            {"input-dir", VariantType::String, "./", {"Input directory"}}}};
}
 
} // namespace hmpid
} // end namespace o2