CaloCellClusterWeights Class Reference

Hash lookup of calibration weights for calorimeter cells. More...

#include <CaloCellClusterWeights.h>

Collaboration diagram for CaloCellClusterWeights:

Public Types
Storage and payload types
typedef std::vector< double >	weight_t
	Type of weight.
typedef std::tuple< bool, weight_t >	value_t
	Type of payload.
typedef std::vector< value_t >	store_t
	Store type.
typedef store_t::const_iterator	const_iterator
	Iterator type for const access.
typedef store_t::iterator	iterator
	Iterator type.

Public Member Functions
	CaloCellClusterWeights ()
	Default constructor.
	CaloCellClusterWeights (size_t size)
	Constructor with client-defined size.
	CaloCellClusterWeights (const CaloCellClusterWeights &cellClusterWeights)
	Copy constructor.
virtual	~CaloCellClusterWeights ()
	Destructor.
Random access to payload
Accessing value using operator Returns Stored value at given index if index is valid, else payload default value (0). Parameters hash index (calorimeter cell hash id)
const weight_t &	operator[] (size_t hash) const
const weight_t &	at (size_t hash) const
	Accessing value using function and hash.
const weight_t &	at (const CaloCell *pCell) const
	Accessing value using function and cell pointer.
bool	check (size_t hash) const
	Safe checking if cell is used by any cluster.
bool	check (const CaloCell *pCell) const
	Safe checking if cell is used by any cluster.
bool	fastCheck (size_t hash) const
	Fast checking if cell is used by any cluster.
bool	fastCheck (const CaloCell *pCell) const
	Fast checking if cell is used by any cluster.
Store modifiers
Loading a value by hash id This method overwrites the stored value at the given index. It also sets the "used" flag in the store for the cell. Parameters hash index in store value value to be stored at index
void	set (size_t hash, double value)
void	set (const CaloCell *pCell, double value)
	Loading a value by cell pointer.
void	reset ()
	Reset the store.
void	clear ()
	Clear the store.
void	clear (size_t hash)
	Clear a specific entry in the store.
Store parameters
size_t	size () const
	Store size.
size_t	reserve () const
	Reserved memory.
Iterators
const_iterator	begin () const
	Constant access iterator pointing to beginning of the store.
const_iterator	end () const
	Constant iterator indicating the end of the store.
iterator	begin ()
	Access iterator pointing to beginning of the store.
iterator	end ()
	Iterator indicating the end of the store.
Store access
const store_t &	store () const
	Read-only access to underlying store.
store_t &	store ()
	Read/write access to underlying store.

Static Public Member Functions
static std::string	key (const std::string &pref)
	Construct a SG key for this object.

Private Attributes
store_t	m_hashTable
	Store implementation.
weight_t	m_defaultValue { weight_t() }
	Default (empty) entry.

Detailed Description

Hash lookup of calibration weights for calorimeter cells.

This object wraps a random access lookup of calibration weights based on the hash id of a calorimeter cell. It is meant to provide these weights to several tools, thus e.g. reducing the number of searches for cells in topo-clusters.

The data object reserves a fixed memory segment sufficient to store one weight per cell, and is of a fixed size which is defaulted to the total number of calorimeter cells, but can also be set at construction.

Definition at line 22 of file CaloCellClusterWeights.h.

Member Typedef Documentation

const_iterator

typedef store_t::const_iterator CaloCellClusterWeights::const_iterator

Iterator type for const access.

Definition at line 31 of file CaloCellClusterWeights.h.

iterator

typedef store_t::iterator CaloCellClusterWeights::iterator

Iterator type.

Definition at line 32 of file CaloCellClusterWeights.h.

store_t

typedef std::vector<value_t> CaloCellClusterWeights::store_t

Store type.

Definition at line 30 of file CaloCellClusterWeights.h.

value_t

typedef std::tuple<bool,weight_t> CaloCellClusterWeights::value_t

Type of payload.

Definition at line 29 of file CaloCellClusterWeights.h.

weight_t

typedef std::vector<double> CaloCellClusterWeights::weight_t

Type of weight.

Definition at line 28 of file CaloCellClusterWeights.h.

Constructor & Destructor Documentation

CaloCellClusterWeights() [1/3]

CaloCellClusterWeights::CaloCellClusterWeights

(

)

Default constructor.

The constructed data object provides a reserved and sized store appropriate for the total number of cells in the calorimeter. The store is pre-filled with the default payload value (0).

Definition at line 18 of file CaloCellClusterWeights.cxx.

  : CaloCellClusterWeights( CELLCLUSTERLOOKUP )
{ }

CaloCellClusterWeights() [2/3]

CaloCellClusterWeights::CaloCellClusterWeights

(

size_t

size

)

Constructor with client-defined size.

A store with the specified size is created and pre-filled with the default payload value (0).

Parameters

size	requested store size

Definition at line 12 of file CaloCellClusterWeights.cxx.

  : m_hashTable(size)
{
  this->clear(); 
}

CaloCellClusterWeights() [3/3]

CaloCellClusterWeights::CaloCellClusterWeights

(

const CaloCellClusterWeights &

cellClusterWeights

)

Copy constructor.

Definition at line 22 of file CaloCellClusterWeights.cxx.

  : m_hashTable(cellClusterWeights.m_hashTable)
{ }

~CaloCellClusterWeights()

CaloCellClusterWeights::~CaloCellClusterWeights ( )

virtualdefault

Destructor.

Member Function Documentation

at() [1/2]

const CaloCellClusterWeights::weight_t & CaloCellClusterWeights::at

(

const CaloCell *

pCell

)

const

Accessing value using function and cell pointer.

Returns

Stored value at given index if index is valid, else payload default value (0).

Parameters

hash	index (calorimeter cell hash id)

Definition at line 33 of file CaloCellClusterWeights.cxx.

{ return this->at(static_cast<size_t>(pCell->caloDDE()->calo_hash())); }

at() [2/2]

const CaloCellClusterWeights::weight_t & CaloCellClusterWeights::at

(

size_t

hash

)

const

Accessing value using function and hash.

Returns

Stored value at given index if index is valid, else payload default value (0).

Parameters

hash	index (calorimeter cell hash id)

Definition at line 31 of file CaloCellClusterWeights.cxx.

{ return this->check(hash) ? std::get<1>( m_hashTable.at(hash)) : m_defaultValue; }

begin() [1/2]

CaloCellClusterWeights::iterator CaloCellClusterWeights::begin ( )

inline

Access iterator pointing to beginning of the store.

Definition at line 147 of file CaloCellClusterWeights.h.

{ return m_hashTable.begin(); }

begin() [2/2]

CaloCellClusterWeights::const_iterator CaloCellClusterWeights::begin ( ) const

inline

Constant access iterator pointing to beginning of the store.

Definition at line 146 of file CaloCellClusterWeights.h.

{ return m_hashTable.begin(); }

check() [1/2]

bool CaloCellClusterWeights::check

(

const CaloCell *

pCell

)

const

Safe checking if cell is used by any cluster.

Returns

true if cell is part of any cluster and has valid hash index

Definition at line 39 of file CaloCellClusterWeights.cxx.

{ return this->check(static_cast<size_t>(pCell->caloDDE()->calo_hash())); } 

check() [2/2]

bool CaloCellClusterWeights::check

(

size_t

hash

)

const

Safe checking if cell is used by any cluster.

Returns

true if cell is part of any cluster and has valid hash index

Definition at line 38 of file CaloCellClusterWeights.cxx.

{ return hash < m_hashTable.size() && this->fastCheck(hash); }

clear() [1/2]

void CaloCellClusterWeights::clear

(

)

Clear the store.

All stored values are overwritten with the default payload value (0).

Definition at line 55 of file CaloCellClusterWeights.cxx.

{ std::fill(m_hashTable.begin(),m_hashTable.end(),value_t(false,m_defaultValue)); }

clear() [2/2]

void CaloCellClusterWeights::clear

(

size_t

hash

)

Clear a specific entry in the store.

The value stored at the given index is overwritten with the default payload value (0).

Parameters

hash	index in store

Definition at line 56 of file CaloCellClusterWeights.cxx.

                                              { 
  if ( hash < m_hashTable.size() ) { std::get<0>(m_hashTable[hash]) = false; std::get<1>(m_hashTable[hash]) = m_defaultValue; } 
}

end() [1/2]

CaloCellClusterWeights::iterator CaloCellClusterWeights::end ( )

inline

Iterator indicating the end of the store.

Definition at line 150 of file CaloCellClusterWeights.h.

{ return m_hashTable.end(); }

end() [2/2]

CaloCellClusterWeights::const_iterator CaloCellClusterWeights::end ( ) const

inline

Constant iterator indicating the end of the store.

Definition at line 149 of file CaloCellClusterWeights.h.

{ return m_hashTable.end(); }

fastCheck() [1/2]

bool CaloCellClusterWeights::fastCheck

(

const CaloCell *

pCell

)

const

Fast checking if cell is used by any cluster.

Returns

true if cell is part of any cluster

Definition at line 37 of file CaloCellClusterWeights.cxx.

{ return this->fastCheck(static_cast<size_t>(pCell->caloDDE()->calo_hash())); } 

fastCheck() [2/2]

bool CaloCellClusterWeights::fastCheck

(

size_t

hash

)

const

Fast checking if cell is used by any cluster.

Returns

true if cell is part of any cluster

Definition at line 36 of file CaloCellClusterWeights.cxx.

{ return std::get<0>(m_hashTable.at(hash)); }

key()

std::string CaloCellClusterWeights::key ( const std::string & pref )

inlinestatic

Construct a SG key for this object.

Definition at line 158 of file CaloCellClusterWeights.h.

{ return pref+std::string("_CCW"); } 

operator[]()

const CaloCellClusterWeights::weight_t & CaloCellClusterWeights::operator[]

(

size_t

hash

)

const

Definition at line 29 of file CaloCellClusterWeights.cxx.

{ return this->check(hash) ? std::get<1>(m_hashTable.at(hash)) : m_defaultValue; }

reserve()

size_t CaloCellClusterWeights::reserve ( ) const

inline

Reserved memory.

Definition at line 153 of file CaloCellClusterWeights.h.

{ return m_hashTable.capacity(); }

reset()

void CaloCellClusterWeights::reset

(

)

Reset the store.

All stored values are overwritten with the default payload value (0).

Definition at line 59 of file CaloCellClusterWeights.cxx.

{ this->clear(); }

set() [1/2]

void CaloCellClusterWeights::set	(	const CaloCell *	pCell,
		double	value )

Loading a value by cell pointer.

This method overwrites the stored value at the given index. It also sets the "used" flag in the store for the cell.

Parameters

hash	index in store
value	value to be stored at index

Definition at line 53 of file CaloCellClusterWeights.cxx.

{ this->set(static_cast<size_t>(pCell->caloDDE()->calo_hash()),value); } 

set() [2/2]

void CaloCellClusterWeights::set	(	size_t	hash,
		double	value )

Definition at line 41 of file CaloCellClusterWeights.cxx.

{ 
  if ( hash < m_hashTable.size() ) {
    if ( this->fastCheck(hash) ) { 
      std::get<1>(m_hashTable[hash]).push_back(value); 
    } else {
      std::get<0>(m_hashTable[hash]) = true;
      std::get<1>(m_hashTable[hash]).push_back(value); 
    } 
  }
}

size()

size_t CaloCellClusterWeights::size ( ) const

inline

Store size.

Definition at line 152 of file CaloCellClusterWeights.h.

{ return m_hashTable.size(); }

store() [1/2]

CaloCellClusterWeights::store_t & CaloCellClusterWeights::store ( )

inline

Read/write access to underlying store.

Definition at line 156 of file CaloCellClusterWeights.h.

{ return m_hashTable; } 

store() [2/2]

const CaloCellClusterWeights::store_t & CaloCellClusterWeights::store ( ) const

inline

Read-only access to underlying store.

Definition at line 155 of file CaloCellClusterWeights.h.

{ return m_hashTable; } 

Member Data Documentation

m_defaultValue

weight_t CaloCellClusterWeights::m_defaultValue { weight_t() }

private

Default (empty) entry.

Definition at line 141 of file CaloCellClusterWeights.h.

{ weight_t() };    

m_hashTable

store_t CaloCellClusterWeights::m_hashTable

private

Store implementation.

Definition at line 140 of file CaloCellClusterWeights.h.

---

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

• CaloCellClusterWeights.h
• CaloCellClusterWeights.cxx