RestFrames::LabRecoFrame Class Reference

Detailed Description

Definition at line 44 of file LabRecoFrame.hh.

Inheritance diagram for RestFrames::LabRecoFrame:

Public Member Functions
	LabRecoFrame (const std::string &sname, const std::string &stitle)
	Standard constructor. More...
	LabRecoFrame ()
	Empty constructor.
virtual void	Clear ()
	Clears LabRecoFrame from all connections to other objects.
virtual bool	InitializeAnalysis ()
	Initialize analysis capability of a tree to reconstruct events. More...
virtual bool	ClearEvent ()
	Clears event. More...
virtual bool	AnalyzeEvent ()
	Analyzes event. More...
void	AddTreeState (VisibleState &state) const
	Adds a state to "VisibleStateList" of this frame. More...
void	AddTreeStates (const VisibleStateList &states) const
	Adds states to "VisibleStateList" of this frame. More...
void	RemoveTreeState (const VisibleState &state) const
	Removes a state from "VisibleStateList" of this frame. More...
void	RemoveTreeStates (const VisibleStateList &states) const
	Removes states from "VisibleStateList" of this frame. More...
VisibleStateList const &	GetTreeStates () const
	Returns list of visible states of this frame. More...
Public Member Functions inherited from RestFrames::LabFrame< ReconstructionFrame >
	LabFrame (const std::string &sname, const std::string &stitle)
	Standard constructor. More...
	LabFrame ()
	Empty constructor.
void	SetChildFrame (RestFrame &frame)
	Sets child of this frame. More...
virtual bool	InitializeTree ()
	Method to initialize tree. More...
TVector3	GetInvisibleMomentum () const
	Returns invisible momentum vector of this RestFrame. More...
Public Member Functions inherited from RestFrames::ReconstructionFrame
	ReconstructionFrame (const std::string &sname, const std::string &stitle)
	Standard constructor. More...
	ReconstructionFrame ()
	Empty constructor.
virtual void	AddChildFrame (RestFrame &frame)
	Add a child RestFrame to this frame. More...
virtual void	RemoveChildFrame (RestFrame &frame)
	Remove a child of this frame. More...
void	RemoveChildFrames ()
	Remove all the children of this frame. More...
virtual void	SetParentFrame (RestFrame &frame=RestFrame::Empty())
	Set the parent frame for this frame. More...
virtual ReconstructionFrame const &	GetParentFrame () const
	Returns the parent of this frame. More...
virtual ReconstructionFrame &	GetChildFrame (int i=0) const
	Get the frame of the i th child. More...
virtual void	SetGroup (Group &group=Group::Empty())
	Sets group of this frame. More...
Group &	GetGroup () const
	Returns group of this class. More...
GroupList	GetListGroups () const
	Returns a list of groups (GroupList) of this class. More...
Public Member Functions inherited from RestFrames::RestFrame
	RestFrame (const std::string &sname, const std::string &stitle)
	Standard constructor. More...
	RestFrame ()
	Empty constructor.
FrameType	GetType () const
	Returns RestFrame (FrameType) type.
bool	IsVisibleFrame () const
	Is this a VisibleFrame ? (yes/no)
bool	IsInvisibleFrame () const
	Is this an InvisibleFrame ? (yes/no)
bool	IsDecayFrame () const
	Is this a DecayFrame ? (yes/no)
bool	IsLabFrame () const
	Is this a LabFrame ? (yes/no)
bool	IsRecoFrame () const
	Is this an ReconstructionFrame ? (yes/no)
bool	IsGenFrame () const
	Is this a GeneratorFrame ? (yes/no)
virtual std::string	PrintString (LogType type) const
	String of information about RestFrame.
void	AddChildFrames (const RestFrameList &frames)
	Adds a list of children to this frame. More...
void	RemoveChildFrame (RestFrame &frame)
	Removes a child of this frame. More...
void	RemoveChildFrames ()
	Removes all the children of this frame. More...
int	GetNChildren () const
	Returns the number of child frames inheriting from this one.
int	GetNDescendants () const
	Returns the number of descendents of this frame.
RestFrameList const &	GetChildFrames () const
	Returns a list of this frame's child RestFrames. More...
virtual RestFrame const &	GetLabFrame () const
	Returns the LabFrame that this frame inherits from. More...
virtual RestFrame const &	GetProductionFrame () const
	Returns the production frame of this frame. More...
virtual RestFrame const &	GetSiblingFrame () const
	Returns the sibling frame of this frame. More...
int	GetFrameDepth (const RestFrame &frame) const
	Returns the depth of frame More...
virtual RestFrame const &	GetFrameAtDepth (int depth, const RestFrame &frame) const
	Returns the frame at depth. More...
virtual RestFrameList	GetListFrames (FrameType type=kLabFrame) const
	Returns a list of frames inheriting from this one. More...
virtual RestFrameList	GetListVisibleFrames () const
	Returns a list of VisibleFrame s inheriting from this.
virtual RestFrameList	GetListInvisibleFrames () const
	Returns a list of InvisibleFrame s inheriting from this.
RestFrameList	operator+ (RestFrame &frame)
	Combines RestFrames into RestFrameList. More...
RestFrameList	operator+ (const RestFrameList &frames)
	Combines RestFrames into RestFrameList. More...
virtual RFCharge	GetCharge () const
	Returns the charge of this frame. More...
virtual double	GetMass () const
	Returns the mass of this frame. More...
TLorentzVector	GetFourVector (const RestFrame &frame=RestFrame::Empty()) const
	Returns this frame's four-vector in a specified frame. More...
TLorentzVector	GetTransverseFourVector (const RestFrame &frame=RestFrame::Empty(), const TVector3 &axis=RestFrame::GetAxis(), const RestFrame &axis_frame=RestFrame::Empty()) const
	Returns this frame's four-vector in a specified frame. More...
TLorentzVector	GetVisibleFourVector (const RestFrame &frame=RestFrame::Empty()) const
	Returns four-vector of visible descendants. More...
TLorentzVector	GetInvisibleFourVector (const RestFrame &frame=RestFrame::Empty()) const
	Returns four-vector of invisible descendants. More...
double	GetEnergy (const RestFrame &frame) const
	Returns energy of this frame in specified reference frame. More...
double	GetMomentum (const RestFrame &frame) const
	Returns magnitude of momentum. More...
TLorentzVector	GetFourVector (const TLorentzVector &P, const RestFrame &def_frame=RestFrame::Empty()) const
	Returns four vector boosted to different frame. More...
TLorentzVector	GetTransverseFourVector (const TLorentzVector &P, const TVector3 &axis=RestFrame::GetAxis(), const RestFrame &axis_frame=RestFrame::Empty()) const
	Returns transverse four vector in this frame.
double	GetTransverseMomentum (const RestFrame &frame=RestFrame::Empty(), const TVector3 &axis=RestFrame::GetAxis(), const RestFrame &axis_frame=RestFrame::Empty()) const
	Returns magnitude of transverse momentum. More...
double	GetTransverseMomentum (const TLorentzVector &P, const TVector3 &axis=RestFrame::GetAxis(), const RestFrame &axis_frame=RestFrame::Empty()) const
	Returns magnitude of transverse momentum of this frame. More...
double	GetVisibleShape () const
	Returns visible shape of frame. More...
double	GetSumVisibleMomentum () const
	Returns scalar sum of visible child momenta. More...
double	GetSumInvisibleMomentum () const
	Returns scalar sum of invisible child momenta. More...
TVector3	GetBoostInParentFrame () const
	Returns the boost of this frame in it's parent's frame. More...
double	GetGammaInParentFrame () const
	Returns the gamma of this frame in its parent's frame. More...
TVector3	GetDecayPlaneNormalVector (const RestFrame &frame=RestFrame::Empty()) const
	Returns the vector normal to the decay plane of this frame. More...
double	GetDeltaPhiDecayPlanes (const RestFrame &frame) const
	Returns difference of azimuthal angle between decay planes. More...
double	GetCosDecayAngle (const RestFrame &frame=RestFrame::Empty()) const
	Returns the cosine of this frame's decay angle. More...
double	GetDeltaPhiDecayAngle (const TVector3 &axis=RestFrame::GetAxis(), const RestFrame &frame=RestFrame::Empty()) const
	Returns difference of azimuthal decay angles in an axis. More...
double	GetDeltaPhiBoostVisible (const TVector3 &axis=RestFrame::GetAxis(), const RestFrame &frame=RestFrame::Empty()) const
	Returns difference of azimuthal angles between the decay angles of the visible particles decaying from this frame. More...
double	GetDeltaPhiDecayVisible (const TVector3 &axis=RestFrame::GetAxis(), const RestFrame &frame=RestFrame::Empty()) const
	Returns difference of azimuthal angles between the decay angles of the visible particles decaying from this frame. More...
double	GetDeltaPhiVisible (const TVector3 &axis=RestFrame::GetAxis(), const RestFrame &frame=RestFrame::Empty()) const
	Returns difference of azimuthal angles between the angles of its visible particles kids. More...
Public Member Functions inherited from RestFrames::RFBase
	RFBase (const std::string &sname, const std::string &stitle, int key)
	Standard constructor. More...
	RFBase ()
	Empty constructor.
bool	IsEmpty () const
	Checks whether this is default (empty) instance of class.
bool	operator! () const
	Tests whether key is the same as this.
void	Print (LogType type) const
	Print information associated with object.
RFKey	GetKey () const
	gets object identification key
std::string	GetName () const
	Returns object name.
std::string	GetTitle () const
	Returns object title.
bool	IsSame (const RFKey &key) const
	Tests whether key is the same as this.
bool	IsSame (const RFBase &obj) const
	Tests whether obj is the same as this.
bool	operator== (const RFKey &key) const
	Tests whether key is the same as this.
bool	operator== (const RFBase &obj) const
	Tests whether obj is the same as this.
bool	operator!= (const RFKey &key) const
	Tests whether key is the same as this.
bool	operator!= (const RFBase &obj) const
	Tests whether obj is the same as this.

Protected Member Functions
bool	InitializeTreeStates ()
bool	InitializeTreeGroups ()
bool	InitializeTreeJigsaws ()
bool	ExecuteJigsaws ()
Protected Member Functions inherited from RestFrames::LabFrame< ReconstructionFrame >
virtual bool	IsSoundBody () const
Protected Member Functions inherited from RestFrames::ReconstructionFrame
bool	InitializeAnalysisRecursive ()
	Recursively initialize this frame and its children for analysis.
bool	ClearEventRecursive ()
	Recursively clear event information from this frame and its children.
bool	AnalyzeEventRecursive ()
	Recursively analyze event in this frame and its children.
virtual bool	ResetRecoFrame ()
virtual bool	ReconstructFrame ()
virtual StateList const &	GetChildStates (int i=0) const
virtual StateList const &	GetChildStates (const RestFrame &child) const
Protected Member Functions inherited from RestFrames::RestFrame
virtual bool	IsSoundBody () const
TVector3 const &	GetChildBoostVector (RestFrame &frame) const
TVector3 const &	GetParentBoostVector () const
virtual bool	InitializeTreeRecursive ()
	Recursively initialize this frame's tree.
bool	IsCircularTree (std::vector< RFKey > &keys) const
	Check this RestFrame 's tree for circular connections.
Protected Member Functions inherited from RestFrames::RFBase
bool	SetBody (bool body) const
bool	SetMind (bool mind) const
bool	SetSpirit (bool spirit) const
virtual bool	IsSoundMind () const
virtual bool	IsSoundSpirit () const
void	UnSoundBody (const std::string &function) const
void	UnSoundMind (const std::string &function) const
void	UnSoundSpirit (const std::string &function) const
void	AddDependent (RFBase *dep)
	pointer to RFBase object owned by this one

Protected Attributes
GroupList	m_TreeGroups
JigsawList	m_TreeJigsaws
VisibleStateList	m_TreeStates
Protected Attributes inherited from RestFrames::RestFrame
FrameType	m_Type
AnaType	m_Ana
Protected Attributes inherited from RestFrames::RFBase
RFLog	m_Log
RFBase *	m_This

Additional Inherited Members
Static Public Member Functions inherited from RestFrames::ReconstructionFrame
static ReconstructionFrame &	Empty ()
	Returns empty ReconstructionFrame. More...
Static Public Member Functions inherited from RestFrames::RestFrame
static void	SetAxis (const TVector3 &axis)
	Set axis perpendicular to transverse plane. More...
static TVector3 const &	GetAxis ()
	Retrieve axis which defines transverse plane. More...
static RestFrame &	Empty ()
	Returns empty RestFrame. More...
static ConstRestFrameList const &	EmptyList ()
	Returns empty RestFrameList. More...
Static Public Member Functions inherited from RestFrames::RFBase
static RFBase &	Empty ()
	Returns empty RFBase. More...
Static Protected Attributes inherited from RestFrames::RFBase
static const TVector3	m_Empty3Vector
static const TLorentzVector	m_Empty4Vector

Constructor & Destructor Documentation

LabRecoFrame()

RestFrames::LabRecoFrame::LabRecoFrame	(	const std::string &	sname,
		const std::string &	stitle
	)

Standard constructor.

Parameters

sname	Class instance name used for log statements
stitle	Class instance title used in figures

Definition at line 41 of file LabRecoFrame.cc.

Member Function Documentation

AddTreeState()

void RestFrames::LabRecoFrame::AddTreeState

(

VisibleState &

state

)

const

Adds a state to "VisibleStateList" of this frame.

Parameters

state

State to be added

Definition at line 58 of file LabRecoFrame.cc.

AddTreeStates()

void RestFrames::LabRecoFrame::AddTreeStates

(

const VisibleStateList &

states

)

const

Adds states to "VisibleStateList" of this frame.

Parameters

states

States to be added

Definition at line 62 of file LabRecoFrame.cc.

AnalyzeEvent()

bool RestFrames::LabRecoFrame::AnalyzeEvent ( )

virtual

Analyzes event.

Returns

True if method was successful else false

Warning

AnalyzeEvent() can only be called after successful call to InitalizeAnalysis()

Implements RestFrames::LabFrame< ReconstructionFrame >.

Definition at line 251 of file LabRecoFrame.cc.

ClearEvent()

bool RestFrames::LabRecoFrame::ClearEvent ( )

virtual

Clears event.

Returns

True if method was successful else false

Warning

ClearEvent() can only be called after successful call to InitalizeAnalysis()

Implements RestFrames::LabFrame< ReconstructionFrame >.

Definition at line 233 of file LabRecoFrame.cc.

GetTreeStates()

VisibleStateList const & RestFrames::LabRecoFrame::GetTreeStates

(

)

const

Returns list of visible states of this frame.

Returns

List of visible states of this frame

Definition at line 74 of file LabRecoFrame.cc.

InitializeAnalysis()

bool RestFrames::LabRecoFrame::InitializeAnalysis ( )

virtual

Initialize analysis capability of a tree to reconstruct events.

Returns

True if method was successful else False

Warning

InitializeAnalysis() can only be called after successful call to LabFrame::InitializeTree()

Implements RestFrames::LabFrame< ReconstructionFrame >.

Definition at line 78 of file LabRecoFrame.cc.

RemoveTreeState()

void RestFrames::LabRecoFrame::RemoveTreeState

(

const VisibleState &

state

)

const

Removes a state from "VisibleStateList" of this frame.

Parameters

state

State to be removed

Definition at line 66 of file LabRecoFrame.cc.

RemoveTreeStates()

void RestFrames::LabRecoFrame::RemoveTreeStates

(

const VisibleStateList &

states

)

const

Removes states from "VisibleStateList" of this frame.

Parameters

states

States to be removed

Definition at line 70 of file LabRecoFrame.cc.

Collaboration diagram for RestFrames::LabRecoFrame:

---

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

• inc/RestFrames/LabRecoFrame.hh
• src/LabRecoFrame.cc