Rivet  1.8.0
Public Types | Public Member Functions | Protected Member Functions
Rivet::FastJets Class Reference

Project out jets found using the FastJet package jet algorithms. More...

#include <FastJets.hh>

Inheritance diagram for Rivet::FastJets:
Rivet::JetAlg Rivet::JetAlg Rivet::Projection Rivet::Projection Rivet::ProjectionApplier Rivet::ProjectionApplier

List of all members.

Public Types

enum  JetAlgName {
  KT, CAM, SISCONE, ANTIKT,
  PXCONE, ATLASCONE, CMSCONE, CDFJETCLU,
  CDFMIDPOINT, D0ILCONE, JADE, DURHAM,
  TRACKJET, KT, CAM, SISCONE,
  ANTIKT, PXCONE, ATLASCONE, CMSCONE,
  CDFJETCLU, CDFMIDPOINT, D0ILCONE, JADE,
  DURHAM, TRACKJET
}
 Wrapper enum for selected Fastjet jet algorithms.
enum  JetAlgName {
  KT, CAM, SISCONE, ANTIKT,
  PXCONE, ATLASCONE, CMSCONE, CDFJETCLU,
  CDFMIDPOINT, D0ILCONE, JADE, DURHAM,
  TRACKJET, KT, CAM, SISCONE,
  ANTIKT, PXCONE, ATLASCONE, CMSCONE,
  CDFJETCLU, CDFMIDPOINT, D0ILCONE, JADE,
  DURHAM, TRACKJET
}
 Wrapper enum for selected Fastjet jet algorithms.

Public Member Functions

void reset ()
 Reset the projection. Jet def, etc. are unchanged.
void useJetArea (fastjet::AreaDefinition *adef)
 Use provided jet area definition.
size_t numJets (double ptmin=0.0) const
 Number of jets above the $ p_\perp $ cut.
size_t size () const
 Number of jets.
PseudoJets pseudoJets (double ptmin=0.0) const
 Get the pseudo jets (unordered).
PseudoJets pseudoJetsByPt (double ptmin=0.0) const
 Get the pseudo jets, ordered by $ p_T $.
PseudoJets pseudoJetsByE (double ptmin=0.0) const
 Get the pseudo jets, ordered by $ E $.
PseudoJets pseudoJetsByRapidity (double ptmin=0.0) const
 Get the pseudo jets, ordered by rapidity.
const fastjet::ClusterSequence * clusterSeq () const
 Return the cluster sequence (FastJet-specific).
const
fastjet::ClusterSequenceArea * 		clusterSeqArea () const
 Return the cluster sequence (FastJet-specific).
const fastjet::JetDefinition & jetDef () const
 Return the jet definition (FastJet-specific).
const fastjet::AreaDefinition * areaDef () const
 Return the area definition (FastJet-specific). May be null.
vector< double > ySubJet (const fastjet::PseudoJet &jet) const
 Get the subjet splitting variables for the given jet.
fastjet::PseudoJet splitJet (fastjet::PseudoJet jet, double &last_R) const
 Split a jet a la PRL100,242001(2008). Based on code from G.Salam, A.Davison.
fastjet::PseudoJet filterJet (fastjet::PseudoJet jet, double &stingy_R, const double def_R) const
 Filter a jet a la PRL100,242001(2008). Based on code from G.Salam, A.Davison.
void calc (const ParticleVector &ps)
 Do the calculation locally (no caching).
void reset ()
 Reset the projection. Jet def, etc. are unchanged.
void useJetArea (fastjet::AreaDefinition *adef)
 Use provided jet area definition.
size_t numJets (double ptmin=0.0) const
 Number of jets above the $ p_\perp $ cut.
size_t size () const
 Number of jets.
PseudoJets pseudoJets (double ptmin=0.0) const
 Get the pseudo jets (unordered).
PseudoJets pseudoJetsByPt (double ptmin=0.0) const
 Get the pseudo jets, ordered by $ p_T $.
PseudoJets pseudoJetsByE (double ptmin=0.0) const
 Get the pseudo jets, ordered by $ E $.
PseudoJets pseudoJetsByRapidity (double ptmin=0.0) const
 Get the pseudo jets, ordered by rapidity.
const fastjet::ClusterSequence * clusterSeq () const
 Return the cluster sequence (FastJet-specific).
const
fastjet::ClusterSequenceArea * 		clusterSeqArea () const
 Return the cluster sequence (FastJet-specific).
const fastjet::JetDefinition & jetDef () const
 Return the jet definition (FastJet-specific).
const fastjet::AreaDefinition * areaDef () const
 Return the area definition (FastJet-specific). May be null.
vector< double > ySubJet (const fastjet::PseudoJet &jet) const
 Get the subjet splitting variables for the given jet.
fastjet::PseudoJet splitJet (fastjet::PseudoJet jet, double &last_R) const
 Split a jet a la PRL100,242001(2008). Based on code from G.Salam, A.Davison.
fastjet::PseudoJet filterJet (fastjet::PseudoJet jet, double &stingy_R, const double def_R) const
 Filter a jet a la PRL100,242001(2008). Based on code from G.Salam, A.Davison.
void calc (const ParticleVector &ps)
 Do the calculation locally (no caching).
Constructors etc.
 FastJets (const FinalState &fsp, JetAlgName alg, double rparameter, double seed_threshold=1.0)
 FastJets (const FinalState &fsp, fastjet::JetAlgorithm type, fastjet::RecombinationScheme recom, double rparameter)
 Native argument constructor, using FastJet alg/scheme enums.
 FastJets (const FinalState &fsp, fastjet::JetDefinition::Plugin *plugin)
 Explicitly pass in an externally-constructed plugin (must be heap-allocated, Rivet will delete)
 FastJets (const FinalState &fsp, fastjet::JetDefinition::Plugin &plugin)
 Explicitly pass in an externally-constructed plugin (must be heap-allocated, Rivet will delete)
 FastJets (JetAlgName alg, double rparameter, double seed_threshold=1.0)
 Same thing as above, but without an FS (for when we want to pass the particles directly to the calc method)
 FastJets (fastjet::JetAlgorithm type, fastjet::RecombinationScheme recom, double rparameter)
 Same thing as above, but without an FS (for when we want to pass the particles directly to the calc method)
 FastJets (fastjet::JetDefinition::Plugin *plugin)
 Same thing as above, but without an FS (for when we want to pass the particles directly to the calc method)
 FastJets (fastjet::JetDefinition::Plugin &plugin)
 Same thing as above, but without an FS (for when we want to pass the particles directly to the calc method)
virtual const Projection * clone () const
 Clone on the heap.
 FastJets (const FinalState &fsp, JetAlgName alg, double rparameter, double seed_threshold=1.0)
 FastJets (const FinalState &fsp, fastjet::JetAlgorithm type, fastjet::RecombinationScheme recom, double rparameter)
 Native argument constructor, using FastJet alg/scheme enums.
 FastJets (const FinalState &fsp, fastjet::JetDefinition::Plugin *plugin)
 Explicitly pass in an externally-constructed plugin (must be heap-allocated, Rivet will delete)
 FastJets (const FinalState &fsp, fastjet::JetDefinition::Plugin &plugin)
 Explicitly pass in an externally-constructed plugin (must be heap-allocated, Rivet will delete)
 FastJets (JetAlgName alg, double rparameter, double seed_threshold=1.0)
 Same thing as above, but without an FS (for when we want to pass the particles directly to the calc method)
 FastJets (fastjet::JetAlgorithm type, fastjet::RecombinationScheme recom, double rparameter)
 Same thing as above, but without an FS (for when we want to pass the particles directly to the calc method)
 FastJets (fastjet::JetDefinition::Plugin *plugin)
 Same thing as above, but without an FS (for when we want to pass the particles directly to the calc method)
 FastJets (fastjet::JetDefinition::Plugin &plugin)
 Same thing as above, but without an FS (for when we want to pass the particles directly to the calc method)
virtual const Projection * clone () const
 Clone on the heap.

Protected Member Functions

void project (const Event &e)
 Perform the projection on the Event.
int compare (const Projection &p) const
 Compare projections.
void project (const Event &e)
 Perform the projection on the Event.
int compare (const Projection &p) const
 Compare projections.

Detailed Description

Project out jets found using the FastJet package jet algorithms.

Constructor & Destructor Documentation

Rivet::FastJets::FastJets ( const FinalState &  fsp,
JetAlgName  alg,
double  rparameter,
double  seed_threshold = 1.0 
) [inline]

"Wrapped" argument constructor using Rivet enums for most common jet alg choices (including some plugins). For the built-in algs, E-scheme recombination is used. For full control of FastJet built-in jet algs, use the native arg constructor.

Referenced by clone().

Rivet::FastJets::FastJets ( const FinalState &  fsp,
JetAlgName  alg,
double  rparameter,
double  seed_threshold = 1.0 
) [inline]

"Wrapped" argument constructor using Rivet enums for most common jet alg choices (including some plugins). For the built-in algs, E-scheme recombination is used. For full control of FastJet built-in jet algs, use the native arg constructor.

Member Function Documentation

const fastjet::ClusterSequenceArea* Rivet::FastJets::clusterSeqArea ( ) const [inline]

Return the cluster sequence (FastJet-specific).

Todo:
Throw error if no area def? Or just blindly call dynamic_cast?
const fastjet::ClusterSequenceArea* Rivet::FastJets::clusterSeqArea ( ) const [inline]

Return the cluster sequence (FastJet-specific).

Todo:
Throw error if no area def? Or just blindly call dynamic_cast?
void Rivet::FastJets::reset ( ) [virtual]

Reset the projection. Jet def, etc. are unchanged.

Todo:
_cseq = fastjet::ClusterSequence();
Todo:
_cseq = fastjet::ClusterSequence();

Implements Rivet::JetAlg.

void Rivet::FastJets::useJetArea ( fastjet::AreaDefinition *  adef) [inline]

Use provided jet area definition.

Warning:
adef is NOT copied, the user must ensure that it remains valid! Provide an adef null pointer to re-disable jet area calculation
void Rivet::FastJets::useJetArea ( fastjet::AreaDefinition *  adef) [inline]

Use provided jet area definition.

Warning:
adef is NOT copied, the user must ensure that it remains valid! Provide an adef null pointer to re-disable jet area calculation
The documentation for this class was generated from the following files:
Generated on Sun Jun 10 2012 18:57:58 for Rivet by   doxygen 1.7.6.1