Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

Cuts Class Reference

#include <Cuts.hh>

List of all members.

Detailed Description

A Cuts object contains information which can be passed from the different Projection and Analysis objects in Rivet to the outside world. The main purpose of the Cut objects is to allow applications which use Rivet to determine whether or not a given analysis "makes sense" on the provided events. An Analysis' Cuts object should be the combination of Cuts from its projections, plus the additional constraints (experiment conditions and cuts) specific to that analysis.

Definition at line 20 of file Cuts.hh.


Non-const iterators over the cuts

typedef NamedBinaryCuts::iterator iterator
iterator begin ()
iterator end ()
iterator find (const string &quantity)

Non-const iterators over the cuts

typedef NamedBinaryCuts::const_iterator const_iterator
const const_iterator begin () const
const const_iterator end () const
const const_iterator find (const string &quantity) const

Public Types

typedef map< string, BinaryCut > NamedBinaryCuts
 Typedef for a named collection of binary cut objects.

Public Member Functions

Cuts & addCut (const string &quantity, const Comparison &comparison, const double value)
 Define this cut by a quantity to be constrained and the comparison type of the constraint.
Cuts & addCuts (const Cuts &other)
 Combine with another set of Cuts, using addCut iternally.
bool checkConsistency () const
 Set the value of this cut, bypassing the combination mechanism.
ostream & print (ostream &stream) const
 Print the parameters to the given stream.
Standard constructors, destructors and assignment.
 Cuts ()
 The default constructor.

Member Typedef Documentation

typedef NamedBinaryCuts::const_iterator const_iterator
 

Definition at line 101 of file Cuts.hh.

typedef NamedBinaryCuts::iterator iterator
 

Definition at line 93 of file Cuts.hh.

typedef map<string, BinaryCut> NamedBinaryCuts
 

Typedef for a named collection of binary cut objects.

Definition at line 86 of file Cuts.hh.

Constructor & Destructor Documentation

Cuts (   )  [inline]
 

The default constructor.

Definition at line 27 of file Cuts.hh.

Member Function Documentation

Cuts & addCut (  const string &  quantity,
const Comparison &  comparison,
const double  value
) 
 

Define this cut by a quantity to be constrained and the comparison type of the constraint.

Definition at line 11 of file Cuts.cc.

References Rivet::EQUAL, Rivet::LESS_EQ, and Rivet::MORE_EQ.

Cuts& addCuts (  const Cuts &  other  )  [inline]
 

Combine with another set of Cuts, using addCut iternally.

Definition at line 37 of file Cuts.hh.

References Cuts::begin(), Cuts::end(), Rivet::LESS_EQ, and Rivet::MORE_EQ.

Referenced by Projection::getCuts(), and Analysis::getCuts().

const const_iterator begin (   )  const [inline]
 

Definition at line 102 of file Cuts.hh.

References Cuts::begin().

iterator begin (   )  [inline]
 

Definition at line 94 of file Cuts.hh.

Referenced by Cuts::addCuts(), Cuts::begin(), Cuts::checkConsistency(), and Cuts::print().

bool checkConsistency (   )  const
 

Set the value of this cut, bypassing the combination mechanism.

Make sure that the cuts are internally consistent. Returns no value, but an exception will be thrown if there is an inconsistency.

Definition at line 41 of file Cuts.cc.

References Cuts::begin(), and Cuts::end().

Referenced by Analysis::checkConsistency().

const const_iterator end (   )  const [inline]
 

Definition at line 103 of file Cuts.hh.

References Cuts::end().

iterator end (   )  [inline]
 

Definition at line 95 of file Cuts.hh.

Referenced by Cuts::addCuts(), Cuts::checkConsistency(), Analysis::checkConsistency(), Cuts::end(), Projection::getBeamPairs(), Projection::getProjections(), Analysis::getProjections(), and Cuts::print().

const const_iterator find (  const string &  quantity  )  const [inline]
 

Definition at line 104 of file Cuts.hh.

References Cuts::find().

iterator find (  const string &  quantity  )  [inline]
 

Definition at line 96 of file Cuts.hh.

Referenced by Cuts::find().

ostream & print (  ostream &  stream  )  const
 

Print the parameters to the given stream.

Definition at line 56 of file Cuts.cc.

References Cuts::begin(), and Cuts::end().

Referenced by Rivet::operator<<().

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