ClusterCandidate Class Reference

Class representing a possible cluster during clustering of the PXD It supports merging of different clusters and keeps track of the highest charge inside the cluster. More...

#include <ClusterCandidate.h>

Public Types
enum	{   c_defaultCapacity = 10 ,   c_maxCapacity = 4 * c_defaultCapacity }

Public Member Functions
	ClusterCandidate ()
	Constructor to create an empty Cluster.
void	clear ()
	Clear the Cluster information (to reuse the same cluster instance)
ClusterCandidate *	merge (ClusterCandidate &cls)
	Merge the given cluster with this one.
void	add (const Pixel &pixel)
	Add a Pixel to the current cluster.
float	getCharge () const
	get the charge of the cluster
float	getSeedCharge () const
	get the seed charge of the cluster
const Pixel &	getSeed () const
	get the seed pixel of the cluster, i.e.
size_t	size () const
	get the cluster size
const std::vector< Pixel > &	pixels () const
	get a reference to all pixels in the cluster

Protected Attributes
ClusterCandidate *	m_merged
	Pointer to the cluster this cluster was merged into.
float	m_charge
	Charge of the cluster.
Pixel	m_seed
	Seed pixel of the cluster, i.e.
std::vector< Pixel >	m_pixels
	List of all pixels in the cluster.

Detailed Description

Class representing a possible cluster during clustering of the PXD It supports merging of different clusters and keeps track of the highest charge inside the cluster.

To save relocation time, each Instance is created with a default capacity of 10 pixels before relocation will occur.

Definition at line 30 of file ClusterCandidate.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
c_defaultCapacity	Reserve space for this number of pixels on construction.
c_maxCapacity	If the capacity exceeds this value, shrink the vector back to c_defaultCapacity after clearing.

Definition at line 32 of file ClusterCandidate.h.

           {
        c_defaultCapacity = 10,
        c_maxCapacity = 4 * c_defaultCapacity
      };

Constructor & Destructor Documentation

ClusterCandidate()

ClusterCandidate ( )

inline

Constructor to create an empty Cluster.

Definition at line 39 of file ClusterCandidate.h.

                        :
        m_merged(0), m_charge(0), m_seed()
      {
        m_pixels.reserve(c_defaultCapacity);
      }

Member Function Documentation

add()

void add

(

const Pixel &

pixel

)

Add a Pixel to the current cluster.

Increases the charge of the cluster and checks if the seed pixel changes. If this method is called on a cluster which has been merged with another cluster, the add method of the merged cluster will be called,

Parameters

pixel

Pixel to add to the cluster

Definition at line 57 of file ClusterCandidate.cc.

    {
      //Delegate to the correct cluster
      if (m_merged) {
        m_merged->add(pixel);
        return;
      }
      //check seed charge
      float charge = pixel.getCharge();
      m_charge += charge;
      if (m_seed.getCharge() < charge) {
        m_seed = pixel;
      }
      //add pixel
      m_pixels.push_back(pixel);
    }

clear()

void clear ( )

inline

Clear the Cluster information (to reuse the same cluster instance)

Definition at line 46 of file ClusterCandidate.h.

      {
        m_merged = 0;
        m_charge = 0;
        m_seed = Pixel();
        m_pixels.clear();
      }

getCharge()

float getCharge ( ) const

inline

get the charge of the cluster

Definition at line 75 of file ClusterCandidate.h.

{ return m_charge; }

getSeed()

const Pixel & getSeed ( ) const

inline

get the seed pixel of the cluster, i.e.

the pixel with the highes charge

Definition at line 79 of file ClusterCandidate.h.

{ return m_seed; }

getSeedCharge()

float getSeedCharge ( ) const

inline

get the seed charge of the cluster

Definition at line 77 of file ClusterCandidate.h.

{ return m_seed.getCharge(); }

merge()

ClusterCandidate * merge

(

ClusterCandidate &

cls

)

Merge the given cluster with this one.

This method will remove all pixels from a given cluster and add it to this one. In addition we set a pointer to this instance in the other cluster so that new pixels will be directly added to the correct cluster when add is called on an already merged cluster

Parameters

cls	Cluster to merge into this one

Returns

the address of the cluster containing all pixels

Definition at line 21 of file ClusterCandidate.cc.

    {
      //If this cluster has been merged, delegate to the correct cluster
      if (m_merged) return m_merged->merge(cls);
      ClusterCandidate* pcls = &cls;
      //No need to merge with ourselves
      if (pcls == this) return this;
      //If the other cluster has been merged, find the parent
      while (pcls->m_merged != 0) {
        ClusterCandidate* tmp = pcls->m_merged;
        if (tmp == this) return this;
        //Update all merged pointers to point to this cluster
        pcls->m_merged = this;
        pcls = tmp;
      }
      //Sum charge, set seed and copy pixels
      m_charge += pcls->m_charge;
      if (pcls->m_seed.getCharge() > m_seed.getCharge()) {
        m_seed = pcls->m_seed;
      }
      //copy only the smaller vector
      if (pcls->m_pixels.size() > m_pixels.size()) std::swap(m_pixels, pcls->m_pixels);
      m_pixels.insert(m_pixels.end(), pcls->m_pixels.begin(), pcls->m_pixels.end());
      //If the allocated memory is too large, shrink it down to default
      if (pcls->m_pixels.capacity() > c_maxCapacity) {
        pcls->m_pixels.resize(c_defaultCapacity);
        pcls->m_pixels.shrink_to_fit();
      }
      //Clear the pixels and charge in the merged cluster
      pcls->m_pixels.clear();
      pcls->m_charge = 0;
      //And set the merge pointer
      pcls->m_merged = this;
      return this;
    }

pixels()

const std::vector< Pixel > & pixels ( ) const

inline

get a reference to all pixels in the cluster

Definition at line 83 of file ClusterCandidate.h.

{ return m_pixels; }

size()

size_t size ( ) const

inline

get the cluster size

Definition at line 81 of file ClusterCandidate.h.

{ return m_pixels.size(); }

Member Data Documentation

m_charge

float m_charge

protected

Charge of the cluster.

Definition at line 89 of file ClusterCandidate.h.

m_merged

ClusterCandidate* m_merged

protected

Pointer to the cluster this cluster was merged into.

Definition at line 87 of file ClusterCandidate.h.

m_pixels

std::vector<Pixel> m_pixels

protected

List of all pixels in the cluster.

Definition at line 93 of file ClusterCandidate.h.

m_seed

Pixel m_seed

protected

Seed pixel of the cluster, i.e.

the pixel with the highest charge

Definition at line 91 of file ClusterCandidate.h.

---

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

• pxd/reconstruction/include/ClusterCandidate.h
• pxd/reconstruction/src/ClusterCandidate.cc