ATLAS Offline Software
Loading...
Searching...
No Matches
D3PD::TileHitInfoFillerTool Class Reference

Block filler tool for total TileHit energy. More...

#include <TileHitInfoFillerTool.h>

Inheritance diagram for D3PD::TileHitInfoFillerTool:
Collaboration diagram for D3PD::TileHitInfoFillerTool:

Public Member Functions

 TileHitInfoFillerTool (const std::string &type, const std::string &name, const IInterface *parent)
 Standard Gaudi tool constructor.
virtual StatusCode book ()
 Book variables for this block.
virtual StatusCode fill (const TileHitVector &p)
 Fill one block — type-safe version.
 BlockFillerToolImpl (const std::string &type, const std::string &name, const IInterface *parent)
 Standard Gaudi tool constructor.
virtual StatusCode configureD3PD (IAddVariable *tree, const std::type_info &ti)
 Configure during initialization: type-check.
StatusCode configureD3PD (IAddVariable *tree)
 Configure the parent tree.
virtual StatusCode fillUntyped (const void *p, bool again=false)
 Fill one block.
virtual StatusCode fillAgain (const TileHitVector &p)
 Fill one block, after AGAIN has been returned (type-safe).
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.
StatusCode addVariable (const std::string &name, TileHitVector *&ptr, const std::string &docstring="")
 Make the template implementation from IAddVariable visible.
StatusCode addVariable (const std::string &name, TileHitVector *&ptr, const std::string &docstring, const U &defval)
 Make the template implementation from IAddVariable visible.
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.
StatusCode addDimensionedVariable (const std::string &name, TileHitVector *&ptr, const std::string &dim, const std::string &docstring="")
 Add a variable to the tuple.
StatusCode addDimensionedVariable (const std::string &name, TileHitVector *&ptr, const std::string &dim, const std::string &docstring, const U &defval)
 Add a variable to the tuple.

Protected Member Functions

StatusCode configureImpl (IAddVariable *tree, const std::type_info &ti, const std::type_info &fill_ti)
 Configure during initialization: type-check.
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.
StatusCode convert (void const *&p) const
 Do type conversion.

Protected Attributes

ObjectMetadata m_metadata
 Metadata about the variables created by this object.

Private Attributes

float * m_energy
float * m_eInTime
float * m_eBefore
float * m_eAfter
float * m_eOutTime
float * m_time
float * m_tInTime
float * m_tBefore
float * m_tAfter
float * m_tOutTime
int * m_nHit
int * m_nHitInTime
int * m_nHitBefore
int * m_nHitAfter
int * m_nHitOutTime
int * m_nChan
int * m_nChanInTime
int * m_nChanBefore
int * m_nChanAfter
int * m_nChanOutTime
float m_timeMin
float m_timeMax
float m_timeOut
std::string m_prefix
 Property: the variable prefix for this block.
std::string m_suffix
 Property: the variable prefix for this block.
std::string m_blockName
 Property: the name of this block.
TypeConverter m_converter
 Helper to do type conversions.
IAddVariablem_tree
 Reference to the block name.

Static Private Attributes

static const std::string s_emptyString
 Used to provide a default value for blockName.

Detailed Description

Block filler tool for total TileHit energy.

Definition at line 31 of file TileHitInfoFillerTool.h.

Constructor & Destructor Documentation

◆ TileHitInfoFillerTool()

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

Standard Gaudi tool constructor.

Parameters
typeThe name of the tool type.
nameThe tool name.
parentThe tool's Gaudi parent.

Definition at line 32 of file TileHitInfoFillerTool.cxx.

36 : BlockFillerTool<TileHitVector> (type, name, parent)
37{
38
39 declareProperty("TimeMin",m_timeMin = -12.5);
40 declareProperty("TimeMax",m_timeMax = 12.5);
41 declareProperty("TimeOut",m_timeOut = 99990.);
42
43 TileHitInfoFillerTool::book().ignore(); // Avoid coverity warnings
44}
virtual StatusCode book()
Book variables for this block.

Member Function Documentation

◆ addDimensionedVariable() [1/3]

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
nameThe name of the variable.
typeThe type of the variable.
ptrPointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling fill().
dimDimension for the variable. (Presently unimplemented!)
docstringDocumentation string for this variable.
defvalPointer 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.

Definition at line 119 of file AddVariable.cxx.

129{
130 if (!m_tree) {
131 // Called from constructor --- just initialize pointer.
132 ptr = 0;
133 return StatusCode::SUCCESS;
134 }
135
137 ti, ptr, dim,
138 docstring, defval ) );
140 ti, ptr, dim,
142}
#define CHECK(...)
Evaluate an expression and check for errors.
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.
Type-safe wrapper for block filler tools.

◆ addDimensionedVariable() [2/3]

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

Add a variable to the tuple.

Parameters
nameThe name of the variable.
ptrPointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling fill().
dimDimension for the variable. (Presently unimplemented!)
docstringDocumentation string for this variable.
defvalPointer 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() [3/3]

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

Add a variable to the tuple.

Parameters
nameThe name of the variable.
ptrPointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling fill().
dimDimension for the variable. (Presently unimplemented!)
docstringDocumentation string for this variable.

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

◆ addVariable() [1/3]

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
nameThe name of the variable.
typeThe type of the variable.
ptrPointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling fill().
docstringDocumentation string for this variable.
defvalPointer 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.

Definition at line 93 of file AddVariable.cxx.

90{
91 if (!m_tree) {
92 // Called from constructor --- just initialize pointer.
93 ptr = 0;
95 }
96
98 ti, ptr, docstring, defval ) );
101}
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.

◆ addVariable() [2/3]

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

Make the template implementation from IAddVariable visible.

◆ addVariable() [3/3]

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

Make the template implementation from IAddVariable visible.

◆ BlockFillerToolImpl()

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

Standard Gaudi tool constructor.

Parameters
typeThe name of the tool type.
nameThe tool name.
parentThe tool's Gaudi parent.

◆ book()

StatusCode D3PD::TileHitInfoFillerTool::book ( )
virtual

Book variables for this block.

Implements D3PD::BlockFillerTool< TileHitVector >.

Definition at line 50 of file TileHitInfoFillerTool.cxx.

51{
52
53 CHECK(addVariable("energy", m_energy ));
54 CHECK(addVariable("eBefore", m_eBefore ));
55 CHECK(addVariable("eInTime", m_eInTime ));
56 CHECK(addVariable("eAfter", m_eAfter ));
57 CHECK(addVariable("eOutTime", m_eOutTime ));
58 CHECK(addVariable("time", m_time ));
59 CHECK(addVariable("tBefore", m_tBefore ));
60 CHECK(addVariable("tInTime", m_tInTime ));
61 CHECK(addVariable("tAfter", m_tAfter ));
62 CHECK(addVariable("tOutTime", m_tOutTime ));
63 CHECK(addVariable("nHit", m_nHit ));
64 CHECK(addVariable("nHitBefore", m_nHitBefore ));
65 CHECK(addVariable("nHitInTime", m_nHitInTime ));
66 CHECK(addVariable("nHitAfter", m_nHitAfter ));
67 CHECK(addVariable("nHitOutTime", m_nHitOutTime ));
68 CHECK(addVariable("nChan", m_nChan ));
69 CHECK(addVariable("nChanBefore", m_nChanBefore ));
70 CHECK(addVariable("nChanInTime", m_nChanInTime ));
71 CHECK(addVariable("nChanAfter", m_nChanAfter ));
72 CHECK(addVariable("nChanOutTime",m_nChanOutTime));
73
74 return StatusCode::SUCCESS;
75}

◆ configureD3PD() [1/2]

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

Configure the parent tree.

Parameters
treeThe parent IAddVariable instance.

Definition at line 69 of file AddVariable.cxx.

62{
63 m_tree = tree;
64 m_metadata.clear();
66}

◆ configureD3PD() [2/2]

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

Configure during initialization: type-check.

Parameters
treeOur parent for tuple making.
tiGives 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
treeOur parent for tuple making.
tiGives the type of the object being passed to fillUntyped.
fill_tiis 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 70 of file BlockFillerToolImpl.cxx.

58{
60 CHECK( m_converter.init (ti, fill_ti) );
61
63}

◆ 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
treeOur parent for tuple making.
tiGives the type of the object being passed to fillUntyped.
tisList of possible input types that we can accept.
[out]whichIndex 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 91 of file BlockFillerToolImpl.cxx.

87{
89 CHECK( m_converter.init (ti, tis, which) );
91}

◆ 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 107 of file BlockFillerToolImpl.cxx.

106{
107 p = m_converter.convertUntyped (p);
108 if (!p) {
110 << "Pointer conversion from " << m_converter.srcName() << " to "
111 << m_converter.dstName() << "failed.";
112 return StatusCode::FAILURE;
113 }
114 return StatusCode::SUCCESS;
115}
#define REPORT_MESSAGE(LVL)
Report a message.

◆ fill()

StatusCode D3PD::TileHitInfoFillerTool::fill ( const TileHitVector & hitCont)
virtual

Fill one block — type-safe version.

Parameters
pThe 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< TileHitVector >.

Definition at line 86 of file TileHitInfoFillerTool.cxx.

87{
88 *m_energy = 0.0;
89 *m_eInTime = 0.0;
90 *m_eBefore = 0.0;
91 *m_eAfter = 0.0;
92 *m_eOutTime = 0.0;
93 *m_time = 0.0;
94 *m_tInTime = 0.0;
95 *m_tBefore = 0.0;
96 *m_tAfter = 0.0;
97 *m_tOutTime = 0.0;
98 *m_nHit = 0;
99 *m_nHitInTime = 0;
100 *m_nHitBefore = 0;
101 *m_nHitAfter = 0;
102 *m_nHitOutTime = 0;
103 *m_nChan = 0;
104 *m_nChanInTime = 0;
105 *m_nChanBefore = 0;
106 *m_nChanAfter = 0;
107 *m_nChanOutTime = 0;
108
109 TileHitVector::const_iterator itr = hitCont.begin();
110 TileHitVector::const_iterator itrLast = hitCont.end();
111
112 double eInTime=0.0;
113 double eBefore=0.0;
114 double eAfter=0.0;
115 double eOutTime=0.0;
116 double tInTime=0.0;
117 double tBefore=0.0;
118 double tAfter=0.0;
119 double tOutTime=0.0;
120
121 for ( ; itr!=itrLast; ++itr) {
122
123 int inTime=0;
124 int before=0;
125 int after=0;
126 int outTime=0;
127
128 const TileHit & hit = (*itr) ;
129
130 int size=hit.size();
131 for(int i=0;i<size;++i) {
132 double energy = hit.energy(i);
133 float time = hit.time(i);
134
135 if (time>m_timeOut) {
136 ++outTime;
137 eOutTime += energy;
138 tOutTime += energy*time;
139 } else if (time>m_timeMax) {
140 ++after;
141 eAfter += energy;
142 tAfter += energy*time;
143 } else if (time<m_timeMin) {
144 ++before;
145 eBefore += energy;
146 tBefore += energy*time;
147 } else {
148 ++inTime;
149 eInTime += energy;
150 tInTime += energy*time;
151 }
152 }
153
154 (*m_nHit) += size;
155 (*m_nChan) += 1;
156
157 if (outTime) {
158 (*m_nHitOutTime) += outTime;
159 (*m_nChanOutTime) += 1;
160 }
161 if (after) {
162 (*m_nHitAfter) += after;
163 (*m_nChanAfter) += 1;
164 }
165 if (before) {
166 (*m_nHitBefore) += before;
167 (*m_nChanBefore) += 1;
168 }
169 if (inTime) {
170 (*m_nHitInTime) += inTime;
171 (*m_nChanInTime) += 1;
172 }
173
174 }
175
176 if (*m_nChan) {
177
178 double energy = 0.0;
179 double time = 0.0;
180
181 if (eBefore!=0.0) {
182 *m_eBefore = eBefore;
183 *m_tBefore = tBefore / eBefore;
184 energy += eBefore;
185 time += tBefore;
186 }
187
188 if (eAfter!=0.0) {
189 *m_eAfter = eAfter;
190 *m_tAfter = tAfter / eAfter;
191 energy += eAfter;
192 time += tAfter;
193 }
194
195 if (eInTime!=0.0) {
196 *m_eInTime = eInTime;
197 *m_tInTime = tInTime / eInTime;
198 energy += eInTime;
199 time += tInTime;
200 }
201
202 if (energy!=0.0) {
203 *m_energy = energy;
204 *m_time = time / energy;
205 }
206
207 if (eOutTime!=0.0) {
208 *m_eOutTime = eOutTime;
209 *m_tOutTime = tOutTime / eOutTime;
210 if (energy != 0.0) {
211 *m_energy += eOutTime;
212 // do not use out-of-time in time calculations
213 } else {
215 *m_time = *m_tOutTime; // only out-of-time energy
216 }
217 }
218
219
220 }
221
222 ATH_MSG_DEBUG(" Tile hits: "<< *m_nChan << " / " << *m_nHit
223 <<" energy " << *m_energy << " time " << *m_time );
224
225 return StatusCode::SUCCESS;
226}
#define ATH_MSG_DEBUG(x)
CONT::const_iterator const_iterator
const_iterator begin() const
const_iterator end() const
float time(int ind=0) const
Return time of ind-th sub-hit.
float energy(int ind=0) const
Return energy of ind-th sub-hit.
int size(void) const
Return length of energy/time vectors.
time(flags, cells_name, *args, **kw)

◆ fillAgain()

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

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

Parameters
pThe 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< TileHitVector >::fillUntyped ( const void * p,
bool again = false )
virtualinherited

Fill one block.

Parameters
pThe input object.
againSet 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.

Member Data Documentation

◆ m_blockName

std::string D3PD::BlockFillerToolImpl::m_blockName
privateinherited

Property: the name of this block.

Definition at line 118 of file BlockFillerToolImpl.h.

◆ m_converter

TypeConverter D3PD::BlockFillerToolImpl::m_converter
privateinherited

Helper to do type conversions.

Definition at line 121 of file BlockFillerToolImpl.h.

◆ m_eAfter

float* D3PD::TileHitInfoFillerTool::m_eAfter
private

Definition at line 66 of file TileHitInfoFillerTool.h.

◆ m_eBefore

float* D3PD::TileHitInfoFillerTool::m_eBefore
private

Definition at line 65 of file TileHitInfoFillerTool.h.

◆ m_eInTime

float* D3PD::TileHitInfoFillerTool::m_eInTime
private

Definition at line 64 of file TileHitInfoFillerTool.h.

◆ m_energy

float* D3PD::TileHitInfoFillerTool::m_energy
private

Definition at line 63 of file TileHitInfoFillerTool.h.

◆ m_eOutTime

float* D3PD::TileHitInfoFillerTool::m_eOutTime
private

Definition at line 67 of file TileHitInfoFillerTool.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_nChan

int* D3PD::TileHitInfoFillerTool::m_nChan
private

Definition at line 81 of file TileHitInfoFillerTool.h.

◆ m_nChanAfter

int* D3PD::TileHitInfoFillerTool::m_nChanAfter
private

Definition at line 84 of file TileHitInfoFillerTool.h.

◆ m_nChanBefore

int* D3PD::TileHitInfoFillerTool::m_nChanBefore
private

Definition at line 83 of file TileHitInfoFillerTool.h.

◆ m_nChanInTime

int* D3PD::TileHitInfoFillerTool::m_nChanInTime
private

Definition at line 82 of file TileHitInfoFillerTool.h.

◆ m_nChanOutTime

int* D3PD::TileHitInfoFillerTool::m_nChanOutTime
private

Definition at line 85 of file TileHitInfoFillerTool.h.

◆ m_nHit

int* D3PD::TileHitInfoFillerTool::m_nHit
private

Definition at line 75 of file TileHitInfoFillerTool.h.

◆ m_nHitAfter

int* D3PD::TileHitInfoFillerTool::m_nHitAfter
private

Definition at line 78 of file TileHitInfoFillerTool.h.

◆ m_nHitBefore

int* D3PD::TileHitInfoFillerTool::m_nHitBefore
private

Definition at line 77 of file TileHitInfoFillerTool.h.

◆ m_nHitInTime

int* D3PD::TileHitInfoFillerTool::m_nHitInTime
private

Definition at line 76 of file TileHitInfoFillerTool.h.

◆ m_nHitOutTime

int* D3PD::TileHitInfoFillerTool::m_nHitOutTime
private

Definition at line 79 of file TileHitInfoFillerTool.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_suffix

std::string D3PD::BlockFillerToolImpl::m_suffix
privateinherited

Property: the variable prefix for this block.

Definition at line 115 of file BlockFillerToolImpl.h.

◆ m_tAfter

float* D3PD::TileHitInfoFillerTool::m_tAfter
private

Definition at line 72 of file TileHitInfoFillerTool.h.

◆ m_tBefore

float* D3PD::TileHitInfoFillerTool::m_tBefore
private

Definition at line 71 of file TileHitInfoFillerTool.h.

◆ m_time

float* D3PD::TileHitInfoFillerTool::m_time
private

Definition at line 69 of file TileHitInfoFillerTool.h.

◆ m_timeMax

float D3PD::TileHitInfoFillerTool::m_timeMax
private

Definition at line 89 of file TileHitInfoFillerTool.h.

◆ m_timeMin

float D3PD::TileHitInfoFillerTool::m_timeMin
private

Definition at line 88 of file TileHitInfoFillerTool.h.

◆ m_timeOut

float D3PD::TileHitInfoFillerTool::m_timeOut
private

Definition at line 90 of file TileHitInfoFillerTool.h.

◆ m_tInTime

float* D3PD::TileHitInfoFillerTool::m_tInTime
private

Definition at line 70 of file TileHitInfoFillerTool.h.

◆ m_tOutTime

float* D3PD::TileHitInfoFillerTool::m_tOutTime
private

Definition at line 73 of file TileHitInfoFillerTool.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.

◆ 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: