State object to store one step in the CKF algorithm together with its parent (the state before), the hit (e.g. More...

#include <CKFState.h>

Classes
struct	stateCache
	Cache containing the most important information of this state which will often be needed. More...

Public Types
using	Seed = ASeed
	Copy the class of the seed track.

using	Hit = AHit
	Copy the class of the hits.

Public Member Functions
	CKFState ()=default
	Default constructor needed for STL containers.

	CKFState (CKFState &&)=default
	Move constructor needed for STL containers.

	CKFState (const CKFState &)=delete
	No copy constructor.

CKFState &	operator= (const CKFState &)=delete
	No copy constructor.

CKFState &	operator= (CKFState &&)=default
	Move assignment constructor.

	~CKFState ()=default
	Destructor.

	CKFState (const Seed *seed)
	Initialize the state as a root without a related hit (but with a seed)

	CKFState (const Hit *hit)
	Initialize the state as non-root with a related hit (and with a seed)

const Seed *	getSeed () const
	Return the track this state is related to.

const Hit *	getHit () const
	Return the SP this state is related to. May be nullptr.

double	getChi2 () const
	Return the chi2 set during fitting. Is only valid after fitting.

void	setChi2 (double chi2)
	Set the chi2 of this state during fitting.

void	setMeasuredStateOnPlane (const genfit::MeasuredStateOnPlane &mSoP)
	Set the mSoP.

const genfit::MeasuredStateOnPlane &	getMeasuredStateOnPlane () const
	Get the mSoP if already set during extrapolation (or fitting)

bool	isFitted () const
	Check if state was already fitted.

bool	mSoPSet () const
	Is the mSoP already set? (= state was already extrapolated)

void	reset ()
	Reset the state to be seen as "new".

TrackFindingCDC::AutomatonCell &	getAutomatonCell ()
	Getter for the automaton cell.

Protected Attributes
stateCache	m_stateCache
	Cache the most important data of this state for better runtime performance.

Private Attributes
const Seed *	m_seed = nullptr
	The seed this state is related with.

const Hit *	m_hit = nullptr
	The hit object this state is attached to.

double	m_chi2 = 0
	Chi2 of this special state with this hit and this reco track. Will only be set after fitting state.

genfit::MeasuredStateOnPlane	m_measuredStateOnPlane
	MSoP after advancing. Is undetermined before extrapolating!

TrackFindingCDC::AutomatonCell	m_automatonCell
	Memory for the automaton cell.

bool	m_isFitted = false
	Flag, if this state was already fitted.

bool	m_hasMSoP = false
	Flag, if this state has a valid mSoP.

Detailed Description

template<class ASeed, class AHit>
class Belle2::CKFState< ASeed, AHit >

State object to store one step in the CKF algorithm together with its parent (the state before), the hit (e.g.

a space point) and the seed (e.g. a cdc reco track).

Please remember: the states are reused during the algorithm and only once constructed (in the C++ sense).

Definition at line 29 of file CKFState.h.

Member Typedef Documentation

◆ Hit

using Hit = AHit

Copy the class of the hits.

Definition at line 34 of file CKFState.h.

◆ Seed

using Seed = ASeed

Copy the class of the seed track.

Definition at line 32 of file CKFState.h.

Constructor & Destructor Documentation

◆ CKFState() [1/2]

CKFState ( const Seed * seed )

inlineexplicit

Initialize the state as a root without a related hit (but with a seed)

Definition at line 50 of file CKFState.h.

                                        : m_seed(seed)
    {
    }

◆ CKFState() [2/2]

CKFState ( const Hit * hit )

inlineexplicit

Initialize the state as non-root with a related hit (and with a seed)

Definition at line 55 of file CKFState.h.

                                      : m_hit(hit)
    {
    }

Member Function Documentation

◆ getAutomatonCell()

TrackFindingCDC::AutomatonCell & getAutomatonCell ( )

inline

Getter for the automaton cell.

Definition at line 119 of file CKFState.h.

    {
      return m_automatonCell;
    }

◆ getChi2()

double getChi2 ( ) const

inline

Return the chi2 set during fitting. Is only valid after fitting.

Definition at line 72 of file CKFState.h.

    {
      B2ASSERT("Chi2 is not set", isFitted());
      return m_chi2;
    }

◆ getHit()

const Hit * getHit ( ) const

inline

Return the SP this state is related to. May be nullptr.

Definition at line 66 of file CKFState.h.

    {
      return m_hit;
    }

◆ getMeasuredStateOnPlane()

const genfit::MeasuredStateOnPlane & getMeasuredStateOnPlane ( ) const

inline

Get the mSoP if already set during extrapolation (or fitting)

Definition at line 93 of file CKFState.h.

    {
      B2ASSERT("You are asking for an invalid variable!", mSoPSet());
      return m_measuredStateOnPlane;
    }

◆ getSeed()

const Seed * getSeed ( ) const

inline

Return the track this state is related to.

Definition at line 60 of file CKFState.h.

    {
      return m_seed;
    }

◆ isFitted()

bool isFitted ( ) const

inline

Check if state was already fitted.

Definition at line 100 of file CKFState.h.

    {
      return m_isFitted;
    }

◆ mSoPSet()

bool mSoPSet ( ) const

inline

Is the mSoP already set? (= state was already extrapolated)

Definition at line 106 of file CKFState.h.

    {
      return m_hasMSoP;
    }

◆ reset()

void reset ( )

inline

Reset the state to be seen as "new".

Definition at line 112 of file CKFState.h.

    {
      m_isFitted = false;
      m_hasMSoP = false;
    }

◆ setChi2()

void setChi2 ( double chi2 )

inline

Set the chi2 of this state during fitting.

Definition at line 79 of file CKFState.h.

    {
      m_chi2 = chi2;
      m_isFitted = true;
    }

◆ setMeasuredStateOnPlane()

void setMeasuredStateOnPlane ( const genfit::MeasuredStateOnPlane & mSoP )

inline

Set the mSoP.

Definition at line 86 of file CKFState.h.

    {
      m_measuredStateOnPlane = mSoP;
      m_hasMSoP = true;
    }

Member Data Documentation

◆ m_automatonCell

TrackFindingCDC::AutomatonCell m_automatonCell

private

Memory for the automaton cell.

Definition at line 167 of file CKFState.h.

◆ m_chi2

double m_chi2 = 0

private

Chi2 of this special state with this hit and this reco track. Will only be set after fitting state.

Definition at line 163 of file CKFState.h.

◆ m_hasMSoP

bool m_hasMSoP = false

private

Flag, if this state has a valid mSoP.

Definition at line 171 of file CKFState.h.

◆ m_hit

const Hit* m_hit = nullptr

private

The hit object this state is attached to.

Definition at line 161 of file CKFState.h.

◆ m_isFitted

bool m_isFitted = false

private

Flag, if this state was already fitted.

Definition at line 169 of file CKFState.h.

◆ m_measuredStateOnPlane

genfit::MeasuredStateOnPlane m_measuredStateOnPlane

private

MSoP after advancing. Is undetermined before extrapolating!

Definition at line 165 of file CKFState.h.

◆ m_seed

const Seed* m_seed = nullptr

private

The seed this state is related with.

Definition at line 159 of file CKFState.h.

◆ m_stateCache

stateCache m_stateCache

protected

Cache the most important data of this state for better runtime performance.

Definition at line 154 of file CKFState.h.

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

tracking/ckf/general/entities/include/CKFState.h

Classes

Public Types

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Hit

◆ Seed

Constructor & Destructor Documentation

◆ CKFState() [1/2]

◆ CKFState() [2/2]

Member Function Documentation

◆ getAutomatonCell()

◆ getChi2()

◆ getHit()

◆ getMeasuredStateOnPlane()

◆ getSeed()

◆ isFitted()

◆ mSoPSet()

◆ reset()

◆ setChi2()

◆ setMeasuredStateOnPlane()

Member Data Documentation

◆ m_automatonCell

◆ m_chi2

◆ m_hasMSoP

◆ m_hit

◆ m_isFitted

◆ m_measuredStateOnPlane

◆ m_seed

◆ m_stateCache