IXtalRecTool Class Reference

Abstract interface class for calculation of total deposited energy & centroid position for a single calorimeter crystal. More...

#include <IXtalRecTool.h>

Inheritance diagram for IXtalRecTool:

[legend]List of all members.

Public Member Functions
virtual StatusCode	calculate (const Event::CalDigi &digi, Event::CalXtalRecData &xtalRec, CalUtil::CalVec< CalUtil::FaceNum, bool > &belowNoise, CalUtil::CalVec< CalUtil::FaceNum, bool > &saturated, INeighborXtalkTool const *const nbrXtalkTool)=0
	estimate total deposited energy given the digital response for both faces
Static Public Member Functions
const InterfaceID &	interfaceID ()

---

Detailed Description

Abstract interface class for calculation of total deposited energy & centroid position for a single calorimeter crystal.

Author:

Z.Fewtrell

Definition at line 38 of file IXtalRecTool.h.

---

Member Function Documentation

virtual StatusCode IXtalRecTool::calculate (  const Event::CalDigi &  digi, Event::CalXtalRecData &  xtalRec, CalUtil::CalVec< CalUtil::FaceNum, bool > &  belowNoise, CalUtil::CalVec< CalUtil::FaceNum, bool > &  saturated, INeighborXtalkTool const *const  nbrXtalkTool )  [pure virtual]

estimate total deposited energy given the digital response for both faces Parameters: digi  single input digi readout xtalRec  expected to contain calxtalid field but no CalRangeRecData objects. calculate() will attempt to create 1 rangeRec object, but this will not always be possible. Caller should check xtalRec.getNReadouts() to see if xtal recon was successful. It _is_ possible for this function to return StatusCode::SUCCESS along w/ 0 CalRangeRecData objects. belowThresh  returns TRUE for each face signal below noise for any adc range xtalBelowThresh  returns TRUE if either face signal below LEX8 noise level saturated  returns TRUE for each face signal that is >= HEX1 saturation level nbrXtalkTool  (optional) pointer to neighboring xtal->xtal electronic crosstalk model Returns: It _is_ possible for this function to return StatusCode::SUCCESS along w/ 0 CalRangeRecData objects. Implemented in XtalRecTool. Referenced by CalXtalRecAlg::execute().

const InterfaceID& IXtalRecTool::interfaceID (   )  [inline, static]

Definition at line 41 of file IXtalRecTool.h. { return IID_IXtalRecTool; }

---

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

• IXtalRecTool.h

---