SCT_ConditionsParameterCondAlg.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2022 CERN for the benefit of the ATLAS collaboration
*/
 
#include "SCT_ConditionsParameterCondAlg.h"
 
#include "AthenaPoolUtilities/CondAttrListVec.h"
#include "Identifier/IdentifierHash.h"
#include "SCT_ConditionsData/SCT_Chip.h"
 
#include <memory>
 
namespace { //anonymous namespace introduces file-scoped functions
  //is the value 'Not-a-Number' ?
  template <typename T>
  bool is_nan(const T& val) {
    return val!=val; //NaN is only value for which this is true
  }
  //response curve fit possibilities
  enum ResponseCurveFit{NO_CURVE=0, POLYNOMIAL, GRILLO, EXPONENTIAL, LINEAR, N_FUNCS}; //'Grillo' refers to Alex Grillo, Santa Cruz, who worked on SCT electronics development
  //response curve fit function
  float responseCurve(const float param0, const float param1, const float param2, const float vthreshold, const unsigned int rcFunc) {
    float result{std::numeric_limits<float>::quiet_NaN()};
    switch (rcFunc) {
    case LINEAR:
      if (param1!=0.0) {
        result = (vthreshold - param0)/param1;
      }
      break;
    case EXPONENTIAL:
      if ((vthreshold - param2)!=0) {
        float err2{param0/(vthreshold-param2)-1.0f};
        if (err2 > 0.0) {
          result = -param1*std::log(err2);
        }
      }
      break;
    case GRILLO:
      if (param2!=0) {
        float err3{param1*(1.0f-((vthreshold-param0)/param2))};
        if (err3!=0) {
          result = (vthreshold-param0)/err3;
        }
      }
      break;
    case POLYNOMIAL:
      if (param2!=0) {
        result = (-param1 + std::sqrt((param1*param1)-(4.0*param2*(param0-vthreshold)))) / 2.0*param2;
      }
      break;
    default:
      //nop
      break;
    }//switch
    if (is_nan(result)) return result;
    result *= result;
    return result;
  }//func responseCurve
 
  void parseResponseCurveArguments(float* p, const  std::string& arguments) {
    //string is of form:
    //p0 1.284730e+03 p1 5.830000e+00 p2 -5.989900e+02
    float* p0{&p[0]};
    float* p1{&p[1]};
    float* p2{&p[2]};
    std::sscanf(arguments.c_str(), "p0 %50e p1 %50e p2 %50e", p0, p1, p2);
  }
  //folder to retrieve for threshold parameters
  const std::string chipFolderName{"/SCT/DAQ/Configuration/Chip"}; //CoraCool folder in the DB
}//namespace
 
SCT_ConditionsParameterCondAlg::SCT_ConditionsParameterCondAlg(const std::string& name, ISvcLocator* pSvcLocator)
  : ::AthReentrantAlgorithm(name, pSvcLocator)
{
}
 
StatusCode SCT_ConditionsParameterCondAlg::initialize() {
  ATH_MSG_DEBUG("initialize " << name());
  
  // Cabling tool
  ATH_CHECK(m_cablingTool.retrieve());
  // Read Cond Handle
  ATH_CHECK(m_readKey.initialize());
  // Write Cond Handle
  ATH_CHECK(m_writeKey.initialize());
 
  return StatusCode::SUCCESS;
}
 
StatusCode SCT_ConditionsParameterCondAlg::execute(const EventContext& ctx) const {
  ATH_MSG_DEBUG("execute " << name());
 
  // Write Cond Handle
  SG::WriteCondHandle<SCT_CondParameterData> writeHandle{m_writeKey, ctx};
  // Do we have a valid Write Cond Handle for current time?
  if (writeHandle.isValid()) {
    ATH_MSG_DEBUG("CondHandle " << writeHandle.fullKey() << " is already valid."
                  << ". In theory this should not be called, but may happen"
                  << " if multiple concurrent events are being processed out of order.");
    return StatusCode::SUCCESS; 
  }
 
  // Read Cond Handle
  SG::ReadCondHandle<CondAttrListVec> readHandle{m_readKey, ctx};
  const CondAttrListVec* readCdo{*readHandle}; 
  if (readCdo==nullptr) {
    ATH_MSG_FATAL("Null pointer to the read conditions object");
    return StatusCode::FAILURE;
  }
  // Add dependency
  writeHandle.addDependency(readHandle);
  ATH_MSG_INFO("Size of CondAttrListVec " << readHandle.fullKey() << " readCdo->size()= " << readCdo->size());
  ATH_MSG_INFO("Range of input is " << readHandle.getRange());
  
  // Construct the output Cond Object and fill it in
  std::unique_ptr<SCT_CondParameterData> writeCdo{std::make_unique<SCT_CondParameterData>()};
 
  // Loop over elements (i.e groups of 6 chips) in DB folder 
  static const unsigned int nChipsPerModule{12};
  static const unsigned int nChipsPerSide{6};
  static const float mVperDacBit{2.5};
  CondAttrListVec::const_iterator modItr{readCdo->begin()};
  CondAttrListVec::const_iterator modEnd{readCdo->end()};
  for (; modItr != modEnd; modItr += nChipsPerModule) {
    // Get SN and identifiers (the channel number is serial number+1)
    const unsigned int truncatedSerialNumber{modItr->first - 1};
    const IdentifierHash& moduleHash{m_cablingTool->getHashFromSerialNumber(truncatedSerialNumber, ctx)};
    if (not moduleHash.is_valid()) continue;
    // Loop over chips within module
   
    for (unsigned int side{0}; side!=2; ++side) {
      IdentifierHash elementHash{moduleHash + side};
      CondAttrListVec::const_iterator channelItr{modItr};
      CondAttrListVec::const_iterator channelEnd{modItr + nChipsPerSide};
      std::vector<SCT_Chip*> chipsInMod;
      chipsInMod.reserve(nChipsPerSide);
      float parameters[3]{0.0, 0.0, 0.0};
      float chipsum{0.0};
      for (; channelItr != channelEnd; ++channelItr) {
        // Can get AttributeList from second (see https://svnweb.cern.ch/trac/lcgcoral/browser/coral/trunk/src/CoralBase/CoralBase/AttributeList.h )
        //short id      = channelItr->second[2].data<short>(); //chip 0-11
        float vthr{mVperDacBit * channelItr->second[10].data<short>()};  //threshold setting
        short rcFunctionIndex{channelItr->second[15].data<short>()}; //response curve function
        const std::string &rcArgumentString{channelItr->second[16].data<std::string>()}; //response curve arguments
        parseResponseCurveArguments(parameters, rcArgumentString);
        //float target = channelItr->second[18].data<float>(); //trim target...use for debugging only
        float femtoCoulombThreshold{responseCurve(parameters[0], parameters[1], parameters[2], vthr, rcFunctionIndex)};
        chipsum+=femtoCoulombThreshold;
      }
      float moduleAverage{chipsum/nChipsPerSide};
      writeCdo->setValue(elementHash, SCT_CondParameterData::AVG_THRESHOLD, moduleAverage);
    }//side loop
  }//module loop
 
  // Record the output cond object
  if (writeHandle.record(std::move(writeCdo)).isFailure()) {
    ATH_MSG_FATAL("Could not record SCT_CondParameterData " << writeHandle.key() 
                  << " with EventRange " << writeHandle.getRange()
                  << " into Conditions Store");
    return StatusCode::FAILURE;
  }
  ATH_MSG_INFO("recorded new CDO " << writeHandle.key() << " with range " << writeHandle.getRange() << " into Conditions Store");
 
  return StatusCode::SUCCESS;
}
 
StatusCode SCT_ConditionsParameterCondAlg::finalize()
{
  ATH_MSG_DEBUG("finalize " << name());
  return StatusCode::SUCCESS;
}