herwig is hosted by Hepforge, IPPP Durham
Herwig 7.3.0
Herwig::MatchboxDeltaRCut Class Reference

MatchboxDeltaRCut implements cuts related to the separation in the legoplot plane. More...

#include <MatchboxDeltaRCut.h>

Inheritance diagram for Herwig::MatchboxDeltaRCut:

Public Member Functions

 MatchboxDeltaRCut ()
 The default constructor.
 
Virtual functions to be overridden by sub-classes.
virtual Energy minDeltaMeasureCuts (tcPDPtr, tcPDPtr) const
 Return the minimum allowed value of the longitudinally invariant \(k_\perp\)-algorithms distance measure.
 
virtual Energy minKTClus (tcPDPtr, tcPDPtr) const
 Return the minimum allowed value of the longitudinally invariant \(k_\perp\)-algorithms distance measure.
 
virtual Energy2 minSij (tcPDPtr, tcPDPtr) const
 Return the minimum allowed squared invariant mass of two outgoing partons of type pi and pj.
 
virtual Energy2 minTij (tcPDPtr, tcPDPtr) const
 Return the minimum allowed value of the negative of the squared invariant mass of an incoming parton of type pi and an outgoing parton of type po.
 
virtual double minDeltaR (tcPDPtr, tcPDPtr) const
 Return the minimum allowed value of \(\Delta R_{ij}=\sqrt{\Delta\eta_{ij}^2+\Delta\phi_{ij}^2}\) of two outgoing partons of type pi and pj.
 
virtual double minDurham (tcPDPtr, tcPDPtr) const
 Return the minimum allowed value of the Durham \(k_\perp\)-algorithms distance measure.
 
virtual bool passCuts (tcCutsPtr parent, tcPDPtr pitype, tcPDPtr pjtype, LorentzMomentum pi, LorentzMomentum pj, bool inci=false, bool incj=false) const
 Return true if a pair of particles with type pitype and pjtype and momenta pi and pj respectively passes the cuts.
 
virtual void describe () const
 Describe the currently active cuts in the log file.
 
double deltaRMin () const
 Return the minimum and maximum allowed legoplot separation.
 
double deltaRMax () const
 
double deltaYMin () const
 Return the minimum and maximum allowed rapidity separation.
 
double deltaYMax () const
 
double deltaPhiMin () const
 Return the minimum and maximum allowed azimuthal separation.
 
double deltaPhiMax () const
 
Ptr< MatcherBase >::tptr firstMatcher () const
 Return the matchers for a pair of particles to cut on.
 
Ptr< MatcherBase >::tptr secondMatcher () const
 
- Public Member Functions inherited from ThePEG::TwoCutBase
virtual Energy2 minSij (tcPDPtr pi, tcPDPtr pj) const=0
 
virtual Energy2 minTij (tcPDPtr pi, tcPDPtr po) const=0
 
virtual double minDeltaR (tcPDPtr pi, tcPDPtr pj) const=0
 
virtual Energy minKTClus (tcPDPtr pi, tcPDPtr pj) const=0
 
virtual double minDurham (tcPDPtr pi, tcPDPtr pj) const=0
 
virtual bool passCuts (tcCutsPtr parent, tcPDPtr pitype, tcPDPtr pjtype, LorentzMomentum pi, LorentzMomentum pj, bool inci=false, bool incj=false) const
 
bool passCuts (tcCutsPtr parent, tcPPtr pi, tcPPtr pj, bool inci=false, bool incj=false) const
 
virtual void describe () const
 
- Public Member Functions inherited from ThePEG::Interfaced
virtual bool defaultInit ()
 
PPtr getParticle (PID) const
 
PDPtr getParticleData (PID) const
 
bool used () const
 
void useMe () const
 
tEGPtr generator () const
 
void persistentOutput (PersistentOStream &os) const
 
void persistentInput (PersistentIStream &is, int version)
 
PPtr getParticle (PID) const
 
PDPtr getParticleData (PID) const
 
bool used () const
 
void useMe () const
 
tEGPtr generator () const
 
- Public Member Functions inherited from ThePEG::InterfacedBase
string fullName () const
 
string name () const
 
string path () const
 
string comment () const
 
void setup (istream &is)
 
void update ()
 
void init ()
 
virtual bool preInitialize () const
 
void initrun ()
 
void finish ()
 
void touch ()
 
void reset ()
 
void clear ()
 
InitState state () const
 
bool locked () const
 
bool touched () const
 
virtual IBPtr fullclone () const
 
void persistentOutput (PersistentOStream &os) const
 
void persistentInput (PersistentIStream &is, int version)
 
virtual void debugme () const
 
void update ()
 
void init ()
 
virtual bool preInitialize () const
 
void initrun ()
 
void finish ()
 
void touch ()
 
void reset ()
 
void clear ()
 
InitState state () const
 
bool locked () const
 
bool touched () const
 
virtual IBPtr fullclone () const
 
- Public Member Functions inherited from ThePEG::Base
void debug () const
 
virtual void debugme () const
 
- Public Member Functions inherited from ThePEG::Pointer::ReferenceCounted
CounterType referenceCount () const
 
- Public Member Functions inherited from ThePEG::Named
 Named (const string &newName=string())
 
 Named (const Named &)=default
 
const string & name () const
 
bool operator== (const Named &other) const
 
bool operator< (const Named &other) const
 

Clone Methods.

double theDeltaRMin
 The minimum and maximum allowed legoplot separation.
 
double theDeltaRMax
 
double theDeltaYMin
 The minimum and maximum allowed rapidity separation.
 
double theDeltaYMax
 
double theDeltaPhiMin
 The minimum and maximum allowed azimuthal separation.
 
double theDeltaPhiMax
 
Ptr< MatcherBase >::ptr theFirstMatcher
 Matchers for a pair of particles to cut on.
 
Ptr< MatcherBase >::ptr theSecondMatcher
 
virtual IBPtr clone () const
 Make a simple clone of this object.
 
virtual IBPtr fullclone () const
 Make a clone of this object, possibly modifying the cloned object to make it sane.
 
MatchboxDeltaRCutoperator= (const MatchboxDeltaRCut &)=delete
 The assignment operator is private and must never be called.
 

Functions used by the persistent I/O system.

void persistentOutput (PersistentOStream &os) const
 Function used to write out object persistently.
 
void persistentInput (PersistentIStream &is, int version)
 Function used to read in object persistently.
 
static void Init ()
 The standard Init function used to initialize the interfaces.
 

Additional Inherited Members

- Public Types inherited from ThePEG::InterfacedBase
enum  InitState
 
- Public Types inherited from ThePEG::Pointer::ReferenceCounted
typedef unsigned int CounterType
 
- Static Public Member Functions inherited from ThePEG::TwoCutBase
static void Init ()
 
- Static Public Member Functions inherited from ThePEG::Interfaced
static void Init ()
 
- Static Public Member Functions inherited from ThePEG::InterfacedBase
static void Init ()
 
- Static Public Member Functions inherited from ThePEG::Base
static void Init ()
 
- Public Attributes inherited from ThePEG::InterfacedBase
 initializing
 
 uninitialized
 
 initialized
 
 runready
 
- Public Attributes inherited from ThePEG::Pointer::ReferenceCounted
const unsigned long uniqueId
 
- Protected Member Functions inherited from ThePEG::Interfaced
void reporeg (IBPtr object, string name) const
 
bool setDefaultReference (PtrT &ptr, string classname, string objectname)
 
 Interfaced (const string &newName)
 
 Interfaced (const Interfaced &i)
 
void setGenerator (tEGPtr generator)
 
- Protected Member Functions inherited from ThePEG::InterfacedBase
virtual void readSetup (istream &is)
 
virtual void doupdate ()
 
virtual void doinit ()
 
virtual void doinitrun ()
 
virtual void dofinish ()
 
virtual IVector getReferences ()
 
virtual void rebind (const TranslationMap &)
 
virtual IBPtr clone () const=0
 
 InterfacedBase (string newName)
 
 InterfacedBase (const InterfacedBase &i)
 
virtual void readSetup (istream &is)
 
virtual void doupdate ()
 
virtual void doinit ()
 
virtual void doinitrun ()
 
virtual void dofinish ()
 
virtual IVector getReferences ()
 
virtual void rebind (const TranslationMap &)
 
- Protected Member Functions inherited from ThePEG::Pointer::ReferenceCounted
 ReferenceCounted (const ReferenceCounted &)
 
ReferenceCountedoperator= (const ReferenceCounted &)
 
- Protected Member Functions inherited from ThePEG::Named
const Namedoperator= (const Named &other)
 
const string & name (const string &newName)
 
- Static Protected Member Functions inherited from ThePEG::Interfaced
static void registerRepository (IBPtr)
 
static void registerRepository (IBPtr, string newName)
 

Detailed Description

MatchboxDeltaRCut implements cuts related to the separation in the legoplot plane.

Author
Christian Reuschle
See also
The interfaces defined for MatchboxDeltaRCut.

Definition at line 31 of file MatchboxDeltaRCut.h.

Member Function Documentation

◆ clone()

virtual IBPtr Herwig::MatchboxDeltaRCut::clone ( ) const
protectedvirtual

Make a simple clone of this object.

Returns
a pointer to the new object.

Implements ThePEG::InterfacedBase.

◆ deltaPhiMax()

double Herwig::MatchboxDeltaRCut::deltaPhiMax ( ) const
inline

Definition at line 130 of file MatchboxDeltaRCut.h.

◆ deltaPhiMin()

double Herwig::MatchboxDeltaRCut::deltaPhiMin ( ) const
inline

Return the minimum and maximum allowed azimuthal separation.

Definition at line 129 of file MatchboxDeltaRCut.h.

References theDeltaPhiMin.

◆ deltaRMax()

double Herwig::MatchboxDeltaRCut::deltaRMax ( ) const
inline

Definition at line 118 of file MatchboxDeltaRCut.h.

◆ deltaRMin()

double Herwig::MatchboxDeltaRCut::deltaRMin ( ) const
inline

Return the minimum and maximum allowed legoplot separation.

Definition at line 117 of file MatchboxDeltaRCut.h.

References theDeltaRMin.

◆ deltaYMax()

double Herwig::MatchboxDeltaRCut::deltaYMax ( ) const
inline

Definition at line 124 of file MatchboxDeltaRCut.h.

◆ deltaYMin()

double Herwig::MatchboxDeltaRCut::deltaYMin ( ) const
inline

Return the minimum and maximum allowed rapidity separation.

Definition at line 123 of file MatchboxDeltaRCut.h.

References theDeltaYMin.

◆ describe()

virtual void Herwig::MatchboxDeltaRCut::describe ( ) const
virtual

Describe the currently active cuts in the log file.

Reimplemented from ThePEG::TwoCutBase.

◆ firstMatcher()

Ptr< MatcherBase >::tptr Herwig::MatchboxDeltaRCut::firstMatcher ( ) const
inline

Return the matchers for a pair of particles to cut on.

Only a pair of particles, matching these objects, will be affected.

Definition at line 136 of file MatchboxDeltaRCut.h.

References theFirstMatcher.

◆ fullclone()

virtual IBPtr Herwig::MatchboxDeltaRCut::fullclone ( ) const
protectedvirtual

Make a clone of this object, possibly modifying the cloned object to make it sane.

Returns
a pointer to the new object.

Reimplemented from ThePEG::InterfacedBase.

◆ Init()

static void Herwig::MatchboxDeltaRCut::Init ( )
static

The standard Init function used to initialize the interfaces.

Called exactly once for each class by the class description system before the main function starts or when this class is dynamically loaded.

◆ minDeltaMeasureCuts()

virtual Energy Herwig::MatchboxDeltaRCut::minDeltaMeasureCuts ( tcPDPtr  ,
tcPDPtr   
) const
inlinevirtual

Return the minimum allowed value of the longitudinally invariant \(k_\perp\)-algorithms distance measure.

This is defined as \(\min(p_{\perp i}, p_{\perp j})\sqrt{\Delta\eta_{ij}^2+\Delta\phi_{ij}^2}\) for two outgoing partons, or simply \(p_{\perp i}\) or \(p_{\perp j}\) for a single outgoing parton. Returns 0 if both partons are incoming. A null pointer indicates an incoming parton, hence the type of the incoming parton is irrelevant.

Definition at line 54 of file MatchboxDeltaRCut.h.

References ThePEG::ZERO.

◆ minDeltaR()

virtual double Herwig::MatchboxDeltaRCut::minDeltaR ( tcPDPtr  ,
tcPDPtr   
) const
inlinevirtual

Return the minimum allowed value of \(\Delta R_{ij}=\sqrt{\Delta\eta_{ij}^2+\Delta\phi_{ij}^2}\) of two outgoing partons of type pi and pj.

Returns zero.

Implements ThePEG::TwoCutBase.

Definition at line 84 of file MatchboxDeltaRCut.h.

References ThePEG::ZERO.

◆ minDurham()

virtual double Herwig::MatchboxDeltaRCut::minDurham ( tcPDPtr  ,
tcPDPtr   
) const
inlinevirtual

Return the minimum allowed value of the Durham \(k_\perp\)-algorithms distance measure.

This is defined as \(2\min(E_j^2, E_j^2)(1-\cos\theta_{ij})/\hat{s}\) for two outgoing partons. Returns zero.

Implements ThePEG::TwoCutBase.

Definition at line 93 of file MatchboxDeltaRCut.h.

◆ minKTClus()

virtual Energy Herwig::MatchboxDeltaRCut::minKTClus ( tcPDPtr  ,
tcPDPtr   
) const
inlinevirtual

Return the minimum allowed value of the longitudinally invariant \(k_\perp\)-algorithms distance measure.

Returns ZERO.

Implements ThePEG::TwoCutBase.

Definition at line 61 of file MatchboxDeltaRCut.h.

References ThePEG::ZERO.

◆ minSij()

virtual Energy2 Herwig::MatchboxDeltaRCut::minSij ( tcPDPtr  ,
tcPDPtr   
) const
inlinevirtual

Return the minimum allowed squared invariant mass of two outgoing partons of type pi and pj.

Returns zero.

Implements ThePEG::TwoCutBase.

Definition at line 68 of file MatchboxDeltaRCut.h.

References ThePEG::ZERO.

◆ minTij()

virtual Energy2 Herwig::MatchboxDeltaRCut::minTij ( tcPDPtr  ,
tcPDPtr   
) const
inlinevirtual

Return the minimum allowed value of the negative of the squared invariant mass of an incoming parton of type pi and an outgoing parton of type po.

Returns zero.

Implements ThePEG::TwoCutBase.

Definition at line 76 of file MatchboxDeltaRCut.h.

References ThePEG::ZERO.

◆ operator=()

MatchboxDeltaRCut & Herwig::MatchboxDeltaRCut::operator= ( const MatchboxDeltaRCut )
privatedelete

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ passCuts()

virtual bool Herwig::MatchboxDeltaRCut::passCuts ( tcCutsPtr  parent,
tcPDPtr  pitype,
tcPDPtr  pjtype,
LorentzMomentum  pi,
LorentzMomentum  pj,
bool  inci = false,
bool  incj = false 
) const
virtual

Return true if a pair of particles with type pitype and pjtype and momenta pi and pj respectively passes the cuts.

inci and inj indicates if the corresponding particles are incoming.

Reimplemented from ThePEG::TwoCutBase.

◆ persistentInput()

void Herwig::MatchboxDeltaRCut::persistentInput ( PersistentIStream is,
int  version 
)

Function used to read in object persistently.

Parameters
isthe persistent input stream read from.
versionthe version number of the object when written.

◆ persistentOutput()

void Herwig::MatchboxDeltaRCut::persistentOutput ( PersistentOStream os) const

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

◆ secondMatcher()

Ptr< MatcherBase >::tptr Herwig::MatchboxDeltaRCut::secondMatcher ( ) const
inline

Definition at line 137 of file MatchboxDeltaRCut.h.

Member Data Documentation

◆ theDeltaPhiMax

double Herwig::MatchboxDeltaRCut::theDeltaPhiMax
private

Definition at line 204 of file MatchboxDeltaRCut.h.

◆ theDeltaPhiMin

double Herwig::MatchboxDeltaRCut::theDeltaPhiMin
private

The minimum and maximum allowed azimuthal separation.

Definition at line 203 of file MatchboxDeltaRCut.h.

Referenced by deltaPhiMin().

◆ theDeltaRMax

double Herwig::MatchboxDeltaRCut::theDeltaRMax
private

Definition at line 192 of file MatchboxDeltaRCut.h.

◆ theDeltaRMin

double Herwig::MatchboxDeltaRCut::theDeltaRMin
private

The minimum and maximum allowed legoplot separation.

Definition at line 191 of file MatchboxDeltaRCut.h.

Referenced by deltaRMin().

◆ theDeltaYMax

double Herwig::MatchboxDeltaRCut::theDeltaYMax
private

Definition at line 198 of file MatchboxDeltaRCut.h.

◆ theDeltaYMin

double Herwig::MatchboxDeltaRCut::theDeltaYMin
private

The minimum and maximum allowed rapidity separation.

Definition at line 197 of file MatchboxDeltaRCut.h.

Referenced by deltaYMin().

◆ theFirstMatcher

Ptr<MatcherBase>::ptr Herwig::MatchboxDeltaRCut::theFirstMatcher
private

Matchers for a pair of particles to cut on.

Only a pair of particles, matching these objects, will be affected.

Definition at line 210 of file MatchboxDeltaRCut.h.

Referenced by firstMatcher().

◆ theSecondMatcher

Ptr<MatcherBase>::ptr Herwig::MatchboxDeltaRCut::theSecondMatcher
private

Definition at line 211 of file MatchboxDeltaRCut.h.


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