TileRawChannelOF1Corrector Class Reference

This tool correct TileRawChannels amplitudes which came from OF1 DSP if pedestal changed. More...

#include <TileRawChannelOF1Corrector.h>

Inheritance diagram for TileRawChannelOF1Corrector:

Collaboration diagram for TileRawChannelOF1Corrector:

Public Member Functions
	TileRawChannelOF1Corrector (const std::string &type, const std::string &name, const IInterface *parent)
	AlgTool like constructor. More...
virtual	~TileRawChannelOF1Corrector ()
	Virtual destructor. More...
virtual StatusCode	initialize () override
	AlgTool initialize method. More...
virtual StatusCode	finalize () override
	AlgTool finalize method. More...
virtual StatusCode	process (TileMutableRawChannelContainer &rchCont, const EventContext &ctx) const override
	Correct TileRawChannel amplitudes if pedestal changed. More...

Private Attributes
const TileHWID *	m_tileHWID
	Pointer to TileHWID. More...
SG::ReadCondHandleKey< TileSampleNoise >	m_sampleNoiseKey
	Name of TileSampleNoise in condition store. More...
SG::ReadCondHandleKey< TileSampleNoise >	m_onlineSampleNoiseKey
	Name of online TileSampleNoise in condition store. More...
ToolHandle< ITileCondToolOfc >	m_tileCondToolOfc
ToolHandle< TileCondToolTiming >	m_tileToolTiming
SG::ReadCondHandleKey< TileEMScale >	m_emScaleKey
	Name of TileEMScale in condition store. More...
ToolHandle< ITileCondToolDspThreshold >	m_tileDspThreshold
SG::ReadHandleKey< TileDigitsContainer >	m_digitsContainerKey
bool	m_zeroAmplitudeWithoutDigits
bool	m_correctPedestalDifference

Detailed Description

This tool correct TileRawChannels amplitudes which came from OF1 DSP if pedestal changed.

Definition at line 38 of file TileRawChannelOF1Corrector.h.

Constructor & Destructor Documentation

TileRawChannelOF1Corrector()

TileRawChannelOF1Corrector::TileRawChannelOF1Corrector	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent
	)

AlgTool like constructor.

Definition at line 20 of file TileRawChannelOF1Corrector.cxx.

    : base_class(type, name, parent)
    , m_tileHWID(0)
{
  declareProperty("ZeroAmplitudeWithoutDigits", m_zeroAmplitudeWithoutDigits = true);
  declareProperty("CorrectPedestalDifference", m_correctPedestalDifference = true);
}

~TileRawChannelOF1Corrector()

virtual TileRawChannelOF1Corrector::~TileRawChannelOF1Corrector ( )

inlinevirtual

Virtual destructor.

Definition at line 46 of file TileRawChannelOF1Corrector.h.

{};

Member Function Documentation

finalize()

StatusCode TileRawChannelOF1Corrector::finalize ( )

overridevirtual

AlgTool finalize method.

Definition at line 199 of file TileRawChannelOF1Corrector.cxx.

                                                {
  return StatusCode::SUCCESS;
}

initialize()

StatusCode TileRawChannelOF1Corrector::initialize ( )

overridevirtual

AlgTool initialize method.

Definition at line 31 of file TileRawChannelOF1Corrector.cxx.

                                                  {
 
  ATH_MSG_INFO("Initializing...");
 
  ATH_CHECK( detStore()->retrieve(m_tileHWID) );
 
  ATH_CHECK( m_sampleNoiseKey.initialize(m_correctPedestalDifference) );
  ATH_CHECK( m_onlineSampleNoiseKey.initialize(m_correctPedestalDifference) );
 
  if (m_correctPedestalDifference) {
    //=== get TileCondToolOfc
    ATH_CHECK( m_tileCondToolOfc.retrieve() );
 
    //=== get TileToolTiming
    ATH_CHECK( m_tileToolTiming.retrieve() );
  } else {
    m_tileCondToolOfc.disable();
    m_tileToolTiming.disable();
  }
 
  ATH_CHECK( m_emScaleKey.initialize(m_zeroAmplitudeWithoutDigits || m_correctPedestalDifference) );
 
  if (m_zeroAmplitudeWithoutDigits) {
    //=== get TileToolTiming
    ATH_CHECK( m_tileDspThreshold.retrieve() );
  } else {
    m_tileDspThreshold.disable();
  }
 
  if (m_zeroAmplitudeWithoutDigits) {
    ATH_CHECK( m_digitsContainerKey.initialize() );
  } else {
    m_digitsContainerKey = "";
  }
 
  return StatusCode::SUCCESS;
}

process()

StatusCode TileRawChannelOF1Corrector::process ( TileMutableRawChannelContainer &  rchCont, const EventContext &  ctx  ) const

overridevirtual

Correct TileRawChannel amplitudes if pedestal changed.

Definition at line 74 of file TileRawChannelOF1Corrector.cxx.

{
  ATH_MSG_DEBUG("in TileRawChannelOF1Corrector::process()");
 
  TileFragHash::TYPE rawChannelType = rchCont.get_type();
  uint32_t bsFlags = rchCont.get_bsflags();
 
  if ((rawChannelType == TileFragHash::OptFilterDsp 
       || rawChannelType == TileFragHash::OptFilterDspCompressed) // DSP container
      && (bsFlags & (1U << 26U)) == 0) { // OF1 method
 
    TileRawChannelUnit::UNIT rawChannelUnit = rchCont.get_unit();
    ATH_MSG_VERBOSE( "Units in container is " << rawChannelUnit );
 
    const TileEMScale* emScale{nullptr};
    const TileDigitsContainer* digitsContainer(nullptr);
 
    if (m_zeroAmplitudeWithoutDigits || m_correctPedestalDifference) {
      SG::ReadCondHandle<TileEMScale> emScaleHandle(m_emScaleKey, ctx);
      ATH_CHECK( emScaleHandle.isValid() );
      emScale = emScaleHandle.cptr();
 
      if (m_zeroAmplitudeWithoutDigits) {
        SG::ReadHandle<TileDigitsContainer> allDigits(m_digitsContainerKey, ctx);
        digitsContainer = allDigits.cptr();
      }
    }
 
    const TileSampleNoise* sampleNoise = nullptr;
    const TileSampleNoise* onlineSampleNoise = nullptr;
    if (m_correctPedestalDifference) {
      SG::ReadCondHandle<TileSampleNoise> sampleNoiseHandle(m_sampleNoiseKey, ctx);
      ATH_CHECK( sampleNoiseHandle.isValid() );
      sampleNoise = sampleNoiseHandle.retrieve();
 
      SG::ReadCondHandle<TileSampleNoise> onlineSampleNoiseHandle(m_onlineSampleNoiseKey, ctx);
      ATH_CHECK( onlineSampleNoiseHandle.isValid() );
      onlineSampleNoise = onlineSampleNoiseHandle.retrieve();
    }
 
 
    for (IdentifierHash hash : rchCont.GetAllCurrentHashes()) {
      TileRawChannelCollection* rawChannelCollection = rchCont.indexFindPtr (hash);
 
      int fragId = rawChannelCollection->identify();
      unsigned int drawer = (fragId & 0x3F);
      unsigned int ros = fragId >> 8;
      unsigned int drawerIdx = TileCalibUtils::getDrawerIdx(ros, drawer);
 
      bool checkDigits(false);
      std::vector<bool> noDigits(TileCalibUtils::MAX_CHAN, true);
      if (digitsContainer) {
        IdentifierHash fragHash = (digitsContainer->hashFunc())(fragId);
        const TileDigitsCollection* digitsCollection = digitsContainer->indexFindPtr(fragHash);
        if (digitsCollection->getFragBCID() != 0xDEAD) {
          ATH_MSG_VERBOSE(TileCalibUtils::getDrawerString(ros, drawer) << ": digits in bytestream => check digits");
          checkDigits = true;
        } else {
          ATH_MSG_VERBOSE(TileCalibUtils::getDrawerString(ros, drawer) << ": no digits in bytestream => do not check digits");
        }
 
        for (const TileDigits* tile_digits : *digitsCollection) {
          int channel = m_tileHWID->channel(tile_digits->adc_HWID());
          noDigits[channel] = false;
        }
      }
 
      for (TileRawChannel* rawChannel : *rawChannelCollection) {
        HWIdentifier adcId = rawChannel->adc_HWID();
        int channel = m_tileHWID->channel(adcId);
        int gain = m_tileHWID->adc(adcId);
 
        if (m_correctPedestalDifference) {
 
          float pedestal = sampleNoise->getPed(drawerIdx, channel, gain);
          float onlinePedestal = onlineSampleNoise->getPed(drawerIdx, channel, gain);
          float onlinePedestalDifference = emScale->calibrateOnlineChannel(drawerIdx, channel, gain, (onlinePedestal - pedestal), rawChannelUnit);
          float phase = -m_tileToolTiming->getSignalPhase(drawerIdx, channel, gain);
          TileOfcWeightsStruct weights;
          ATH_CHECK( m_tileCondToolOfc->getOfcWeights(drawerIdx, channel, gain, phase, false, weights, ctx) );
          float weightsSum(0.0);
          for (int i = 0; i < weights.n_samples; ++i) weightsSum += weights.w_a[i];
          float energyCorrection = onlinePedestalDifference * weightsSum;
          ATH_MSG_VERBOSE( TileCalibUtils::getDrawerString(ros, drawer) 
                           << " ch" << channel << (gain ? " HG: " : " LG: ")
                           << "online pedestal difference: " << onlinePedestalDifference
                           << "; OFC weights (a) sum: " << weightsSum
                           << " => energy correction: " << energyCorrection);
          
          rawChannel->setAmplitude(rawChannel->amplitude() + energyCorrection);
 
        }
 
        if (checkDigits && noDigits[channel]) {
 
          float amplitude = emScale->undoOnlineChannelCalibration(drawerIdx, channel, gain, rawChannel->amplitude(), rawChannelUnit);
          float minimuAmplitudeThreshold(-99999.0);
          float maximumAmplitudeThreshold(99999.0);
          m_tileDspThreshold->getAmplitudeThresholds(drawerIdx, channel, gain, minimuAmplitudeThreshold, maximumAmplitudeThreshold);
          if (amplitude < minimuAmplitudeThreshold
               || amplitude > maximumAmplitudeThreshold) 
            {
 
            ATH_MSG_VERBOSE( TileCalibUtils::getDrawerString(ros, drawer) 
                             << " ch" << channel << (gain ? " HG:" : " LG:")
                             << " amplitude: " << amplitude << " [ADC]"
                             << " outside range: " << minimuAmplitudeThreshold << ".." << maximumAmplitudeThreshold
                             << " without digits => set apmlitude/time/quality: 0.0/0.0/15.0");
 
            rawChannel->insert(0.0F, 0.0F, 15.0F);
 
          }
 
        }
 
      }
    }
 
  }
 
  return StatusCode::SUCCESS;
}

Member Data Documentation

m_correctPedestalDifference

bool TileRawChannelOF1Corrector::m_correctPedestalDifference

private

Definition at line 93 of file TileRawChannelOF1Corrector.h.

m_digitsContainerKey

SG::ReadHandleKey<TileDigitsContainer> TileRawChannelOF1Corrector::m_digitsContainerKey

private

Initial value:

{this,
        "TileDigitsContainer", "TileDigitsCnt", "Input Tile digits container key"}

Definition at line 88 of file TileRawChannelOF1Corrector.h.

m_emScaleKey

SG::ReadCondHandleKey<TileEMScale> TileRawChannelOF1Corrector::m_emScaleKey

private

Initial value:

{this,
        "TileEMScale", "TileEMScale", "Input Tile EMS calibration constants"}

Name of TileEMScale in condition store.

Definition at line 81 of file TileRawChannelOF1Corrector.h.

m_onlineSampleNoiseKey

SG::ReadCondHandleKey<TileSampleNoise> TileRawChannelOF1Corrector::m_onlineSampleNoiseKey

private

Initial value:

{this,
        "TileOnlineSampleNoise", "TileOnlineSampleNoise", "Input online Tile sample noise"}

Name of online TileSampleNoise in condition store.

Definition at line 69 of file TileRawChannelOF1Corrector.h.

m_sampleNoiseKey

SG::ReadCondHandleKey<TileSampleNoise> TileRawChannelOF1Corrector::m_sampleNoiseKey

private

Initial value:

{this,
        "TileSampleNoise", "TileSampleNoise", "Input Tile sample noise"}

Name of TileSampleNoise in condition store.

Definition at line 64 of file TileRawChannelOF1Corrector.h.

m_tileCondToolOfc

ToolHandle<ITileCondToolOfc> TileRawChannelOF1Corrector::m_tileCondToolOfc

private

Initial value:

{this,
        "TileCondToolOfc", "TileCondToolOfcCoolOF1", "Tile OFC tool"}

Definition at line 72 of file TileRawChannelOF1Corrector.h.

m_tileDspThreshold

ToolHandle<ITileCondToolDspThreshold> TileRawChannelOF1Corrector::m_tileDspThreshold

private

Initial value:

{this,
        "TileCondToolDspThreshold", "TileCondToolDspThreshold", "Tile DSP thresholds tool"}

Definition at line 84 of file TileRawChannelOF1Corrector.h.

m_tileHWID

const TileHWID* TileRawChannelOF1Corrector::m_tileHWID

private

Pointer to TileHWID.

Definition at line 59 of file TileRawChannelOF1Corrector.h.

m_tileToolTiming

ToolHandle<TileCondToolTiming> TileRawChannelOF1Corrector::m_tileToolTiming

private

Initial value:

{this,
        "TileCondToolTiming", "TileCondToolOnlineTiming", "Tile timing tool"}

Definition at line 75 of file TileRawChannelOF1Corrector.h.

m_zeroAmplitudeWithoutDigits

bool TileRawChannelOF1Corrector::m_zeroAmplitudeWithoutDigits

private

Definition at line 92 of file TileRawChannelOF1Corrector.h.

---

The documentation for this class was generated from the following files:

• TileRawChannelOF1Corrector.h
• TileRawChannelOF1Corrector.cxx