xAOD::AFPSiHit_v2 Class Reference

Class representing a hit in silicon detector. More...

#include <AFPSiHit_v2.h>

Inheritance diagram for xAOD::AFPSiHit_v2:

Collaboration diagram for xAOD::AFPSiHit_v2:

Public Types
using	TypelessConstAccessor = ConstAuxElement::TypelessConstAccessor
template<class T , class ALLOC = AuxAllocator_t<T>>
using	ConstAccessor = SG::ConstAccessor< T, ALLOC >
template<class T , class ALLOC = AuxAllocator_t<T>>
using	Accessor = SG::Accessor< T, ALLOC >
template<class T , class ALLOC = AuxAllocator_t<T>>
using	Decorator = SG::Decorator< T, ALLOC >

Public Member Functions
	AFPSiHit_v2 ()
float	depositedCharge () const
	Charge deposited in the pixel. More...
void	setDepositedCharge (float charge)
	Method setting value of the charge deposited in the pixel. More...
float	timeOverThreshold () const
	Time over threshold of signal for a pixel. More...
void	setTimeOverThreshold (float timeOverThreshold)
	Method setting value of time over threshold. More...
int	stationID () const
	Index of the station with pixel hit. More...
void	setStationID (int stationID)
	Set index of the station with pixel hit. More...
int	pixelLayerID () const
	Index of the layer of pixels, i.e. More...
void	setPixelLayerID (int layerID)
	Method setting index of the pixel layer with hit. More...
int	pixelRowIDChip () const
	Index of the pixel row in chip coordinate system. More...
void	setPixelRowIDChip (int rowID)
	Set pixel row index in the chip coordinate system. More...
int	pixelColIDChip () const
	Index of the pixel column in chip coordinate system. More...
void	setPixelColIDChip (int colID)
	Set pixel column index in the chip coordinate system. More...
int	pixelHorizID () const
	Index of the pixel along X axis in LHC coordinate system. More...
void	setPixelHorizID (const int horizontalID)
	Set index of the pixel along X axis in LHC coordinate system. More...
int	pixelVertID () const
	Index of the pixel along Y axis in LHC coordinate system. More...
void	setPixelVertID (const int verticalID)
	Set index of the pixel along Y axis in LHC coordinate system. More...
void	toPersistent ()
	Function making sure that the object is ready for persistification i.e. saving. More...
const SG::AuxVectorData *	container () const
	Return the container holding this element. More...
SG::AuxVectorData *	container ()
	Return the container holding this element. More...
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::reference_type	auxdata (const std::string &name)
	Fetch an aux data variable, as a non-const reference. More...
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::reference_type	auxdata (const std::string &name, const std::string &clsname)
	Fetch an aux data variable, as a non-const reference. More...
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type	auxdata (const std::string &name) const
	Fetch an aux data variable, as a const reference. More...
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type	auxdata (const std::string &name, const std::string &clsname) const
	Fetch an aux data variable, as a const reference. More...
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type	auxdataConst (const std::string &name) const
	Fetch an aux data variable, as a const reference. More...
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type	auxdataConst (const std::string &name, const std::string &clsname) const
	Fetch an aux data variable, as a const reference. More...
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED bool	isAvailable (const std::string &name, const std::string &clsname="") const
	Check if an aux variable is available for reading. More...
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED bool	isAvailableWritable (const std::string &name, const std::string &clsname="")
	Check if an aux variable is available for writing. More...
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED bool	isAvailableWritableAsDecoration (const std::string &name, const std::string &clsname="") const
	Check if an aux variable is available for writing as a decoration. More...
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Decorator< T, ALLOC >::reference_type	auxdecor (const std::string &name) const
	Fetch an aux decoration, as a non-const reference. More...
template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Decorator< T, ALLOC >::reference_type	auxdecor (const std::string &name, const std::string &clsname) const
	Fetch an aux decoration, as a non-const reference. More...
void	makePrivateStore ()
	Create a new (empty) private store for this object. More...
template<class U1 >
void	makePrivateStore (const U1 &other)
	Create a new private store for this object and copy aux data. More...
template<class U1 >
void	makePrivateStore (const U1 *other)
	Create a new private store for this object and copy aux data. More...
void	releasePrivateStore ()
	Release and free any private store associated with this object. More...
void	setStore (const SG::IConstAuxStore *store)
	Set the store associated with this object. More...
void	setStore (SG::IAuxStore *store)
	Set the store associated with this object. More...
void	setStore (const DataLink< SG::IConstAuxStore > &store)
	Set the store associated with this object. More...
void	setConstStore (const SG::IConstAuxStore *store)
	Synonym for setStore with IConstAuxStore. More...
void	setNonConstStore (SG::IAuxStore *store)
	Synonym for setStore with IAuxStore. More...
bool	usingPrivateStore () const
	Test to see if this object is currently using a private store. More...
bool	usingStandaloneStore () const
	Test to see if this object is currently using a standalone store. More...
const SG::IConstAuxStore *	getConstStore () const
	Return the current store, as a const interface. More...
SG::IAuxStore *	getStore () const
	Return the current store, as a non-const interface. More...
void	clearCache ()
	Clear the cached aux data pointers. More...
const SG::auxid_set_t &	getAuxIDs () const
	Return a set of identifiers for existing data items for this object. More...
bool	hasStore () const
	Return true if this object has an associated store. More...
bool	hasNonConstStore () const
	Return true if this object has an associated non-const store. More...
bool	clearDecorations () const
	Clear all decorations. More...
bool	trackIndices () const
	Return true if index tracking is enabled for this object. More...
size_t	index () const
	Return the index of this element within its container. More...
size_t	index () const
	Return the index of this element within its container. More...

Static Public Attributes
static constexpr bool	supportsThinning = true
	Mark that this type supports thinning operations. More...

Protected Member Functions
bool	noPrivateData () const
	True if this element has no private data. More...
bool	havePrivateData () const
	True if this element currently has private data. More...
bool	hadPrivateData () const
	True if this element had private data before it was added to its current container. More...

Private Types
enum	PrivateStoreState : uint8_t { PrivateStoreState::NO_PRIVATE = 0, PrivateStoreState::HAVE_PRIVATE = 1, PrivateStoreState::HAD_PRIVATE = 2 }
	The current private data state. More...

Private Member Functions
void	releasePrivateStoreForDtor ()
	Out-of-line portion of destructor. More...
void	setIndex (size_t index, SG::AuxVectorData *container)
	Set the index/container for this element. More...
bool	setIndexPrivate (size_t index, SG::AuxVectorData *container)
	Set the index/container for this element. More...
void	makePrivateStore1 (const void *)
	Create a new private store for this object and copy aux data. More...
void	makePrivateStore1 (const AuxElement *other)
	Create a new private store for this object and copy aux data. More...
AuxElementStandaloneData *	setStore1 (const SG::IConstAuxStore *store)
	Set the store associated with this object. More...
void	clearAux ()
	Clear all aux data associated with this element. More...
void	copyAux (const ConstAuxElement &other)
	Copy aux data from another object. More...
void	setNoPrivateData ()
	Record that this element does not have private data. More...
void	setHavePrivateData ()
	Record that this element currently has private data. More...
void	setHadPrivateData ()
	Record that this element used to have private data. More...

Private Attributes
const SG::AuxVectorData *	m_container
	The container of which this object is an element. More...
size_t	m_index
	The index of this element within its container. More...
PrivateStoreState	m_privateStoreState

Detailed Description

Class representing a hit in silicon detector.

This class provides information about a single hit in AFP silicon detector.

Definition at line 29 of file AFPSiHit_v2.h.

Member Typedef Documentation

Accessor

template<class T , class ALLOC = AuxAllocator_t<T>>

using SG::AuxElement::Accessor = SG::Accessor<T, ALLOC>

inherited

Definition at line 548 of file AuxElement.h.

ConstAccessor

template<class T , class ALLOC = AuxAllocator_t<T>>

using SG::AuxElement::ConstAccessor = SG::ConstAccessor<T, ALLOC>

inherited

Definition at line 545 of file AuxElement.h.

Decorator

template<class T , class ALLOC = AuxAllocator_t<T>>

using SG::AuxElement::Decorator = SG::Decorator<T, ALLOC>

inherited

Definition at line 551 of file AuxElement.h.

TypelessConstAccessor

using SG::AuxElement::TypelessConstAccessor = ConstAuxElement::TypelessConstAccessor

inherited

Definition at line 542 of file AuxElement.h.

Member Enumeration Documentation

PrivateStoreState

enum SG::IAuxElement::PrivateStoreState : uint8_t

strongprivateinherited

The current private data state.

Enumerator
NO_PRIVATE
HAVE_PRIVATE
HAD_PRIVATE

Definition at line 131 of file IAuxElement.h.

  {
    NO_PRIVATE = 0,
    HAVE_PRIVATE = 1,
    HAD_PRIVATE = 2,
  };

Constructor & Destructor Documentation

AFPSiHit_v2()

xAOD::AFPSiHit_v2::AFPSiHit_v2

(

)

Definition at line 24 of file AFPSiHit_v2.cxx.

                           : SG::AuxElement()
  { }

Member Function Documentation

auxdata() [1/4]

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Accessor<T, ALLOC>::reference_type SG::AuxElement::auxdata ( const std::string &  name )

inherited

Fetch an aux data variable, as a non-const reference.

Parameters

name	Name of the aux variable.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

auxdata() [2/4]

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Accessor<T, ALLOC>::const_reference_type SG::AuxElement::auxdata ( const std::string &  name ) const

inherited

Fetch an aux data variable, as a const reference.

Parameters

name	Name of the aux variable.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor or ConstAccessor classes.

auxdata() [3/4]

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Accessor<T, ALLOC>::reference_type SG::AuxElement::auxdata ( const std::string &  name, const std::string &  clsname  )

inherited

Fetch an aux data variable, as a non-const reference.

Parameters

name	Name of the aux variable.
clsname	The name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

auxdata() [4/4]

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Accessor<T, ALLOC>::const_reference_type SG::AuxElement::auxdata ( const std::string &  name, const std::string &  clsname  ) const

inherited

Fetch an aux data variable, as a const reference.

Parameters

name	Name of the aux variable.
clsname	The name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor or ConstAccessor classes.

auxdataConst() [1/2]

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Accessor<T, ALLOC>::const_reference_type SG::AuxElement::auxdataConst ( const std::string &  name ) const

inherited

Fetch an aux data variable, as a const reference.

Parameters

name	Name of the aux variable.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the ConstAccessor class.

auxdataConst() [2/2]

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Accessor<T, ALLOC>::const_reference_type SG::AuxElement::auxdataConst ( const std::string &  name, const std::string &  clsname  ) const

inherited

Fetch an aux data variable, as a const reference.

Parameters

name	Name of the aux variable.
clsname	The name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the ConstAccessor class.

auxdecor() [1/2]

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Decorator<T, ALLOC>::reference_type SG::AuxElement::auxdecor ( const std::string &  name ) const

inherited

Fetch an aux decoration, as a non-const reference.

Parameters

name	Name of the aux variable.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

If the container is locked, this will allow fetching only variables that do not yet exist (in which case they will be marked as decorations) or variables already marked as decorations.

auxdecor() [2/2]

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Decorator<T, ALLOC>::reference_type SG::AuxElement::auxdecor ( const std::string &  name, const std::string &  clsname  ) const

inherited

Fetch an aux decoration, as a non-const reference.

Parameters

name	Name of the aux variable.
clsname	The name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

If the container is locked, this will allow fetching only variables that do not yet exist (in which case they will be marked as decorations) or variables already marked as decorations.

clearAux()

void SG::AuxElement::clearAux ( )

privateinherited

Clear all aux data associated with this element.

If this object has no associated store, this does nothing. If the associated aux data is const, this throws ExcConstAuxData.

Definition at line 535 of file AuxElement.cxx.

{
  if (!m_container) return;
  if (!m_container->hasStore()) return;
  if (!m_container->hasNonConstStore())
    throw SG::ExcConstAuxData ("clearAux", SG::null_auxid);
 
  SG::AuxTypeRegistry& r = SG::AuxTypeRegistry::instance();
  for (SG::auxid_t auxid : m_container->getWritableAuxIDs()) {
    r.clear (auxid, *container(), index(), 1);
  }
}

clearCache()

void SG::AuxElement::clearCache ( )

inherited

Clear the cached aux data pointers.

You should call this any time something changes in the aux store that could invalidate the vector pointers.

Definition at line 319 of file AuxElement.cxx.

{
  if (container())
    container()->clearCache();
}

clearDecorations()

bool SG::AuxElement::clearDecorations ( ) const

inherited

Clear all decorations.

Erase all decorations from an associated store, restoring the state to when lock was called.

Returns true if there were any decorations that were cleared, false if the store did not contain any decorations.

Definition at line 385 of file AuxElement.cxx.

{
  if (havePrivateData())
    return m_container->clearDecorations();
  return false;
}

container() [1/2]

SG::AuxVectorData* SG::AuxElement::container ( )

inherited

Return the container holding this element.

container() [2/2]

const SG::AuxVectorData* SG::AuxElement::container ( ) const

inherited

Return the container holding this element.

copyAux()

void SG::AuxElement::copyAux ( const ConstAuxElement &  other )

privateinherited

Copy aux data from another object.

Parameters

other

The object from which to copy.

If this object has no associated store, this does nothing. If the associated aux data is const, this throws ExcConstAuxData.

All aux data items from other are copied to this object. Any aux data items associated with this object that are not present in other are cleared. (If other has no aux data, then all aux data items for this object are cleared.)

Definition at line 561 of file AuxElement.cxx.

{
  if (!m_container) return;
  if (!m_container->hasStore()) return;
  if (!m_container->hasNonConstStore())
    throw SG::ExcConstAuxData ("copyAux");
 
  const SG::AuxVectorData* ocont = other.container();
 
  if (!ocont || !ocont->hasStore()) {
    this->clearAux();
    return;
  }
 
  size_t oindex = other.index();
  SG::auxid_set_t other_ids = ocont->getAuxIDs();
 
  SG::AuxTypeRegistry& r = SG::AuxTypeRegistry::instance();
 
  SG::AuxVectorData& cont = *container();
  for (SG::auxid_t auxid : other_ids) {
    if (!r.isLinked (auxid)) {
      r.copy (auxid, cont, index(), *ocont, oindex, 1);
    }
  }
 
  for (SG::auxid_t auxid : m_container->getWritableAuxIDs()) {
    if (!other_ids.test (auxid)) {
      r.clear (auxid, cont, index(), 1);
    }
  }
}

depositedCharge()

float xAOD::AFPSiHit_v2::depositedCharge

(

)

const

Charge deposited in the pixel.

Charge deposited in the pixel (amplitude of the signal) calculated based on the time over threshold. Time over threshold should be proportional to the deposited charge, but there may be small deviations.

Returns

charge deposited in the pixel

getAuxIDs()

const SG::auxid_set_t & SG::AuxElement::getAuxIDs ( ) const

inherited

Return a set of identifiers for existing data items for this object.

If this object has a private or standalone store, then information from that will be returned. Otherwise, if this element is part of a container, then information for the container will be returned. Otherwise, return an empty set.

Definition at line 335 of file AuxElement.cxx.

{
#ifdef ATHCONTAINERS_R21_COMPAT
  if (havePrivateData())
    return m_container->getConstStore()->getAuxIDs();
  if (container())
    return container()->getAuxIDs();
  static const SG::auxid_set_t null_set;
  return null_set;
#else
  return ConstAuxElement::getAuxIDs();
#endif
}

getConstStore()

const SG::IConstAuxStore * SG::AuxElement::getConstStore ( ) const

inherited

Return the current store, as a const interface.

This will be non-zero if either a const or non-const store is associated with this object. This will fetch either a private or standalone store.

Definition at line 284 of file AuxElement.cxx.

{
  if (havePrivateData()) {
    return m_container->getConstStore();
  }
  return 0;
}

getStore()

SG::IAuxStore * SG::AuxElement::getStore ( ) const

inherited

Return the current store, as a non-const interface.

This will be non-zero if a non-const store is associated with this object. This will fetch either a private or standalone store.

Definition at line 299 of file AuxElement.cxx.

{
  if (havePrivateData()) {
#ifdef ATHCONTAINERS_R21_COMPAT
    SG::AuxVectorData* container_nc ATLAS_THREAD_SAFE = m_container;
#else
    SG::AuxVectorData* container_nc ATLAS_THREAD_SAFE = const_cast<SG::AuxVectorData*>(container());
#endif
    return container_nc->getStore();
  }
  return 0;
}

hadPrivateData()

bool SG::IAuxElement::hadPrivateData ( ) const

protectedinherited

True if this element had private data before it was added to its current container.

hasNonConstStore()

bool SG::AuxElement::hasNonConstStore ( ) const

inherited

Return true if this object has an associated non-const store.

This will be true for either a private or standalone store.

Definition at line 368 of file AuxElement.cxx.

{
  if (havePrivateData())
    return m_container->hasNonConstStore();
  return false;
}

hasStore()

bool SG::AuxElement::hasStore ( ) const

inherited

Return true if this object has an associated store.

This will be true for either a private or standalone store.

Definition at line 355 of file AuxElement.cxx.

{
  if (havePrivateData())
    return m_container->hasStore();
  return false;
}

havePrivateData()

bool SG::IAuxElement::havePrivateData ( ) const

protectedinherited

True if this element currently has private data.

index() [1/2]

size_t SG::IAuxElement::index ( ) const

inherited

Return the index of this element within its container.

index() [2/2]

size_t SG::IAuxElement::index

inherited

Return the index of this element within its container.

Inherited from IAuxElement.

isAvailable()

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED bool SG::AuxElement::isAvailable ( const std::string &  name, const std::string &  clsname = ""  ) const

inherited

Check if an aux variable is available for reading.

Parameters

name	Name of the aux variable.
clsname	The name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

isAvailableWritable()

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED bool SG::AuxElement::isAvailableWritable ( const std::string &  name, const std::string &  clsname = ""  )

inherited

Check if an aux variable is available for writing.

Parameters

name	Name of the aux variable.
clsname	The name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

isAvailableWritableAsDecoration()

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED bool SG::AuxElement::isAvailableWritableAsDecoration ( const std::string &  name, const std::string &  clsname = ""  ) const

inherited

Check if an aux variable is available for writing as a decoration.

Parameters

name	Name of the aux variable.
clsname	The name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

makePrivateStore() [1/3]

void SG::AuxElement::makePrivateStore ( )

inherited

Create a new (empty) private store for this object.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

Definition at line 172 of file AuxElement.cxx.

{
  if (m_container) {
    throw SG::ExcBadPrivateStore ("store already exists");
  }
 
  m_container = new SG::AuxElementPrivateData;
  IAuxElement::setIndex (0);
  IAuxElement::setHavePrivateData();
}

makePrivateStore() [2/3]

template<class U1 >

void SG::AuxElement::makePrivateStore ( const U1 &  other )

inherited

Create a new private store for this object and copy aux data.

Parameters

other

The object from which aux data should be copied.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

If other is an object that has aux data, then those data will be copied; otherwise, nothing will be done.

makePrivateStore() [3/3]

template<class U1 >

void SG::AuxElement::makePrivateStore ( const U1 *  other )

inherited

Create a new private store for this object and copy aux data.

Parameters

other

The object from which aux data should be copied.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

If other is an object that has aux data, then those data will be copied; otherwise, nothing will be done.

makePrivateStore1() [1/2]

void SG::AuxElement::makePrivateStore1 ( const AuxElement *  other )

privateinherited

Create a new private store for this object and copy aux data.

Parameters

other

The object from which aux data should be copied.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

This overload handles the case where other does have aux data.

Definition at line 521 of file AuxElement.cxx.

{
  makePrivateStore();
  if (other)
    this->copyAux (*other);
}

makePrivateStore1() [2/2]

void SG::AuxElement::makePrivateStore1 ( const void *  )

privateinherited

Create a new private store for this object and copy aux data.

Parameters

other

The object from which aux data should be copied.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

This overload handles the case where other does not have aux data.

noPrivateData()

bool SG::IAuxElement::noPrivateData ( ) const

protectedinherited

True if this element has no private data.

pixelColIDChip()

int xAOD::AFPSiHit_v2::pixelColIDChip

(

)

const

Index of the pixel column in chip coordinate system.

Index of the column in chip coordinate system. There are 80 columns numbered from 1. Column number 1 is the bottom one, while column 80 is the topmost one.

Note

Columns in chip coordinate system are horizontal, because the chips are mounted rotated by 90 degrees.

Returns

index of the pixel column which is in horizontal direction

pixelHorizID()

int xAOD::AFPSiHit_v2::pixelHorizID

(

)

const

Index of the pixel along X axis in LHC coordinate system.

There are 336 pixels in the horizontal direction numbered from 0. The numbering is according to the LHC coordinate system i.e. pixel 0 is the outermost pixel and pixel 335 is the innermost (closest to the LHC centre).

This method transforms index from the chip coordinate system to the LHC coordinate system.

Returns

index of the pixel along X axis in LHC coordinate system

Definition at line 37 of file AFPSiHit_v2.cxx.

  {
    // use pixel rows because detectors are rotated and subtract
    // from 336, because the axis is reversed
    return 336 - pixelRowIDChip();
  }

pixelLayerID()

int xAOD::AFPSiHit_v2::pixelLayerID

(

)

const

Index of the layer of pixels, i.e.

the silicon detector, with hit.

It is advised to use class xAOD::AFPPixelLayerID instead of integers to process this information. In this class the numbering scheme is explained.

Returns

index of the pixels layer with hit (see class xAOD::AFPPixelLayerID )

pixelRowIDChip()

int xAOD::AFPSiHit_v2::pixelRowIDChip

(

)

const

Index of the pixel row in chip coordinate system.

Index of the row in chip coordinate system. There are 336 rows numbered from 1. Row number 1 is closest to the LHC centre, while row 336 is the outermost.

Note

Rows in chip coordinate system are vertical, because the chips are mounted rotated by 90 degrees.

Returns

index of the pixel row which is in vertical direction

pixelVertID()

int xAOD::AFPSiHit_v2::pixelVertID

(

)

const

Index of the pixel along Y axis in LHC coordinate system.

There are 80 pixels in the vertical direction numbered from 0. The numbering is according to the LHC coordinate system i.e. pixel 0 is the lowest and pixel 79 is the topmost.

This method transforms index from the chip coordinate system to the LHC coordinate system.

Returns

index of the pixel along Y axis in LHC coordinate system

Definition at line 52 of file AFPSiHit_v2.cxx.

  {
    // use pixel columns because detectors are rotated
    return pixelColIDChip();
  }

releasePrivateStore()

void SG::AuxElement::releasePrivateStore ( )

inherited

Release and free any private store associated with this object.

ExcBadPrivateStore will be thrown if this object does not have a private store.

Definition at line 190 of file AuxElement.cxx.

{
  if (hadPrivateData()) {
    // We had a private store, but it was released because this object
    // was added to a container.  Just forget about it.
    IAuxElement::setNoPrivateData();
    return;
  }
 
  if (!havePrivateData() ||
      !m_container ||
      typeid(*m_container) != typeid(AuxElementPrivateData))
  {
    throw SG::ExcBadPrivateStore ("no private store exists");
  }
 
  IAuxElement::setIndex (0);
  IAuxElement::setNoPrivateData();
  delete m_container;
  m_container = 0;
}

releasePrivateStoreForDtor()

void SG::AuxElement::releasePrivateStoreForDtor ( )

privateinherited

Out-of-line portion of destructor.

Delete a private store if we have one.

Definition at line 398 of file AuxElement.cxx.

{
#ifdef ATHCONTAINERS_R21_COMPAT
  if (havePrivateData()) {
    delete m_container;
  }
#else
  ConstAuxElement::releasePrivateStoreForDtor();
#endif
}

setConstStore()

void SG::AuxElement::setConstStore ( const SG::IConstAuxStore *  store )

inherited

Synonym for setStore with IConstAuxStore.

Parameters

store

The new store.

setDepositedCharge()

void xAOD::AFPSiHit_v2::setDepositedCharge

(

float

charge

)

Method setting value of the charge deposited in the pixel.

Parameters

charge

value of the charge deposited in the pixel

setHadPrivateData()

void SG::IAuxElement::setHadPrivateData ( )

privateinherited

Record that this element used to have private data.

setHavePrivateData()

void SG::IAuxElement::setHavePrivateData ( )

privateinherited

Record that this element currently has private data.

setIndex()

void SG::AuxElement::setIndex ( size_t  index, SG::AuxVectorData *  container  )

privateinherited

Set the index/container for this element.

Parameters

index	The index of this object within the container.
container	The container holding this object. May be null if this object is being removed from a container.

Usually this simply sets the index and container members of this object. However, in the case where this object has an associated private store, then we need to deal with releasing the store if the object is being added to a container, or making a new store if the object is being removed from a container.

setIndexPrivate()

bool SG::AuxElement::setIndexPrivate ( size_t  index, SG::AuxVectorData *  container  )

privateinherited

Set the index/container for this element.

Parameters

index	The index of this object within the container.
container	The container holding this object. May be null if this object is being removed from a container.

This is called from setIndex when we have a private store to deal with.

Definition at line 462 of file AuxElement.cxx.

{
#ifdef ATHCONTAINERS_R21_COMPAT
  if (hadPrivateData()) {
    // We had a private store, but it was released because we were added
    // to a container.
 
    if (container == 0) {
      // We're being moved out of the container.  Make a new private
      // store, copy the data, and switch to it.
      auto privateData = new SG::AuxElementPrivateData;
      AuxElement to (privateData, 0);
      to.copyAux (*this);
      IAuxElement::setIndex (0);
      IAuxElement::setHavePrivateData();
      m_container = privateData;
      return true;
    }
  }
  else if (havePrivateData() &&
           typeid(*m_container) == typeid(AuxElementPrivateData))
  {
    // We currently have a private store.
 
    if (container != 0 && container != m_container) {
      // We're being added to a container.
      // Aux data has already been copied.
      // Release private store.
      IAuxElement::setIndex (index);
      IAuxElement::setHadPrivateData();
      delete m_container;
      m_container = container;
      return false;
    }
  }
  else {
    // We have a standalone store.
    throw SG::ExcBadPrivateStore ("Attempt to add/remove a standalone object "
                                  "from a container.");
  }
 
  IAuxElement::setIndex (index);
  m_container = container;
  return false;
#else
  return ConstAuxElement::setIndexPrivate (index, container);
#endif
}

setNonConstStore()

void SG::AuxElement::setNonConstStore ( SG::IAuxStore *  store )

inherited

Synonym for setStore with IAuxStore.

Parameters

store

The new store.

setNoPrivateData()

void SG::IAuxElement::setNoPrivateData ( )

privateinherited

Record that this element does not have private data.

setPixelColIDChip()

void xAOD::AFPSiHit_v2::setPixelColIDChip

(

int

colID

)

Set pixel column index in the chip coordinate system.

Index of the column in chip coordinate system can have value between 1 and 80. Column number 1 is the bottom one, while column 80 is the topmost one.

Note

Columns in chip coordinate system are horizontal, because the chips are mounted rotated by 90 degrees.

Parameters

colID

index of pixel column in chip coordinate system to be assigned to the hit

setPixelHorizID()

void xAOD::AFPSiHit_v2::setPixelHorizID

(

const int

horizontalID

)

Set index of the pixel along X axis in LHC coordinate system.

There are 336 pixels in the horizontal direction numbered from 0. The numbering is according to the LHC coordinate system i.e. pixel 0 is the outermost pixel and pixel 335 is the inner most (closest to the LHC centre).

This method transforms input from the LHC coordinate system to the chip coordinate system and saves it.

Parameters

horizontalID

index of pixel along X axis in the LHC coordinate system

Definition at line 44 of file AFPSiHit_v2.cxx.

  {
    // use pixel rows because detectors are rotated and subtract
    // from 336, because the axis is reversed
    setPixelRowIDChip (336 - horizontalID);
  }

setPixelLayerID()

void xAOD::AFPSiHit_v2::setPixelLayerID

(

int

layerID

)

Method setting index of the pixel layer with hit.

The index of the layer should be set according to the convention in pixelLayerID()

Parameters

layerID

index of the pixel layer with hit

setPixelRowIDChip()

void xAOD::AFPSiHit_v2::setPixelRowIDChip

(

int

rowID

)

Set pixel row index in the chip coordinate system.

Index of the row in chip coordinate system can have value between 1 and 336. Row number 1 is closest to the LHC centre, while row 336 is the outermost.

Note

Rows in chip coordinate system are vertical, because the chips are mounted rotated by 90 degrees.

Parameters

rowID

index of pixel row in chip coordinate system to be assigned to the hit

setPixelVertID()

void xAOD::AFPSiHit_v2::setPixelVertID

(

const int

verticalID

)

Set index of the pixel along Y axis in LHC coordinate system.

There are 80 pixels in the horizontal direction numbered from 0. The numbering is according to the LHC coordinate system i.e. pixel 0 is the lowest and pixel 79 is the topmost.

This method transforms input from the LHC coordinate system to the chip coordinate system and saves it.

Parameters

verticalID

index of pixel along Y axis in the LHC coordinate system

Definition at line 58 of file AFPSiHit_v2.cxx.

  {
    // use pixel columns because detectors are rotated
    setPixelColIDChip (verticalID);
  }

setStationID()

void xAOD::AFPSiHit_v2::setStationID

(

int

stationID

)

Set index of the station with pixel hit.

It is advised to use class xAOD::AFPStationID instead of integers to process this information. In this class the numbering scheme is explained.

Returns

index of the station (see class xAOD::AFPStationID )

Parameters

stationID

index of the station with the hit

setStore() [1/3]

void SG::AuxElement::setStore ( const DataLink< SG::IConstAuxStore > &  store )

inherited

Set the store associated with this object.

Parameters

store

The new store.

If store is nonzero, this adds a standalone store to the object. The object must not be in a container and must not have a private store. If store is zero, this removes a standalone store.

Parameters

store

Link to the new store.

Definition at line 249 of file AuxElement.cxx.

{
  AuxElementStandaloneData* data = setStore1 (store);
  if (store)
    data->setStore (store);
}

setStore() [2/3]

void SG::AuxElement::setStore ( const SG::IConstAuxStore *  store )

inherited

Set the store associated with this object.

Parameters

store

The new store.

If store is nonzero, this adds a standalone store to the object. The object must not be in a container and must not have a private store. If store is zero, this removes a standalone store.

Definition at line 221 of file AuxElement.cxx.

{
  AuxElementStandaloneData* data = setStore1 (store);
  if (store)
    data->setStore (store);
}

setStore() [3/3]

void SG::AuxElement::setStore ( SG::IAuxStore *  store )

inherited

Set the store associated with this object.

Parameters

store

The new store.

If store is nonzero, this adds a standalone store to the object. The object must not be in a container and must not have a private store. If store is zero, this removes a standalone store.

Definition at line 237 of file AuxElement.cxx.

{
  AuxElementStandaloneData* data = setStore1 (store);
  if (store)
    data->setStore (store);
}

setStore1()

AuxElementStandaloneData * SG::AuxElement::setStore1 ( const SG::IConstAuxStore *  store )

privateinherited

Set the store associated with this object.

Parameters

store

The new store.

Helper for setStore. Creates the AuxElementStandaloneData object if needed and returns it.

Parameters

store

The new store.

Helper for setStore. Creates the @x AuxElementStandaloneData object if needed and returns it.

Definition at line 418 of file AuxElement.cxx.

{
  if (store) {
    // Want this object be standalone.
    if (!m_container) {
      // Not in a container (and no private store).  Make a new object.
      AuxElementStandaloneData* data = new AuxElementStandaloneData;
      IAuxElement::setHavePrivateData();
      m_container = data;
      return data;
    }
    if (usingStandaloneStore()) {
      // Standalone --- return existing object.
      return static_cast<AuxElementStandaloneData*> (container());
    }
    // Otherwise, it's an error.
    throw ExcBadPrivateStore ("Attempt to attach a standalone store to an "
                              "object in a container or with a private store.");
  }
 
  else {
    // Getting rid of a standalone store.
    if (usingStandaloneStore()) {
      IAuxElement::setNoPrivateData();
      delete m_container;
      m_container = 0;
    }
    else if (m_container != 0)
      throw ExcBadPrivateStore ("Attempt to remove a standalone store from an "
                                "object in a container or with a private store.");
    return 0;
  }
}

setTimeOverThreshold()

void xAOD::AFPSiHit_v2::setTimeOverThreshold

(

float

timeOverThreshold

)

Method setting value of time over threshold.

Parameters

timeOverThreshold

value of the time over threshold for a pixel

stationID()

int xAOD::AFPSiHit_v2::stationID

(

)

const

Index of the station with pixel hit.

It is advised to use class xAOD::AFPStationID instead of integers to process this information. In this class the numbering scheme is explained.

Returns

index of the station (see class xAOD::AFPStationID )

timeOverThreshold()

float xAOD::AFPSiHit_v2::timeOverThreshold

(

)

const

Time over threshold of signal for a pixel.

The length of the signal is proportional to the charge deposited in the pixel. The transformation is configured during the detector running and requires calibration. This is basic quantity which is used to reconstruct charge deposited in the pixel.

Returns

time over threshold of the signal

toPersistent()

void xAOD::AFPSiHit_v2::toPersistent

(

)

Function making sure that the object is ready for persistification i.e. saving.

Definition at line 34 of file AFPSiHit_v2.cxx.

                                 {
  }

trackIndices()

bool SG::AuxElement::trackIndices ( ) const

inherited

Return true if index tracking is enabled for this object.

Always returns true. Included here to be consistent with AuxVectorBase when standalone objects may be used as template parameters.

usingPrivateStore()

bool SG::AuxElement::usingPrivateStore ( ) const

inherited

Test to see if this object is currently using a private store.

Definition at line 260 of file AuxElement.cxx.

{
  return havePrivateData() && 
    typeid(*m_container) == typeid(AuxElementPrivateData);
}

usingStandaloneStore()

bool SG::AuxElement::usingStandaloneStore ( ) const

inherited

Test to see if this object is currently using a standalone store.

Test to see if this object is currently using a private store.

Definition at line 270 of file AuxElement.cxx.

{
  return havePrivateData() &&
    typeid(*m_container) == typeid(AuxElementStandaloneData);
}

Member Data Documentation

m_container

const SG::AuxVectorData* SG::ConstAuxElement::m_container

privateinherited

The container of which this object is an element.

Should be null if this object is not within a container, except that it may also point at a private store.

Definition at line 324 of file AuxElement.h.

m_index

size_t SG::IAuxElement::m_index

privateinherited

The index of this element within its container.

Should be 0 if this object is not within a container.

Definition at line 128 of file IAuxElement.h.

m_privateStoreState

PrivateStoreState SG::IAuxElement::m_privateStoreState

privateinherited

Definition at line 137 of file IAuxElement.h.

supportsThinning

constexpr bool SG::AuxElement::supportsThinning = true

staticconstexprinherited

Mark that this type supports thinning operations.

See AthContainers/supportsThinning.h and AthenaPoolCnvSvc/T_AthenaPoolCnv.h. Helps guide which pool converter template will be used. If false, the default pool converter will be used rather than the aux store-specific one. Ordinary xAOD type should not touch this, but may be overridden in a derived class to handle certain special cases.

Definition at line 920 of file AuxElement.h.

---

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

• AFPSiHit_v2.h
• AFPSiHit_v2.cxx