#include <TruthPixelClusterSplitter.h>

Inheritance diagram for InDet::TruthPixelClusterSplitter:

Collaboration diagram for InDet::TruthPixelClusterSplitter:

Public Member Functions
	TruthPixelClusterSplitter (const std::string &type, const std::string &name, const IInterface *parent)
	Constructor.
	~TruthPixelClusterSplitter ()=default
	Destructor.
virtual StatusCode	initialize () override
	AthAlgTool interface methods.
virtual StatusCode	finalize () override
virtual std::vector< InDet::PixelClusterParts >	splitCluster (const InDet::PixelCluster &origCluster) const override
	take one, give zero or many
virtual std::vector< InDet::PixelClusterParts >	splitCluster (const InDet::PixelCluster &origCluster, const InDet::PixelClusterSplitProb &spo) const override
	take one, give zero or many - with split probability object
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 ()
	interface ID

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
ToolHandle< TruthClusterizationFactory >	m_truthClusterizationFactory {this, "NnClusterizationFactory", "InDet::NnClusterizationFactory/TruthClusterizationFactory"}
DoubleProperty	m_thresholdSplittingIntoTwoClusters {this, "ThresholdSplittingIntoTwoClusters", 0.95}
DoubleProperty	m_thresholdSplittingIntoThreeClusters {this, "ThresholdSplittingIntoThreeClusters", 0.90}
BooleanProperty	m_splitOnlyOnBLayer {this, "SplitOnlyOnBLayer", true}
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

Author: Rolan.nosp@m.d.Ja.nosp@m.nsky@.nosp@m.cern.nosp@m..ch

Definition at line 29 of file TruthPixelClusterSplitter.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

◆ TruthPixelClusterSplitter()

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

Constructor.

Name : TruthPixelClusterSplitter.cxx Package : SiClusterizationTool Author : Roland Jansky & Felix Cormier Created : April 2016.

DESCRIPTION: Split cluster given the truth information

Definition at line 24 of file TruthPixelClusterSplitter.cxx.

                                  :
        AthAlgTool(type,name,parent)
 {
   declareInterface<IPixelClusterSplitter>(this);
}

◆ ~TruthPixelClusterSplitter()

InDet::TruthPixelClusterSplitter::~TruthPixelClusterSplitter ( )

default

Destructor.

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

◆ 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 InDet::TruthPixelClusterSplitter::finalize ( )

overridevirtual

Definition at line 44 of file TruthPixelClusterSplitter.cxx.

                                                    {
    return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode InDet::TruthPixelClusterSplitter::initialize ( )

overridevirtual

AthAlgTool interface methods.

Definition at line 32 of file TruthPixelClusterSplitter.cxx.

                                                      {
    
  if (m_truthClusterizationFactory.retrieve().isFailure())
  {
    ATH_MSG_ERROR(" Unable to retrieve "<< m_truthClusterizationFactory );
    return StatusCode::FAILURE;
  }
  
  ATH_MSG_DEBUG(" Cluster splitter initialized successfully "<< m_truthClusterizationFactory );
  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 & InDet::IPixelClusterSplitter::interfaceID ( )

inlinestaticinherited

interface ID

Definition at line 36 of file IPixelClusterSplitter.h.

36{ return IID_IPixelClusterSplitter; }

InDet::IID_IPixelClusterSplitter

static const InterfaceID IID_IPixelClusterSplitter("IPixelClusterSplitter", 1, 0)

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

◆ splitCluster() [1/2]

std::vector< InDet::PixelClusterParts > InDet::TruthPixelClusterSplitter::splitCluster ( const InDet::PixelCluster & origCluster ) const

overridevirtual

take one, give zero or many

Implements InDet::IPixelClusterSplitter.

Definition at line 49 of file TruthPixelClusterSplitter.cxx.

{
 
  //add treatment for b-layer only HERE
 
  const std::vector<Identifier>& rdos  = origCluster.rdoList();  
  const std::vector<int>&  totList     = origCluster.totList();
 
  //fill lvl1group all with the same value... (not best way but ...)
  std::vector<int> lvl1group(rdos.size(),origCluster.LVL1A());
  
  std::vector<Amg::Vector2D> allLocalPositions;
  std::vector<Amg::MatrixX>  allErrorMatrix;
  std::vector<Amg::MatrixX>  errorMatrix;
  std::vector<Amg::Vector2D> localPosition=m_truthClusterizationFactory->estimatePositions(origCluster);
  if ((errorMatrix.size()!=2) or (localPosition.size()!=2)){
    throw std::length_error("Position and error vector sizes *must* be 2 in TruthPixelClusterSplitter::splitCluster");
  }
  std::vector<InDet::PixelClusterParts> allMultiPClusters;
  allMultiPClusters.emplace_back(rdos,totList,lvl1group,localPosition.at(0),errorMatrix.at(0));
  allMultiPClusters.emplace_back(rdos,totList,lvl1group,localPosition.at(1),errorMatrix.at(1));
  return allMultiPClusters;
 
}

◆ splitCluster() [2/2]

std::vector< InDet::PixelClusterParts > InDet::TruthPixelClusterSplitter::splitCluster	(	const InDet::PixelCluster &	origCluster,
		const InDet::PixelClusterSplitProb &	spo ) const

overridevirtual

take one, give zero or many - with split probability object

Implements InDet::IPixelClusterSplitter.

Definition at line 74 of file TruthPixelClusterSplitter.cxx.

{
 
 
  if (m_splitOnlyOnBLayer)
  {
    const InDetDD::SiDetectorElement* element=origCluster.detectorElement();
    if (element==nullptr) {
      ATH_MSG_WARNING("Could not get detector element");
      return {};
    }
    const AtlasDetectorID* aid = element->getIdHelper();
    if (aid==nullptr)
    {
      ATH_MSG_WARNING("Could not get ATLASDetectorID");
      return {};
    }
    if (aid->helper() != AtlasDetectorID::HelperType::Pixel)
    {
      ATH_MSG_WARNING("Could not get PixelID pointer");
      return {};
    } 
    const PixelID* pixelIDp=static_cast<const PixelID*>(aid);
    //check if original pixel is on b-layer and if yes continue, otherwise interrupt...
    Identifier pixelId = origCluster.identify();
    if (!pixelIDp->is_blayer(pixelId))
    {
      //return empty object...
      ATH_MSG_VERBOSE(" Cluster not on b-layer. Return empty object-->back to default clustering." );
      return {};
    }
  }
 
  //add treatment for b-layer only HERE
 
  const std::vector<Identifier>& rdos  = origCluster.rdoList();  
  const std::vector<int>&  totList     = origCluster.totList();
 
  //fill lvl1group all with the same value... (not best way but ...)
  std::vector<int> lvl1group(rdos.size(),origCluster.LVL1A());
 
  if (splitProb.getHighestSplitMultiplicityStored()<3) return {};
 
  double splitProb2=splitProb.splitProbability(2);
  double splitProb3rel=splitProb.splitProbability(3);
 
  double splitProb3=splitProb3rel/(splitProb3rel+splitProb2);
 
  ATH_MSG_VERBOSE( " SplitProb -->2 " << splitProb2 << " SplitProb -->3 " << splitProb3 );
 
  int nParticles=1;
  
  if (splitProb2>m_thresholdSplittingIntoTwoClusters)
  {
    if (splitProb3>m_thresholdSplittingIntoThreeClusters)
    {
      nParticles=3;
    }
    else
    {
      nParticles=2;
    }
  }
 
 
  ATH_MSG_VERBOSE( " Decided for n. particles: " << nParticles << "." );
 
  std::vector<Amg::Vector2D>      allLocalPositions;
  std::vector<Amg::MatrixX>       allErrorMatrix;
  
  std::vector<InDet::PixelClusterParts> allMultiPClusters;
  
  if (nParticles==1)
  {
    std::vector<Amg::MatrixX> errorMatrix;
    std::vector<Amg::Vector2D> localPosition=m_truthClusterizationFactory->estimatePositions(origCluster);
 
    if ((errorMatrix.size()!=1) or (localPosition.size()!=1))
    {
      throw std::length_error("Position and error vector sizes *must* be 1 in TruthPixelClusterSplitter::splitCluster");
    }
    allMultiPClusters.emplace_back(rdos,totList,lvl1group,localPosition.at(0),errorMatrix.at(0));
  }
  else if (nParticles==2)
  {
 
    std::vector<Amg::MatrixX> errorMatrix;
    std::vector<Amg::Vector2D> localPosition=m_truthClusterizationFactory->estimatePositions(origCluster);
    
    if ((errorMatrix.size()!=2) or localPosition.size()!=2)
    {
      throw std::length_error("Position and error vector sizes *must* be 2 in TruthPixelClusterSplitter::splitCluster");
    }
    
    allMultiPClusters.emplace_back(rdos,totList,lvl1group,localPosition.at(0),errorMatrix.at(0));
    allMultiPClusters.emplace_back(rdos,totList,lvl1group,localPosition.at(1),errorMatrix.at(1));
  }
  else if (nParticles==3)
  {
 
    std::vector<Amg::MatrixX> errorMatrix;
    std::vector<Amg::Vector2D> localPosition=m_truthClusterizationFactory->estimatePositions(origCluster);
    
    if ((errorMatrix.size()!=3) or (localPosition.size()!=3))
    {
      throw std::length_error("Position and error vector sizes *must* be 3 in TruthPixelClusterSplitter::splitCluster");
    }
    allMultiPClusters.emplace_back(rdos,totList,lvl1group,localPosition.at(0),errorMatrix.at(0));
    allMultiPClusters.emplace_back(rdos,totList,lvl1group,localPosition.at(1),errorMatrix.at(1));
    allMultiPClusters.emplace_back(rdos,totList,lvl1group,localPosition.at(2),errorMatrix.at(2));
  }
  
  return allMultiPClusters;
 
}

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

BooleanProperty InDet::TruthPixelClusterSplitter::m_splitOnlyOnBLayer {this, "SplitOnlyOnBLayer", true}

private

Definition at line 58 of file TruthPixelClusterSplitter.h.

58{this, "SplitOnlyOnBLayer", true};

◆ m_thresholdSplittingIntoThreeClusters

DoubleProperty InDet::TruthPixelClusterSplitter::m_thresholdSplittingIntoThreeClusters {this, "ThresholdSplittingIntoThreeClusters", 0.90}

private

Definition at line 57 of file TruthPixelClusterSplitter.h.

57{this, "ThresholdSplittingIntoThreeClusters", 0.90};

◆ m_thresholdSplittingIntoTwoClusters

DoubleProperty InDet::TruthPixelClusterSplitter::m_thresholdSplittingIntoTwoClusters {this, "ThresholdSplittingIntoTwoClusters", 0.95}

private

Definition at line 56 of file TruthPixelClusterSplitter.h.

56{this, "ThresholdSplittingIntoTwoClusters", 0.95};

◆ m_truthClusterizationFactory

ToolHandle<TruthClusterizationFactory> InDet::TruthPixelClusterSplitter::m_truthClusterizationFactory {this, "NnClusterizationFactory", "InDet::NnClusterizationFactory/TruthClusterizationFactory"}

private

Definition at line 54 of file TruthPixelClusterSplitter.h.

54{this, "NnClusterizationFactory", "InDet::NnClusterizationFactory/TruthClusterizationFactory"};

◆ 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

◆ TruthPixelClusterSplitter()

◆ ~TruthPixelClusterSplitter()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ splitCluster() [1/2]

◆ splitCluster() [2/2]

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_splitOnlyOnBLayer

◆ m_thresholdSplittingIntoThreeClusters

◆ m_thresholdSplittingIntoTwoClusters

◆ m_truthClusterizationFactory

◆ m_varHandleArraysDeclared

◆ m_vhka