FastJet  3.0.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Friends | List of all members
fastjet::PrunerStructure Class Reference

The structure associated with a PseudoJet thas has gone through a Pruner transformer. More...

#include <fastjet/tools/Pruner.hh>

Inheritance diagram for fastjet::PrunerStructure:
Inheritance graph
[legend]
Collaboration diagram for fastjet::PrunerStructure:
Collaboration graph
[legend]

Public Member Functions

 PrunerStructure (const PseudoJet &result_jet)
 default ctor
virtual std::string description () const
 description
std::vector< PseudoJetrejected () const
 return the constituents that have been rejected
std::vector< PseudoJetextra_jets () const
 return the other jets that may have been found along with the result of the pruning The resulting vector is sorted in pt
- Public Member Functions inherited from fastjet::WrappedStructure
 WrappedStructure (const SharedPtr< PseudoJetStructureBase > &to_be_shared)
 default ctor the argument is the structure we need to wrap
virtual ~WrappedStructure ()
 default (virtual) dtor
virtual bool has_associated_cluster_sequence () const
 returns true if there is an associated ClusterSequence
virtual const ClusterSequenceassociated_cluster_sequence () const
 get a (const) pointer to the parent ClusterSequence (NULL if inexistent)
virtual bool has_valid_cluster_sequence () const
 returns true if this PseudoJet has an associated and still valid ClusterSequence.
virtual const ClusterSequencevalidated_cs () const
 if the jet has a valid associated cluster sequence then return a pointer to it; otherwise throw an error
virtual const
ClusterSequenceAreaBase
validated_csab () const
 if the jet has valid area information then return a pointer to the associated ClusterSequenceAreaBase object; otherwise throw an error
virtual bool has_partner (const PseudoJet &reference, PseudoJet &partner) const
 check if it has been recombined with another PseudoJet in which case, return its partner through the argument.
virtual bool has_child (const PseudoJet &reference, PseudoJet &child) const
 check if it has been recombined with another PseudoJet in which case, return its child through the argument.
virtual bool has_parents (const PseudoJet &reference, PseudoJet &parent1, PseudoJet &parent2) const
 check if it is the product of a recombination, in which case return the 2 parents through the 'parent1' and 'parent2' arguments.
virtual bool object_in_jet (const PseudoJet &reference, const PseudoJet &jet) const
 check if the reference PseudoJet is contained the second one passed as argument.
virtual bool has_constituents () const
 return true if the structure supports constituents.
virtual std::vector< PseudoJetconstituents (const PseudoJet &reference) const
 retrieve the constituents.
virtual bool has_exclusive_subjets () const
 return true if the structure supports exclusive_subjets.
virtual std::vector< PseudoJetexclusive_subjets (const PseudoJet &reference, const double &dcut) const
 return a vector of all subjets of the current jet (in the sense of the exclusive algorithm) that would be obtained when running the algorithm with the given dcut.
virtual int n_exclusive_subjets (const PseudoJet &reference, const double &dcut) const
 return the size of exclusive_subjets(...); still n ln n with same coefficient, but marginally more efficient than manually taking exclusive_subjets.size()
virtual std::vector< PseudoJetexclusive_subjets_up_to (const PseudoJet &reference, int nsub) const
 return the list of subjets obtained by unclustering the supplied jet down to n subjets (or all constituents if there are fewer than n).
virtual double exclusive_subdmerge (const PseudoJet &reference, int nsub) const
 return the dij that was present in the merging nsub+1 -> nsub subjets inside this jet.
virtual double exclusive_subdmerge_max (const PseudoJet &reference, int nsub) const
 return the maximum dij that occurred in the whole event at the stage that the nsub+1 -> nsub merge of subjets occurred inside this jet.
virtual bool has_pieces (const PseudoJet &reference) const
 return true if the structure supports pieces.
virtual std::vector< PseudoJetpieces (const PseudoJet &reference) const
 retrieve the pieces building the jet.
virtual bool has_area () const
 check if it has a defined area
virtual double area (const PseudoJet &reference) const
 return the jet (scalar) area.
virtual double area_error (const PseudoJet &reference) const
 return the error (uncertainty) associated with the determination of the area of this jet.
virtual PseudoJet area_4vector (const PseudoJet &reference) const
 return the jet 4-vector area.
virtual bool is_pure_ghost (const PseudoJet &reference) const
 true if this jet is made exclusively of ghosts.
- Public Member Functions inherited from fastjet::PseudoJetStructureBase
 PseudoJetStructureBase ()
 default ctor
virtual ~PseudoJetStructureBase ()
 default (virtual) dtor

Friends

class Pruner
 to allow setting the internal information

Additional Inherited Members

- Protected Attributes inherited from fastjet::WrappedStructure
SharedPtr< PseudoJetStructureBase_structure
 the wrapped structure

Detailed Description

The structure associated with a PseudoJet thas has gone through a Pruner transformer.

Definition at line 176 of file Pruner.hh.

Constructor & Destructor Documentation

fastjet::PrunerStructure::PrunerStructure ( const PseudoJet result_jet)
inline

default ctor

Parameters
result_jetthe jet for which we have to keep the structure

Definition at line 180 of file Pruner.hh.


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