EIC Software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Attributes | Private Attributes | List of all members
GFAbsRecoHit Class Referenceabstract
Genfit

Base Class for representing a Hit in GENFIT. More...

#include <EicRoot/blob/master/genfit/GFAbsRecoHit.h>

+ Inheritance diagram for GFAbsRecoHit:
+ Collaboration diagram for GFAbsRecoHit:

Public Member Functions

virtual ~GFAbsRecoHit ()
 
 GFAbsRecoHit (int NparHit)
 Constructor specifying dimension of coordinate vector.
 
 GFAbsRecoHit ()
 Default constructor needed for compatibility with ROOT.
 
virtual TMatrixT< double > getHMatrix (const GFAbsTrackRep *stateVector)=0
 Get transformation matrix. Transformation between hit coordinates and track representation coordinates.
 
virtual void getMeasurement (const GFAbsTrackRep *rep, const GFDetPlane &pl, const TMatrixT< double > &statePred, const TMatrixT< double > &covPred, TMatrixT< double > &m, TMatrixT< double > &V)=0
 get measurement vector and hit covariance
 
TMatrixT< double > getRawHitCov () const
 Get raw hit covariances.
 
TMatrixT< double > getRawHitCoord () const
 Get raw hit coordinates.
 
virtual const GFDetPlane & getDetPlane (GFAbsTrackRep *)=0
 Get detector plane for a given track representation.
 
double getRho ()
 
void setRho (double rho)
 
virtual GFAbsRecoHit * clone ()=0
 Get clone of this object.
 
virtual void Print (const Option_t *option="") const
 Print raw hit coordinates.
 
virtual const std::string & getPolicyName ()
 
int getNparHit ()
 

Protected Attributes

TMatrixT< double > fHitCoord
 Vector of raw coordinates of hit.
 
TMatrixT< double > fHitCov
 Covariance of raw hit coordinates.
 
double fRho
 Sorting parameter used in GFTrack::sortHits()
 

Private Attributes

int fNparHit
 

Detailed Description

Base Class for representing a Hit in GENFIT.

Author
Christian Höppner (Technische Universität München, original author)
Sebastian Neubert (Technische Universität München, original author)

A hit is defined as a single measurement of a detector. Each detector can define it's own hit representation (geometry) by inherting from GFAbsRecoHit. We call such a child object a "RecoHit" to make clear that it inherits from GFAbsRecoHit. All detector specific information is handled inside the RecoHit objects. The idea behind this is that the fitting algorithms can work on different detectors simultanously.

GFAbsRecoHit defines the basic interface that is used by all genfit algorithms to access hit-measurement information. It provides:

  • the matrices to store hit coordinates and covariances
  • defines methods to access these data
  • the interface to access a hit's detector plane object

All hits have to inherit from this base class. Inheritance can be direct or through template class RecoHitIfc<GeometryPolicy>. These interface classes (defined with a specific policy) provide additional functionality for specific hit geometries, such as space points, wires, etc. For details look at the RecoHitIfc documentation.

A simple example is given in VirtSpacePointRecoHit

Background information: The main feature here is that coordinates and covariances are available as general TMatrixT<double> objects. By using these general algebraic objects it is possible to abstract from the concrete measurement and thus define a unified framework to handle the data. This is a key ingredient for the separation of data and algorithms which in turn enables us to elegantly combine information from different detectors.

Definition at line 73 of file GFAbsRecoHit.h.

View newest version in sPHENIX GitHub at line 73 of file GFAbsRecoHit.h

Constructor & Destructor Documentation

GFAbsRecoHit::~GFAbsRecoHit ( )
virtual

Definition at line 35 of file GFAbsRecoHit.cxx.

View newest version in sPHENIX GitHub at line 35 of file GFAbsRecoHit.cxx

GFAbsRecoHit::GFAbsRecoHit ( int  NparHit)

Constructor specifying dimension of coordinate vector.

One hit is generally represented by a vector of coordinates.

Parameters
NparHitspecifies the dimension of this vector. (e.g. 3 for a spacepoint, 2 for a pixel, 1 for a strip)
GFAbsRecoHit::GFAbsRecoHit ( )

Default constructor needed for compatibility with ROOT.

Definition at line 32 of file GFAbsRecoHit.cxx.

View newest version in sPHENIX GitHub at line 32 of file GFAbsRecoHit.cxx

Member Function Documentation

virtual GFAbsRecoHit* GFAbsRecoHit::clone ( )
pure virtual

Get clone of this object.

Virtual abstract method. Has to be implemented by inherting classes. Creates a deep copy of this object. Ownership is trandsferred to the caller!

Implemented in GFDafHit, VirtSpacePointRecoHit, EicSpaceRecoHit, PndHitRecoHit, and EicPlanarRecoHit.

virtual const GFDetPlane& GFAbsRecoHit::getDetPlane ( GFAbsTrackRep *  )
pure virtual

Get detector plane for a given track representation.

Virtual abstract method has to be implemented by inherting classes.

In general the detector plane can depend both on the detector/hit geometry as well as the track geometry. E.g. for a space point one usually chooses a plane that is perpendicular to the current track, since in that case no other plane is predefined.

There are several implementations for this method in the HitPolicies. In the most simple case (a planar detector) the method just returns a fixed (detector module specific) plane. This behaviour for example is implemented in PlanarHitPolicy.

Implemented in GFDafHit, GFRecoHitIfc< HitPolicy >, GFRecoHitIfc< GFSpacepointHitPolicy >, and GFRecoHitIfc< GFPlanarHitPolicy >.

Referenced by GFDaf::calcWeights(), GFKalman::getChi2Hit(), GFTrack::getResiduals(), and GFKalman::processHit().

+ Here is the caller graph for this function:

virtual TMatrixT<double> GFAbsRecoHit::getHMatrix ( const GFAbsTrackRep *  stateVector)
pure virtual

Get transformation matrix. Transformation between hit coordinates and track representation coordinates.

This is a virtual abstract method which has to be implemented in the child classes.

In general there is a linear transformation between the coordinate system of the hit (which is defined by the detector plane) and the coordinates of the track representation in that plane. In the most simple case the track representation has 5 parameters (space + momentum) while a hit usually has less (one to three space coordinates).

The transformation matrix is then simply projecting out the space-components of the track representation.

Its dimensions are NxM. Where N is the number of dimensions of the hit in the detector plane (usually 2 or 1) and M is the dimension of the track representation.

In this method a hit has to define with which track representations it can work together. It should be the only point where this explicit coordination is necessary.

For example code see implementing classes below:

Implemented in GFDafHit, VirtSpacePointRecoHit, EicSpaceRecoHit, PndHitRecoHit, and EicPlanarRecoHit.

Referenced by GFTools::getBiasedSmoothedCov(), GFTools::getBiasedSmoothedPos(), GFTools::getBiasedSmoothedPosXYZ(), GFKalman::getChi2Hit(), GFTrack::getResiduals(), GFTools::getSmoothedChiSqu(), GFTools::getSmoothedCov(), GFTools::getSmoothedPos(), GFTools::getSmoothedPosXYZ(), and GFKalman::processHit().

+ Here is the caller graph for this function:

virtual void GFAbsRecoHit::getMeasurement ( const GFAbsTrackRep *  rep,
const GFDetPlane &  pl,
const TMatrixT< double > &  statePred,
const TMatrixT< double > &  covPred,
TMatrixT< double > &  m,
TMatrixT< double > &  V 
)
pure virtual

get measurement vector and hit covariance

Implemented in GFRecoHitIfc< HitPolicy >, GFRecoHitIfc< GFSpacepointHitPolicy >, GFRecoHitIfc< GFPlanarHitPolicy >, and GFDafHit.

Referenced by GFDaf::calcWeights(), GFKalman::getChi2Hit(), GFTrack::getResiduals(), and GFKalman::processHit().

+ Here is the caller graph for this function:

int GFAbsRecoHit::getNparHit ( )
inline

Definition at line 185 of file GFAbsRecoHit.h.

View newest version in sPHENIX GitHub at line 185 of file GFAbsRecoHit.h

References fNparHit.

const std::string & GFAbsRecoHit::getPolicyName ( )
virtual

Reimplemented in GFDafHit, GFRecoHitIfc< HitPolicy >, GFRecoHitIfc< GFSpacepointHitPolicy >, and GFRecoHitIfc< GFPlanarHitPolicy >.

Definition at line 37 of file GFAbsRecoHit.cxx.

View newest version in sPHENIX GitHub at line 37 of file GFAbsRecoHit.cxx

TMatrixT<double> GFAbsRecoHit::getRawHitCoord ( ) const
inline

Get raw hit coordinates.

Definition at line 142 of file GFAbsRecoHit.h.

View newest version in sPHENIX GitHub at line 142 of file GFAbsRecoHit.h

References fHitCoord.

Referenced by GFWirepointHitPolicy::checkPlane(), GFWireHitPolicy::checkPlane(), GFWirepointHitPolicy::detPlane(), GFWireHitPolicy::detPlane(), GFPseudoSpacepointWireHitPolicy::detPlane(), GFSpacepointHitPolicy::detPlane(), GFTools::getSmoothedChiSqu(), GFWirepointHitPolicy::hitCoord(), GFWireHitPolicy::hitCoord(), GFPseudoSpacepointWireHitPolicy::hitCoord(), GFSpacepointHitPolicy::hitCoord(), and GFPlanarHitPolicy::hitCoord().

+ Here is the caller graph for this function:

TMatrixT<double> GFAbsRecoHit::getRawHitCov ( ) const
inline

Get raw hit covariances.

Definition at line 137 of file GFAbsRecoHit.h.

View newest version in sPHENIX GitHub at line 137 of file GFAbsRecoHit.h

References fHitCov.

Referenced by GFTools::getSmoothedChiSqu(), GFWirepointHitPolicy::hitCov(), GFWireHitPolicy::hitCov(), GFPseudoSpacepointWireHitPolicy::hitCov(), GFSpacepointHitPolicy::hitCov(), and GFPlanarHitPolicy::hitCov().

+ Here is the caller graph for this function:

double GFAbsRecoHit::getRho ( )
inline

Get sorting parameter rho.

Definition at line 164 of file GFAbsRecoHit.h.

View newest version in sPHENIX GitHub at line 164 of file GFAbsRecoHit.h

References fRho.

virtual void GFAbsRecoHit::Print ( const Option_t *  option = "") const
inlinevirtual

Print raw hit coordinates.

Definition at line 181 of file GFAbsRecoHit.h.

View newest version in sPHENIX GitHub at line 181 of file GFAbsRecoHit.h

References fHitCoord.

void GFAbsRecoHit::setRho ( double  rho)
inline

Set sorting parameter rho.

Definition at line 169 of file GFAbsRecoHit.h.

View newest version in sPHENIX GitHub at line 169 of file GFAbsRecoHit.h

References fRho.

Member Data Documentation

TMatrixT<double> GFAbsRecoHit::fHitCoord
protected

Vector of raw coordinates of hit.

Definition at line 76 of file GFAbsRecoHit.h.

View newest version in sPHENIX GitHub at line 76 of file GFAbsRecoHit.h

Referenced by EicPlanarRecoHit::EicPlanarRecoHit(), EicSpaceRecoHit::EicSpaceRecoHit(), GFDafHit::getMeasurement(), getRawHitCoord(), PndHitRecoHit::PndHitRecoHit(), Print(), and VirtSpacePointRecoHit::VirtSpacePointRecoHit().

TMatrixT<double> GFAbsRecoHit::fHitCov
protected

Covariance of raw hit coordinates.

Definition at line 79 of file GFAbsRecoHit.h.

View newest version in sPHENIX GitHub at line 79 of file GFAbsRecoHit.h

Referenced by EicPlanarRecoHit::EicPlanarRecoHit(), EicSpaceRecoHit::EicSpaceRecoHit(), GFDafHit::getMeasurement(), getRawHitCov(), PndHitRecoHit::PndHitRecoHit(), and VirtSpacePointRecoHit::VirtSpacePointRecoHit().

int GFAbsRecoHit::fNparHit
private

Definition at line 85 of file GFAbsRecoHit.h.

View newest version in sPHENIX GitHub at line 85 of file GFAbsRecoHit.h

Referenced by getNparHit().

double GFAbsRecoHit::fRho
protected

Sorting parameter used in GFTrack::sortHits()

Definition at line 82 of file GFAbsRecoHit.h.

View newest version in sPHENIX GitHub at line 82 of file GFAbsRecoHit.h

Referenced by getRho(), and setRho().

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