stf-decoder-workflow.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 "ITSMFTWorkflow/STFDecoderSpec.h"
#include "CommonUtils/ConfigurableParam.h"
#include "Framework/ConfigParamSpec.h"
 
using namespace o2::framework;
 
// ------------------------------------------------------------------
 
// we need to add workflow options before including Framework/runDataProcessing
void customize(std::vector<o2::framework::ConfigParamSpec>& workflowOptions)
{
  // option allowing to set parameters
  std::vector<ConfigParamSpec> options{
    ConfigParamSpec{"verify", VariantType::Bool, false, {"verify ALPIDE decoder by re-encoding the data"}},
    ConfigParamSpec{"runmft", VariantType::Bool, false, {"source detector is MFT (default ITS)"}},
    ConfigParamSpec{"no-clusters", VariantType::Bool, false, {"do not produce clusters (def: produce)"}},
    ConfigParamSpec{"no-cluster-patterns", VariantType::Bool, false, {"do not produce clusters patterns (def: produce)"}},
    ConfigParamSpec{"digits", VariantType::Bool, false, {"produce digits (def: skip)"}},
    ConfigParamSpec{"enable-calib-data", VariantType::Bool, false, {"produce GBT calibration stream (def: skip)"}},
    ConfigParamSpec{"squash-overflow-pixels", VariantType::Bool, false, {"merge chip information of consecutively fired neighbour pixels (for ALPIDE time-walking)"}},
    ConfigParamSpec{"ignore-dist-stf", VariantType::Bool, false, {"do not subscribe to FLP/DISTSUBTIMEFRAME/0 message (no lost TF recovery)"}},
    ConfigParamSpec{"dataspec", VariantType::String, "", {"selection string for the input data, if not provided <DET>Raw:<DET>/RAWDATA with DET=ITS or MFT will be used"}},
    ConfigParamSpec{"report-dds-collection-index", VariantType::Int, -1, {"number of dpl collection allowed to produce decoding report (-1 means no limit)"}},
    ConfigParamSpec{"configKeyValues", VariantType::String, "", {"Semicolon separated key=value strings"}}};
 
  std::swap(workflowOptions, options);
}
 
// ------------------------------------------------------------------
 
#include "Framework/runDataProcessing.h"
 
WorkflowSpec defineDataProcessing(ConfigContext const& cfgc)
{
  WorkflowSpec wf;
  o2::itsmft::STFDecoderInp inp;
  inp.doClusters = !cfgc.options().get<bool>("no-clusters");
  inp.doPatterns = inp.doClusters && !cfgc.options().get<bool>("no-cluster-patterns");
  inp.doDigits = cfgc.options().get<bool>("digits");
  inp.doCalib = cfgc.options().get<bool>("enable-calib-data");
  inp.doSquashing = cfgc.options().get<bool>("squash-overflow-pixels");
  inp.askSTFDist = !cfgc.options().get<bool>("ignore-dist-stf");
  inp.verifyDecoder = cfgc.options().get<bool>("verify");
  inp.inputSpec = cfgc.options().get<std::string>("dataspec");
  // Update the (declared) parameters if changed from the command line
  o2::conf::ConfigurableParam::updateFromString(cfgc.options().get<std::string>("configKeyValues"));
 
  if (cfgc.options().get<bool>("runmft")) {
    if (inp.inputSpec.empty()) {
      inp.inputSpec = "mftRAW:MFT/RAWDATA";
    }
    inp.origin = o2::header::gDataOriginMFT;
    inp.deviceName = "mft-stf-decoder";
  } else {
    if (inp.inputSpec.empty()) {
      inp.inputSpec = "itsRAW:ITS/RAWDATA";
    }
    inp.origin = o2::header::gDataOriginITS;
    inp.deviceName = "its-stf-decoder";
  }
 
  inp.allowReporting = true;
  int repDDSColIdx = cfgc.options().get<int>("report-dds-collection-index");
  if (repDDSColIdx != -1) {
    char* colIdx = getenv("DDS_COLLECTION_INDEX");
    int myIdx = colIdx ? atoi(colIdx) : -1;
    inp.allowReporting = myIdx == repDDSColIdx;
  }
 
  wf.emplace_back(o2::itsmft::getSTFDecoderSpec(inp));
 
  return wf;
}