Block filler tool for EM samplings from a CaloCluster. More...

#include <CaloCellDetailsFillerTool.h>

Inheritance diagram for D3PD::CaloCellDetailsFillerTool:

Collaboration diagram for D3PD::CaloCellDetailsFillerTool:

Public Member Functions
	CaloCellDetailsFillerTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Gaudi tool constructor. More...

virtual StatusCode	initialize () override

virtual StatusCode	book () override
	Book variables for this block. More...

virtual StatusCode	fill (const CaloCell &p) override
	Fill one block — type-safe version. More...

virtual StatusCode	configureD3PD (IAddVariable *tree, const std::type_info &ti)
	Configure during initialization: type-check. More...

StatusCode	configureD3PD (IAddVariable *tree)
	Configure the parent tree. More...

virtual StatusCode	fillUntyped (const void *p, bool again=false)
	Fill one block. More...

virtual StatusCode	fillAgain (const CaloCell &p)
	Fill one block, after `AGAIN` has been returned (type-safe). More...

virtual StatusCode	addVariable (const std::string &name, const std::type_info &ti, void &ptr, const std::string &docstring="", const void defval=0)
	Add a variable to the tuple. More...

template<class T >
StatusCode	addVariable (const std::string &name, T *&ptr, const std::string &docstring="")
	Make the template implementation from `IAddVariable` visible. More...

template<class T , class U >
StatusCode	addVariable (const std::string &name, T *&ptr, const std::string &docstring, const U &defval)
	Make the template implementation from `IAddVariable` visible. More...

virtual StatusCode	addVariable (const std::string &name, const std::type_info &ti, void &ptr, const std::string &docstring="", const void defval=0)=0
	Make the template implementation from `IAddVariable` visible. More...

template<class T >
StatusCode	addVariable (const std::string &name, T *&ptr, const std::string &docstring="")
	Add a variable to the tuple. More...

template<class T , class U >
StatusCode	addVariable (const std::string &name, T *&ptr, const std::string &docstring, const U &defval)
	Add a variable to the tuple. More...

virtual StatusCode	addDimensionedVariable (const std::string &name, const std::type_info &ti, void &ptr, const std::string &dim, const std::string &docstring="", const void defval=0)
	Add a variable to the tuple. More...

template<class T >
StatusCode	addDimensionedVariable (const std::string &name, T *&ptr, const std::string &dim, const std::string &docstring="")
	Add a variable to the tuple. More...

template<class T , class U >
StatusCode	addDimensionedVariable (const std::string &name, T *&ptr, const std::string &dim, const std::string &docstring, const U &defval)
	Add a variable to the tuple. More...

virtual StatusCode	addDimensionedVariable (const std::string &name, const std::type_info &ti, void &ptr, const std::string &dim, const std::string &docstring="", const void defval=0)=0
	Add a variable to the tuple. More...

template<class T >
StatusCode	addDimensionedVariable (const std::string &name, T *&ptr, const std::string &dim, const std::string &docstring="")
	Add a variable to the tuple. More...

template<class T , class U >
StatusCode	addDimensionedVariable (const std::string &name, T *&ptr, const std::string &dim, const std::string &docstring, const U &defval)
	Add a variable to the tuple. More...

Protected Member Functions
StatusCode	configureImpl (IAddVariable *tree, const std::type_info &ti, const std::type_info &fill_ti)
	Configure during initialization: type-check. More...

StatusCode	configureImpl (IAddVariable tree, const std::type_info &ti, const std::vector< const std::type_info > &tis, size_t &which)
	Configure during initialization: type-check. More...

StatusCode	convert (void const *&p) const
	Do type conversion. More...

Protected Attributes
ObjectMetadata	m_metadata
	Metadata about the variables created by this object. More...

Private Member Functions
unsigned int	CaloCell_GetDetectorInfo (const CaloCell &cell) const

Private Attributes
bool	m_saveCellGain

bool	m_saveCellQuality

bool	m_saveDetInfo

bool	m_saveTimeInfo

bool	m_saveCellStatus

bool	m_saveId

bool	m_savePosition

bool	m_saveSigma

ToolHandle< ICaloBadChanTool >	m_pb_tool { this, "BadChannelTool", "CaloBadChanTool", "" }

SG::ReadCondHandleKey< CaloNoise >	m_caloNoiseKey
	Key of the CaloNoise Conditions data object. More...

float *	m_xCells

float *	m_yCells

float *	m_zCells

int *	m_detCells

float *	m_timeCells

int *	m_badCell

int *	m_fitQCells

int *	m_gainCells

unsigned int *	m_offId

float *	m_sigma

bool	m_useNoise

std::string	m_prefix
	Property: the variable prefix for this block. More...

std::string	m_suffix
	Property: the variable prefix for this block. More...

std::string	m_blockName
	Property: the name of this block. More...

TypeConverter	m_converter
	Helper to do type conversions. More...

IAddVariable *	m_tree
	Reference to the block name. More...

Static Private Attributes
static const std::string	s_emptyString
	Used to provide a default value for blockName. More...

Detailed Description

Block filler tool for EM samplings from a CaloCluster.

Definition at line 32 of file CaloCellDetailsFillerTool.h.

Constructor & Destructor Documentation

◆ CaloCellDetailsFillerTool()

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

Standard Gaudi tool constructor.

Parameters

type	The name of the tool type.
name	The tool name.
parent	The tool's Gaudi parent.

Definition at line 37 of file CaloCellDetailsFillerTool.cxx.

       : BlockFillerTool<CaloCell> (type, name, parent),
         m_saveCellGain(false), m_saveCellQuality(false), 
     m_saveDetInfo(false),m_saveTimeInfo(false),m_saveCellStatus(false),
     m_saveId(false),m_savePosition(false), m_saveSigma(false),
     m_useNoise(false)
 {
  
   declareProperty("SaveCellGain",m_saveCellGain);
   declareProperty("SaveCellQuality",m_saveCellQuality);
   declareProperty("SaveDetInfo",m_saveDetInfo);
   declareProperty("SaveTimeInfo",m_saveTimeInfo);
   declareProperty("SaveBadCellStatus",m_saveCellStatus); 
   declareProperty("SaveId",m_saveId);
   declareProperty("SavePositionInfo",m_savePosition);
   declareProperty("SaveSigma",m_saveSigma);
  
   m_fitQCells = 0;
   m_gainCells = 0;
   m_xCells = 0;
   m_yCells = 0;
   m_zCells = 0;
   m_detCells = 0;
   m_timeCells = 0;
   m_badCell = 0;
   m_offId = 0;
   m_sigma = 0;
 }

Member Function Documentation

◆ addDimensionedVariable() [1/6]

StatusCode D3PD::AddVariable::addDimensionedVariable	(	const std::string &	name,
		const std::type_info &	ti,
		void *&	ptr,
		const std::string &	dim,
		const std::string &	docstring = `""`,
		const void *	defval = `0`
	)

virtualinherited

Add a variable to the tuple.

Parameters

name	The name of the variable.
type	The type of the variable.
ptr	Pointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling `fill()`.
dim	Dimension for the variable. (Presently unimplemented!)
docstring	Documentation string for this variable.
defval	Pointer to the default value to use for this variable. Null for no default (generally means to fill with zeros). Of the type given by `ti`. Only works for basic types.

If called from the constructor, the only effect is to clear ptr.

Implements D3PD::IAddVariable.

Definition at line 123 of file AddVariable.cxx.

 {
   if (!m_tree) {
     // Called from constructor --- just initialize pointer.
     ptr = 0;
     return StatusCode::SUCCESS;
   }
  
   CHECK( m_metadata.addDimensionedVariable( m_prefix + name + m_suffix,
                                             ti, ptr, dim,
                                             docstring, defval ) );
   return m_tree->addDimensionedVariable (m_prefix + name + m_suffix,
                                          ti, ptr, dim,
                                          docstring, defval);
 }

◆ addDimensionedVariable() [2/6]

virtual StatusCode D3PD::IAddVariable::addDimensionedVariable

inherited

Add a variable to the tuple.

Parameters

name	The name of the variable.
type	The type of the variable.
ptr	Pointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling `fill()`.
dim	Dimension for the variable. (Presently unimplemented!)
docstring	Documentation string for this variable.
defval	Pointer to the default value to use for this variable. Null for no default (generally means to fill with zeros). Of the type given by `ti`. Only works for basic types.

If called from the constructor, the only effect is to clear ptr.

◆ addDimensionedVariable() [3/6]

template<class T , class U >

StatusCode D3PD::IAddVariable::addDimensionedVariable	(	class T	,
		class U
	)

inherited

Add a variable to the tuple.

Parameters

name	The name of the variable.
ptr	Pointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling `fill()`.
dim	Dimension for the variable. (Presently unimplemented!)
docstring	Documentation string for this variable.
defval	Pointer to the default value to use for this variable. Only works for basic types.

If called from the constructor, the only effect is to clear ptr.

◆ addDimensionedVariable() [4/6]

template<class T , class U >

StatusCode D3PD::IAddVariable::addDimensionedVariable	(	const std::string &	name,
		T *&	ptr,
		const std::string &	dim,
		const std::string &	docstring,
		const U &	defval
	)

inherited

Add a variable to the tuple.

Parameters

name	The name of the variable.
ptr	Pointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling `fill()`.
dim	Dimension for the variable. (Presently unimplemented!)
docstring	Documentation string for this variable.
defval	Pointer to the default value to use for this variable. Only works for basic types.

If called from the constructor, the only effect is to clear ptr.

◆ addDimensionedVariable() [5/6]

template<class T >

StatusCode D3PD::IAddVariable::addDimensionedVariable ( class T )

inherited

Add a variable to the tuple.

Parameters

name	The name of the variable.
ptr	Pointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling `fill()`.
dim	Dimension for the variable. (Presently unimplemented!)
docstring	Documentation string for this variable.

If called from the constructor, the only effect is to clear ptr.

◆ addDimensionedVariable() [6/6]

template<class T >

StatusCode D3PD::IAddVariable::addDimensionedVariable	(	const std::string &	name,
		T *&	ptr,
		const std::string &	dim,
		const std::string &	docstring = `""`
	)

inherited

Add a variable to the tuple.

Parameters

name	The name of the variable.
ptr	Pointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling `fill()`.
dim	Dimension for the variable. (Presently unimplemented!)
docstring	Documentation string for this variable.

If called from the constructor, the only effect is to clear ptr.

◆ addVariable() [1/6]

StatusCode D3PD::AddVariable::addVariable	(	const std::string &	name,
		const std::type_info &	ti,
		void *&	ptr,
		const std::string &	docstring = `""`,
		const void *	defval = `0`
	)

virtualinherited

Add a variable to the tuple.

Parameters

name	The name of the variable.
type	The type of the variable.
ptr	Pointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling `fill()`.
docstring	Documentation string for this variable.
defval	Pointer to the default value to use for this variable. Null for no default (generally means to fill with zeros). Of the type given by `ti`. Only works for basic types.

If called from the constructor, the only effect is to clear ptr.

Implements D3PD::IAddVariable.

Definition at line 85 of file AddVariable.cxx.

 {
   if (!m_tree) {
     // Called from constructor --- just initialize pointer.
     ptr = 0;
     return StatusCode::SUCCESS;
   }
  
   CHECK( m_metadata.addVariable( m_prefix + name + m_suffix,
                                  ti, ptr, docstring, defval ) );
   return m_tree->addVariable (m_prefix + name + m_suffix,
                               ti, ptr, docstring, defval);
 }

◆ addVariable() [2/6]

virtual StatusCode D3PD::IAddVariable::addVariable

inherited

Make the template implementation from IAddVariable visible.

◆ addVariable() [3/6]

template<class T , class U >

StatusCode D3PD::IAddVariable::addVariable	(	class T	,
		class U
	)

inherited

Make the template implementation from IAddVariable visible.

◆ addVariable() [4/6]

template<class T , class U >

StatusCode D3PD::IAddVariable::addVariable	(	const std::string &	name,
		T *&	ptr,
		const std::string &	docstring,
		const U &	defval
	)

inherited

Add a variable to the tuple.

Parameters

name	The name of the variable.
ptr	Pointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling `fill()`.
docstring	Documentation string for this variable.
defval	Pointer to the default value to use for this variable. Only works for basic types.

If called from the constructor, the only effect is to clear ptr.

◆ addVariable() [5/6]

template<class T >

StatusCode D3PD::IAddVariable::addVariable ( class T )

inherited

Make the template implementation from IAddVariable visible.

◆ addVariable() [6/6]

template<class T >

StatusCode D3PD::IAddVariable::addVariable	(	const std::string &	name,
		T *&	ptr,
		const std::string &	docstring = `""`
	)

inherited

Add a variable to the tuple.

Parameters

name	The name of the variable.
ptr	Pointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling `fill()`.
docstring	Documentation string for this variable.

If called from the constructor, the only effect is to clear ptr.

◆ book()

StatusCode D3PD::CaloCellDetailsFillerTool::book ( )

overridevirtual

Book variables for this block.

Implements D3PD::BlockFillerTool< CaloCell >.

Definition at line 93 of file CaloCellDetailsFillerTool.cxx.

 {
    if (m_saveCellQuality) CHECK( addVariable  ("QCells",m_fitQCells) ) ;
    if (m_saveCellGain)    CHECK( addVariable  ("GainCells",m_gainCells) );
  
  
    if  (m_savePosition) {
      CHECK( addVariable  ("xCells", m_xCells) );
      CHECK( addVariable  ("yCells", m_yCells) );
      CHECK( addVariable  ("zCells", m_zCells) );
    }
  
    if (m_saveDetInfo) CHECK( addVariable  ("DetCells",m_detCells));
    if (m_saveTimeInfo) CHECK( addVariable  ("TimeCells",m_timeCells));
    if (m_saveCellStatus) CHECK( addVariable  ("BadCells",m_badCell)); 
    if (m_saveId) CHECK( addVariable ("IdCells",m_offId) );       
  
    if (m_saveSigma) CHECK( addVariable ("Sigma", m_sigma) );
    
  
   return StatusCode::SUCCESS;
     
 }

◆ CaloCell_GetDetectorInfo()

unsigned D3PD::CaloCellDetailsFillerTool::CaloCell_GetDetectorInfo ( const CaloCell & cell ) const

private

Definition at line 161 of file CaloCellDetailsFillerTool.cxx.

 {
   const CaloDetDescriptor& desc = *cell.caloDDE()->descriptor();
   const CaloCell_Base_ID& calo_id = *desc.get_calo_helper();
   Identifier cellID = cell.ID();
  
   // AtlasID bit (4)
   // 1 : lar_em
   // 2 : lar_hec
   // 3 : lar_fcal
   // 4 : tile
   unsigned ATbit1 = desc.is_lar_em()   ? (1<<0) : 0;
   unsigned ATbit2 = desc.is_lar_hec()  ? (1<<1) : 0;
   unsigned ATbit3 = desc.is_lar_fcal() ? (1<<2) : 0;
   unsigned ATbit4 = desc.is_tile()     ? (1<<3) : 0;
   unsigned ATbit  = (ATbit1 | ATbit2 | ATbit3 | ATbit4);
  
   //std::cout << "ATLAS Calo(EM,HEC,FCal,Tile) : " << ATbit1 << " " << ATbit2 << " " << ATbit3 << " " << ATbit4 << std::endl;
   
   // EM bit (5)
   // 1-2 : sampling
   //       0,1,2,3
   //       0 presampler
   //       1,2,3 each layer
   // 3   : barrel
   // 4   : endcap_inner
   // 5   : endcap_outer
   unsigned EMbit1 = 0;
   unsigned EMbit3 = 0;
   unsigned EMbit4 = 0;
   unsigned EMbit5 = 0;
   if (ATbit1) {
     const LArEM_Base_ID& emid = *calo_id.em_idHelper();
     EMbit1 = unsigned(emid.sampling(cellID));
     EMbit3 = emid.is_em_barrel(cellID)       ? (1<<2) : 0;
     EMbit4 = emid.is_em_endcap_inner(cellID) ? (1<<3) : 0;
     EMbit5 = emid.is_em_endcap_outer(cellID) ? (1<<4) : 0;
   }
   unsigned EMbit  = (EMbit1 | EMbit3 | EMbit4 | EMbit5);
  
   //std::cout << "EM : " << EMbit1 << " " << EMbit3 << " " << EMbit4 << " " << EMbit5 << std::endl;
  
   // HEC (2)
   // 1-2: sampling
   //      0,1 = first wheel
   //      2,3 = second wheel
   unsigned HCbit1 = 0;
   if (ATbit2) {
     const LArHEC_Base_ID& hecid = *calo_id.hec_idHelper();
     HCbit1 = unsigned(hecid.sampling(cellID));
   }
   unsigned HCbit = HCbit1;
  
   //std::cout << "HEC :  " << HCbit1 << std::endl;
  
   // FCal (2)
   // 1-2 : module
   //       1,2,3
   //       1 EM
   //       2,3 Hadronic
   //
   unsigned FCbit1 = 0;
   if (ATbit3) {
     const LArFCAL_Base_ID& fcalid = *calo_id.fcal_idHelper();
     FCbit1 = unsigned(fcalid.module(cellID));
   }
   unsigned FCbit = FCbit1;
  
   //std::cout << "FCal : " << FCbit1 << std::endl;
  
   // Tile bit (8)
   // 1-3 : sample
   //       0 = SAMP_A
   //       1 = SAMP_B, SAMP_BC, SAMP_C
   //       2 = SAMP_D
   //       3 = SAMP_E
   //       4 = SAMP_X
   // 4   : barrel
   // 5   : extbarrel
   // 6   : gap
   // 7   : gapscin
   unsigned TLbit1 = 0;
   unsigned TLbit4 = 0;
   unsigned TLbit5 = 0;
   unsigned TLbit6 = 0;
   unsigned TLbit7 = 0;
   if (ATbit4) {
     const Tile_Base_ID& tileid = *calo_id.tile_idHelper();
     TLbit1 = unsigned(tileid.sample(cellID));
     TLbit4 = tileid.is_tile_barrel(cellID)    ? (1<<3) : 0;
     TLbit5 = tileid.is_tile_extbarrel(cellID) ? (1<<4) : 0;
     TLbit6 = tileid.is_tile_gap(cellID)       ? (1<<5) : 0;
     TLbit7 = tileid.is_tile_gapscin(cellID)   ? (1<<6) : 0;
   }
   unsigned TLbit  = (TLbit1 | TLbit4 | TLbit5 | TLbit6 | TLbit7);
  
   //std::cout << "Tile : " << TLbit1 << " " << TLbit4 << " " << TLbit5 << " " << TLbit6 << " " << TLbit7 << std::endl;
   
   unsigned CombBit = (ATbit | (EMbit<<4) | (HCbit<<9) | 
               (FCbit<<11) | (TLbit<<13));
  
   return CombBit;
 }

◆ configureD3PD() [1/2]

StatusCode D3PD::AddVariable::configureD3PD ( IAddVariable * tree )

inherited

Configure the parent tree.

Parameters

tree	The parent `IAddVariable` instance.

Definition at line 61 of file AddVariable.cxx.

 {
   m_tree = tree;
   m_metadata.clear();
   return StatusCode::SUCCESS;
 }

◆ configureD3PD() [2/2]

virtual StatusCode D3PD::BlockFillerTool< CaloCell >::configureD3PD	(	IAddVariable *	tree,
		const std::type_info &	ti
	)

virtualinherited

Configure during initialization: type-check.

Parameters

tree	Our parent for tuple making.
ti	Gives the type of the object being passed to `fillUntyped`.

configureD3PD should check that the type of the object coming as input is compatible with what it expects, and raise an error otherwise.

◆ configureImpl() [1/2]

StatusCode D3PD::BlockFillerToolImpl::configureImpl	(	IAddVariable *	tree,
		const std::type_info &	ti,
		const std::type_info &	fill_ti
	)

protectedinherited

Configure during initialization: type-check.

Parameters

tree	Our parent for tuple making.
ti	Gives the type of the object being passed to `fillUntyped`.
fill_ti	is the type of object that the user code will expect.

This is the common implementation for the configureD3PD method of IBlockFillerTool. It checks that the type of the object coming as input is compatible with what the user code is expecting, and raises an error otherwise.

Definition at line 55 of file BlockFillerToolImpl.cxx.

 {
   CHECK( AddVariable::configureD3PD (tree) );
   CHECK( m_converter.init (ti, fill_ti) );
  
   return StatusCode::SUCCESS;
 }

◆ configureImpl() [2/2]

StatusCode D3PD::BlockFillerToolImpl::configureImpl	(	IAddVariable *	tree,
		const std::type_info &	ti,
		const std::vector< const std::type_info * > &	tis,
		size_t &	which
	)

protectedinherited

Configure during initialization: type-check.

Parameters

	tree	Our parent for tuple making.
	ti	Gives the type of the object being passed to `fillUntyped`.
	tis	List of possible input types that we can accept.
[out]	which	Index of the accepted type.

This is the common implementation for the configureD3PD method of IBlockFillerTool. It checks that the type of the object coming as input is compatible with what the user code is expecting, and raises an error otherwise.

This version allows for one of a set of types to match. If successful, WHICH is set to the index (0-based) of the matching type.

Definition at line 83 of file BlockFillerToolImpl.cxx.

 {
   CHECK( AddVariable::configureD3PD (tree) );
   CHECK( m_converter.init (ti, tis, which) );
   return StatusCode::SUCCESS;
 }

◆ convert()

StatusCode D3PD::BlockFillerToolImpl::convert ( void const *& p ) const

protectedinherited

Do type conversion.

Parameters

p[in,out] Pointer to convert.

On entry, p is a pointer to an object of the type that was passed into configureImpl as ti. Convert the pointer to point to an object of the type that was given as fill_ti. If the conversion fails, the pointer is set to 0 (and FAILURE is returned).

Definition at line 105 of file BlockFillerToolImpl.cxx.

 {
   p = m_converter.convertUntyped (p);
   if (!p) {
     REPORT_MESSAGE (MSG::ERROR)
       << "Pointer conversion from " << m_converter.srcName() << " to "
       << m_converter.dstName() << "failed.";
     return StatusCode::FAILURE;
   }
   return StatusCode::SUCCESS;
 }

◆ fill()

StatusCode D3PD::CaloCellDetailsFillerTool::fill ( const CaloCell & p )

overridevirtual

Fill one block — type-safe version.

Parameters

p	The input object.

This is called once per object. The caller is responsible for arranging that all the pointers for booked variables are set appropriately upon entry.

Implements D3PD::BlockFillerTool< CaloCell >.

Definition at line 119 of file CaloCellDetailsFillerTool.cxx.

 {
   const CaloCell* cell = &c; 
  
  
   Identifier id  = cell->ID();        
  
   if (m_savePosition) {
     *m_xCells = cell->x() ;
     *m_yCells = cell->y() ;
     *m_zCells = cell->z() ;
     if (std::abs (*m_zCells) < 1e-8) *m_zCells = 0;
   }
  
 // pack into one work the quality and provenance information
  
   if (m_saveCellQuality) {
     int quality = ( (cell->quality()&0xFFFF) | ((cell->provenance()&0xFFFF) <<16));
     *m_fitQCells = quality;
   }
   if (m_saveCellGain)    *m_gainCells = cell->gain();
   if (m_saveTimeInfo) *m_timeCells =cell->time() ;
  
   if (m_saveDetInfo)
     *m_detCells = CaloCell_GetDetectorInfo(*cell);
  
  
   if (m_saveId)       *m_offId = id.get_identifier32().get_compact()     ;
   if (m_saveCellStatus)    *m_badCell = m_pb_tool->caloStatus(id).packedData() ;
  
   if (!m_caloNoiseKey.empty()) {
     SG::ReadCondHandle<CaloNoise> caloNoise{m_caloNoiseKey};
     *m_sigma = caloNoise-> getNoise(cell->ID(), cell->gain());
   }
  
   return StatusCode::SUCCESS ;
 }

◆ fillAgain()

virtual StatusCode D3PD::BlockFillerTool< CaloCell >::fillAgain ( const CaloCell & p )

virtualinherited

Fill one block, after AGAIN has been returned (type-safe).

Parameters

p	The input object.

Once fill returns AGAIN, the parent should call fillAgain with the same arguments. This continues until fillAgain returns something other than AGAIN.

By default, this just calls fill().

◆ fillUntyped()

virtual StatusCode D3PD::BlockFillerTool< CaloCell >::fillUntyped	(	const void *	p,
		bool	again = `false`
	)

virtualinherited

Fill one block.

Parameters

p	The input object.
again	Set if this is a subsequent call requested by an AGAIN return

This is called once per object. The type of the object at which p points is given by the ti argument to configureD3PD. The caller is responsible for arranging that all the pointers for booked variables are set appropriately upon entry.

If the return status is the special code AGAIN (defined above), then this filler tool wants to make multiple entries. The parent should set up to capture a new ‘row’ and run through the list of block filler tools again, but for this tool call fillAgainUntyped instead of fillUntyped. This should be repeated as long as fillAgainUntyped returns AGAIN.

Once fillUntyped returns AGAIN, the parent should call fillUntyped with the same p argument and again set to true. This continues until fillUntyped returns something other than AGAIN.

Not all parents may support this. In that case, returning AGAIN will be treated as an error.

◆ initialize()

StatusCode D3PD::CaloCellDetailsFillerTool::initialize ( )

overridevirtual

Definition at line 70 of file CaloCellDetailsFillerTool.cxx.

 {
   if (m_saveCellStatus) {
     CHECK( m_pb_tool.retrieve());
   }
  
  
   // retrieve the noise tool
   if(m_saveSigma) m_useNoise = true;
   if (m_useNoise) {
     CHECK( m_caloNoiseKey.initialize (SG::AllowEmpty) );
   }
   else {
     CHECK( m_caloNoiseKey.initialize (false) );
   }
  
   return StatusCode::SUCCESS;
 }

Member Data Documentation

◆ m_badCell

int* D3PD::CaloCellDetailsFillerTool::m_badCell

private

Definition at line 93 of file CaloCellDetailsFillerTool.h.

◆ m_blockName

std::string D3PD::BlockFillerToolImpl::m_blockName

privateinherited

Property: the name of this block.

Definition at line 118 of file BlockFillerToolImpl.h.

◆ m_caloNoiseKey

SG::ReadCondHandleKey<CaloNoise> D3PD::CaloCellDetailsFillerTool::m_caloNoiseKey

private

Initial value:

{this,

"CaloNoise", "", "Calo noise object name"}

Key of the CaloNoise Conditions data object.

Typical values are '"electronicNoise', 'pileupNoise', or '"totalNoise'

Definition at line 83 of file CaloCellDetailsFillerTool.h.

◆ m_converter

TypeConverter D3PD::BlockFillerToolImpl::m_converter

privateinherited

Helper to do type conversions.

Definition at line 121 of file BlockFillerToolImpl.h.

◆ m_detCells

int* D3PD::CaloCellDetailsFillerTool::m_detCells

private

Definition at line 91 of file CaloCellDetailsFillerTool.h.

◆ m_fitQCells

int* D3PD::CaloCellDetailsFillerTool::m_fitQCells

private

Definition at line 94 of file CaloCellDetailsFillerTool.h.

◆ m_gainCells

int* D3PD::CaloCellDetailsFillerTool::m_gainCells

private

Definition at line 95 of file CaloCellDetailsFillerTool.h.

◆ m_metadata

ObjectMetadata D3PD::AddVariable::m_metadata

protectedinherited

Metadata about the variables created by this object.

Definition at line 129 of file AddVariable.h.

◆ m_offId

unsigned int* D3PD::CaloCellDetailsFillerTool::m_offId

private

Definition at line 96 of file CaloCellDetailsFillerTool.h.

◆ m_pb_tool

ToolHandle<ICaloBadChanTool> D3PD::CaloCellDetailsFillerTool::m_pb_tool { this, "BadChannelTool", "CaloBadChanTool", "" }

private

Definition at line 76 of file CaloCellDetailsFillerTool.h.

◆ m_prefix

std::string D3PD::BlockFillerToolImpl::m_prefix

privateinherited

Property: the variable prefix for this block.

Definition at line 112 of file BlockFillerToolImpl.h.

◆ m_saveCellGain

bool D3PD::CaloCellDetailsFillerTool::m_saveCellGain

private

Definition at line 67 of file CaloCellDetailsFillerTool.h.

◆ m_saveCellQuality

bool D3PD::CaloCellDetailsFillerTool::m_saveCellQuality

private

Definition at line 68 of file CaloCellDetailsFillerTool.h.

◆ m_saveCellStatus

bool D3PD::CaloCellDetailsFillerTool::m_saveCellStatus

private

Definition at line 71 of file CaloCellDetailsFillerTool.h.

◆ m_saveDetInfo

bool D3PD::CaloCellDetailsFillerTool::m_saveDetInfo

private

Definition at line 69 of file CaloCellDetailsFillerTool.h.

◆ m_saveId

bool D3PD::CaloCellDetailsFillerTool::m_saveId

private

Definition at line 72 of file CaloCellDetailsFillerTool.h.

◆ m_savePosition

bool D3PD::CaloCellDetailsFillerTool::m_savePosition

private

Definition at line 73 of file CaloCellDetailsFillerTool.h.

◆ m_saveSigma

bool D3PD::CaloCellDetailsFillerTool::m_saveSigma

private

Definition at line 74 of file CaloCellDetailsFillerTool.h.

◆ m_saveTimeInfo

bool D3PD::CaloCellDetailsFillerTool::m_saveTimeInfo

private

Definition at line 70 of file CaloCellDetailsFillerTool.h.

◆ m_sigma

float* D3PD::CaloCellDetailsFillerTool::m_sigma

private

Definition at line 97 of file CaloCellDetailsFillerTool.h.

◆ m_suffix

std::string D3PD::BlockFillerToolImpl::m_suffix

privateinherited

Property: the variable prefix for this block.

Definition at line 115 of file BlockFillerToolImpl.h.

◆ m_timeCells

float* D3PD::CaloCellDetailsFillerTool::m_timeCells

private

Definition at line 92 of file CaloCellDetailsFillerTool.h.

◆ m_tree

IAddVariable* D3PD::AddVariable::m_tree

privateinherited

Reference to the block name.

The parent IAddVariable instance.

Definition at line 143 of file AddVariable.h.

◆ m_useNoise

bool D3PD::CaloCellDetailsFillerTool::m_useNoise

private

Definition at line 99 of file CaloCellDetailsFillerTool.h.

◆ m_xCells

float* D3PD::CaloCellDetailsFillerTool::m_xCells

private

Definition at line 88 of file CaloCellDetailsFillerTool.h.

◆ m_yCells

float* D3PD::CaloCellDetailsFillerTool::m_yCells

private

Definition at line 89 of file CaloCellDetailsFillerTool.h.

◆ m_zCells

float* D3PD::CaloCellDetailsFillerTool::m_zCells

private

Definition at line 90 of file CaloCellDetailsFillerTool.h.

◆ s_emptyString

const std::string D3PD::AddVariable::s_emptyString

staticprivateinherited

Used to provide a default value for blockName.

Definition at line 41 of file AddVariable.h.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CaloCellDetailsFillerTool()

Member Function Documentation

◆ addDimensionedVariable() [1/6]

◆ addDimensionedVariable() [2/6]

◆ addDimensionedVariable() [3/6]

◆ addDimensionedVariable() [4/6]

◆ addDimensionedVariable() [5/6]

◆ addDimensionedVariable() [6/6]

◆ addVariable() [1/6]

◆ addVariable() [2/6]

◆ addVariable() [3/6]

◆ addVariable() [4/6]

◆ addVariable() [5/6]

◆ addVariable() [6/6]

◆ book()

◆ CaloCell_GetDetectorInfo()

◆ configureD3PD() [1/2]

◆ configureD3PD() [2/2]

◆ configureImpl() [1/2]

◆ configureImpl() [2/2]

◆ convert()

◆ fill()

◆ fillAgain()

◆ fillUntyped()

◆ initialize()

Member Data Documentation

◆ m_badCell

◆ m_blockName

◆ m_caloNoiseKey

◆ m_converter

◆ m_detCells

◆ m_fitQCells

◆ m_gainCells

◆ m_metadata

◆ m_offId

◆ m_pb_tool

◆ m_prefix

◆ m_saveCellGain

◆ m_saveCellQuality

◆ m_saveCellStatus

◆ m_saveDetInfo

◆ m_saveId

◆ m_savePosition

◆ m_saveSigma

◆ m_saveTimeInfo

◆ m_sigma

◆ m_suffix

◆ m_timeCells

◆ m_tree

◆ m_useNoise

◆ m_xCells

◆ m_yCells

◆ m_zCells

◆ s_emptyString