HepMC event record
Public Types | Public Member Functions | Static Public Member Functions | Data Fields
Cut Struct Reference

Detailed Description

The Cut class represents a cut used by the Matrix Element generator.

Definition at line 575 of file build/outputs/include/HepMC/LHEF.h.

#include <LHEF.h>

+ Inheritance diagram for Cut:
+ Collaboration diagram for Cut:

Public Types

typedef XMLTag::AttributeMap AttributeMap
 
typedef XMLTag::AttributeMap AttributeMap
 

Public Member Functions

 Cut ()
 
 Cut (const XMLTag &tag, const std::map< std::string, std::set< long > > &ptypes)
 
void print (std::ostream &file) const
 
bool match (long id1, long id2=0) const
 
bool passCuts (const std::vector< long > &id, const std::vector< std::vector< double > > &p) const
 
bool outside (double value) const
 
 Cut ()
 
 Cut (const XMLTag &tag, const std::map< std::string, std::set< long > > &ptypes)
 
void print (std::ostream &file) const
 
bool match (long id1, long id2=0) const
 
bool passCuts (const std::vector< long > &id, const std::vector< std::vector< double > > &p) const
 
bool outside (double value) const
 
bool getattr (std::string n, double &v, bool erase=true)
 
bool getattr (std::string n, bool &v, bool erase=true)
 
bool getattr (std::string n, long &v, bool erase=true)
 
bool getattr (std::string n, int &v, bool erase=true)
 
bool getattr (std::string n, std::string &v, bool erase=true)
 
bool getattr (std::string n, double &v, bool erase=true)
 
bool getattr (std::string n, bool &v, bool erase=true)
 
bool getattr (std::string n, long &v, bool erase=true)
 
bool getattr (std::string n, int &v, bool erase=true)
 
bool getattr (std::string n, std::string &v, bool erase=true)
 
void printattrs (std::ostream &file) const
 
void printattrs (std::ostream &file) const
 
void closetag (std::ostream &file, std::string tag) const
 
void closetag (std::ostream &file, std::string tag) const
 

Static Public Member Functions

static double eta (const std::vector< double > &p)
 
static double rap (const std::vector< double > &p)
 
static double deltaR (const std::vector< double > &p1, const std::vector< double > &p2)
 
static double eta (const std::vector< double > &p)
 
static double rap (const std::vector< double > &p)
 
static double deltaR (const std::vector< double > &p1, const std::vector< double > &p2)
 
static std::string yes ()
 
static std::string yes ()
 

Data Fields

std::string type
 
std::set< long > p1
 
std::string np1
 
std::set< long > p2
 
std::string np2
 
double min
 
double max
 
XMLTag::AttributeMap attributes
 
std::string contents
 

Member Typedef Documentation

◆ AttributeMap [1/2]

Convenient typedef.

Definition at line 338 of file build/outputs/include/HepMC/LHEF.h.

◆ AttributeMap [2/2]

Convenient typedef.

Definition at line 338 of file include/HepMC/LHEF.h.

Constructor & Destructor Documentation

◆ Cut() [1/4]

Cut ( )
inline

Intitialize default values.

Definition at line 580 of file build/outputs/include/HepMC/LHEF.h.

◆ Cut() [2/4]

Cut ( const XMLTag tag,
const std::map< std::string, std::set< long > > &  ptypes 
)
inline

◆ Cut() [3/4]

Cut ( )
inline

Intitialize default values.

Definition at line 580 of file include/HepMC/LHEF.h.

◆ Cut() [4/4]

Cut ( const XMLTag tag,
const std::map< std::string, std::set< long > > &  ptypes 
)
inline

Create from XML tag.

Definition at line 586 of file include/HepMC/LHEF.h.

References TagBase::attributes, TagBase::getattr(), Cut::max, Cut::min, Cut::np1, Cut::np2, Cut::p1, Cut::p2, and Cut::type.

Member Function Documentation

◆ closetag() [1/2]

void closetag ( std::ostream &  file,
std::string  tag 
) const
inlineinherited

Print out end of tag marker. Print contents if not empty else print simple close tag.

Definition at line 434 of file build/outputs/include/HepMC/LHEF.h.

References TagBase::contents.

◆ closetag() [2/2]

void closetag ( std::ostream &  file,
std::string  tag 
) const
inlineinherited

Print out end of tag marker. Print contents if not empty else print simple close tag.

Definition at line 434 of file include/HepMC/LHEF.h.

References TagBase::contents.

◆ deltaR() [1/2]

static double deltaR ( const std::vector< double > &  p1,
const std::vector< double > &  p2 
)
inlinestatic

Return the delta-R of a particle pair with momenta p1 and p2.

Definition at line 766 of file include/HepMC/LHEF.h.

References Cut::eta(), Cut::p1, and Cut::p2.

◆ deltaR() [2/2]

static double deltaR ( const std::vector< double > &  p1,
const std::vector< double > &  p2 
)
inlinestatic

Return the delta-R of a particle pair with momenta p1 and p2.

Definition at line 766 of file build/outputs/include/HepMC/LHEF.h.

References Cut::eta(), Cut::p1, and Cut::p2.

◆ eta() [1/2]

static double eta ( const std::vector< double > &  p)
inlinestatic

Return the pseudorapidity of a particle with momentum p.

Definition at line 738 of file include/HepMC/LHEF.h.

◆ eta() [2/2]

static double eta ( const std::vector< double > &  p)
inlinestatic

Return the pseudorapidity of a particle with momentum p.

Definition at line 738 of file build/outputs/include/HepMC/LHEF.h.

◆ getattr() [1/10]

bool getattr ( std::string  n,
double &  v,
bool  erase = true 
)
inlineinherited

Find an attribute named n and set the double variable v to the corresponding value. Remove the correspondig attribute from the list if found and erase is true.

Returns
false if no attribute was found.

Definition at line 357 of file include/HepMC/LHEF.h.

References TagBase::attributes.

◆ getattr() [2/10]

bool getattr ( std::string  n,
double &  v,
bool  erase = true 
)
inlineinherited

Find an attribute named n and set the double variable v to the corresponding value. Remove the correspondig attribute from the list if found and erase is true.

Returns
false if no attribute was found.

Definition at line 357 of file build/outputs/include/HepMC/LHEF.h.

References TagBase::attributes.

◆ getattr() [3/10]

bool getattr ( std::string  n,
bool &  v,
bool  erase = true 
)
inlineinherited

Find an attribute named n and set the bool variable v to true if the corresponding value is "yes". Remove the correspondig attribute from the list if found and erase is true.

Returns
false if no attribute was found.

Definition at line 371 of file build/outputs/include/HepMC/LHEF.h.

References TagBase::attributes.

◆ getattr() [4/10]

bool getattr ( std::string  n,
bool &  v,
bool  erase = true 
)
inlineinherited

Find an attribute named n and set the bool variable v to true if the corresponding value is "yes". Remove the correspondig attribute from the list if found and erase is true.

Returns
false if no attribute was found.

Definition at line 371 of file include/HepMC/LHEF.h.

References TagBase::attributes.

◆ getattr() [5/10]

bool getattr ( std::string  n,
long &  v,
bool  erase = true 
)
inlineinherited

Find an attribute named n and set the long variable v to the corresponding value. Remove the correspondig attribute from the list if found and erase is true.

Returns
false if no attribute was found.

Definition at line 385 of file build/outputs/include/HepMC/LHEF.h.

References TagBase::attributes.

◆ getattr() [6/10]

bool getattr ( std::string  n,
long &  v,
bool  erase = true 
)
inlineinherited

Find an attribute named n and set the long variable v to the corresponding value. Remove the correspondig attribute from the list if found and erase is true.

Returns
false if no attribute was found.

Definition at line 385 of file include/HepMC/LHEF.h.

References TagBase::attributes.

◆ getattr() [7/10]

bool getattr ( std::string  n,
int &  v,
bool  erase = true 
)
inlineinherited

Find an attribute named n and set the long variable v to the corresponding value. Remove the correspondig attribute from the list if found and erase is true.

Returns
false if no attribute was found.

Definition at line 399 of file build/outputs/include/HepMC/LHEF.h.

References TagBase::attributes.

◆ getattr() [8/10]

bool getattr ( std::string  n,
int &  v,
bool  erase = true 
)
inlineinherited

Find an attribute named n and set the long variable v to the corresponding value. Remove the correspondig attribute from the list if found and erase is true.

Returns
false if no attribute was found.

Definition at line 399 of file include/HepMC/LHEF.h.

References TagBase::attributes.

◆ getattr() [9/10]

bool getattr ( std::string  n,
std::string &  v,
bool  erase = true 
)
inlineinherited

Find an attribute named n and set the string variable v to the corresponding value. Remove the correspondig attribute from the list if found and erase is true.

Returns
false if no attribute was found.

Definition at line 413 of file build/outputs/include/HepMC/LHEF.h.

References TagBase::attributes.

◆ getattr() [10/10]

bool getattr ( std::string  n,
std::string &  v,
bool  erase = true 
)
inlineinherited

Find an attribute named n and set the string variable v to the corresponding value. Remove the correspondig attribute from the list if found and erase is true.

Returns
false if no attribute was found.

Definition at line 413 of file include/HepMC/LHEF.h.

References TagBase::attributes.

◆ match() [1/2]

bool match ( long  id1,
long  id2 = 0 
) const
inline

Check if a id1 matches p1 and id2 matches p2. Only non-zero values are considered.

Definition at line 655 of file include/HepMC/LHEF.h.

References Cut::p1, and Cut::p2.

◆ match() [2/2]

bool match ( long  id1,
long  id2 = 0 
) const
inline

Check if a id1 matches p1 and id2 matches p2. Only non-zero values are considered.

Definition at line 655 of file build/outputs/include/HepMC/LHEF.h.

References Cut::p1, and Cut::p2.

◆ outside() [1/2]

bool outside ( double  value) const
inline

Return true if the given value is outside limits.

Definition at line 778 of file include/HepMC/LHEF.h.

References Cut::max.

◆ outside() [2/2]

bool outside ( double  value) const
inline

Return true if the given value is outside limits.

Definition at line 778 of file build/outputs/include/HepMC/LHEF.h.

References Cut::max.

◆ passCuts() [1/2]

bool passCuts ( const std::vector< long > &  id,
const std::vector< std::vector< double > > &  p 
) const
inline

Check if the particles given as a vector of PDG id numbers, and a vector of vectors of momentum components, p, will pass the cut defined in this event.

Definition at line 671 of file include/HepMC/LHEF.h.

References Cut::deltaR(), Cut::eta(), Cut::match(), Cut::outside(), Cut::p2, Cut::rap(), and Cut::type.

◆ passCuts() [2/2]

bool passCuts ( const std::vector< long > &  id,
const std::vector< std::vector< double > > &  p 
) const
inline

Check if the particles given as a vector of PDG id numbers, and a vector of vectors of momentum components, p, will pass the cut defined in this event.

Definition at line 671 of file build/outputs/include/HepMC/LHEF.h.

References Cut::deltaR(), Cut::eta(), Cut::match(), Cut::outside(), Cut::p2, Cut::rap(), and Cut::type.

◆ print() [1/2]

void print ( std::ostream &  file) const
inline

◆ print() [2/2]

void print ( std::ostream &  file) const
inline

Print out an XML tag.

Definition at line 628 of file include/HepMC/LHEF.h.

References TagBase::contents, Cut::max, Cut::min, Cut::np1, Cut::np2, Cut::p1, Cut::p2, TagBase::printattrs(), and Cut::type.

◆ printattrs() [1/2]

void printattrs ( std::ostream &  file) const
inlineinherited

print out ' name="value"' for all unparsed attributes.

Definition at line 424 of file include/HepMC/LHEF.h.

References TagBase::attributes.

◆ printattrs() [2/2]

void printattrs ( std::ostream &  file) const
inlineinherited

print out ' name="value"' for all unparsed attributes.

Definition at line 424 of file build/outputs/include/HepMC/LHEF.h.

References TagBase::attributes.

◆ rap() [1/2]

static double rap ( const std::vector< double > &  p)
inlinestatic

Return the true rapidity of a particle with momentum p.

Definition at line 752 of file include/HepMC/LHEF.h.

◆ rap() [2/2]

static double rap ( const std::vector< double > &  p)
inlinestatic

Return the true rapidity of a particle with momentum p.

Definition at line 752 of file build/outputs/include/HepMC/LHEF.h.

◆ yes() [1/2]

static std::string yes ( )
inlinestaticinherited

Static string token for truth values.

Definition at line 456 of file include/HepMC/LHEF.h.

◆ yes() [2/2]

static std::string yes ( )
inlinestaticinherited

Static string token for truth values.

Definition at line 456 of file build/outputs/include/HepMC/LHEF.h.

Field Documentation

◆ attributes

XMLTag::AttributeMap attributes
inherited

The attributes of this tag;

Definition at line 446 of file build/outputs/include/HepMC/LHEF.h.

◆ contents

std::string contents
inherited

The contents of this tag.

Definition at line 451 of file build/outputs/include/HepMC/LHEF.h.

◆ max

double max

The maximum value of the variable

Definition at line 814 of file build/outputs/include/HepMC/LHEF.h.

◆ min

double min

The minimum value of the variable

Definition at line 810 of file build/outputs/include/HepMC/LHEF.h.

◆ np1

std::string np1

Symbolic name for p1.

Definition at line 795 of file build/outputs/include/HepMC/LHEF.h.

◆ np2

std::string np2

Symbolic name for p1.

Definition at line 805 of file build/outputs/include/HepMC/LHEF.h.

◆ p1

std::set< long > p1

The first types particle types for which this cut applies.

Definition at line 790 of file build/outputs/include/HepMC/LHEF.h.

◆ p2

std::set< long > p2

The second type of particles for which this cut applies.

Definition at line 800 of file build/outputs/include/HepMC/LHEF.h.

◆ type

std::string type

The variable in which to cut.

Definition at line 785 of file build/outputs/include/HepMC/LHEF.h.


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