AFPSiClusterAllNeighbours Class Reference

#include <AFPSiClusterAllNeighbours.h>

Inheritance diagram for AFPSiClusterAllNeighbours:

Collaboration diagram for AFPSiClusterAllNeighbours:

Public Member Functions
	AFPSiClusterAllNeighbours (const std::string &type, const std::string &name, const IInterface *parent)
virtual	~AFPSiClusterAllNeighbours () override
virtual StatusCode	initialize () override
	does nothing
virtual StatusCode	finalize () override
	does nothing
virtual StatusCode	doClustering (const std::list< const xAOD::AFPSiHit * > &hits, std::list< AFPSiClusterBasicObj > &outputClusters) const override
	Creates a cluster from the neighbouring pixels, joining only two pixels with charge above m_chargeThreshold.
float	chargeThreshold () const

Private Attributes
Gaudi::Property< float >	m_chargeThreshold {this, "chargeThreshold", 1000., "charge above which hits are used for clustering"}
Gaudi::Property< std::string >	m_neighbourhoodType {this, "neighbourhoodType", "X", "type of hit neighbourhood in cluster, either X (only long-edge) or XY (both long- and short-edge)"}
bool	m_doOnlyHorz = false

Detailed Description

Definition at line 31 of file AFPSiClusterAllNeighbours.h.

Constructor & Destructor Documentation

AFPSiClusterAllNeighbours()

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

Definition at line 25 of file AFPSiClusterAllNeighbours.cxx.

    : base_class(type, name, parent) {
}

~AFPSiClusterAllNeighbours()

virtual AFPSiClusterAllNeighbours::~AFPSiClusterAllNeighbours ( )

inlineoverridevirtual

Definition at line 39 of file AFPSiClusterAllNeighbours.h.

{}

Member Function Documentation

chargeThreshold()

float AFPSiClusterAllNeighbours::chargeThreshold ( ) const

inline

Definition at line 51 of file AFPSiClusterAllNeighbours.h.

{return m_chargeThreshold;}

doClustering()

StatusCode AFPSiClusterAllNeighbours::doClustering ( const std::list< const xAOD::AFPSiHit * > & hits, std::list< AFPSiClusterBasicObj > & outputClusters ) const

overridevirtual

Creates a cluster from the neighbouring pixels, joining only two pixels with charge above m_chargeThreshold.

Definition at line 48 of file AFPSiClusterAllNeighbours.cxx.

{
  std::list<const xAOD::AFPSiHit*> hitsAboveThreshold;
 
  // select only hits above charge threshold
  for (const xAOD::AFPSiHit* theHit : hits)
    if (theHit->depositedCharge() > m_chargeThreshold)
      hitsAboveThreshold.push_back(theHit);
    
  while (!hitsAboveThreshold.empty())
  {    
    // add the first hit to a new proto-cluster
    std::list<const xAOD::AFPSiHit*> currentProtoCluster{hitsAboveThreshold.front()};    
    // and remove the hit from the list
    hitsAboveThreshold.pop_front();        
        
    // for each hit in the growing list of hits in the current proto-cluster
    for(const xAOD::AFPSiHit* currHit : currentProtoCluster)
    {
      // loop over remaining hits
      for(std::list<const xAOD::AFPSiHit*>::iterator remHit=hitsAboveThreshold.begin();remHit!=hitsAboveThreshold.end();)
      {
        if(abs(currHit->pixelVertID()-(*remHit)->pixelVertID())<=1 && abs(currHit->pixelHorizID()-(*remHit)->pixelHorizID())<=1)
        {
          if(m_doOnlyHorz && currHit->pixelVertID()!=(*remHit)->pixelVertID())
          {
            ++remHit;
          }
          else
          {
            // these hits are neighbours
            currentProtoCluster.push_back(*remHit);
            hitsAboveThreshold.erase(remHit++); // move iterator first, then erase the element
          }
        }
        else
        {
          ++remHit;
        }
      }
      // end loop over remaining hits, all neighbours of the current hit are added to currentProtoCluster
      // let's continue with the next hit in currentProtoCluster, possible the one that has been just added
    }
    // reach end of currentProtoCluster, no more hits to be added
    
    // calculate positions on plane and save the cluster
    outputClusters.emplace_back(0,0,0,xAOD::AFPClusterAlgID::allNeighbours);
    AFPSiClusterBasicObj& newCluster = outputClusters.back();
    double horizID = 0.;
    double vertID  = 0.;
    double charge  = 0.;
    for (const xAOD::AFPSiHit* currHit : currentProtoCluster)
    {
      charge  += currHit->depositedCharge();
      horizID += currHit->pixelHorizID() * currHit->depositedCharge();
      vertID  += currHit->pixelVertID() * currHit->depositedCharge();
      
      newCluster.hits().push_back(currHit);
    }
    
    newCluster.setHorizID(horizID/charge);
    newCluster.setVertID(vertID/charge);
    newCluster.setCharge(charge);
  }
 
  
  return StatusCode::SUCCESS;
}

finalize()

StatusCode AFPSiClusterAllNeighbours::finalize ( )

overridevirtual

does nothing

Definition at line 44 of file AFPSiClusterAllNeighbours.cxx.

                                               {
  return StatusCode::SUCCESS;
}

initialize()

StatusCode AFPSiClusterAllNeighbours::initialize ( )

overridevirtual

does nothing

Definition at line 31 of file AFPSiClusterAllNeighbours.cxx.

{
  if(m_neighbourhoodType=="x" || m_neighbourhoodType=="X")        m_doOnlyHorz=true;
  else if(m_neighbourhoodType=="xy" || m_neighbourhoodType=="XY") m_doOnlyHorz=false;
  else
  {
    ATH_MSG_ERROR("neighbourhoodType is "<<m_neighbourhoodType<<" but allowed values are only \"X\" (only long-edge) or \"XY\" (both long- and short-edge); will abort");
    return StatusCode::FAILURE;
  }
  
  return StatusCode::SUCCESS;
}

Member Data Documentation

m_chargeThreshold

Gaudi::Property<float> AFPSiClusterAllNeighbours::m_chargeThreshold {this, "chargeThreshold", 1000., "charge above which hits are used for clustering"}

private

Definition at line 54 of file AFPSiClusterAllNeighbours.h.

{this, "chargeThreshold", 1000., "charge above which hits are used for clustering"};

m_doOnlyHorz

bool AFPSiClusterAllNeighbours::m_doOnlyHorz = false

private

Definition at line 58 of file AFPSiClusterAllNeighbours.h.

m_neighbourhoodType

Gaudi::Property<std::string> AFPSiClusterAllNeighbours::m_neighbourhoodType {this, "neighbourhoodType", "X", "type of hit neighbourhood in cluster, either X (only long-edge) or XY (both long- and short-edge)"}

private

Definition at line 56 of file AFPSiClusterAllNeighbours.h.

{this, "neighbourhoodType", "X", "type of hit neighbourhood in cluster, either X (only long-edge) or XY (both long- and short-edge)"};

---

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

• AFPSiClusterAllNeighbours.h
• AFPSiClusterAllNeighbours.cxx