|
ATLAS Offline Software
|
Block filler tool for EM samplings from a CaloCluster.
More...
#include <ClusterSamplingFillerTool.h>
|
| ClusterSamplingFillerTool (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 CaloCluster &p) override |
| Fill one block — type-safe version. More...
|
|
virtual StatusCode | fill (const xAOD::CaloCluster &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 | fill (const Types< CaloCluster, xAOD::CaloCluster > &p)=0 |
| Fill one block — type-safe version. More...
|
|
virtual StatusCode | fillAgain (const Types< CaloCluster, xAOD::CaloCluster > &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 31 of file ClusterSamplingFillerTool.h.
◆ Base
◆ ClusterSamplingFillerTool()
D3PD::ClusterSamplingFillerTool::ClusterSamplingFillerTool |
( |
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 45 of file ClusterSamplingFillerTool.cxx.
52 "Samplings to write. Empty means to write all.");
54 "Should total E/Had energies be written?");
56 "Should per-sampling energies be written?");
58 "Should per-sampling eta/phi be written?");
60 "Should per-sampling raw eta/phi be written?");
62 "Should per-sampling maximum eta be written?");
64 "Should reconstruction status word be written?");
◆ 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::ClusterSamplingFillerTool::book |
( |
| ) |
|
|
overridevirtual |
Book variables for this block.
Implements D3PD::BlockFillerTool< Types< CaloCluster, xAOD::CaloCluster > >.
Definition at line 86 of file ClusterSamplingFillerTool.cxx.
93 std::string samplingnames[
NSAMP] =
94 {
"PreSamplerB",
"EMB1",
"EMB2",
"EMB3",
95 "PreSamplerE",
"EME1",
"EME2",
"EME3",
96 "HEC0",
"HEC1",
"HEC2",
"HEC3",
97 "TileBar0",
"TileBar1",
"TileBar2",
98 "TileGap1",
"TileGap2",
"TileGap3",
99 "TileExt0",
"TileExt1",
"TileExt2",
100 "FCAL0",
"FCAL1",
"FCAL2"};
103 for (
unsigned int i = 0;
i <
NSAMP;
i++)
110 <<
"; max is " << 24;
111 return StatusCode::FAILURE;
118 <<
s <<
" which is out of range.";
119 return StatusCode::FAILURE;
122 const std::string& sname = samplingnames[
s];
126 "Energy in sampling " + sname) );
130 "Aligned eta barycenter in sampling " + sname) );
132 "Aligned phi barycenter in sampling " + sname) );
137 "Raw eta barycenter in sampling " + sname,
140 "Raw phi barycenter in sampling " + sname,
146 "Eta of maximum cell in sampling " + sname) );
153 return StatusCode::SUCCESS;
◆ 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() [1/3]
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.
Definition at line 165 of file ClusterSamplingFillerTool.cxx.
167 std::vector<double> eSamp;
168 p.getEInSamples(eSamp);
170 std::vector<double> etaSamp;
171 p.getEtaInSamples(etaSamp);
173 std::vector<double> phiSamp;
174 p.getPhiInSamples(phiSamp);
182 return StatusCode::SUCCESS;
◆ fill() [2/3]
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.
◆ fill() [3/3]
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.
Definition at line 194 of file ClusterSamplingFillerTool.cxx.
198 std::vector<double> eSamp (nsamp);
199 std::vector<double> etaSamp (nsamp);
200 std::vector<double> phiSamp (nsamp);
202 for (
unsigned int i=0;
i < nsamp;
i++) {
211 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()
.
◆ fillEtamax()
template<class T >
StatusCode D3PD::ClusterSamplingFillerTool::fillEtamax |
( |
const T & |
p | ) |
|
|
private |
◆ fillSamplings()
StatusCode D3PD::ClusterSamplingFillerTool::fillSamplings |
( |
const std::vector< double > & |
eSamp, |
|
|
const std::vector< double > & |
etaSamp, |
|
|
const std::vector< double > & |
phiSamp |
|
) |
| |
|
private |
Fill sampling variables.
- Parameters
-
eSamp | Energy per sample. |
etaSamp | Eta per sample. |
phiSamp | Phi per sample. |
Definition at line 239 of file ClusterSamplingFillerTool.cxx.
285 double eta_raw=0, phi_raw=0;
287 **caloDetDescrMgrHandle,
299 return StatusCode::SUCCESS;
◆ 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.
◆ initialize()
StatusCode D3PD::ClusterSamplingFillerTool::initialize |
( |
| ) |
|
|
overridevirtual |
◆ m_blockName
std::string D3PD::BlockFillerToolImpl::m_blockName |
|
privateinherited |
◆ m_caloDetDescrMgrKey
Initial value:{
this,
"CaloDetDescrManager",
"CaloDetDescrManager",
"SG Key for CaloDetDescrManager in the Condition Store"
}
Definition at line 133 of file ClusterSamplingFillerTool.h.
◆ m_converter
◆ m_Eem
float* D3PD::ClusterSamplingFillerTool::m_Eem |
|
private |
◆ m_Ehad
float* D3PD::ClusterSamplingFillerTool::m_Ehad |
|
private |
◆ m_Es
float* D3PD::ClusterSamplingFillerTool::m_Es[NSAMP] |
|
private |
◆ m_etamax
float* D3PD::ClusterSamplingFillerTool::m_etamax[NSAMP] |
|
private |
◆ m_etas
float* D3PD::ClusterSamplingFillerTool::m_etas[NSAMP] |
|
private |
◆ m_metadata
Metadata about the variables created by this object.
Definition at line 129 of file AddVariable.h.
◆ m_phis
float* D3PD::ClusterSamplingFillerTool::m_phis[NSAMP] |
|
private |
◆ m_prefix
std::string D3PD::BlockFillerToolImpl::m_prefix |
|
privateinherited |
◆ m_raw_etas
float* D3PD::ClusterSamplingFillerTool::m_raw_etas[NSAMP] |
|
private |
◆ m_raw_phis
float* D3PD::ClusterSamplingFillerTool::m_raw_phis[NSAMP] |
|
private |
◆ m_RecoStatus
unsigned int* D3PD::ClusterSamplingFillerTool::m_RecoStatus |
|
private |
◆ m_samplings
std::vector<unsigned int> D3PD::ClusterSamplingFillerTool::m_samplings |
|
private |
◆ m_suffix
std::string D3PD::BlockFillerToolImpl::m_suffix |
|
privateinherited |
◆ m_tree
◆ m_writeEmHadEnergies
bool D3PD::ClusterSamplingFillerTool::m_writeEmHadEnergies |
|
private |
◆ m_writeRecoStatus
bool D3PD::ClusterSamplingFillerTool::m_writeRecoStatus |
|
private |
◆ m_writeSamplingEnergies
bool D3PD::ClusterSamplingFillerTool::m_writeSamplingEnergies |
|
private |
◆ m_writeSamplingEtamax
bool D3PD::ClusterSamplingFillerTool::m_writeSamplingEtamax |
|
private |
◆ m_writeSamplingEtaPhi
bool D3PD::ClusterSamplingFillerTool::m_writeSamplingEtaPhi |
|
private |
◆ m_writeSamplingEtaPhiRaw
bool D3PD::ClusterSamplingFillerTool::m_writeSamplingEtaPhiRaw |
|
private |
◆ NSAMP
const unsigned int D3PD::ClusterSamplingFillerTool::NSAMP = 24 |
|
staticprivate |
◆ 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.
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.
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.
#define CHECK(...)
Evaluate an expression and check for errors.
void fill(H5::Group &out_file, size_t iterations)
static bool getDetPosition(const CaloDetDescrManager &mgr, CaloCell_ID::CaloSample sam, double etaAtlas, double phiAtlas, double &etaDet, double &phiDet)
get Detector level eta-phi position from Atlas level (aligned) position
StatusCode initialize(bool used=true)
#define REPORT_MESSAGE(LVL)
Report a message.
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.