|
ATLAS Offline Software
|
Block filler tool for EM samplings from a CaloCluster.
More...
#include <CaloInfoFillerTool.h>
|
| CaloInfoFillerTool (const std::string &type, const std::string &name, const IInterface *parent) |
| Standard Gaudi tool constructor. More...
|
|
virtual StatusCode | book () |
| Book variables for this block. More...
|
|
virtual StatusCode | fill (const CaloCellContainer &p) |
| 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 CaloCellContainer &p) |
| Fill one block, after AGAIN has been returned (type-safe). More...
|
|
| BlockFillerToolImpl (const std::string &type, const std::string &name, const IInterface *parent) |
| Standard Gaudi tool constructor. 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...
|
|
Block filler tool for EM samplings from a CaloCluster.
Definition at line 35 of file CaloInfoFillerTool.h.
◆ CaloInfoFillerTool()
D3PD::CaloInfoFillerTool::CaloInfoFillerTool |
( |
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 CaloInfoFillerTool.cxx.
44 declareProperty(
"PosNeg",
m_posneg = 0);
45 declareProperty(
"DoEt",
m_doEt = 0);
◆ 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.
133 return StatusCode::SUCCESS;
138 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.
94 return StatusCode::SUCCESS;
98 ti,
ptr, docstring, defval ) );
100 ti,
ptr, docstring, defval);
◆ addVariable() [2/6]
virtual StatusCode D3PD::IAddVariable::addVariable |
|
inherited |
◆ addVariable() [3/6]
template<class T , class U >
StatusCode D3PD::IAddVariable::addVariable |
( |
class T |
, |
|
|
class U |
|
|
) |
| |
|
inherited |
◆ 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 |
◆ 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
.
◆ BlockFillerToolImpl()
D3PD::BlockFillerToolImpl::BlockFillerToolImpl |
|
inherited |
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 73 of file BlockFillerToolImpl.cxx.
33 declareProperty (
"Prefix",
m_prefix =
"",
34 "Tuple variable prefix for this block.");
35 declareProperty (
"Suffix",
m_suffix =
"",
36 "Tuple variable suffix for this block.");
38 "The name of this block.");
◆ book()
StatusCode D3PD::CaloInfoFillerTool::book |
( |
| ) |
|
|
virtual |
◆ configureD3PD() [1/2]
StatusCode D3PD::AddVariable::configureD3PD |
( |
IAddVariable * |
tree | ) |
|
|
inherited |
Configure the parent tree.
- Parameters
-
Definition at line 61 of file AddVariable.cxx.
65 return StatusCode::SUCCESS;
◆ configureD3PD() [2/2]
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.
62 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.
90 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.
112 return StatusCode::FAILURE;
114 return StatusCode::SUCCESS;
◆ fill()
Fill one block — type-safe version.
- Parameters
-
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< CaloCellContainer >.
Definition at line 94 of file CaloInfoFillerTool.cxx.
154 double theCellE=
cell->energy();
180 (*m_Eh_PresB)[0] += theCellE;
184 (*m_Eh_PresE)[0] += theCellE;
209 (*m_Eh_Tile)[0] += theCellE;
212 (*m_Eh_Tile)[1] += theCellE;
215 (*m_Eh_Tile)[2] += theCellE;
221 (*m_Eh_TileGap)[0] += theCellE;
224 (*m_Eh_Scint)[0] += theCellE;
255 return StatusCode::SUCCESS;
◆ fillAgain()
Fill one block, after AGAIN
has been returned (type-safe).
- Parameters
-
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()
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.
◆ m_blockName
std::string D3PD::BlockFillerToolImpl::m_blockName |
|
privateinherited |
◆ m_converter
◆ m_doEt
bool D3PD::CaloInfoFillerTool::m_doEt |
|
private |
◆ m_Eh_Calo
float* D3PD::CaloInfoFillerTool::m_Eh_Calo |
|
private |
◆ m_Eh_EM
float* D3PD::CaloInfoFillerTool::m_Eh_EM |
|
private |
◆ m_Eh_EMB
std::vector<float>* D3PD::CaloInfoFillerTool::m_Eh_EMB |
|
private |
◆ m_Eh_EMEC
std::vector<float>* D3PD::CaloInfoFillerTool::m_Eh_EMEC |
|
private |
◆ m_Eh_FCal
std::vector<float>* D3PD::CaloInfoFillerTool::m_Eh_FCal |
|
private |
◆ m_Eh_HAD
float* D3PD::CaloInfoFillerTool::m_Eh_HAD |
|
private |
◆ m_Eh_HEC
std::vector<float>* D3PD::CaloInfoFillerTool::m_Eh_HEC |
|
private |
◆ m_Eh_PresB
std::vector<float>* D3PD::CaloInfoFillerTool::m_Eh_PresB |
|
private |
◆ m_Eh_PresE
std::vector<float>* D3PD::CaloInfoFillerTool::m_Eh_PresE |
|
private |
◆ m_Eh_Scint
std::vector<float>* D3PD::CaloInfoFillerTool::m_Eh_Scint |
|
private |
◆ m_Eh_Tile
std::vector<float>* D3PD::CaloInfoFillerTool::m_Eh_Tile |
|
private |
◆ m_Eh_TileGap
std::vector<float>* D3PD::CaloInfoFillerTool::m_Eh_TileGap |
|
private |
◆ m_metadata
Metadata about the variables created by this object.
Definition at line 129 of file AddVariable.h.
◆ m_Nh_Calo
int* D3PD::CaloInfoFillerTool::m_Nh_Calo |
|
private |
◆ m_Nh_EM
int* D3PD::CaloInfoFillerTool::m_Nh_EM |
|
private |
◆ m_Nh_EMB
int* D3PD::CaloInfoFillerTool::m_Nh_EMB |
|
private |
◆ m_Nh_EMEC
int* D3PD::CaloInfoFillerTool::m_Nh_EMEC |
|
private |
◆ m_Nh_FCal
int* D3PD::CaloInfoFillerTool::m_Nh_FCal |
|
private |
◆ m_Nh_HAD
int* D3PD::CaloInfoFillerTool::m_Nh_HAD |
|
private |
◆ m_Nh_HEC
int* D3PD::CaloInfoFillerTool::m_Nh_HEC |
|
private |
◆ m_Nh_PresB
int* D3PD::CaloInfoFillerTool::m_Nh_PresB |
|
private |
◆ m_Nh_PresE
int* D3PD::CaloInfoFillerTool::m_Nh_PresE |
|
private |
◆ m_Nh_Scint
int* D3PD::CaloInfoFillerTool::m_Nh_Scint |
|
private |
◆ m_Nh_Tile
int* D3PD::CaloInfoFillerTool::m_Nh_Tile |
|
private |
◆ m_Nh_TileGap
int* D3PD::CaloInfoFillerTool::m_Nh_TileGap |
|
private |
◆ m_posneg
int D3PD::CaloInfoFillerTool::m_posneg |
|
private |
◆ m_prefix
std::string D3PD::BlockFillerToolImpl::m_prefix |
|
privateinherited |
◆ m_suffix
std::string D3PD::BlockFillerToolImpl::m_suffix |
|
privateinherited |
◆ m_tree
◆ 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:
std::string dstName() const
Return the name of the destination type, or an empty string.
StatusCode configureD3PD(IAddVariable *tree)
Configure the parent tree.
AddVariable(const std::string &prefix, const std::string &blockName=s_emptyString)
Constructor.
const std::string & m_suffix
Reference to the variable suffix.
This class groups all DetDescr information related to a CaloCell. Provides a generic interface for al...
const std::string & m_prefix
Reference to the variable prefix.
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.
IAddVariable * m_tree
Reference to the block name.
StatusCode init(const std::type_info &src_ti, const std::type_info &dst_ti)
Initialize the converter.
float eta_raw() const
cell eta_raw
CaloCell_ID::SUBCALO getSubCalo() const
cell subcalo
std::string srcName() const
Return the name of the source type, or an empty string.
ObjectMetadata m_metadata
Metadata about the variables created by this object.
const void * convertUntyped(const void *p) const
Convert pointer.
SUBCALO
enumeration of sub calorimeters
int nCellsCalo(const CaloCell_ID::SUBCALO caloNum) const
get number of cels of given calorimeter
#define CHECK(...)
Evaluate an expression and check for errors.
#define REPORT_MESSAGE(LVL)
Report a message.
static CaloSample getSampling(const CaloCell &c)
Retrieves the sampling indicator for a cell.
Data object for each calorimeter readout cell.
StatusCode addVariable(const std::string &name, T *&ptr, const std::string &docstring="")
Add a variable to the tuple.
StatusCode addDimensionedVariable(const std::string &name, T *&ptr, const std::string &dim, const std::string &docstring="")
Add a variable to the tuple.