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

Class to contain structure information for a filtered jet. More...

#include <fastjet/tools/Filter.hh>

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

Public Member Functions

 FilterStructure (const std::vector< PseudoJet > &pieces_in, const JetDefinition::Recombiner *rec=0)
 constructor from an original ClusterSequenceInfo We just share the original ClusterSequenceWrapper and initialise the rest
virtual ~FilterStructure ()
 virtual dtor to allow further overloading
virtual std::string description () const
 description
- Public Member Functions inherited from fastjet::CompositeJetStructure
 CompositeJetStructure ()
 default ctor
 CompositeJetStructure (const std::vector< PseudoJet > &initial_pieces, const JetDefinition::Recombiner *recombiner=0)
 ctor with initialisation
virtual ~CompositeJetStructure ()
 default dtor
virtual bool has_constituents () const
 true unless the jet has no pieces (see also the description of constituents() below)
virtual std::vector< PseudoJetconstituents (const PseudoJet &jet) const
 return the constituents (i.e.
virtual bool has_pieces (const PseudoJet &) const
 true if it has pieces (always the case)
virtual std::vector< PseudoJetpieces (const PseudoJet &jet) const
 returns the pieces
virtual bool has_area () const
 check if it has a well-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.
void set_area_information (PseudoJet *area_4vector_ptr)
- Public Member Functions inherited from fastjet::PseudoJetStructureBase
 PseudoJetStructureBase ()
 default ctor
virtual ~PseudoJetStructureBase ()
 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_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 nsub subjets (or all constituents if there are fewer than nsub).
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.

The filter-specific information

class Filter
std::vector< PseudoJet_rejected
 the subjets rejected by the filter
const std::vector< PseudoJet > & rejected () const
 returns the subjets that were not kept during the filtering procedure (subtracted if the filter requests it, and valid in the original cs)

Additional Inherited Members

- Protected Attributes inherited from fastjet::CompositeJetStructure
std::vector< PseudoJet_pieces
 the pieces building the jet
PseudoJet_area_4vector_ptr
 pointer to the 4-vector jet area

Detailed Description

Class to contain structure information for a filtered jet.

Definition at line 220 of file Filter.hh.


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