KinematicParticle Class Reference

#include <KinematicParticle.h>

Inheritance diagram for KinematicParticle:

Public Types
typedef ReferenceCountingPointer< LinearizedTrackState< 6 > >	RefCountedLinearizedTrackState

Public Member Functions
virtual float	chiSquared () const
virtual KinematicTree *	correspondingTree () const
virtual KinematicState	currentState () const
virtual float	degreesOfFreedom () const
virtual KinematicState	initialState () const
	KinematicParticle ()
virtual KinematicConstraint *	lastConstraint () const
const MagneticField *	magneticField () const
virtual bool	operator!= (const KinematicParticle &other) const =0
virtual bool	operator< (const KinematicParticle &other) const
virtual bool	operator== (const KinematicParticle &other) const =0
virtual bool	operator== (const ReferenceCountingPointer< KinematicParticle > &other) const =0
virtual RefCountedLinearizedTrackState	particleLinearizedTrackState (const GlobalPoint &point) const =0
virtual ReferenceCountingPointer< KinematicParticle >	previousParticle () const
virtual ReferenceCountingPointer< KinematicParticle >	refittedParticle (const KinematicState &state, float chi2, float ndf, KinematicConstraint *cons=nullptr) const =0
reco::TransientTrack	refittedTransientTrack () const
virtual KinematicState	stateAtPoint (const GlobalPoint &point) const =0
	~KinematicParticle () override

Protected Member Functions
virtual void	setTreePointer (KinematicTree *tr) const

Protected Attributes
float	chi2
KinematicState	cState
KinematicState	initState
KinematicConstraint *	lConstraint
float	ndf
ReferenceCountingPointer< KinematicParticle >	pState
const MagneticField *	theField
KinematicTree *	tree

Friends
class	KinematicParticleVertexFitter
class	KinematicTree

Detailed Description

Definition at line 21 of file KinematicParticle.h.

Member Typedef Documentation

RefCountedLinearizedTrackState

typedef ReferenceCountingPointer<LinearizedTrackState<6> > KinematicParticle::RefCountedLinearizedTrackState

Definition at line 23 of file KinematicParticle.h.

Constructor & Destructor Documentation

KinematicParticle()

KinematicParticle::KinematicParticle ( )

inline

Default constructor: does not create a valid particle. Method is needed for debugging purposes only.

Definition at line 33 of file KinematicParticle.h.

{}

~KinematicParticle()

KinematicParticle::~KinematicParticle ( )

override

Definition at line 5 of file KinematicParticle.cc.

References lConstraint.

{ delete lConstraint; }

Member Function Documentation

chiSquared()

float KinematicParticle::chiSquared ( ) const

virtual

Access metods for chi2 and number of degrees of freedom

Definition at line 24 of file KinematicParticle.cc.

References chi2.

Referenced by VirtualKinematicParticle::VirtualKinematicParticle().

{ return chi2; }

correspondingTree()

KinematicTree * KinematicParticle::correspondingTree ( ) const

virtual

Returns the pointer to the kinematic tree (if any) current particle belongs to 0 pointer returned in case not any tree is built yet

Definition at line 22 of file KinematicParticle.cc.

References tree.

{ return tree; }

currentState()

KinematicState KinematicParticle::currentState ( ) const

virtual

Access to the last calculated kinematic state

Definition at line 16 of file KinematicParticle.cc.

References cState.

Referenced by refittedTransientTrack().

{ return cState; }

degreesOfFreedom()

float KinematicParticle::degreesOfFreedom ( ) const

virtual

Definition at line 26 of file KinematicParticle.cc.

References ndf.

{ return ndf; }

initialState()

KinematicState KinematicParticle::initialState ( ) const

virtual

Access to the kinematic state with which particle was first created

Definition at line 14 of file KinematicParticle.cc.

References initState.

Referenced by VirtualKinematicParticle::operator==(), and TransientTrackKinematicParticle::operator==().

{ return initState; }

lastConstraint()

KinematicConstraint * KinematicParticle::lastConstraint ( ) const

virtual

Returns last constraint aplied to this particle.

Definition at line 18 of file KinematicParticle.cc.

References lConstraint.

Referenced by VirtualKinematicParticle::VirtualKinematicParticle().

{ return lConstraint; }

magneticField()

const MagneticField* KinematicParticle::magneticField ( ) const

inline

Definition at line 122 of file KinematicParticle.h.

References theField.

{ return theField; }

operator!=()

virtual bool KinematicParticle::operator!= ( const KinematicParticle &  other ) const

pure virtual

Implemented in TransientTrackKinematicParticle, and VirtualKinematicParticle.

operator<()

bool KinematicParticle::operator< ( const KinematicParticle &  other ) const

virtual

Comparison by adress operator Has NO physical meaning To be used inside graph only

Definition at line 7 of file KinematicParticle.cc.

References trackingPlots::other.

                                                                      {
  bool res = false;
  if (this < &other)
    res = true;
  return res;
}

operator==() [1/2]

virtual bool KinematicParticle::operator== ( const KinematicParticle &  other ) const

pure virtual

Comparison by contents operators Returns TRUE if initial PhysicsObjects match(if they exist). If not, compares the initial KinematicStates Retunes true if they match. Should be implemented by user

Implemented in TransientTrackKinematicParticle, and VirtualKinematicParticle.

operator==() [2/2]

virtual bool KinematicParticle::operator== ( const ReferenceCountingPointer< KinematicParticle > &  other ) const

pure virtual

Implemented in TransientTrackKinematicParticle, and VirtualKinematicParticle.

particleLinearizedTrackState()

virtual RefCountedLinearizedTrackState KinematicParticle::particleLinearizedTrackState ( const GlobalPoint &  point ) const

pure virtual

Method returning LinearizedTrackState of the particle needed for Kalman flter vertex fit. Should be implemented by user. For track(helix)-like objects one can use the ParticleLinearizedTrackStateFactory class.

Implemented in TransientTrackKinematicParticle, and VirtualKinematicParticle.

previousParticle()

ReferenceCountingPointer< KinematicParticle > KinematicParticle::previousParticle ( ) const

virtual

Returns the state of Kinematic Particle before last constraint was aplied

Definition at line 20 of file KinematicParticle.cc.

References pState.

Referenced by VirtualKinematicParticle::VirtualKinematicParticle().

{ return pState; }

refittedParticle()

virtual ReferenceCountingPointer<KinematicParticle> KinematicParticle::refittedParticle ( const KinematicState &  state, float  chi2, float  ndf, KinematicConstraint *  cons = nullptr  ) const

pure virtual

Method producing new particle out of the current one and RefittedState obtained from kinematic fitting. To be used by Fitter classes only. Method should be implemented by used for every specific type of KinematicParticle

Implemented in TransientTrackKinematicParticle, and VirtualKinematicParticle.

refittedTransientTrack()

reco::TransientTrack KinematicParticle::refittedTransientTrack

(

)

const

Definition at line 30 of file KinematicParticle.cc.

References TransientTrackFromFTSFactory::build(), and currentState().

Referenced by KinematicVertex::operator reco::Vertex().

                                                                   {
  TransientTrackFromFTSFactory factory;
  return factory.build(currentState().freeTrajectoryState());
}

setTreePointer()

void KinematicParticle::setTreePointer ( KinematicTree *  tr ) const

protectedvirtual

Definition at line 28 of file KinematicParticle.cc.

{ tree = tr; }

stateAtPoint()

virtual KinematicState KinematicParticle::stateAtPoint ( const GlobalPoint &  point ) const

pure virtual

Access to KinematicState of particle at given point. The current state of particle does not change after this operation.

Implemented in TransientTrackKinematicParticle, and VirtualKinematicParticle.

Friends And Related Function Documentation

KinematicParticleVertexFitter

friend class KinematicParticleVertexFitter

friend

Definition at line 25 of file KinematicParticle.h.

KinematicTree

friend class KinematicTree

friend

Definition at line 26 of file KinematicParticle.h.

Member Data Documentation

chi2

float KinematicParticle::chi2

protected

Definition at line 154 of file KinematicParticle.h.

Referenced by chiSquared(), VirtualKinematicParticle::refittedParticle(), and VirtualKinematicParticle::VirtualKinematicParticle().

cState

KinematicState KinematicParticle::cState

mutableprotected

Definition at line 151 of file KinematicParticle.h.

Referenced by currentState(), VirtualKinematicParticle::stateAtPoint(), and VirtualKinematicParticle::VirtualKinematicParticle().

initState

KinematicState KinematicParticle::initState

protected

Definition at line 148 of file KinematicParticle.h.

Referenced by initialState(), and VirtualKinematicParticle::VirtualKinematicParticle().

lConstraint

KinematicConstraint* KinematicParticle::lConstraint

mutableprotected

Definition at line 141 of file KinematicParticle.h.

Referenced by lastConstraint(), VirtualKinematicParticle::VirtualKinematicParticle(), and ~KinematicParticle().

ndf

float KinematicParticle::ndf

protected

Definition at line 156 of file KinematicParticle.h.

Referenced by degreesOfFreedom(), VirtualKinematicParticle::refittedParticle(), and VirtualKinematicParticle::VirtualKinematicParticle().

pState

ReferenceCountingPointer<KinematicParticle> KinematicParticle::pState

mutableprotected

Definition at line 144 of file KinematicParticle.h.

Referenced by previousParticle(), and VirtualKinematicParticle::VirtualKinematicParticle().

theField

const MagneticField* KinematicParticle::theField

protected

Data members which should be initialized by user in derived classes

Definition at line 134 of file KinematicParticle.h.

Referenced by magneticField(), and VirtualKinematicParticle::VirtualKinematicParticle().

tree

KinematicTree* KinematicParticle::tree

mutableprotected

Definition at line 138 of file KinematicParticle.h.

Referenced by svgfig.SVG::__str__(), ZJetsTreeAnalyzer.ZJetsTreeAnalyzer::beginLoop(), correspondingTree(), MetTreeProducer.MetTreeProducer::declareVariables(), core.AutoFillTreeProducer.AutoFillTreeProducer::declareVariables(), core.AutoFillTreeProducer.AutoFillTreeProducer::fillTree(), ZJetsTreeAnalyzer.ZJetsTreeAnalyzer::process(), MetTreeProducer.MetTreeProducer::process(), and python.cmstools.EventTree::SetAlias().