#include <LArShapeDumperTool.h>

Inheritance diagram for LArShapeDumperTool:

Collaboration diagram for LArShapeDumperTool:

Public Member Functions
	LArShapeDumperTool (const std::string &type, const std::string &name, const IInterface *parent)
virtual	~LArShapeDumperTool ()
StatusCode	initialize () override
StatusCode	finalize () override
virtual LArSamples::CellInfo *	makeCellInfo (const HWIdentifier &channelID, const Identifier &id, const CaloDetDescrElement *caloDetElement=0) const override
virtual LArSamples::ShapeInfo *	retrieveShape (const HWIdentifier &channelID, CaloGain::CaloGain gain) const override
virtual bool	doShape () const override
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

Static Public Member Functions
static const InterfaceID &	interfaceID ()

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
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
bool	m_doShape
bool	m_doAllShapes
bool	m_isSC
std::string	m_shapeKey
const LArOnlineID_Base *	m_onlineHelper {nullptr}
const LArEM_Base_ID *	m_emId {nullptr}
const LArHEC_Base_ID *	m_hecId {nullptr}
const LArFCAL_Base_ID *	m_fcalId {nullptr}
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 20 of file LArShapeDumperTool.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

◆ LArShapeDumperTool()

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

Definition at line 25 of file LArShapeDumperTool.cxx.

  : AthAlgTool(type, name, parent)
{
  declareInterface<ILArShapeDumperTool>(this);
  declareProperty("DoShape", m_doShape = true);
  declareProperty("DoAllShapes", m_doAllShapes = false);
  declareProperty("ShapeKey",m_shapeKey="LArShape17phases");
  declareProperty("IsSC", m_isSC = false);
}

◆ ~LArShapeDumperTool()

LArShapeDumperTool::~LArShapeDumperTool ( )

virtual

Definition at line 38 of file LArShapeDumperTool.cxx.

39{

40}

Member Function Documentation

◆ 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());
 
  }

◆ 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.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ doShape()

virtual bool LArShapeDumperTool::doShape ( ) const

inlineoverridevirtual

Implements ILArShapeDumperTool.

Definition at line 35 of file LArShapeDumperTool.h.

35{ return m_doShape; }

◆ 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.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ 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

◆ finalize()

StatusCode LArShapeDumperTool::finalize ( )

override

Definition at line 68 of file LArShapeDumperTool.cxx.

{
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode LArShapeDumperTool::initialize ( )

override

Definition at line 43 of file LArShapeDumperTool.cxx.

                                          {
 
  const CaloCell_Base_ID* idHelper = nullptr;
  if(m_isSC)
     ATH_CHECK( detStore()->retrieve (idHelper, "CaloCell_SuperCell_ID") );
  else   
     ATH_CHECK( detStore()->retrieve (idHelper, "CaloCell_ID") );
  m_emId   = idHelper->em_idHelper();
  m_hecId  = idHelper->hec_idHelper();
  m_fcalId = idHelper->fcal_idHelper();
 
  if(m_isSC) {
     const LArOnline_SuperCellID *onlHSC;
     ATH_CHECK(detStore()->retrieve(onlHSC, "LArOnline_SuperCellID"));
     m_onlineHelper=onlHSC;
  } else {   
     const LArOnlineID *onlH;
     ATH_CHECK(detStore()->retrieve(onlH, "LArOnlineID"));
     m_onlineHelper=onlH;
  }
  
  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.

◆ interfaceID()

const InterfaceID & ILArShapeDumperTool::interfaceID ( )

inlinestaticinherited

Definition at line 32 of file ILArShapeDumperTool.h.

32{ return IID_ILArShapeDumperTool; }

IID_ILArShapeDumperTool

static const InterfaceID IID_ILArShapeDumperTool("ILArShapeDumperTool", 1, 0)

◆ makeCellInfo()

CellInfo * LArShapeDumperTool::makeCellInfo	(	const HWIdentifier &	channelID,
		const Identifier &	id,
		const CaloDetDescrElement *	caloDetElement = 0 ) const

overridevirtual

Implements ILArShapeDumperTool.

Definition at line 74 of file LArShapeDumperTool.cxx.

{
  CaloId calo = UNKNOWN_CALO;
  short iEta = -1, iPhi = -1, layer = -1;
  if (m_emId->is_lar_em(id)) {
    calo = (CaloId)m_emId->barrel_ec(id);
    iEta = m_emId->eta(id) + (m_emId->region(id) << 10);
    iPhi = m_emId->phi(id);
    layer = m_emId->sampling(id);
//      cout << "NJPB: " << hash << " " << m_emId->barrel_ec(channelID) << " " << m_emId->eta(id) << " " << m_emId->phi(id) << " " 
//           << m_emId->sampling(id) << " " << m_emId->region(id) << endl;
  }
  else if (m_hecId->is_lar_hec(id)) {
    calo = (CaloId)(abs(int(HEC_A))*(m_onlineHelper->pos_neg(channelID) ? 1 : -1));
    iEta = m_hecId->eta(id) + (m_hecId->region(id) << 10);
    iPhi = m_hecId->phi(id);
    layer = m_hecId->sampling(id);
  }
  else if (m_fcalId->is_lar_fcal(id)) {
    calo = (CaloId)(abs(int(FCAL_A))*(m_onlineHelper->pos_neg(channelID) ? 1 : -1));
    iEta = m_fcalId->eta(id);
    iPhi = m_fcalId->phi(id);
    layer = m_fcalId->module(id);
  }
  else {
    msg(MSG::WARNING) << "LArDigit Id "<< MSG::hex << id.get_identifier32().get_compact() << MSG::dec 
              << " (FT: " << m_onlineHelper->feedthrough(channelID) << " FEBSlot: " 
              << m_onlineHelper->slot(channelID) << " Chan: " << m_onlineHelper->channel(channelID)
              << ") appears to be neither EM nor HEC nor FCAL." << endmsg;
    return nullptr;
  }
 
  ShapeInfo* shapeL = nullptr;
  ShapeInfo* shapeM = nullptr;
  ShapeInfo* shapeH = nullptr;
            
  if (m_doAllShapes) {
    shapeL = retrieveShape(channelID, CaloGain::LARLOWGAIN);
    shapeM = retrieveShape(channelID, CaloGain::LARMEDIUMGAIN);
    shapeH = retrieveShape(channelID, CaloGain::LARHIGHGAIN);
  }
 
  TVector3 position(0,0,1);
  ULong64_t onlid = (ULong64_t)channelID.get_identifier32().get_compact(); 
  if (caloDetElement) position = TVector3(caloDetElement->x(), caloDetElement->y(), caloDetElement->z());
 
  return new CellInfo(calo, layer, iEta, iPhi, 
                      m_onlineHelper->feedthrough(channelID), 
                      m_onlineHelper->slot(channelID), m_onlineHelper->channel(channelID), 
                      shapeL, shapeM, shapeH, position,  onlid);
}

◆ 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.

◆ 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();
  }

◆ retrieveShape()

ShapeInfo * LArShapeDumperTool::retrieveShape	(	const HWIdentifier &	channelID,
		CaloGain::CaloGain	gain ) const

overridevirtual

Implements ILArShapeDumperTool.

Definition at line 128 of file LArShapeDumperTool.cxx.

{
  ILArShape* ishape=nullptr;
  if (detStore()->retrieve(ishape,m_shapeKey)!=StatusCode::SUCCESS) {
    return nullptr;
  }
 
  const LArShapeComplete* shapeObj = dynamic_cast<const LArShapeComplete*>(ishape);
  if (!shapeObj) {
    msg(MSG::INFO) << "Shape object is not of type LArShapeComplete!" << endmsg;
    return nullptr;
  }
  //const std::vector< std::vector<float> >& fullShape = shapeObj->get(channelID, gain).m_vShape;
  //ILArShape::ShapeRef_t shapeder=shapeObj->Shape(chid,igain,iphase);
 
  ShapeInfo* shape = nullptr;
  const size_t nPhases=shapeObj->nTimeBins(channelID,gain);
  if (nPhases == 0) {
    msg(MSG::WARNING) << "Shape object for channel " << channelID << " and gain " << gain 
             << " has 0 phases !" << endmsg;
    return nullptr;
  }    
 
  for (unsigned int iPhase = 0; iPhase < nPhases; iPhase++) {
     ILArShape::ShapeRef_t shape_i=shapeObj->Shape(channelID,gain,iPhase);
     //const std::vector<float>& shape_i = fullShape[iPhase];
     if (!(shape_i.valid() && shape_i.size()>0)) {
       msg(MSG::WARNING) << "Shape object for channel " << channelID << " and gain " << gain 
             << " has no data in phase " << iPhase << " !" << endmsg;
       delete shape;
       return nullptr;
     }
     for (unsigned int iSample = 0; iSample < shape_i.size(); iSample++) {
       if (iSample == 0 && iPhase == 0)
         shape = new ShapeInfo(shape_i.size(), 3, nPhases, 0);  // 0 was 12.5 
       shape->set(iSample, iPhase, shape_i[iSample]);
     }
  }
  return shape;
}

◆ 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_doAllShapes

bool LArShapeDumperTool::m_doAllShapes

private

Definition at line 39 of file LArShapeDumperTool.h.

◆ m_doShape

bool LArShapeDumperTool::m_doShape

private

Definition at line 39 of file LArShapeDumperTool.h.

◆ m_emId

const LArEM_Base_ID* LArShapeDumperTool::m_emId {nullptr}

private

Definition at line 43 of file LArShapeDumperTool.h.

43{nullptr};

◆ 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_fcalId

const LArFCAL_Base_ID* LArShapeDumperTool::m_fcalId {nullptr}

private

Definition at line 45 of file LArShapeDumperTool.h.

45{nullptr};

◆ m_hecId

const LArHEC_Base_ID* LArShapeDumperTool::m_hecId {nullptr}

private

Definition at line 44 of file LArShapeDumperTool.h.

44{nullptr};

◆ m_isSC

bool LArShapeDumperTool::m_isSC

private

Definition at line 39 of file LArShapeDumperTool.h.

◆ m_onlineHelper

const LArOnlineID_Base* LArShapeDumperTool::m_onlineHelper {nullptr}

private

Definition at line 42 of file LArShapeDumperTool.h.

42{nullptr};

◆ m_shapeKey

std::string LArShapeDumperTool::m_shapeKey

private

Definition at line 40 of file LArShapeDumperTool.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.

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ LArShapeDumperTool()

◆ ~LArShapeDumperTool()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ doShape()

◆ evtStore()

◆ extraDeps_update_handler()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ makeCellInfo()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ retrieveShape()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_doAllShapes

◆ m_doShape

◆ m_emId

◆ m_evtStore

◆ m_fcalId

◆ m_hecId

◆ m_isSC

◆ m_onlineHelper

◆ m_shapeKey

◆ m_varHandleArraysDeclared

◆ m_vhka