CaloClusterCellLink Class Reference

Bookkeeping of cells that make up a cluster Simplified replacement for CaloCellLink, CaloClusterNavigable and Navigable classes used during run 1. More...

#include <CaloClusterCellLink.h>

Collaboration diagram for CaloClusterCellLink:

Classes
class	const_iterator
	const_iterator to loop over cells belonging to a cluster More...
class	iterator

Public Types
typedef double	weight_t

Public Member Functions
	CaloClusterCellLink ()
	default constructor (for persistency only) More...
	CaloClusterCellLink (const CaloCellContainer *cellCont)
	useful constructor More...
	CaloClusterCellLink (const DataLink< CaloCellContainer > &cellCont)
	Constructor from DataLink. More...
	~CaloClusterCellLink ()
	standard destructor More...
const_iterator	begin () const
	const begin method More...
const_iterator	end () const
	const end method More...
size_t	size () const
	size method More...
iterator	begin ()
	non-const begin method More...
iterator	end ()
	const end method More...
bool	addCell (const unsigned cellIdx, const weight_t weight=1.0)
	Method to add a cell to the cluster. More...
CaloClusterCellLink::iterator	removeCell (iterator cellItr)
	Method to remove a cell. More...
bool	removeCell (const CaloCell *ptr)
	Method to remove a cell by pointer (slow!) More...
const CaloCellContainer *	getCellContainer () const
	Method to access underlying cell container. More...
const DataLink< CaloCellContainer > &	getCellContainerLink () const
void	reserve (const size_t s)
	Method to reserve space the underlying vector<pair> More...
void	clear ()
	Method to remove all cells;. More...
void	toPersistent ()
	Prepare for writing. More...

Static Public Attributes
static const CaloClusterCellLink::const_iterator	dummyIt
	Dummy iterator to be used as begin/end if no cell-links are present. More...

Private Types
typedef std::vector< std::pair< unsigned, weight_t > >	linkAndWeightCollType

Private Attributes
DataLink< CaloCellContainer >	m_cellCont
linkAndWeightCollType	m_indicesAndWeights

Static Private Attributes
static const linkAndWeightCollType	m_dummyIndicesAndWeights

Detailed Description

Bookkeeping of cells that make up a cluster Simplified replacement for CaloCellLink, CaloClusterNavigable and Navigable classes used during run 1.

Author

Walter Lampl

Definition at line 24 of file CaloClusterCellLink.h.

Member Typedef Documentation

linkAndWeightCollType

typedef std::vector<std::pair<unsigned, weight_t> > CaloClusterCellLink::linkAndWeightCollType

private

Definition at line 31 of file CaloClusterCellLink.h.

weight_t

typedef double CaloClusterCellLink::weight_t

Definition at line 27 of file CaloClusterCellLink.h.

Constructor & Destructor Documentation

CaloClusterCellLink() [1/3]

CaloClusterCellLink::CaloClusterCellLink ( )

default

default constructor (for persistency only)

CaloClusterCellLink() [2/3]

CaloClusterCellLink::CaloClusterCellLink

(

const CaloCellContainer *

cellCont

)

useful constructor

Parameters

[in]

cellCont

Pointer to the CaloCellContainer from which this cluster is built

Definition at line 19 of file CaloClusterCellLink.cxx.

                                                                          :
  m_cellCont(cellCont)
{}

CaloClusterCellLink() [3/3]

CaloClusterCellLink::CaloClusterCellLink

(

const DataLink< CaloCellContainer > &

cellCont

)

Constructor from DataLink.

Parameters

[in]

cellCont

Link to the CaloCellContainer from which this cluster is built

Definition at line 24 of file CaloClusterCellLink.cxx.

                                                                                    :
  m_cellCont(cellCont)
{}

~CaloClusterCellLink()

CaloClusterCellLink::~CaloClusterCellLink ( )

default

standard destructor

Member Function Documentation

addCell()

bool CaloClusterCellLink::addCell ( const unsigned  cellIdx, const weight_t  weight = 1.0  )

inline

Method to add a cell to the cluster.

Parameters

cellIdx	Index of the cell in the CaloCellContainer
weight	cell weight

Returns

true if this cell was added (always in this implementation)

Definition at line 234 of file CaloClusterCellLink.h.

                                                                                      {
 
  /* map version - with uniqueness check
  std::pair<linkAndWeightCollType::iterator,bool> tryInsert=
    m_indicesAndWeights.insert(std::make_pair(cellIdx,weight));
  if (!tryInsert.second) {
    //Cell existed before, need to overwrite
    tryInsert.first->second=weight;
  }
  return !tryInsert.second;
  */
  m_indicesAndWeights.emplace_back(cellIdx,weight);
  return true;
 
}

begin() [1/2]

iterator CaloClusterCellLink::begin ( )

inline

non-const begin method

Returns

begin iterator

Definition at line 180 of file CaloClusterCellLink.h.

{return iterator(m_cellCont, m_indicesAndWeights.begin());} 

begin() [2/2]

const_iterator CaloClusterCellLink::begin ( ) const

inline

const begin method

Returns

const_iterator to the first cell belonging to this cluster

Definition at line 107 of file CaloClusterCellLink.h.

{return const_iterator(m_cellCont, m_indicesAndWeights.begin());} 

clear()

void CaloClusterCellLink::clear ( )

inline

Method to remove all cells;.

Definition at line 220 of file CaloClusterCellLink.h.

{m_indicesAndWeights.clear();}

end() [1/2]

iterator CaloClusterCellLink::end ( )

inline

const end method

Returns

end iterator

Definition at line 185 of file CaloClusterCellLink.h.

{return iterator(m_cellCont, m_indicesAndWeights.end());} 

end() [2/2]

const_iterator CaloClusterCellLink::end ( ) const

inline

const end method

Returns

const_iterator end iterator

Definition at line 112 of file CaloClusterCellLink.h.

{return const_iterator(m_cellCont, m_indicesAndWeights.end());} 

getCellContainer()

const CaloCellContainer* CaloClusterCellLink::getCellContainer ( ) const

inline

Method to access underlying cell container.

Returns

const pointer to CaloCellContainer

Definition at line 212 of file CaloClusterCellLink.h.

{ return m_cellCont.cptr();}

getCellContainerLink()

const DataLink<CaloCellContainer>& CaloClusterCellLink::getCellContainerLink ( ) const

inline

Definition at line 213 of file CaloClusterCellLink.h.

{ return m_cellCont;}

removeCell() [1/2]

bool CaloClusterCellLink::removeCell

(

const CaloCell *

ptr

)

Method to remove a cell by pointer (slow!)

Parameters

pointer

to the cell in teh cell container

Returns

True if the cell was removed, False if it was not found.

Definition at line 37 of file CaloClusterCellLink.cxx.

                                                                {
  bool success=false;
  CaloClusterCellLink::iterator it=this->begin();
  CaloClusterCellLink::iterator it_e=this->end();
  for(;it!=it_e;++it) {
    const CaloCell* pCell=(*it);
    if (pCell==ptrToDelete) { //Pointer comparison!
      this->removeCell(it);
      success=true;
      break;
    }//end cell found
  }//end for loop
  return success;
}

removeCell() [2/2]

CaloClusterCellLink::iterator CaloClusterCellLink::removeCell

(

CaloClusterCellLink::iterator

cellItr

)

Method to remove a cell.

Parameters

cellItr

Iterator pointing to the cell to be removed

Returns

iterator to the cell following the removed one

Definition at line 29 of file CaloClusterCellLink.cxx.

                                                                                               {
  linkAndWeightCollType::iterator toDelete=cellItr.m_it;
  auto newVecIt=m_indicesAndWeights.erase(toDelete);
  return {cellItr.m_ccc,newVecIt};
  
}

reserve()

void CaloClusterCellLink::reserve ( const size_t  s )

inline

Method to reserve space the underlying vector<pair>

Definition at line 216 of file CaloClusterCellLink.h.

{ m_indicesAndWeights.reserve(s);}

size()

size_t CaloClusterCellLink::size ( ) const

inline

size method

Returns

The number of cells

Definition at line 117 of file CaloClusterCellLink.h.

{return m_indicesAndWeights.size();}

toPersistent()

void CaloClusterCellLink::toPersistent

(

)

Prepare for writing.

Definition at line 55 of file CaloClusterCellLink.cxx.

{
  m_cellCont.toPersistent();
}

Member Data Documentation

dummyIt

const CaloClusterCellLink::const_iterator CaloClusterCellLink::dummyIt

static

Dummy iterator to be used as begin/end if no cell-links are present.

Definition at line 102 of file CaloClusterCellLink.h.

m_cellCont

DataLink<CaloCellContainer> CaloClusterCellLink::m_cellCont

private

Definition at line 227 of file CaloClusterCellLink.h.

m_dummyIndicesAndWeights

const CaloClusterCellLink::linkAndWeightCollType CaloClusterCellLink::m_dummyIndicesAndWeights

staticprivate

Definition at line 230 of file CaloClusterCellLink.h.

m_indicesAndWeights

linkAndWeightCollType CaloClusterCellLink::m_indicesAndWeights

private

Definition at line 228 of file CaloClusterCellLink.h.

---

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

• CaloClusterCellLink.h
• CaloClusterCellLink.cxx