Detailed Description

Definition at line 41 of file LabGenFrame.hh.

Inheritance diagram for RestFrames::LabGenFrame:

[legend]

Public Member Functions
	LabGenFrame (const std::string &sname, const std::string &stitle)
	Standard constructor. More...

virtual void	Clear ()
	Clears LabGenFrame from all connections to other objects

virtual bool	InitializeAnalysis ()
	Initialize analysis capability of a tree to generate events. More...

virtual bool	ClearEvent ()
	Clears event. More...

virtual bool	AnalyzeEvent ()
	Analyzes event. More...

virtual void	SetThreeVector (const TVector3 &P)
	Sets momentum's three-vector of this frame. More...

virtual void	SetTransverseMomentum (double val)
	Sets transverse momentum of this frame. More...

virtual void	SetLongitudinalMomentum (double val)
	Sets longitudinal momentum of this frame. More...

virtual void	SetPhi (double val)
	Sets phi of this frame. More...

virtual void	SetPToverM (double val)
	Sets transverse momentum over mass. More...

void	SetN_MCMCBurnIn (int N)
	Sets number of events to be thrown away before keeping any. More...

void	SetN_MCMCDiscard (int N)
	Sets which Nth events to keep. More...

void	SetFailTolerance (int N)
	Sets tolerance number of fail events before stopping the generation. More...

Public Member Functions inherited from RestFrames::LabFrame< GeneratorFrame >
	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::GeneratorFrame
	GeneratorFrame (const std::string &sname, const std::string &stitle)
	Standard constructor. More...

	GeneratorFrame ()
	Empty constructor.

virtual void	AddChildFrame (RestFrame &frame)
	Adds a child RestFrame to this frame. More...

virtual void	SetParentFrame (RestFrame &frame=RestFrame::Empty())
	Set the parent frame for this frame. More...

virtual GeneratorFrame const &	GetParentFrame () const
	Returns the parent of this frame. More...

virtual GeneratorFrame &	GetChildFrame (int i=0) const
	Returns the frame of the i th child. More...

void	SetPCut (double cut)
	Sets momentum cut. More...

void	SetPtCut (double cut)
	Sets transverse momentum cut. More...

void	SetEtaCut (double cut)
	Sets pseudorapidity cut. More...

void	SetMassWindowCut (double min, double max)
	Sets mass frame cut. More...

void	RemovePCut ()
	Removes momentum cut.

void	RemovePtCut ()
	Removes transverse momentum cut.

void	RemoveEtaCut ()
	Removes pseudorapidity cut.

void	RemoveMassWindowCut ()
	Removes mass frame cuts.

void	PrintGeneratorEfficiency () const
	Print generator efficiency information.

virtual double	GetMass () const
	Get the mass of this frame.

bool	IsVariableMassMCMC () const
	Is this frame capable having a variable mass? (true/false)

virtual double	GetMinimumMassMCMC () const
	Returns minimun mass of Markov Chain MonteCarlo event generation.

virtual void	GenerateMassMCMC (double &mass, double &prob, double max=-1.) const
	Generates mass for Markov Chain MonteCarlo event generation.

virtual double	GetProbMCMC (double mass=-1.) const
	Evaluates probability of the state is in right now or the probablility of a state it could go in.

double	GetRandom () const
	Returns random value. More...

double	GetGaus (double mu, double sig) const
	Returns gaussian random number. 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...

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
virtual bool	InitializeGenAnalysis ()

virtual void	ResetGenFrame ()

virtual bool	GenerateFrame ()

virtual bool	IterateMCMC ()

Protected Member Functions inherited from RestFrames::LabFrame< GeneratorFrame >
virtual bool	IsSoundBody () const

Protected Member Functions inherited from RestFrames::GeneratorFrame
bool	InitializeAnalysisRecursive ()
	Recursively initialize this frame and its children for analysis.

bool	AnalyzeEventRecursive ()
	Recursively analyze event in this frame and its children.

bool	ClearEventRecursive ()
	Recursively clear event information from this frame and its children.

void	SetChildren (const std::vector< TLorentzVector > &P_children)

bool	IterateRecursiveMCMC ()

void	SetVariableMassMCMC (bool var=true)

virtual void	SetMassMCMC (double mass)

void	SetMassMCMC (double mass, GeneratorFrame &frame) const

bool	EventInAcceptance () 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
double	m_PT

double	m_PL

double	m_Phi

double	m_PToM

double	m_MaxM

double	m_ChildMassMCMC

double	m_ChildProbMCMC

int	m_NBurnInMCMC

int	m_NDiscardMCMC

int	m_FailTolerance

long	m_Ngenerated

long	m_Npassed

Protected Attributes inherited from RestFrames::GeneratorFrame
double	m_Mass

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::GeneratorFrame
static GeneratorFrame &	Empty ()
	Returns empty GeneratorFrame. 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

◆ LabGenFrame()

RestFrames::LabGenFrame::LabGenFrame	(	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 37 of file LabGenFrame.cc.

Member Function Documentation

◆ AnalyzeEvent()

bool RestFrames::LabGenFrame::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< GeneratorFrame >.

Definition at line 217 of file LabGenFrame.cc.

◆ ClearEvent()

bool RestFrames::LabGenFrame::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< GeneratorFrame >.

Definition at line 210 of file LabGenFrame.cc.

◆ InitializeAnalysis()

bool RestFrames::LabGenFrame::InitializeAnalysis ( )

virtual

Initialize analysis capability of a tree to generate events.

Returns: True if method was successful else False

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

Implements RestFrames::LabFrame< GeneratorFrame >.

Definition at line 105 of file LabGenFrame.cc.

◆ SetFailTolerance()

void RestFrames::LabGenFrame::SetFailTolerance ( int N )

Sets tolerance number of fail events before stopping the generation.

Parameters

N	Tolerance number

Definition at line 138 of file LabGenFrame.cc.

◆ SetLongitudinalMomentum()

void RestFrames::LabGenFrame::SetLongitudinalMomentum ( double val )

virtual

Sets longitudinal momentum of this frame.

Parameters

val	Longitudinal momentum

Definition at line 90 of file LabGenFrame.cc.

◆ SetN_MCMCBurnIn()

void RestFrames::LabGenFrame::SetN_MCMCBurnIn ( int N )

Sets number of events to be thrown away before keeping any.

Parameters

N	Number of events to be thrown away

Definition at line 128 of file LabGenFrame.cc.

◆ SetN_MCMCDiscard()

void RestFrames::LabGenFrame::SetN_MCMCDiscard ( int N )

Sets which Nth events to keep.

Parameters

N	Nth events to keep

Method to set which Nth events to keep. For example, if N = 5 it will only keep every 5th event

Definition at line 133 of file LabGenFrame.cc.

◆ SetPhi()

void RestFrames::LabGenFrame::SetPhi ( double val )

virtual

Sets phi of this frame.

Parameters

val Phi

Definition at line 94 of file LabGenFrame.cc.

◆ SetPToverM()

void RestFrames::LabGenFrame::SetPToverM ( double val )

virtual

Sets transverse momentum over mass.

Parameters

val	Value to be set

Warning: If val is less than 0, transverse momentum over mass won't be set

Definition at line 66 of file LabGenFrame.cc.

◆ SetThreeVector()

void RestFrames::LabGenFrame::SetThreeVector ( const TVector3 & P )

virtual

Sets momentum's three-vector of this frame.

Parameters

P	Three-vector to be set

Definition at line 60 of file LabGenFrame.cc.

◆ SetTransverseMomentum()

void RestFrames::LabGenFrame::SetTransverseMomentum ( double val )

virtual

Sets transverse momentum of this frame.

Parameters

val	Transverse momentum

Warning: If val is less than 0, transverse momentum won't be set

Definition at line 78 of file LabGenFrame.cc.

Collaboration diagram for RestFrames::LabGenFrame:

[legend]

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

inc/RestFrames/LabGenFrame.hh
src/LabGenFrame.cc

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ LabGenFrame()

Member Function Documentation

◆ AnalyzeEvent()

◆ ClearEvent()

◆ InitializeAnalysis()

◆ SetFailTolerance()

◆ SetLongitudinalMomentum()

◆ SetN_MCMCBurnIn()

◆ SetN_MCMCDiscard()

◆ SetPhi()

◆ SetPToverM()

◆ SetThreeVector()

◆ SetTransverseMomentum()