KLMCluster Class Reference

KLM cluster data. More...

#include <KLMCluster.h>

Inheritance diagram for KLMCluster:

Public Member Functions
	KLMCluster ()
	Constructor.
	KLMCluster (float x, float y, float z, float time, int nLayers, int nInnermostLayer, float p)
	Constructor.
	~KLMCluster ()
	Destructor.
float	getTime () const
	Get time.
int	getLayers () const
	Get number of layers with hits.
int	getInnermostLayer () const
	Get number of the innermost layer with hits.
ROOT::Math::XYZVector	getClusterPosition () const
	Get global position (ROOT::Math::XYZVector version).
ROOT::Math::XYZVector	getPosition () const
	Get global position (ROOT::Math::XYZVector version) of the origin of KLMCluster (always return (0,0,0) since we believe all KLMClusters to originate at or near primary vertex).
float	getMomentumMag () const
	Get momentum magnitude.
float	getEnergy () const
	Get energy.
ROOT::Math::PxPyPzEVector	getMomentum () const
	Get momentum.
TMatrixDSym	getError4x4 () const
	Get KLM cluster momentum error matrix.
TMatrixDSym	getError7x7 () const
	Get KLM cluster momentum error matrix.
bool	getAssociatedEclClusterFlag () const
	Check for associated ECL clusters.
bool	getAssociatedTrackFlag () const
	Check for associated tracks.
float	getClusterTrackRotationAngle () const
	Get KLM cluster-track rotation angle.
float	getClusterTrackSeparationAngle () const
	Get KLM cluster-track separation angle.
float	getClusterTrackSeparation () const
	Get KLM cluster-track distance.
float	getShapeStdDev1 () const
	Get std deviation of the 1st axis from PCA.
float	getShapeStdDev2 () const
	Get KLM std deviation of the 2nd axis from PCA.
float	getShapeStdDev3 () const
	Get std deviation of the 3rd axis from PCA.
void	setClusterTrackRotationAngle (float rotation)
	Set KLM cluster-track rotation angle.
void	setClusterTrackSeparationAngle (float separation)
	Set KLM cluster-track separation angle.
void	setClusterTrackSeparation (float dist)
	Set KLM cluster-track distance.
void	setShapeStdDev1 (float std1)
	Set std deviation of the 1st axis, from PCA.
void	setShapeStdDev2 (float std2)
	Set std deviation of the 2nd axis, from PCA.
void	setShapeStdDev3 (float std3)
	Set std deviation of the 3rd axis, from PCA.
void	setTime (float time)
	Set time.
void	setLayers (int layers)
	Set number of layers with hits.
void	setInnermostLayer (int innermostLayer)
	Set number of the innermost layer with hits.
void	setClusterPosition (float globalX, float globalY, float globalZ)
	Set global position.
void	setMomentumMag (float momentumMag)
	Set momentum magnitude.
void	addRelationTo (const RelationsInterface< TObject > *object, float weight=1.0, const std::string &namedRelation="") const
	Add a relation from this object to another object (with caching).
void	addRelationTo (const TObject *object, float weight=1.0, const std::string &namedRelation="") const
	Add a relation from this object to another object (no caching, can be quite slow).
void	addRelationTo (const RelationsInterface< TObject > *object, float weight=1.0, const std::string &namedRelation="") const
	Add a relation from this object to another object (with caching).
void	addRelationTo (const TObject *object, float weight=1.0, const std::string &namedRelation="") const
	Add a relation from this object to another object (no caching, can be quite slow).
void	copyRelations (const RelationsInterface< TObject > *sourceObj)
	Copies all relations of sourceObj (pointing from or to sourceObj) to this object (including weights).
void	copyRelations (const RelationsInterface< TObject > *sourceObj)
	Copies all relations of sourceObj (pointing from or to sourceObj) to this object (including weights).
RelationVector< TO >	getRelationsTo (const std::string &name="", const std::string &namedRelation="") const
	Get the relations that point from this object to another store array.
RelationVector< TO >	getRelationsTo (const std::string &name="", const std::string &namedRelation="") const
	Get the relations that point from this object to another store array.
RelationVector< FROM >	getRelationsFrom (const std::string &name="", const std::string &namedRelation="") const
	Get the relations that point from another store array to this object.
RelationVector< FROM >	getRelationsFrom (const std::string &name="", const std::string &namedRelation="") const
	Get the relations that point from another store array to this object.
RelationVector< T >	getRelationsWith (const std::string &name="", const std::string &namedRelation="") const
	Get the relations between this object and another store array.
RelationVector< T >	getRelationsWith (const std::string &name="", const std::string &namedRelation="") const
	Get the relations between this object and another store array.
TO *	getRelatedTo (const std::string &name="", const std::string &namedRelation="") const
	Get the object to which this object has a relation.
TO *	getRelatedTo (const std::string &name="", const std::string &namedRelation="") const
	Get the object to which this object has a relation.
FROM *	getRelatedFrom (const std::string &name="", const std::string &namedRelation="") const
	Get the object from which this object has a relation.
FROM *	getRelatedFrom (const std::string &name="", const std::string &namedRelation="") const
	Get the object from which this object has a relation.
T *	getRelated (const std::string &name="", const std::string &namedRelation="") const
	Get the object to or from which this object has a relation.
T *	getRelated (const std::string &name="", const std::string &namedRelation="") const
	Get the object to or from which this object has a relation.
std::pair< TO *, float >	getRelatedToWithWeight (const std::string &name="", const std::string &namedRelation="") const
	Get first related object & weight of relation pointing to an array.
std::pair< TO *, float >	getRelatedToWithWeight (const std::string &name="", const std::string &namedRelation="") const
	Get first related object & weight of relation pointing to an array.
std::pair< FROM *, float >	getRelatedFromWithWeight (const std::string &name="", const std::string &namedRelation="") const
	Get first related object & weight of relation pointing from an array.
std::pair< FROM *, float >	getRelatedFromWithWeight (const std::string &name="", const std::string &namedRelation="") const
	Get first related object & weight of relation pointing from an array.
std::pair< T *, float >	getRelatedWithWeight (const std::string &name="", const std::string &namedRelation="") const
	Get first related object & weight of relation pointing from/to an array.
std::pair< T *, float >	getRelatedWithWeight (const std::string &name="", const std::string &namedRelation="") const
	Get first related object & weight of relation pointing from/to an array.
virtual std::string	getName () const
	Return a short name that describes this object, e.g.
virtual std::string	getName () const
	Return a short name that describes this object, e.g.
virtual std::string	getInfoHTML () const
	Return a short summary of this object's contents in HTML format.
virtual std::string	getInfoHTML () const
	Return a short summary of this object's contents in HTML format.
std::string	getInfo () const
	Return a short summary of this object's contents in raw text format.
std::string	getInfo () const
	Return a short summary of this object's contents in raw text format.
std::string	getArrayName () const
	Get name of array this object is stored in, or "" if not found.
std::string	getArrayName () const
	Get name of array this object is stored in, or "" if not found.
int	getArrayIndex () const
	Returns this object's array index (in StoreArray), or -1 if not found.
int	getArrayIndex () const
	Returns this object's array index (in StoreArray), or -1 if not found.

Protected Member Functions
TClonesArray *	getArrayPointer () const
	Returns the pointer to the raw DataStore array holding this object (protected since these arrays are easy to misuse).
TClonesArray *	getArrayPointer () const
	Returns the pointer to the raw DataStore array holding this object (protected since these arrays are easy to misuse).

Private Member Functions
	ClassDef (Belle2::KLMCluster, 4)
	Needed to make objects storable.

Private Attributes
float	m_time
	Decay time.
int	m_layers
	Number of layers with hits.
int	m_innermostLayer
	Number of the innermost layer with hits.
float	m_globalX
	Global position X coordinate.
float	m_globalY
	Global position Y coordinate.
float	m_globalZ
	Global position Z coordinate.
float	m_p
	Absolute value of momentum, 0 means unknown.
float	m_clusterTrackRotationAngle = Const::floatNaN
	Track-cluster rotation angle.
float	m_clusterTrackSeparationAngle = Const::floatNaN
	Track-cluster separation angle.
float	m_clusterTrackSeparation = Const::floatNaN
	Track-cluster separation (distance).
float	m_shapeStdDev1 = 0
	Std deviation of axis 1 (from Cluster Shape PCA).
float	m_shapeStdDev2 = 0
	Std deviation of axis 2 (from Cluster Shape PCA).
float	m_shapeStdDev3 = 0
	Std deviation of axis 3 (from Cluster Shape PCA).
DataStore::StoreEntry *	m_cacheDataStoreEntry
	Cache of the data store entry to which this object belongs.
DataStore::StoreEntry *	m_cacheDataStoreEntry
	Cache of the data store entry to which this object belongs.
int	m_cacheArrayIndex
	Cache of the index in the TClonesArray to which this object belongs.
int	m_cacheArrayIndex
	Cache of the index in the TClonesArray to which this object belongs.

Detailed Description

KLM cluster data.

Definition at line 29 of file KLMCluster.h.

Constructor & Destructor Documentation

KLMCluster() [1/2]

KLMCluster

(

)

Constructor.

Definition at line 22 of file KLMCluster.cc.

                       : m_time(0), m_layers(0), m_innermostLayer(0),
  m_globalX(0), m_globalY(0), m_globalZ(0), m_p(0)
{
}

KLMCluster() [2/2]

KLMCluster	(	float	x,
		float	y,
		float	z,
		float	time,
		int	nLayers,
		int	nInnermostLayer,
		float	p )

Constructor.

Parameters

[in]	x	Vertex X coordinate.
[in]	y	Vertex Y coordinate.
[in]	z	Vertex Z coordinate.
[in]	time	Decay (interaction) time.
[in]	nLayers	Number of layers with signal.
[in]	nInnermostLayer	First layer.
[in]	p	Absolute value of 3-momentum.

Definition at line 27 of file KLMCluster.cc.

                                                     :
  m_time(time), m_layers(nLayers), m_innermostLayer(nInnermostLayer),
  m_globalX(x), m_globalY(y), m_globalZ(z), m_p(p)
{
}

~KLMCluster()

~KLMCluster

(

)

Destructor.

Definition at line 34 of file KLMCluster.cc.

{
}

Member Function Documentation

addRelationTo() [1/4]

void addRelationTo ( const RelationsInterface< TObject > * object, float weight = 1.0, const std::string & namedRelation = "" ) const

inlineinherited

Add a relation from this object to another object (with caching).

Parameters

object	The object to which the relation should point.
weight	The weight of the relation.
namedRelation	Additional name for the relation, or "" for the default naming

Definition at line 142 of file RelationsObject.h.

    {
      if (object)
        DataStore::Instance().addRelation(this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                                          object, object->m_cacheDataStoreEntry, object->m_cacheArrayIndex, weight, namedRelation);
    }

addRelationTo() [2/4]

void addRelationTo ( const RelationsInterface< TObject > * object, float weight = 1.0, const std::string & namedRelation = "" ) const

inlineinherited

Add a relation from this object to another object (with caching).

Parameters

object	The object to which the relation should point.
weight	The weight of the relation.
namedRelation	Additional name for the relation, or "" for the default naming

Definition at line 142 of file RelationsObject.h.

    {
      if (object)
        DataStore::Instance().addRelation(this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                                          object, object->m_cacheDataStoreEntry, object->m_cacheArrayIndex, weight, namedRelation);
    }

addRelationTo() [3/4]

void addRelationTo ( const TObject * object, float weight = 1.0, const std::string & namedRelation = "" ) const

inlineinherited

Add a relation from this object to another object (no caching, can be quite slow).

Parameters

object	The object to which the relation should point.
weight	The weight of the relation.
namedRelation	Additional name for the relation, or "" for the default naming

Definition at line 155 of file RelationsObject.h.

    {
      StoreEntry* toEntry = nullptr;
      int toIndex = -1;
      DataStore::Instance().addRelation(this, m_cacheDataStoreEntry, m_cacheArrayIndex, object, toEntry, toIndex, weight, namedRelation);
    }

addRelationTo() [4/4]

void addRelationTo ( const TObject * object, float weight = 1.0, const std::string & namedRelation = "" ) const

inlineinherited

Add a relation from this object to another object (no caching, can be quite slow).

Parameters

object	The object to which the relation should point.
weight	The weight of the relation.
namedRelation	Additional name for the relation, or "" for the default naming

Definition at line 155 of file RelationsObject.h.

    {
      StoreEntry* toEntry = nullptr;
      int toIndex = -1;
      DataStore::Instance().addRelation(this, m_cacheDataStoreEntry, m_cacheArrayIndex, object, toEntry, toIndex, weight, namedRelation);
    }

copyRelations() [1/2]

void copyRelations ( const RelationsInterface< TObject > * sourceObj )

inlineinherited

Copies all relations of sourceObj (pointing from or to sourceObj) to this object (including weights).

Useful if you want to make a complete copy of a StoreArray object to make modifications to it, but retain all information on linked objects.

Note: this only works if sourceObj inherits from the same base (e.g. RelationsObject), and only for related objects that also inherit from the same base.

Definition at line 170 of file RelationsObject.h.

    {
      if (!sourceObj)
        return;
      auto fromRels = sourceObj->getRelationsFrom<RelationsInterface<BASE>>("ALL");
      for (unsigned int iRel = 0; iRel < fromRels.size(); iRel++) {
        fromRels.object(iRel)->addRelationTo(this, fromRels.weight(iRel));
      }
 
      auto toRels = sourceObj->getRelationsTo<RelationsInterface<BASE>>("ALL");
      for (unsigned int iRel = 0; iRel < toRels.size(); iRel++) {
        this->addRelationTo(toRels.object(iRel), toRels.weight(iRel));
      }
    }

copyRelations() [2/2]

void copyRelations ( const RelationsInterface< TObject > * sourceObj )

inlineinherited

Copies all relations of sourceObj (pointing from or to sourceObj) to this object (including weights).

Useful if you want to make a complete copy of a StoreArray object to make modifications to it, but retain all information on linked objects.

Note: this only works if sourceObj inherits from the same base (e.g. RelationsObject), and only for related objects that also inherit from the same base.

Definition at line 170 of file RelationsObject.h.

    {
      if (!sourceObj)
        return;
      auto fromRels = sourceObj->getRelationsFrom<RelationsInterface<BASE>>("ALL");
      for (unsigned int iRel = 0; iRel < fromRels.size(); iRel++) {
        fromRels.object(iRel)->addRelationTo(this, fromRels.weight(iRel));
      }
 
      auto toRels = sourceObj->getRelationsTo<RelationsInterface<BASE>>("ALL");
      for (unsigned int iRel = 0; iRel < toRels.size(); iRel++) {
        this->addRelationTo(toRels.object(iRel), toRels.weight(iRel));
      }
    }

getArrayIndex() [1/2]

int getArrayIndex ( ) const

inlineinherited

Returns this object's array index (in StoreArray), or -1 if not found.

Definition at line 385 of file RelationsObject.h.

    {
      DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);
      return m_cacheArrayIndex;
    }

getArrayIndex() [2/2]

int getArrayIndex ( ) const

inlineinherited

Returns this object's array index (in StoreArray), or -1 if not found.

Definition at line 385 of file RelationsObject.h.

    {
      DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);
      return m_cacheArrayIndex;
    }

getArrayName() [1/2]

std::string getArrayName ( ) const

inlineinherited

Get name of array this object is stored in, or "" if not found.

Definition at line 377 of file RelationsObject.h.

    {
      DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);
      return m_cacheDataStoreEntry ? m_cacheDataStoreEntry->name : "";
    }

getArrayName() [2/2]

std::string getArrayName ( ) const

inlineinherited

Get name of array this object is stored in, or "" if not found.

Definition at line 377 of file RelationsObject.h.

    {
      DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);
      return m_cacheDataStoreEntry ? m_cacheDataStoreEntry->name : "";
    }

getArrayPointer() [1/2]

TClonesArray * getArrayPointer ( ) const

inlineprotectedinherited

Returns the pointer to the raw DataStore array holding this object (protected since these arrays are easy to misuse).

Definition at line 418 of file RelationsObject.h.

    {
      DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);
      if (!m_cacheDataStoreEntry)
        return nullptr;
      return m_cacheDataStoreEntry->getPtrAsArray();
    }

getArrayPointer() [2/2]

TClonesArray * getArrayPointer ( ) const

inlineprotectedinherited

Returns the pointer to the raw DataStore array holding this object (protected since these arrays are easy to misuse).

Definition at line 418 of file RelationsObject.h.

    {
      DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);
      if (!m_cacheDataStoreEntry)
        return nullptr;
      return m_cacheDataStoreEntry->getPtrAsArray();
    }

getAssociatedEclClusterFlag()

bool getAssociatedEclClusterFlag

(

)

const

Check for associated ECL clusters.

Returns

True if associated ECL clusters exist.

Definition at line 56 of file KLMCluster.cc.

{
  RelationVector<ECLCluster> eclClusters = this->getRelationsTo<ECLCluster>();
  return eclClusters.size() > 0;
}

getAssociatedTrackFlag()

bool getAssociatedTrackFlag

(

)

const

Check for associated tracks.

Returns

True if associated tracks exist.

Definition at line 62 of file KLMCluster.cc.

{
  RelationVector<Track> tracks = this->getRelationsFrom<Track>();
  return tracks.size() > 0;
}

getClusterPosition()

ROOT::Math::XYZVector getClusterPosition ( ) const

inline

Get global position (ROOT::Math::XYZVector version).

Returns

Hit coordinates.

Definition at line 81 of file KLMCluster.h.

    {return ROOT::Math::XYZVector(m_globalX, m_globalY, m_globalZ);}

getClusterTrackRotationAngle()

float getClusterTrackRotationAngle ( ) const

inline

Get KLM cluster-track rotation angle.

Returns

KLM rotation angle to the nearest track [rad].

Definition at line 139 of file KLMCluster.h.

{ return m_clusterTrackRotationAngle; }

getClusterTrackSeparation()

float getClusterTrackSeparation ( ) const

inline

Get KLM cluster-track distance.

Returns

KLM cluster separation from the nearest track [cm].

Definition at line 151 of file KLMCluster.h.

{ return m_clusterTrackSeparation; }

getClusterTrackSeparationAngle()

float getClusterTrackSeparationAngle ( ) const

inline

Get KLM cluster-track separation angle.

Returns

KLM cluster separation angle to the nearest track [rad].

Definition at line 145 of file KLMCluster.h.

{ return m_clusterTrackSeparationAngle; }

getEnergy()

float getEnergy

(

)

const

Get energy.

Returns

Full energy.

Definition at line 43 of file KLMCluster.cc.

{
  static double mass = Const::Klong.getMass();
  return sqrt(mass * mass + m_p * m_p);
}

getError4x4()

TMatrixDSym getError4x4

(

)

const

Get KLM cluster momentum error matrix.

Returns

4x4 KLM cluster momentum error matrix.

Definition at line 68 of file KLMCluster.cc.

{
  /* Elements: px, py, pz, E. */
  double vertexDist3;
  TMatrixDSym errorMatrix(4);
  TMatrixD jacobian(4, 4);
  vertexDist3 = pow(m_globalX * m_globalX + m_globalY * m_globalY +
                    m_globalZ * m_globalZ, 1.5);
  jacobian(0, 0) = m_p * (m_globalY * m_globalY + m_globalZ * m_globalZ) /
                   vertexDist3;
  jacobian(0, 1) = -m_p * m_globalX * m_globalY / vertexDist3;
  jacobian(0, 2) = -m_p * m_globalX * m_globalZ / vertexDist3;
  jacobian(0, 3) = m_globalX / vertexDist3;
  jacobian(1, 0) = jacobian(0, 1);
  jacobian(1, 1) = m_p * (m_globalX * m_globalX + m_globalZ * m_globalZ) /
                   vertexDist3;
  jacobian(1, 2) = -m_p * m_globalY * m_globalZ / vertexDist3;
  jacobian(1, 3) = m_globalY / vertexDist3;
  jacobian(2, 0) = jacobian(0, 2);
  jacobian(2, 1) = jacobian(1, 2);
  jacobian(2, 2) = m_p * (m_globalX * m_globalX + m_globalY * m_globalY) /
                   vertexDist3;
  jacobian(2, 3) = m_globalZ / vertexDist3;
  jacobian(3, 3) = m_p / getEnergy();
  return errorMatrix.Similarity(jacobian);
}

getError7x7()

TMatrixDSym getError7x7

(

)

const

Get KLM cluster momentum error matrix.

Returns

7x7 KLM cluster momentum error matrix.

Definition at line 95 of file KLMCluster.cc.

{
  /* Elements: px, py, pz, E, x, y, z. */
  int i, j;
  TMatrixDSym errorMatrix(7);
  TMatrixDSym errorMatrix4 = getError4x4();
  for (i = 0; i < 4; i++) {
    for (j = i; j < 4; j++)
      errorMatrix[i][j] = errorMatrix4[i][j];
  }
  for (i = 4; i < 7; i++)
    errorMatrix[i][i] = 1.0;
  return errorMatrix;
}

getInfo() [1/2]

std::string getInfo ( ) const

inlineinherited

Return a short summary of this object's contents in raw text format.

Returns the contents of getInfoHTML() while translating line-breaks etc.

Note

: You don't need to implement this function (it's not virtual), getInfoHTML() is enough.

Definition at line 370 of file RelationsObject.h.

    {
      return _RelationsInterfaceImpl::htmlToPlainText(getInfoHTML());
    }

getInfo() [2/2]

std::string getInfo ( ) const

inlineinherited

Return a short summary of this object's contents in raw text format.

Returns the contents of getInfoHTML() while translating line-breaks etc.

Note

: You don't need to implement this function (it's not virtual), getInfoHTML() is enough.

Definition at line 370 of file RelationsObject.h.

    {
      return _RelationsInterfaceImpl::htmlToPlainText(getInfoHTML());
    }

getInfoHTML() [1/2]

virtual std::string getInfoHTML ( ) const

inlinevirtualinherited

Return a short summary of this object's contents in HTML format.

Reimplement this in your own class to provide useful output for display or debugging purposes. For example, you might do something like:

std::stringstream out;
out << "<b>PDG</b>: " << m_pdg << "<br>";
out << "<b>Covariance Matrix</b>: " << HTML::getString(getCovariance5()) << "<br>";
return out.str();

See also

Particle::getInfoHTML() for a more complex example.

HTML for some utility functions.

Use getInfo() to get a raw text version of this output.

Reimplemented in Cluster, MCParticle, Particle, PIDLikelihood, RecoTrack, SoftwareTriggerResult, Track, TrackFitResult, and TRGSummary.

Definition at line 362 of file RelationsObject.h.

{ return ""; }

getInfoHTML() [2/2]

virtual std::string getInfoHTML ( ) const

inlinevirtualinherited

Return a short summary of this object's contents in HTML format.

Reimplement this in your own class to provide useful output for display or debugging purposes. For example, you might do something like:

std::stringstream out;
out << "<b>PDG</b>: " << m_pdg << "<br>";
out << "<b>Covariance Matrix</b>: " << HTML::getString(getCovariance5()) << "<br>";
return out.str();

See also

Particle::getInfoHTML() for a more complex example.

HTML for some utility functions.

Use getInfo() to get a raw text version of this output.

Reimplemented in Cluster, MCParticle, Particle, PIDLikelihood, RecoTrack, SoftwareTriggerResult, Track, TrackFitResult, and TRGSummary.

Definition at line 362 of file RelationsObject.h.

{ return ""; }

getInnermostLayer()

int getInnermostLayer ( ) const

inline

Get number of the innermost layer with hits.

Returns

Number of the innermost layer with hits.

Definition at line 74 of file KLMCluster.h.

    {return m_innermostLayer;}

getLayers()

int getLayers ( ) const

inline

Get number of layers with hits.

Returns

Number of layers.

Definition at line 67 of file KLMCluster.h.

    {return m_layers;}

getMomentum()

ROOT::Math::PxPyPzEVector getMomentum

(

)

const

Get momentum.

Returns

4-Momentum.

Definition at line 49 of file KLMCluster.cc.

{
  ROOT::Math::XYZVector p3(m_globalX, m_globalY, m_globalZ);
  p3 = p3.Unit() * m_p;
  return ROOT::Math::PxPyPzEVector(p3.X(), p3.Y(), p3.Z(), getEnergy());
}

getMomentumMag()

float getMomentumMag

(

)

const

Get momentum magnitude.

Returns

Absolute value of 3-momentum.

Definition at line 38 of file KLMCluster.cc.

{
  return m_p;
}

getName() [1/2]

virtual std::string getName ( ) const

inlinevirtualinherited

Return a short name that describes this object, e.g.

pi+ for an MCParticle.

Reimplemented in MCParticle, Particle, and SpacePoint.

Definition at line 344 of file RelationsObject.h.

{ return ""; }

getName() [2/2]

virtual std::string getName ( ) const

inlinevirtualinherited

Return a short name that describes this object, e.g.

pi+ for an MCParticle.

Reimplemented in MCParticle, Particle, and SpacePoint.

Definition at line 344 of file RelationsObject.h.

{ return ""; }

getPosition()

ROOT::Math::XYZVector getPosition ( ) const

inline

Get global position (ROOT::Math::XYZVector version) of the origin of KLMCluster (always return (0,0,0) since we believe all KLMClusters to originate at or near primary vertex).

Returns

KLMCluster origin coordinates.

Definition at line 90 of file KLMCluster.h.

    {return ROOT::Math::XYZVector(0, 0, 0);}

getRelated() [1/2]

T * getRelated ( const std::string & name = "", const std::string & namedRelation = "" ) const

inlineinherited

Get the object to or from which this object has a relation.

Template Parameters

T	The class of objects to or from which the relation points.

Parameters

name	The name of the store array to or from which the relation points. If empty the default store array name for class T will be used. If the special name "ALL" is given all store arrays containing objects of type T are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns

The first related object or a null pointer.

Definition at line 278 of file RelationsObject.h.

    {
      return static_cast<T*>(DataStore::Instance().getRelationWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                             T::Class(), name, namedRelation).object);
    }

getRelated() [2/2]

T * getRelated ( const std::string & name = "", const std::string & namedRelation = "" ) const

inlineinherited

Get the object to or from which this object has a relation.

Template Parameters

T	The class of objects to or from which the relation points.

Parameters

name	The name of the store array to or from which the relation points. If empty the default store array name for class T will be used. If the special name "ALL" is given all store arrays containing objects of type T are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns

The first related object or a null pointer.

Definition at line 278 of file RelationsObject.h.

    {
      return static_cast<T*>(DataStore::Instance().getRelationWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                             T::Class(), name, namedRelation).object);
    }

getRelatedFrom() [1/2]

FROM * getRelatedFrom ( const std::string & name = "", const std::string & namedRelation = "" ) const

inlineinherited

Get the object from which this object has a relation.

Template Parameters

FROM	The class of objects from which the relation points.

Parameters

name	The name of the store array from which the relation points. If empty the default store array name for class FROM will be used. If the special name "ALL" is given all store arrays containing objects of type FROM are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns

The first related object or a null pointer.

Definition at line 263 of file RelationsObject.h.

    {
      return static_cast<FROM*>(DataStore::Instance().getRelationWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry,
                                m_cacheArrayIndex, FROM::Class(), name, namedRelation).object);
    }

getRelatedFrom() [2/2]

FROM * getRelatedFrom ( const std::string & name = "", const std::string & namedRelation = "" ) const

inlineinherited

Get the object from which this object has a relation.

Template Parameters

FROM	The class of objects from which the relation points.

Parameters

name	The name of the store array from which the relation points. If empty the default store array name for class FROM will be used. If the special name "ALL" is given all store arrays containing objects of type FROM are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns

The first related object or a null pointer.

Definition at line 263 of file RelationsObject.h.

    {
      return static_cast<FROM*>(DataStore::Instance().getRelationWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry,
                                m_cacheArrayIndex, FROM::Class(), name, namedRelation).object);
    }

getRelatedFromWithWeight() [1/2]

std::pair< FROM *, float > getRelatedFromWithWeight ( const std::string & name = "", const std::string & namedRelation = "" ) const

inlineinherited

Get first related object & weight of relation pointing from an array.

Template Parameters

FROM	The class of objects from which the relation points.

Parameters

name	The name of the store array from which the relation points. If empty the default store array name for class FROM will be used. If the special name "ALL" is given all store arrays containing objects of type FROM are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns

Pair of first related object and the relation weight, or (NULL, 1.0) if none found.

Definition at line 314 of file RelationsObject.h.

    {
      RelationEntry entry = DataStore::Instance().getRelationWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                                                                  FROM::Class(), name, namedRelation);
      return std::make_pair(static_cast<FROM*>(entry.object), entry.weight);
    }

getRelatedFromWithWeight() [2/2]

std::pair< FROM *, float > getRelatedFromWithWeight ( const std::string & name = "", const std::string & namedRelation = "" ) const

inlineinherited

Get first related object & weight of relation pointing from an array.

Template Parameters

FROM	The class of objects from which the relation points.

Parameters

name	The name of the store array from which the relation points. If empty the default store array name for class FROM will be used. If the special name "ALL" is given all store arrays containing objects of type FROM are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns

Pair of first related object and the relation weight, or (NULL, 1.0) if none found.

Definition at line 314 of file RelationsObject.h.

    {
      RelationEntry entry = DataStore::Instance().getRelationWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                                                                  FROM::Class(), name, namedRelation);
      return std::make_pair(static_cast<FROM*>(entry.object), entry.weight);
    }

getRelatedTo() [1/2]

TO * getRelatedTo ( const std::string & name = "", const std::string & namedRelation = "" ) const

inlineinherited

Get the object to which this object has a relation.

Template Parameters

TO	The class of objects to which the relation points.

Parameters

name	The name of the store array to which the relation points. If empty the default store array name for class TO will be used. If the special name "ALL" is given all store arrays containing objects of type TO are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns

The first related object or a null pointer.

Definition at line 248 of file RelationsObject.h.

    {
      return static_cast<TO*>(DataStore::Instance().getRelationWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                              TO::Class(), name, namedRelation).object);
    }

getRelatedTo() [2/2]

TO * getRelatedTo ( const std::string & name = "", const std::string & namedRelation = "" ) const

inlineinherited

Get the object to which this object has a relation.

Template Parameters

TO	The class of objects to which the relation points.

Parameters

name	The name of the store array to which the relation points. If empty the default store array name for class TO will be used. If the special name "ALL" is given all store arrays containing objects of type TO are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns

The first related object or a null pointer.

Definition at line 248 of file RelationsObject.h.

    {
      return static_cast<TO*>(DataStore::Instance().getRelationWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                              TO::Class(), name, namedRelation).object);
    }

getRelatedToWithWeight() [1/2]

std::pair< TO *, float > getRelatedToWithWeight ( const std::string & name = "", const std::string & namedRelation = "" ) const

inlineinherited

Get first related object & weight of relation pointing to an array.

Template Parameters

TO	The class of objects to which the relation points.

Parameters

name	The name of the store array to which the relation points. If empty the default store array name for class TO will be used. If the special name "ALL" is given all store arrays containing objects of type TO are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns

Pair of first related object and the relation weight, or (NULL, 1.0) if none found.

Definition at line 297 of file RelationsObject.h.

    {
      RelationEntry entry = DataStore::Instance().getRelationWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                                                                  TO::Class(), name, namedRelation);
      return std::make_pair(static_cast<TO*>(entry.object), entry.weight);
    }

getRelatedToWithWeight() [2/2]

std::pair< TO *, float > getRelatedToWithWeight ( const std::string & name = "", const std::string & namedRelation = "" ) const

inlineinherited

Get first related object & weight of relation pointing to an array.

Template Parameters

TO	The class of objects to which the relation points.

Parameters

name	The name of the store array to which the relation points. If empty the default store array name for class TO will be used. If the special name "ALL" is given all store arrays containing objects of type TO are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns

Pair of first related object and the relation weight, or (NULL, 1.0) if none found.

Definition at line 297 of file RelationsObject.h.

    {
      RelationEntry entry = DataStore::Instance().getRelationWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                                                                  TO::Class(), name, namedRelation);
      return std::make_pair(static_cast<TO*>(entry.object), entry.weight);
    }

getRelatedWithWeight() [1/2]

std::pair< T *, float > getRelatedWithWeight ( const std::string & name = "", const std::string & namedRelation = "" ) const

inlineinherited

Get first related object & weight of relation pointing from/to an array.

Template Parameters

T	The class of objects to or from which the relation points.

Parameters

name	The name of the store array to or from which the relation points. If empty the default store array name for class T will be used. If the special name "ALL" is given all store arrays containing objects of type T are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns

Pair of first related object and the relation weight, or (NULL, 1.0) if none found.

Definition at line 331 of file RelationsObject.h.

    {
      RelationEntry entry = DataStore::Instance().getRelationWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                                                                  T::Class(), name, namedRelation);
      return std::make_pair(static_cast<T*>(entry.object), entry.weight);
    }

getRelatedWithWeight() [2/2]

std::pair< T *, float > getRelatedWithWeight ( const std::string & name = "", const std::string & namedRelation = "" ) const

inlineinherited

Get first related object & weight of relation pointing from/to an array.

Template Parameters

T	The class of objects to or from which the relation points.

Parameters

name	The name of the store array to or from which the relation points. If empty the default store array name for class T will be used. If the special name "ALL" is given all store arrays containing objects of type T are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns

Pair of first related object and the relation weight, or (NULL, 1.0) if none found.

Definition at line 331 of file RelationsObject.h.

    {
      RelationEntry entry = DataStore::Instance().getRelationWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                                                                  T::Class(), name, namedRelation);
      return std::make_pair(static_cast<T*>(entry.object), entry.weight);
    }

getRelationsFrom() [1/2]

RelationVector< FROM > getRelationsFrom ( const std::string & name = "", const std::string & namedRelation = "" ) const

inlineinherited

Get the relations that point from another store array to this object.

Template Parameters

FROM	The class of objects from which the relations point.

Parameters

name	The name of the store array from which the relations point. If empty the default store array name for class FROM will be used. If the special name "ALL" is given all store arrays containing objects of type FROM are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns

A vector of relations.

Definition at line 212 of file RelationsObject.h.

    {
      return RelationVector<FROM>(DataStore::Instance().getRelationsWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry,
                                  m_cacheArrayIndex, FROM::Class(), name, namedRelation));
    }

getRelationsFrom() [2/2]

RelationVector< FROM > getRelationsFrom ( const std::string & name = "", const std::string & namedRelation = "" ) const

inlineinherited

Get the relations that point from another store array to this object.

Template Parameters

FROM	The class of objects from which the relations point.

Parameters

name	The name of the store array from which the relations point. If empty the default store array name for class FROM will be used. If the special name "ALL" is given all store arrays containing objects of type FROM are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns

A vector of relations.

Definition at line 212 of file RelationsObject.h.

    {
      return RelationVector<FROM>(DataStore::Instance().getRelationsWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry,
                                  m_cacheArrayIndex, FROM::Class(), name, namedRelation));
    }

getRelationsTo() [1/2]

RelationVector< TO > getRelationsTo ( const std::string & name = "", const std::string & namedRelation = "" ) const

inlineinherited

Get the relations that point from this object to another store array.

Template Parameters

TO	The class of objects to which the relations point.

Parameters

name	The name of the store array to which the relations point. If empty the default store array name for class TO will be used. If the special name "ALL" is given all store arrays containing objects of type TO are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns

A vector of relations.

Definition at line 197 of file RelationsObject.h.

    {
      return RelationVector<TO>(DataStore::Instance().getRelationsWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry,
                                m_cacheArrayIndex, TO::Class(), name, namedRelation));
    }

getRelationsTo() [2/2]

RelationVector< TO > getRelationsTo ( const std::string & name = "", const std::string & namedRelation = "" ) const

inlineinherited

Get the relations that point from this object to another store array.

Template Parameters

TO	The class of objects to which the relations point.

Parameters

name	The name of the store array to which the relations point. If empty the default store array name for class TO will be used. If the special name "ALL" is given all store arrays containing objects of type TO are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns

A vector of relations.

Definition at line 197 of file RelationsObject.h.

    {
      return RelationVector<TO>(DataStore::Instance().getRelationsWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry,
                                m_cacheArrayIndex, TO::Class(), name, namedRelation));
    }

getRelationsWith() [1/2]

RelationVector< T > getRelationsWith ( const std::string & name = "", const std::string & namedRelation = "" ) const

inlineinherited

Get the relations between this object and another store array.

Relations in both directions are returned.

Template Parameters

T	The class of objects to or from which the relations point.

Parameters

name	The name of the store array to or from which the relations point. If empty the default store array name for class T will be used. If the special name "ALL" is given all store arrays containing objects of type T are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns

A vector of relations.

Definition at line 230 of file RelationsObject.h.

    {
      return RelationVector<T>(DataStore::Instance().getRelationsWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry,
                               m_cacheArrayIndex, T::Class(), name, namedRelation));
    }

getRelationsWith() [2/2]

RelationVector< T > getRelationsWith ( const std::string & name = "", const std::string & namedRelation = "" ) const

inlineinherited

Get the relations between this object and another store array.

Relations in both directions are returned.

Template Parameters

T	The class of objects to or from which the relations point.

Parameters

name	The name of the store array to or from which the relations point. If empty the default store array name for class T will be used. If the special name "ALL" is given all store arrays containing objects of type T are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns

A vector of relations.

Definition at line 230 of file RelationsObject.h.

    {
      return RelationVector<T>(DataStore::Instance().getRelationsWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry,
                               m_cacheArrayIndex, T::Class(), name, namedRelation));
    }

getShapeStdDev1()

float getShapeStdDev1 ( ) const

inline

Get std deviation of the 1st axis from PCA.

Returns

std deviation of the 1st axis from PCA [cm].

Definition at line 157 of file KLMCluster.h.

{ return m_shapeStdDev1; }

getShapeStdDev2()

float getShapeStdDev2 ( ) const

inline

Get KLM std deviation of the 2nd axis from PCA.

Returns

std deviation of the 2nd axis from PCA.

Definition at line 163 of file KLMCluster.h.

{ return m_shapeStdDev2; }

getShapeStdDev3()

float getShapeStdDev3 ( ) const

inline

Get std deviation of the 3rd axis from PCA.

Returns

std deviation of the 3rd axis from PCA.

Definition at line 169 of file KLMCluster.h.

{ return m_shapeStdDev3; }

getTime()

float getTime ( ) const

inline

Get time.

Returns

Time of decay.

Definition at line 60 of file KLMCluster.h.

    {return m_time;}

setClusterPosition()

void setClusterPosition ( float globalX, float globalY, float globalZ )

inline

Set global position.

Parameters

[in]	globalX	X coordinate [cm].
[in]	globalY	Y coordinate [cm].
[in]	globalZ	Z coordinate [cm].

Definition at line 258 of file KLMCluster.h.

    {
      m_globalX = globalX;
      m_globalY = globalY;
      m_globalZ = globalZ;
    }

setClusterTrackRotationAngle()

void setClusterTrackRotationAngle ( float rotation )

inline

Set KLM cluster-track rotation angle.

Parameters

[in]

rotation

angle to the nearest track.

Definition at line 175 of file KLMCluster.h.

    {
      m_clusterTrackRotationAngle = rotation;
    }

setClusterTrackSeparation()

void setClusterTrackSeparation ( float dist )

inline

Set KLM cluster-track distance.

Parameters

[in]

dist

distance to the nearest track.

Definition at line 193 of file KLMCluster.h.

    {
      m_clusterTrackSeparation = dist;
    }

setClusterTrackSeparationAngle()

void setClusterTrackSeparationAngle ( float separation )

inline

Set KLM cluster-track separation angle.

Parameters

[in]

separation

angle to the nearest track.

Definition at line 184 of file KLMCluster.h.

    {
      m_clusterTrackSeparationAngle = separation;
    }

setInnermostLayer()

void setInnermostLayer ( int innermostLayer )

inline

Set number of the innermost layer with hits.

Parameters

[in]

innermostLayer

Number of the innermost layer with hits.

Definition at line 247 of file KLMCluster.h.

    {
      m_innermostLayer = innermostLayer;
    }

setLayers()

void setLayers ( int layers )

inline

Set number of layers with hits.

Parameters

[in]

layers

Number of layers with hits.

Definition at line 238 of file KLMCluster.h.

    {
      m_layers = layers;
    }

setMomentumMag()

void setMomentumMag ( float momentumMag )

inline

Set momentum magnitude.

Parameters

[in]

momentumMag

Momentum magnitude.

Definition at line 269 of file KLMCluster.h.

    {
      m_p = momentumMag;
    }

setShapeStdDev1()

void setShapeStdDev1 ( float std1 )

inline

Set std deviation of the 1st axis, from PCA.

Parameters

[in]

std1

: std deviation of the 1st axis from PCA [cm].

Definition at line 202 of file KLMCluster.h.

    {
      m_shapeStdDev1 = std1;
    }

setShapeStdDev2()

void setShapeStdDev2 ( float std2 )

inline

Set std deviation of the 2nd axis, from PCA.

Parameters

[in]

std2

: std deviation of the 2nd axis from PCA [cm].

Definition at line 211 of file KLMCluster.h.

    {
      m_shapeStdDev2 = std2;
    }

setShapeStdDev3()

void setShapeStdDev3 ( float std3 )

inline

Set std deviation of the 3rd axis, from PCA.

Parameters

[in]

std3

: std deviation of the 3rd axis from PCA [cm].

Definition at line 220 of file KLMCluster.h.

    {
      m_shapeStdDev3 = std3;
    }

setTime()

void setTime ( float time )

inline

Set time.

Parameters

[in]

time

Time [ns].

Definition at line 229 of file KLMCluster.h.

    {
      m_time = time;
    }

Member Data Documentation

m_cacheArrayIndex [1/2]

int m_cacheArrayIndex

mutableprivateinherited

Cache of the index in the TClonesArray to which this object belongs.

Definition at line 432 of file RelationsObject.h.

m_cacheArrayIndex [2/2]

int m_cacheArrayIndex

mutableprivateinherited

Cache of the index in the TClonesArray to which this object belongs.

Definition at line 432 of file RelationsObject.h.

m_cacheDataStoreEntry [1/2]

DataStore::StoreEntry* m_cacheDataStoreEntry

mutableprivateinherited

Cache of the data store entry to which this object belongs.

Definition at line 429 of file RelationsObject.h.

m_cacheDataStoreEntry [2/2]

DataStore::StoreEntry* m_cacheDataStoreEntry

mutableprivateinherited

Cache of the data store entry to which this object belongs.

Definition at line 429 of file RelationsObject.h.

m_clusterTrackRotationAngle

float m_clusterTrackRotationAngle = Const::floatNaN

private

Track-cluster rotation angle.

Definition at line 298 of file KLMCluster.h.

m_clusterTrackSeparation

float m_clusterTrackSeparation = Const::floatNaN

private

Track-cluster separation (distance).

Definition at line 304 of file KLMCluster.h.

m_clusterTrackSeparationAngle

float m_clusterTrackSeparationAngle = Const::floatNaN

private

Track-cluster separation angle.

Definition at line 301 of file KLMCluster.h.

m_globalX

float m_globalX

private

Global position X coordinate.

Definition at line 286 of file KLMCluster.h.

m_globalY

float m_globalY

private

Global position Y coordinate.

Definition at line 289 of file KLMCluster.h.

m_globalZ

float m_globalZ

private

Global position Z coordinate.

Definition at line 292 of file KLMCluster.h.

m_innermostLayer

int m_innermostLayer

private

Number of the innermost layer with hits.

Definition at line 283 of file KLMCluster.h.

m_layers

int m_layers

private

Number of layers with hits.

Definition at line 280 of file KLMCluster.h.

m_p

float m_p

private

Absolute value of momentum, 0 means unknown.

Definition at line 295 of file KLMCluster.h.

m_shapeStdDev1

float m_shapeStdDev1 = 0

private

Std deviation of axis 1 (from Cluster Shape PCA).

Definition at line 307 of file KLMCluster.h.

m_shapeStdDev2

float m_shapeStdDev2 = 0

private

Std deviation of axis 2 (from Cluster Shape PCA).

Definition at line 310 of file KLMCluster.h.

m_shapeStdDev3

float m_shapeStdDev3 = 0

private

Std deviation of axis 3 (from Cluster Shape PCA).

Definition at line 313 of file KLMCluster.h.

m_time

float m_time

private

Decay time.

Definition at line 277 of file KLMCluster.h.

---

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

• mdst/dataobjects/include/KLMCluster.h
• mdst/dataobjects/src/KLMCluster.cc