TileCellMaskingTool Class Reference

#include <TileCellMaskingTool.h>

Inheritance diagram for TileCellMaskingTool:

Collaboration diagram for TileCellMaskingTool:

Public Member Functions
	TileCellMaskingTool (const std::string &type, const std::string &name, const IInterface *parent)
virtual StatusCode	initialize () override
virtual StatusCode	process (CaloCellContainer *theCellContainer, const EventContext &ctx) const override
virtual StatusCode	finalize () override
virtual bool	channel_is_good (HWIdentifier &hwid)
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const
	DeclareInterfaceID (ICaloCellMakerTool, 1, 0)

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	fillIncludedCellsMap ()
void	killer (std::string_view component, int ros, int drw, int index)
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
std::vector< std::string >	m_rejectedTileDrawer
std::vector< std::string >	m_rejectedTileMB
std::vector< std::string >	m_rejectedTileDigitizer
std::vector< std::string >	m_rejectedTileDMU
std::vector< std::string >	m_rejectedTileChannels
float	m_zeroEnergy
const TileID *	m_tileID
const TileHWID *	m_tileHWID
std::bitset< 65536 >	m_includedCellsMap
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default).
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default).
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 26 of file TileCellMaskingTool.h.

Member Typedef Documentation

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

TileCellMaskingTool()

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

Definition at line 26 of file TileCellMaskingTool.cxx.

  : AthAlgTool(type, name, parent)
  , m_tileID(0)
  , m_tileHWID(0)
{
  declareInterface<ICaloCellMakerTool>( this );
 
  declareProperty("RejectedTileDrawer", m_rejectedTileDrawer) ;
  declareProperty("RejectedTileMB", m_rejectedTileMB) ;
  declareProperty("RejectedTileDigitizer", m_rejectedTileDigitizer) ;
  declareProperty("RejectedTileDMU", m_rejectedTileDMU) ;
  declareProperty("RejectedTileChannels", m_rejectedTileChannels) ;
 
  declareProperty("BadChannelZeroEnergy",m_zeroEnergy = 0.5 * MeV); // half a MeV in both PMTs i.e. one MeV in a cell
}

Member Function Documentation

channel_is_good()

bool TileCellMaskingTool::channel_is_good ( HWIdentifier & hwid )

virtual

Definition at line 318 of file TileCellMaskingTool.cxx.

                                                            {
 
  IdentifierHash ChHash = m_tileHWID->get_channel_hash(m_tileHWID->channel_id(hwid));
 
  return m_includedCellsMap.test(ChHash);
}

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & hndl, const SG::VarHandleKeyType &  )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

DeclareInterfaceID()

ICaloCellMakerTool::DeclareInterfaceID ( ICaloCellMakerTool , 1 , 0  )

inherited

declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

fillIncludedCellsMap()

StatusCode TileCellMaskingTool::fillIncludedCellsMap ( )

private

Definition at line 62 of file TileCellMaskingTool.cxx.

                                                     {
 
  m_includedCellsMap.set();
 
  int ros = 0, drw = 0, index = -1;
 
  for (const std::string& dr : m_rejectedTileDrawer) {
    std::stringstream dris;
    dris << dr;
    dris >> ros >> drw;
    killer("drawer", ros, drw, index);
  }
 
  for (const std::string& mb : m_rejectedTileMB) {
    std::stringstream dris;
    dris << mb;
    dris >> ros >> drw >> index;
    killer("mb", ros, drw, index);
  }
 
  for (const std::string& dig : m_rejectedTileDigitizer) {
    std::stringstream dris;
    dris << dig;
    dris >> ros >> drw >> index;
    killer("dig", ros, drw, index);
  }
 
  for (const std::string& dmu : m_rejectedTileDMU) {
    std::stringstream dris;
    dris << dmu;
    dris >> ros >> drw >> index;
    killer("dmu", ros, drw, index);
  }
 
  for (const std::string& chan : m_rejectedTileChannels) {
    std::stringstream dris;
    dris << chan;
    dris >> ros >> drw >> index;
    killer("channel", ros, drw, index);
  }
 
  return StatusCode::SUCCESS;
}

finalize()

StatusCode TileCellMaskingTool::finalize ( )

overridevirtual

Definition at line 311 of file TileCellMaskingTool.cxx.

                                         {
 
  return StatusCode::SUCCESS;
}

initialize()

StatusCode TileCellMaskingTool::initialize ( )

overridevirtual

Definition at line 45 of file TileCellMaskingTool.cxx.

                                           {
 
  ATH_MSG_DEBUG( " TileCellMaskingTool called " );
 
  CHECK( detStore() -> retrieve(m_tileID, "TileID") );
  CHECK( detStore() -> retrieve(m_tileHWID, "TileHWID") );
 
  CHECK( fillIncludedCellsMap() );
  ATH_MSG_DEBUG( " Will exclude "
                << m_includedCellsMap.size() - m_includedCellsMap.count()
                << " channels " );
 
  return StatusCode::SUCCESS;
}

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

killer()

void TileCellMaskingTool::killer ( std::string_view component, int ros, int drw, int index )

private

Definition at line 108 of file TileCellMaskingTool.cxx.

                                                                                      {
 
  int begin = 0, end = 0;
 
  if (component == "drawer") {
    begin = 0;
    end = 48;
  } else if (component == "mb") {
    begin = (4 - index) * 12;
    end = begin + 12;
  } else if (component == "dig") {
    begin = (8 - index) * 6;
    end = begin + 6;
  } else if (component == "dmu") {
    begin = index * 3;
    end = begin + 3;
  } else {
    begin = index;
    end = begin + 1;
  }
 
  if (ros < 1 || ros > 4) {
    ATH_MSG_WARNING( " wrong selection of ros = " << ros << " in TileCellMaskingTool::killer ");
  } else if (drw < 0 || drw > 63) {
    ATH_MSG_WARNING( " wrong selection of drawer = " << drw << " in TileCellMaskingTool::killer ");
  } else if (begin < 0 || end > 48) {
    ATH_MSG_WARNING( " wrong selection of "<< component
                    << " = " << index << " in TileCellMaskingTool::killer ");
  } else {
    msg(MSG::INFO) << " killing ros " << ros << " drawer " << drw;
    if (component != "drawer") {
      msg(MSG::INFO) << component << " " << index << endmsg;
    } else {
      msg(MSG::INFO) << endmsg;
    }
 
    for (int channel = begin; channel < end; ++channel) {
      HWIdentifier chid = m_tileHWID->channel_id(ros, drw, channel);
      IdentifierHash hash = m_tileHWID->get_channel_hash(chid);
      m_includedCellsMap.reset(hash);
      ATH_MSG_DEBUG( "deleting channel " << m_tileHWID->to_string(chid,-1)
                    << " hash " << hash );
    }
  }
}

msg()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

process()

StatusCode TileCellMaskingTool::process ( CaloCellContainer * theCellContainer, const EventContext & ctx ) const

overridevirtual

Implements ICaloCellMakerTool.

Definition at line 156 of file TileCellMaskingTool.cxx.

{
  int n_cells = 0, n_masked_1 = 0, n_masked_2 = 0, n_masked_12 = 0;
  double ene_before = 0.0, ene_after = 0.0;
 
  size_t firstCell = theCont->indexFirstCellCalo(CaloCell_ID::TILE);
  size_t lastCell = theCont->indexLastCellCalo(CaloCell_ID::TILE);
 
  for (size_t iCell = firstCell; iCell <= lastCell; ++iCell) {
 
    CaloCell* aCell = (*theCont)[iCell];
    const CaloDetDescrElement * caloDDE = aCell->caloDDE();
 
    if (caloDDE->is_tile()) { // check if cell belongs to TileCalorimeter
 
      if (msgLvl(MSG::DEBUG)) {
        ++n_cells;
        ene_before += aCell->energy();
      }
 
      IdentifierHash hash1 = caloDDE->onl1();
      IdentifierHash hash2 = caloDDE->onl2();
 
      bool bit1 = m_includedCellsMap.test(hash1); // true - good channel
      bool bit2 = m_includedCellsMap.test(hash2); // false - channel should be masked
 
      TileCell* pCell = static_cast<TileCell*>(aCell);
      int gain1 = pCell->gain1();
      int gain2 = pCell->gain2();
 
      if (bit1) { // first is good
 
        if (!bit2) { // second is bad
 
          if (msgLvl(MSG::DEBUG)) {
            ++n_masked_12;
            if (msgLvl(MSG::VERBOSE)) {
              msg(MSG::VERBOSE) << " second channel is OFF"
                                << ", hash2: " << hash2
                                << "  before " << pCell->ene1()
                                << " + " << pCell->ene2()
                                << " = " << pCell->energy();
            }
          }
 
          float ene1 = pCell->ene1();
          pCell->setEnergy(ene1, ene1, gain1, gain1); // use energy/gain from first pmt for both pmts
          pCell->setTime(pCell->time1());  // use time from first pmt as cell time
          pCell->setQuality(pCell->qual1(), (pCell->qbit1() | TileCell::MASK_BADCH), 1); // change quality flag for second pmt
 
          if (msgLvl(MSG::VERBOSE)) {
            msg(MSG::VERBOSE) << "  after " << pCell -> ene1()
                              << " + " << pCell -> ene2()
                              << " = " << pCell -> energy() << endmsg;
          }
        }
      } else { // first is bad
 
        if (hash2 == TileHWID::NOT_VALID_HASH) { // cells wih single PMT
 
          if (msgLvl(MSG::DEBUG)) {
            ++n_masked_1;
            if (msgLvl(MSG::VERBOSE)) {
              msg(MSG::VERBOSE) << " channel in GAP is OFF"
                                << ", hash1: " << hash1
                                << "  before " << pCell->ene1()
                                << " + " << pCell->ene2()
                                << " = " << pCell->energy();
            }
          }
 
          if (gain1 == CaloGain::INVALIDGAIN) {
            pCell->setEnergy(m_zeroEnergy, 0.0, TileID::LOWGAIN, CaloGain::INVALIDGAIN); // reset energy completely, indicate problem putting low gain
          } else {
            pCell->setEnergy(m_zeroEnergy, 0.0); // reset energy completely without changing gain
          }
          pCell->setTime(0.0); // reset time completely
          pCell->setQuality(255, TileCell::MASK_BADCH, 0); // reset quality flag for first pmt
          pCell->setQuality(0, TileCell::MASK_BADCH, 1); // reset quality flag for second pmt
 
          if (msgLvl(MSG::VERBOSE)) {
            msg(MSG::VERBOSE) << "  after " << pCell->ene1()
                              << " + " << pCell->ene2()
                              << " = " << pCell->energy() << endmsg;
          }
 
        } else if (bit2) { // second is good
 
          if (msgLvl(MSG::DEBUG)) {
            ++n_masked_12;
            if (msgLvl(MSG::VERBOSE)) {
              msg(MSG::VERBOSE) << " first  channel is OFF"
                                << ", hash1: " << hash1
                                << "  before " << pCell->ene1()
                                << " + " << pCell->ene2()
                                << " = " << pCell->energy();
            }
          }
 
          float ene2 = pCell->ene2();
          pCell->setEnergy(ene2, ene2, gain2, gain2); // use energy/gain from second pmt for both pmts
          pCell->setTime(pCell->time2());  // use time from second pmt as cell time
          pCell->setQuality(pCell->qual2(), (pCell->qbit2() | TileCell::MASK_BADCH), 0); // change quality flag for first pmt
 
          if (msgLvl(MSG::VERBOSE))
            msg(MSG::VERBOSE) << "  after " << pCell->ene1()
                              << " + " << pCell->ene2()
                              << " = " << pCell->energy() << endmsg;
 
        } else { // second is bad
 
          if (msgLvl(MSG::DEBUG)) {
            ++n_masked_2;
            if (msgLvl(MSG::VERBOSE)) {
              msg(MSG::VERBOSE) << " both channels are OFF"
                                << ", hash1: " << hash1
                                << ", hash2: " << hash2
                                << "  before " << pCell->ene1()
                                << " + " << pCell->ene2()
                                << " = " << pCell->energy();
            }
          }
 
          if (gain1 == CaloGain::INVALIDGAIN || gain2 == CaloGain::INVALIDGAIN) {
            if (gain1 == CaloGain::INVALIDGAIN) gain1 = 0; // this is TileID::LOWGAIN; - commented out to make Coverity happy
            if (gain2 == CaloGain::INVALIDGAIN) gain2 = 0; // this is TileID::LOWGAIN; - commented out to make Coverity happy
            pCell->setEnergy(m_zeroEnergy, m_zeroEnergy, gain1, gain2); // reset energy completely, indicate problem putting low gain
          } else {
            pCell->setEnergy(m_zeroEnergy, m_zeroEnergy); // reset energy completely without changing gain
          }
          pCell->setTime(0.0);  // reset time completely
          pCell->setQuality(255, TileCell::MASK_BADCH, 0); // reset quality flag for first pmt
          pCell->setQuality(255, TileCell::MASK_BADCH, 1); // reset quality flag for second pmt
 
          if (msgLvl(MSG::VERBOSE)) {
            msg(MSG::VERBOSE) << "  after " << pCell->ene1()
                              << " + " << pCell->ene2()
                              << " = " << pCell->energy() << endmsg;
          }
        }
      }
      ene_after += aCell->energy();
    }
  }
 
  ATH_MSG_DEBUG( " Ncells: " << n_cells
                << " N masked gap/normal/half-masked: " << n_masked_1 << " " << n_masked_2 << " " << n_masked_12
                << " Ene before/after/delta: " << ene_before << " " << ene_after << " " << ene_after-ene_before );
 
  return StatusCode::SUCCESS;
}

renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default).

Definition at line 393 of file AthCommonDataStore.h.

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default).

Definition at line 390 of file AthCommonDataStore.h.

m_includedCellsMap

std::bitset<65536> TileCellMaskingTool::m_includedCellsMap

private

Definition at line 54 of file TileCellMaskingTool.h.

m_rejectedTileChannels

std::vector<std::string> TileCellMaskingTool::m_rejectedTileChannels

private

Definition at line 48 of file TileCellMaskingTool.h.

m_rejectedTileDigitizer

std::vector<std::string> TileCellMaskingTool::m_rejectedTileDigitizer

private

Definition at line 46 of file TileCellMaskingTool.h.

m_rejectedTileDMU

std::vector<std::string> TileCellMaskingTool::m_rejectedTileDMU

private

Definition at line 47 of file TileCellMaskingTool.h.

m_rejectedTileDrawer

std::vector<std::string> TileCellMaskingTool::m_rejectedTileDrawer

private

Definition at line 44 of file TileCellMaskingTool.h.

m_rejectedTileMB

std::vector<std::string> TileCellMaskingTool::m_rejectedTileMB

private

Definition at line 45 of file TileCellMaskingTool.h.

m_tileHWID

const TileHWID* TileCellMaskingTool::m_tileHWID

private

Definition at line 52 of file TileCellMaskingTool.h.

m_tileID

const TileID* TileCellMaskingTool::m_tileID

private

Definition at line 51 of file TileCellMaskingTool.h.

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

m_zeroEnergy

float TileCellMaskingTool::m_zeroEnergy

private

Definition at line 49 of file TileCellMaskingTool.h.

---

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

• TileCellMaskingTool.h
• TileCellMaskingTool.cxx