The XSecCheck class is a simple analysis class used for testing purposes. More...
#include <XSecCheck.h>
Classes | |
struct | UnexpectedXSec |
The exception class used if the target cross section was not met. More... | |
Public Member Functions | |
XSecCheck () | |
The default constructor. | |
Virtual functions required by the AnalysisHandler class. | |
virtual void | analyze (tEventPtr event, long ieve, int loop, int state) |
Analyze a given Event. | |
Public Member Functions inherited from ThePEG::AnalysisHandler | |
virtual LorentzRotation | transform (tEventPtr event) const |
Transform the event to the desired Lorentz frame and return the corresponding LorentzRotation. | |
virtual LorentzRotation | transform (tcEventPtr event) const |
Return a LorentzTransform which would put the event in the desired Lorentz frame. | |
virtual void | analyze (const tPVector &particles) |
Analyze the given vector of particles. | |
virtual void | analyze (const tPVector &particles, double weight) |
Analyze the given vector of particles. | |
virtual void | analyze (tPPtr particle) |
Analyze the given particle. | |
virtual void | analyze (tPPtr particle, double weight) |
Analyze the given particle. | |
bool | checkHistogramFactory (bool warn=false) const |
Check if the associated EventGenerator has been assigned a histogram factory. | |
FactoryBase & | histogramFactory () |
Access the HistogramFactory from the EventGenerator. | |
const FactoryBase & | histogramFactory () const |
Access the HistogramFactory from the EventGenerator. | |
AIDA::IHistogramFactory & | iHistogramFactory () const |
Access the underlying AIDA::IHistogramFactory in the HistogramFactory from the EventGenerator. | |
void | normalize (tH1DPtr h, CrossSection unit=picobarn) const |
Normalize the histogran h using the collected statistics from the EventGenerator. | |
void | unitNormalize (tH1DPtr h) const |
Normalize the histogran h to unit integral. | |
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::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. | |
Protected Member Functions | |
Clone Methods. | |
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. | |
Protected Member Functions inherited from ThePEG::AnalysisHandler | |
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 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. | |
Standard Interfaced functions. | |
CrossSection | target |
The expected total cross section. | |
double | tol |
The relative tolerance accepted when comparing the total cross section with the target. | |
double | sumw |
The sum of the weights of the events analyzed. | |
static ClassDescription< XSecCheck > | initXSecCheck |
The static object used to initialize the description of this class. | |
virtual void | doinitrun () |
Initialize this object. | |
virtual void | dofinish () |
Finalize this object. | |
XSecCheck & | operator= (const XSecCheck &)=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::AnalysisHandler | |
typedef FactoryBase::tH1DPtr | tH1DPtr |
Convenient typedef for pointer to AIDA::IHistogram1D. | |
typedef FactoryBase::tcH1DPtr | tcH1DPtr |
Convenient typedef for pointer to AIDA::IHistogram1D. | |
typedef FactoryBase::tH2DPtr | tH2DPtr |
Convenient typedef for pointer to AIDA::IHistogram1D. | |
typedef FactoryBase::tcH2DPtr | tcH2DPtr |
Convenient typedef for pointer to AIDA::IHistogram1D. | |
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::AnalysisHandler | |
static void | Init () |
Standard Init function used to initialize the interface. | |
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. | |
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. | |
The XSecCheck class is a simple analysis class used for testing purposes.
If the total cross section does not match the one specified by TargetXSec, an exception will be thrown.
Definition at line 21 of file XSecCheck.h.
|
inline |
The default constructor.
Definition at line 28 of file XSecCheck.h.
|
virtual |
Analyze a given Event.
Note that a fully generated event may be presented several times, if it has been manipulated in between. The default version of this function will call transform to make a lorentz transformation of the whole event, then extract all final state particles and call analyze(tPVector) of this analysis object and those of all associated analysis objects. The default version will not, however, do anything on events which have not been fully generated, or have been manipulated in any way.
event | pointer to the Event to be analyzed. |
ieve | the event number. |
loop | the number of times this event has been presented. If negative the event is now fully generated. |
state | a number different from zero if the event has been manipulated in some way since it was last presented. |
Reimplemented from ThePEG::AnalysisHandler.
|
protectedvirtual |
Make a simple clone of this object.
Reimplemented from ThePEG::AnalysisHandler.
|
protectedvirtual |
Finalize this object.
Called in the run phase just after a run has ended. Used eg. to write out statistics.
Reimplemented from ThePEG::InterfacedBase.
|
inlineprotectedvirtual |
Initialize this object.
Called in the run phase just before a run begins.
Reimplemented from ThePEG::InterfacedBase.
Definition at line 114 of file XSecCheck.h.
References ThePEG::InterfacedBase::doinitrun(), and sumw.
|
protectedvirtual |
Make a clone of this object, possibly modifying the cloned object to make it sane.
Reimplemented from ThePEG::AnalysisHandler.
|
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.
The assignment operator is private and must never be called.
In fact, it should not even be implemented.
void ThePEG::XSecCheck::persistentInput | ( | PersistentIStream & | is, |
int | version | ||
) |
Function used to read in object persistently.
is | the persistent input stream read from. |
version | the version number of the object when written. |
void ThePEG::XSecCheck::persistentOutput | ( | PersistentOStream & | os | ) | const |
Function used to write out object persistently.
os | the persistent output stream written to. |
|
staticprivate |
The static object used to initialize the description of this class.
Indicates that this is a concrete class with persistent data.
Definition at line 150 of file XSecCheck.h.
|
private |
The sum of the weights of the events analyzed.
Definition at line 142 of file XSecCheck.h.
Referenced by doinitrun().
|
private |
The expected total cross section.
Definition at line 131 of file XSecCheck.h.
|
private |
The relative tolerance accepted when comparing the total cross section with the target.
Definition at line 137 of file XSecCheck.h.