Logo ROOT  
Reference Guide
TPythia6Decayer Class Reference

This class implements the TVirtualMCDecayer interface.


The TPythia6 singleton object is used to decay particles. Note, that since this class modifies common blocks (global variables) it is defined as a singleton.

Definition at line 31 of file TPythia6Decayer.h.

Public Types

enum  EDecayType {
  kSemiElectronic, kDiElectron, kSemiMuonic, kDiMuon,
  kBJpsiDiMuon, kBJpsiDiElectron, kBPsiPrimeDiMuon, kBPsiPrimeDiElectron,
  kPiToMu, kKaToMu, kNoDecay, kHadronicD,
  kOmega, kPhiKK, kAll, kNoDecayHeavy,
  kHardMuons, kBJpsi, kWToMuon, kWToCharm,
  kWToCharmToMuon, kZDiMuon, kMaxDecay
}
 
- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kInconsistent = 0x08000000,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5),
  kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 

Public Member Functions

 TPythia6Decayer ()
 Constructor. More...
 
virtual ~TPythia6Decayer ()
 
virtual void Decay (Int_t idpart, TLorentzVector *p)
 Decay a particle of type IDPART (PDG code) and momentum P. More...
 
virtual void ForceDecay ()
 Force a particle decay mode. More...
 
void ForceParticleDecay (Int_t particle, Int_t *products, Int_t *mult, Int_t npart)
 Force decay of particle into products with multiplicity mult. More...
 
void ForceParticleDecay (Int_t particle, Int_t product, Int_t mult)
 Force decay of particle into products with multiplicity mult. More...
 
virtual Float_t GetLifetime (Int_t kf)
 Get the life-time of a particle of type KF (a PDG code). More...
 
virtual Float_t GetPartialBranchingRatio (Int_t ipart)
 Get the partial branching ratio for a particle of type IPART (a PDG code). More...
 
virtual Int_t ImportParticles (TClonesArray *particles)
 Get the decay products into the passed PARTICLES TClonesArray of TParticles. More...
 
virtual void Init ()
 Initialize the decayer. More...
 
virtual void ReadDecayTable ()
 Read in particle data from an ASCII file. More...
 
virtual void SetDecayTableFile (const char *name)
 
virtual void SetForceDecay (EDecayType type)
 
virtual void SetForceDecay (Int_t type)
 Force a particular decay type. More...
 
virtual void WriteDecayTable ()
 write particle data to an ASCII file. More...
 
- Public Member Functions inherited from TVirtualMCDecayer
 TVirtualMCDecayer ()
 
virtual ~TVirtualMCDecayer ()
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
virtual Bool_t IsSortable () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. More...
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 

Static Public Member Functions

static TPythia6DecayerInstance ()
 Get the singleton object. More...
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 

Protected Member Functions

Int_t CountProducts (Int_t channel, Int_t particle)
 Count number of decay products. More...
 
void ForceHadronicD ()
 Force golden D decay modes. More...
 
void ForceOmega ()
 Force Omega -> Lambda K- Decay. More...
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 
void MakeZombie ()
 

Protected Attributes

TArrayF fBraPart
 
EDecayType fDecay
 
TString fDecayTableFile
 

Static Protected Attributes

static TPythia6DecayerfgInstance = 0
 Branching ratios. More...
 

#include <TPythia6Decayer.h>

Inheritance diagram for TPythia6Decayer:
[legend]

Member Enumeration Documentation

◆ EDecayType

Enumerator
kSemiElectronic 
kDiElectron 
kSemiMuonic 
kDiMuon 
kBJpsiDiMuon 
kBJpsiDiElectron 
kBPsiPrimeDiMuon 
kBPsiPrimeDiElectron 
kPiToMu 
kKaToMu 
kNoDecay 
kHadronicD 
kOmega 
kPhiKK 
kAll 
kNoDecayHeavy 
kHardMuons 
kBJpsi 
kWToMuon 
kWToCharm 
kWToCharmToMuon 
kZDiMuon 
kMaxDecay 

Definition at line 35 of file TPythia6Decayer.h.

Constructor & Destructor Documentation

◆ TPythia6Decayer()

TPythia6Decayer::TPythia6Decayer ( )

Constructor.

Definition at line 45 of file TPythia6Decayer.cxx.

◆ ~TPythia6Decayer()

virtual TPythia6Decayer::~TPythia6Decayer ( )
inlinevirtual

Definition at line 75 of file TPythia6Decayer.h.

Member Function Documentation

◆ CountProducts()

Int_t TPythia6Decayer::CountProducts ( Int_t  channel,
Int_t  particle 
)
protected

Count number of decay products.

Definition at line 489 of file TPythia6Decayer.cxx.

◆ Decay()

void TPythia6Decayer::Decay ( Int_t  idpart,
TLorentzVector p 
)
virtual

Decay a particle of type IDPART (PDG code) and momentum P.

Implements TVirtualMCDecayer.

Definition at line 66 of file TPythia6Decayer.cxx.

◆ ForceDecay()

void TPythia6Decayer::ForceDecay ( )
virtual

Force a particle decay mode.

Implements TVirtualMCDecayer.

Definition at line 97 of file TPythia6Decayer.cxx.

◆ ForceHadronicD()

void TPythia6Decayer::ForceHadronicD ( )
protected

Force golden D decay modes.

Definition at line 500 of file TPythia6Decayer.cxx.

◆ ForceOmega()

void TPythia6Decayer::ForceOmega ( )
protected

Force Omega -> Lambda K- Decay.

Definition at line 613 of file TPythia6Decayer.cxx.

◆ ForceParticleDecay() [1/2]

void TPythia6Decayer::ForceParticleDecay ( Int_t  particle,
Int_t products,
Int_t mult,
Int_t  npart 
)

Force decay of particle into products with multiplicity mult.

Definition at line 585 of file TPythia6Decayer.cxx.

◆ ForceParticleDecay() [2/2]

void TPythia6Decayer::ForceParticleDecay ( Int_t  particle,
Int_t  product,
Int_t  mult 
)

Force decay of particle into products with multiplicity mult.

Definition at line 558 of file TPythia6Decayer.cxx.

◆ GetLifetime()

Float_t TPythia6Decayer::GetLifetime ( Int_t  kf)
virtual

Get the life-time of a particle of type KF (a PDG code).

Implements TVirtualMCDecayer.

Definition at line 286 of file TPythia6Decayer.cxx.

◆ GetPartialBranchingRatio()

Float_t TPythia6Decayer::GetPartialBranchingRatio ( Int_t  ipart)
virtual

Get the partial branching ratio for a particle of type IPART (a PDG code).

Implements TVirtualMCDecayer.

Definition at line 276 of file TPythia6Decayer.cxx.

◆ ImportParticles()

Int_t TPythia6Decayer::ImportParticles ( TClonesArray particles)
virtual

Get the decay products into the passed PARTICLES TClonesArray of TParticles.

Implements TVirtualMCDecayer.

Definition at line 77 of file TPythia6Decayer.cxx.

◆ Init()

void TPythia6Decayer::Init ( )
virtual

Initialize the decayer.

Implements TVirtualMCDecayer.

Definition at line 55 of file TPythia6Decayer.cxx.

◆ Instance()

TPythia6Decayer * TPythia6Decayer::Instance ( )
static

Get the singleton object.

Definition at line 36 of file TPythia6Decayer.cxx.

◆ ReadDecayTable()

void TPythia6Decayer::ReadDecayTable ( )
virtual

Read in particle data from an ASCII file.

The file name must previously have been set using the member function SetDecayTableFile.

Implements TVirtualMCDecayer.

Definition at line 297 of file TPythia6Decayer.cxx.

◆ SetDecayTableFile()

void TPythia6Decayer::SetDecayTableFile ( const char *  name)
inlinevirtual

Definition at line 97 of file TPythia6Decayer.h.

◆ SetForceDecay() [1/2]

virtual void TPythia6Decayer::SetForceDecay ( EDecayType  type)
inlinevirtual

Definition at line 90 of file TPythia6Decayer.h.

◆ SetForceDecay() [2/2]

void TPythia6Decayer::SetForceDecay ( Int_t  type)
virtual

Force a particular decay type.

Implements TVirtualMCDecayer.

Definition at line 85 of file TPythia6Decayer.cxx.

◆ WriteDecayTable()

void TPythia6Decayer::WriteDecayTable ( )
virtual

write particle data to an ASCII file.

The file name must previously have been set using the member function SetDecayTableFile.

Users can use this function to make an initial decay list file, which then can be edited by hand, and re-loaded into the decayer using ReadDecayTable.

The file syntax is

particle_list : partcle_data
              | particle_list particle_data
             ;
particle_data : particle_info
              | particle_info '\n' decay_list
              ;
particle_info : See below
              ;
decay_list    : decay_entry
              | decay_list decay_entry
              ;
decay_entry   : See below

The particle_info consists of 13 fields:

PDG code             int
Name                 string
Anti-particle name   string  if there's no anti-particle,
                             then this field must be the
                             empty string
Electic charge       int     in units of |e|/3
Color charge         int     in units of quark color charges
Have anti-particle   int     1 of there's an anti-particle
                             to this particle, or 0
                             otherwise
Mass                 float   in units of GeV
Resonance width      float
Max broadning        float
Lifetime             float
MWID                 int     ??? (some sort of flag)
Decay                int     1 if it decays. 0 otherwise

The format to write these entries in are

" %9  %-16s  %-16s%3d%3d%3d%12.5f%12.5f%12.5f%13.gf%3d%d\n"

The decay_entry consists of 8 fields:

On/Off               int     1 for on, -1 for off
Matrix element type  int
Branching ratio      float
Product 1            int     PDG code of decay product 1
Product 2            int     PDG code of decay product 2
Product 3            int     PDG code of decay product 3
Product 4            int     PDG code of decay product 4
Product 5            int     PDG code of decay product 5

The format for these lines are

" %5d%5d%12.5f%10d%10d%10d%10d%10d\n"

Definition at line 473 of file TPythia6Decayer.cxx.

Member Data Documentation

◆ fBraPart

TArrayF TPythia6Decayer::fBraPart
protected

Definition at line 64 of file TPythia6Decayer.h.

◆ fDecay

EDecayType TPythia6Decayer::fDecay
protected

Definition at line 63 of file TPythia6Decayer.h.

◆ fDecayTableFile

TString TPythia6Decayer::fDecayTableFile
protected

Definition at line 62 of file TPythia6Decayer.h.

◆ fgInstance

TPythia6Decayer * TPythia6Decayer::fgInstance = 0
staticprotected

Branching ratios.

Definition at line 66 of file TPythia6Decayer.h.


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