JetRegion implements the requirement of finding a jet inside a given range of transverse momenta, and (pseudo-)rapidity. More...

#include <JetRegion.h>

Inheritance diagram for ThePEG::JetRegion:

[legend]

Public Member Functions
	JetRegion ()
	The default constructor.

Energy	ptMin () const
	Return the minimum pt.

Energy	ptMax () const
	Return the maximum pt.

const vector< pair< double, double > > &	yRanges () const
	Return the rapidity ranges.

const vector< int > &	accepts () const
	Return the jets accepted by this region (with respect to the ordering imposed by the JetCuts object).

bool	fuzzy () const
	Return true, if this jet region is fuzzy.

double	cutWeight () const
	Return the cut weight encountered from the last call to matches()

bool	lessThanEnergy (Energy a, Energy b, double &weight) const
	Perform a (potentially) fuzzy check on energy-type quantities.

bool	lessThanRapidity (double a, double b, double &weight) const
	Perform a (potentially) fuzzy check on angular-type quantities.

virtual void	describe () const
	Describe the currently active cuts in the log file.

virtual bool	matches (tcCutsPtr parent, int n, const LorentzMomentum &p, double yHat=0.0)
	Return true, if the given jet matches this region.

bool	didMatch ()
	Return true, if this region matched a jet in the last call to matches().

virtual void	reset ()
	Reset this region to act on a new event.

int	lastNumber () const
	Return the number of the last jet matching this region.

const LorentzMomentum &	lastMomentum () const
	Return the momentum of the last jet matching this region.

Public Member Functions inherited from ThePEG::HandlerBaseT< UseRandom >
virtual	~HandlerBaseT ()
	Destructor.

double	rnd () const
	Return a simple flat random number in the range ]0,1[.

double	rnd (double xu) const
	Return a simple flat random number in the range ]0,xu[.

double	rnd (double xl, double xu) const
	Return a simple flat random number in the range ]xl,xu[.

bool	rndbool () const
	Return true with 50% probability.

bool	rndbool (double p) const
	Return a true with probability p.

bool	rndbool (double p1, double p2) const
	Return a true with probability p1/(p1+p2).

int	rndsign (double p1, double p2, double p3) const
	Return -1, 0, or 1 with relative probabilities p1, p2, p3.

int	rnd2 (double p0, double p1) const
	Return an integer \(i\) with probability p \(i\)/(p0+p1).

int	rnd3 (double p0, double p1, double p2) const
	Return an integer \(i\) with probability p \(i\)/(p0+p1+p2).

int	rnd4 (double p0, double p1, double p2, double p3) const
	Return an integer/ \(i\) with probability p \(i\)(p0+p1+p2+p3).

long	irnd (long xu=2) const
	Return a simple flat random integrer number in the range [0,xu[.

long	irnd (long xl, long xu) const
	Return a simple flat random integrer number in the range [xl,xu[.

const StandardModelBase &	SM () const
	Return a reference to the object containing the standard model parameters for this run.

tSMPtr	standardModel () const
	Return a pointer to the object containing the standard model parameters for this run.

Public Member Functions inherited from ThePEG::Interfaced
virtual	~Interfaced ()
	Empty virtual destructor.

virtual bool	defaultInit ()
	Functions which are to be used during the actual event generation, after the setup is complete.

PPtr	getParticle (PID) const
	Create a new Particle instance given a id number.

PDPtr	getParticleData (PID) const
	Return a pointer to the ParticleData object corresponding to the given id number.

bool	used () const
	Returns true if this object has actally been used.

void	useMe () const
	Should be called to indicate that this object has actually been used.

tEGPtr	generator () const
	Return a pointer to the EventGenerator controlling the run.

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.

Public Member Functions inherited from ThePEG::InterfacedBase
virtual	~InterfacedBase ()
	The virtual (empty) destructor;.

string	fullName () const
	Returns the full name of this object including its path, e.g.

string	name () const
	Returns the name of this object, without the path.

string	path () const
	Returns the path to this object including the trailing '/'.

string	comment () const
	Returns a comment assigned to this object.

void	setup (istream &is)
	Read setup info from a standard istream is.

void	update ()
	Calls the doupdate() function with recursion prevention.

void	init ()
	Calls the doinit() function with recursion prevention.

virtual bool	preInitialize () const
	Return true if this object needs to be initialized before all other objects (except those for which this function also returns true).

void	initrun ()
	Calls the doinitrun() function with recursion prevention.

void	finish ()
	Calls the dofinish() function with recursion prevention.

void	touch ()
	This function should be called every time something in this object has changed in a way that a sanity check with update() is needed.

void	reset ()
	Set the state of this object to uninitialized.

void	clear ()
	Calls reset() and unTouch().

InitState	state () const
	Return the state of initialization of this object.

bool	locked () const
	Return true if the BaseRepository is not allowed to change the state of this object.

bool	touched () const
	Return true if the state of this object has been changed since the last call to update().

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.

virtual void	debugme () const
	Print out debugging information for this object on std::cerr.

Public Member Functions inherited from ThePEG::Base
virtual	~Base ()
	The virtual destructor.

void	debug () const
	Print out debugging information for this object on std::cerr.

virtual void	debugme () const
	Print out debugging information for this object on std::cerr.

Public Member Functions inherited from ThePEG::Pointer::ReferenceCounted
CounterType	referenceCount () const
	Return the reference count.

Public Member Functions inherited from ThePEG::Named
	Named (const string &newName=string())
	Constructor with name.

	Named (const Named &)=default
	Explicit default copy-constructor (too avoid compiler warnings)

const string &	name () const
	Return name.

bool	operator== (const Named &other) const
	Test for equality.

bool	operator< (const Named &other) const
	Lexicographical comparison.

Clone Methods.
Energy	thePtMin
	The minimum pt.

Energy	thePtMax
	The maximum pt.

vector< pair< double, double > >	theYRanges
	The rapidity ranges.

vector< int >	theAccepts
	The jets accepted by this region (with respect to the ordering imposed by the JetCuts object).

bool	theDidMatch
	True, if this region matched a jet in the last call to matches().

int	theLastNumber
	The number of the last jet matching this region.

LorentzMomentum	theLastMomentum
	Return the momentum of the last jet matching this region.

bool	theFuzzy
	True if this region is fuzzy.

double	theCutWeight
	The cut weight encountered from the last call to matches()

Energy	theEnergyCutWidth
	The smearing width for the pt or mass cuts, if fuzzy.

double	theRapidityCutWidth
	The smearing width for the rapidity cut, if fuzzy.

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.

string	doYRange (string)
	Command to insert a rapidity range.

JetRegion &	operator= (const JetRegion &)=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 { initializing = -1 , uninitialized = 0 , initialized = 1 , runready = 2 }
	Enumeration reflecting the state of an InterfacedBase object. More...

Public Types inherited from ThePEG::Pointer::ReferenceCounted
typedef unsigned int	CounterType
	The integer type used for counting.

Static Public Member Functions inherited from ThePEG::HandlerBase
static void	Init ()
	Standard Init function used to initialize the interface.

Static Public Member Functions inherited from ThePEG::Interfaced
static void	Init ()
	Standard Init function.

Static Public Member Functions inherited from ThePEG::InterfacedBase
static void	Init ()
	Standard Init function.

Static Public Member Functions inherited from ThePEG::Base
static void	Init ()
	The standard Init function used to initialize the interfaces.

Public Attributes inherited from ThePEG::Pointer::ReferenceCounted
const unsigned long	uniqueId
	The unique ID.

Protected Member Functions inherited from ThePEG::Interfaced
void	reporeg (IBPtr object, string name) const
	Register the given object in the Repository with the given name in a subdirectory with the same name as this object.

template<typename PtrT >
bool	setDefaultReference (PtrT &ptr, string classname, string objectname)
	If the pointer, ptr, to an object is not set, create an object of class classname and register it with the Repository with the given objectname in a sib-directory with the same name as this object.

	Interfaced ()
	Protected default constructor.

	Interfaced (const string &newName)
	Protected constructor taking a name as argument.

	Interfaced (const Interfaced &i)
	Protected copy-constructor.

void	setGenerator (tEGPtr generator)
	Protected function to reset the generator pointer, required for automatic decayer generation in Herwig++ BSM models.

Protected Member Functions inherited from ThePEG::InterfacedBase
virtual void	readSetup (istream &is)
	Read setup info from a standard istream is.

virtual void	doupdate ()
	Check sanity of the object during the setup phase.

virtual void	doinit ()
	Initialize this object after the setup phase before saving an EventGenerator to disk.

virtual void	doinitrun ()
	Initialize this object.

virtual void	dofinish ()
	Finalize this object.

virtual IVector	getReferences ()
	Return a vector of all pointers to Interfaced objects used in this object.

virtual void	rebind (const TranslationMap &)
	Rebind pointer to other Interfaced objects.

	InterfacedBase ()
	Protected default constructor.

	InterfacedBase (string newName)
	Protected constructor with the name given as argument.

	InterfacedBase (const InterfacedBase &i)
	Protected copy-constructor.

Protected Member Functions inherited from ThePEG::Pointer::ReferenceCounted
	ReferenceCounted ()
	Default constructor.

	ReferenceCounted (const ReferenceCounted &)
	Copy-constructor.

ReferenceCounted &	operator= (const ReferenceCounted &)
	Assignment.

Protected Member Functions inherited from ThePEG::Named
const Named &	operator= (const Named &other)
	Assignment.

const string &	name (const string &newName)
	Set new name.

Static Protected Member Functions inherited from ThePEG::Interfaced
static void	registerRepository (IBPtr)
	Register an Interfaced object with the Repository.

static void	registerRepository (IBPtr, string newName)
	Register an Interfaced object with the Repository, giving it a name.

Detailed Description

JetRegion implements the requirement of finding a jet inside a given range of transverse momenta, and (pseudo-)rapidity.

See also: JetPairRegion; JetCuts; The interfaces defined for JetRegion.

Definition at line 32 of file JetRegion.h.

Member Function Documentation

◆ accepts()

const vector< int > & ThePEG::JetRegion::accepts ( ) const

inline

Return the jets accepted by this region (with respect to the ordering imposed by the JetCuts object).

If empty, any jet will be accepted.

Definition at line 63 of file JetRegion.h.

References theAccepts.

◆ clone()

virtual IBPtr ThePEG::JetRegion::clone ( ) const

protectedvirtual

Make a simple clone of this object.

Returns: a pointer to the new object.

Implements ThePEG::InterfacedBase.

◆ cutWeight()

double ThePEG::JetRegion::cutWeight ( ) const

inline

Return the cut weight encountered from the last call to matches()

Definition at line 73 of file JetRegion.h.

References theCutWeight.

◆ didMatch()

bool ThePEG::JetRegion::didMatch ( )

inline

Return true, if this region matched a jet in the last call to matches().

Definition at line 101 of file JetRegion.h.

References theDidMatch.

◆ fullclone()

virtual IBPtr ThePEG::JetRegion::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.

◆ fuzzy()

bool ThePEG::JetRegion::fuzzy ( ) const

inline

Return true, if this jet region is fuzzy.

Definition at line 68 of file JetRegion.h.

References theFuzzy.

◆ Init()

static void ThePEG::JetRegion::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.

◆ lastMomentum()

const LorentzMomentum & ThePEG::JetRegion::lastMomentum ( ) const

inline

Return the momentum of the last jet matching this region.

Definition at line 116 of file JetRegion.h.

References theLastMomentum.

◆ lastNumber()

int ThePEG::JetRegion::lastNumber ( ) const

inline

Return the number of the last jet matching this region.

Definition at line 111 of file JetRegion.h.

References theLastNumber.

◆ operator=()

JetRegion & ThePEG::JetRegion::operator= ( const JetRegion & )

privatedelete

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ persistentInput()

void ThePEG::JetRegion::persistentInput	(	PersistentIStream &	is,
		int	version
	)

Function used to read in object persistently.

Parameters

is	the persistent input stream read from.
version	the version number of the object when written.

◆ persistentOutput()

void ThePEG::JetRegion::persistentOutput ( PersistentOStream & os ) const

Function used to write out object persistently.

Parameters

os	the persistent output stream written to.

◆ ptMax()

Energy ThePEG::JetRegion::ptMax ( ) const

inline

Return the maximum pt.

Definition at line 51 of file JetRegion.h.

References thePtMax.

◆ ptMin()

Energy ThePEG::JetRegion::ptMin ( ) const

inline

Return the minimum pt.

Definition at line 46 of file JetRegion.h.

References thePtMin.

◆ reset()

virtual void ThePEG::JetRegion::reset ( )

inlinevirtual

Reset this region to act on a new event.

Definition at line 106 of file JetRegion.h.

References theDidMatch.

◆ yRanges()

const vector< pair< double, double > > & ThePEG::JetRegion::yRanges ( ) const

inline

Return the rapidity ranges.

Definition at line 56 of file JetRegion.h.

References theYRanges.

Member Data Documentation

◆ theAccepts

vector<int> ThePEG::JetRegion::theAccepts

private

The jets accepted by this region (with respect to the ordering imposed by the JetCuts object).

If empty, any jet will be accepted.

Definition at line 193 of file JetRegion.h.

Referenced by accepts().

◆ theCutWeight

double ThePEG::JetRegion::theCutWeight

private

The cut weight encountered from the last call to matches()

Definition at line 218 of file JetRegion.h.

Referenced by cutWeight().

◆ theDidMatch

bool ThePEG::JetRegion::theDidMatch

private

True, if this region matched a jet in the last call to matches().

Definition at line 198 of file JetRegion.h.

Referenced by didMatch(), and reset().

◆ theEnergyCutWidth

Energy ThePEG::JetRegion::theEnergyCutWidth

private

The smearing width for the pt or mass cuts, if fuzzy.

Definition at line 223 of file JetRegion.h.

◆ theFuzzy

bool ThePEG::JetRegion::theFuzzy

private

True if this region is fuzzy.

Definition at line 213 of file JetRegion.h.

Referenced by fuzzy().

◆ theLastMomentum

LorentzMomentum ThePEG::JetRegion::theLastMomentum

private

Return the momentum of the last jet matching this region.

Definition at line 208 of file JetRegion.h.

Referenced by lastMomentum().

◆ theLastNumber

int ThePEG::JetRegion::theLastNumber

private

The number of the last jet matching this region.

Definition at line 203 of file JetRegion.h.

Referenced by lastNumber().

◆ thePtMax

Energy ThePEG::JetRegion::thePtMax

private

The maximum pt.

Definition at line 181 of file JetRegion.h.

Referenced by ptMax().

◆ thePtMin

Energy ThePEG::JetRegion::thePtMin

private

The minimum pt.

Definition at line 176 of file JetRegion.h.

Referenced by ptMin().

◆ theRapidityCutWidth

double ThePEG::JetRegion::theRapidityCutWidth

private

The smearing width for the rapidity cut, if fuzzy.

Definition at line 228 of file JetRegion.h.

◆ theYRanges

vector<pair<double,double> > ThePEG::JetRegion::theYRanges

private

The rapidity ranges.

Definition at line 186 of file JetRegion.h.

Referenced by yRanges().

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

JetRegion.h

Public Member Functions

Clone Methods.

Functions used by the persistent I/O system.

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ accepts()

◆ clone()

◆ cutWeight()

◆ didMatch()

◆ fullclone()

◆ fuzzy()

◆ Init()

◆ lastMomentum()

◆ lastNumber()

◆ operator=()

◆ persistentInput()

◆ persistentOutput()

◆ ptMax()

◆ ptMin()

◆ reset()

◆ yRanges()

Member Data Documentation

◆ theAccepts

◆ theCutWeight

◆ theDidMatch

◆ theEnergyCutWidth

◆ theFuzzy

◆ theLastMomentum

◆ theLastNumber

◆ thePtMax

◆ thePtMin

◆ theRapidityCutWidth

◆ theYRanges