|
FastJet 3.0.6
|
|
FastJet 3.0.6
|
Contains any information related to the clustering that should be directly accessible to PseudoJet. More...
#include <fastjet/PseudoJetStructureBase.hh>
Public Member Functions | |
| PseudoJetStructureBase () | |
| default ctor | |
| virtual | ~PseudoJetStructureBase () |
| default (virtual) dtor | |
| virtual std::string | description () const |
| description | |
Direct access to the associated ClusterSequence object. | |
Get access to the associated ClusterSequence (if any) | |
| virtual bool | has_associated_cluster_sequence () const |
| returns true if there is an associated ClusterSequence | |
| virtual const ClusterSequence * | associated_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 ClusterSequence * | validated_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 | |
Methods for access to information about jet structure | |
These allow access to jet constituents, and other jet subtructure information. They only work if the jet is associated with a ClusterSequence. | |
| 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< PseudoJet > | constituents (const PseudoJet &reference) const |
| retrieve the constituents. | |
| virtual bool | has_exclusive_subjets () const |
| return true if the structure supports exclusive_subjets. | |
| virtual std::vector< PseudoJet > | exclusive_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< PseudoJet > | exclusive_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. | |
| virtual bool | has_pieces (const PseudoJet &) const |
| return true if the structure supports pieces. | |
| virtual std::vector< PseudoJet > | pieces (const PseudoJet &) 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. | |
Contains any information related to the clustering that should be directly accessible to PseudoJet.
By default, this class implements basic access to the ClusterSequence related to a PseudoJet (like its constituents or its area). But it can be overloaded in order e.g. to give access to the jet substructure.
Definition at line 57 of file PseudoJetStructureBase.hh.
| virtual bool fastjet::PseudoJetStructureBase::has_valid_cluster_sequence | ( | ) | const [inline, virtual] |
returns true if this PseudoJet has an associated and still valid ClusterSequence.
Reimplemented in fastjet::ClusterSequenceStructure, and fastjet::WrappedStructure.
Definition at line 83 of file PseudoJetStructureBase.hh.
| bool fastjet::PseudoJetStructureBase::has_partner | ( | const PseudoJet & | reference, |
| PseudoJet & | partner | ||
| ) | const [virtual] |
check if it has been recombined with another PseudoJet in which case, return its partner through the argument.
Otherwise, 'partner' is set to 0.
By default, throws an Error
Reimplemented in fastjet::ClusterSequenceStructure, and fastjet::WrappedStructure.
Definition at line 102 of file PseudoJetStructureBase.cc.
| bool fastjet::PseudoJetStructureBase::has_child | ( | const PseudoJet & | reference, |
| PseudoJet & | child | ||
| ) | const [virtual] |
check if it has been recombined with another PseudoJet in which case, return its child through the argument.
Otherwise, 'child' is set to 0.
By default, throws an Error
Reimplemented in fastjet::ClusterSequenceStructure, and fastjet::WrappedStructure.
Definition at line 111 of file PseudoJetStructureBase.cc.
| bool fastjet::PseudoJetStructureBase::has_parents | ( | const PseudoJet & | reference, |
| PseudoJet & | parent1, | ||
| PseudoJet & | parent2 | ||
| ) | const [virtual] |
check if it is the product of a recombination, in which case return the 2 parents through the 'parent1' and 'parent2' arguments.
Otherwise, set these to 0.
By default, throws an Error
Reimplemented in fastjet::ClusterSequenceStructure, and fastjet::WrappedStructure.
Definition at line 120 of file PseudoJetStructureBase.cc.
| bool fastjet::PseudoJetStructureBase::object_in_jet | ( | const PseudoJet & | reference, |
| const PseudoJet & | jet | ||
| ) | const [virtual] |
check if the reference PseudoJet is contained the second one passed as argument.
By default, throws an Error
Reimplemented in fastjet::ClusterSequenceStructure, and fastjet::WrappedStructure.
Definition at line 128 of file PseudoJetStructureBase.cc.
| virtual bool fastjet::PseudoJetStructureBase::has_constituents | ( | ) | const [inline, virtual] |
return true if the structure supports constituents.
false by default
Reimplemented in fastjet::ClusterSequenceStructure, fastjet::CompositeJetStructure, and fastjet::WrappedStructure.
Definition at line 137 of file PseudoJetStructureBase.hh.
| vector< PseudoJet > fastjet::PseudoJetStructureBase::constituents | ( | const PseudoJet & | reference | ) | const [virtual] |
retrieve the constituents.
By default, throws an Error
Reimplemented in fastjet::ClusterSequenceStructure, fastjet::CompositeJetStructure, and fastjet::WrappedStructure.
Definition at line 135 of file PseudoJetStructureBase.cc.
| vector< PseudoJet > fastjet::PseudoJetStructureBase::exclusive_subjets | ( | const PseudoJet & | reference, |
| const double & | dcut | ||
| ) | const [virtual] |
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.
Time taken is O(m ln m), where m is the number of subjets that are found. If m gets to be of order of the total number of constituents in the jet, this could be substantially slower than just getting that list of constituents.
By default, throws an Error
Reimplemented in fastjet::ClusterSequenceStructure, and fastjet::WrappedStructure.
Definition at line 149 of file PseudoJetStructureBase.cc.
| int fastjet::PseudoJetStructureBase::n_exclusive_subjets | ( | const PseudoJet & | reference, |
| const double & | dcut | ||
| ) | const [virtual] |
return the size of exclusive_subjets(...); still n ln n with same coefficient, but marginally more efficient than manually taking exclusive_subjets.size()
By default, throws an Error
Reimplemented in fastjet::ClusterSequenceStructure, and fastjet::WrappedStructure.
Definition at line 158 of file PseudoJetStructureBase.cc.
| vector< PseudoJet > fastjet::PseudoJetStructureBase::exclusive_subjets_up_to | ( | const PseudoJet & | reference, |
| int | nsub | ||
| ) | const [virtual] |
return the list of subjets obtained by unclustering the supplied jet down to nsub subjets (or all constituents if there are fewer than nsub).
By default, throws an Error
Reimplemented in fastjet::ClusterSequenceStructure, and fastjet::WrappedStructure.
Definition at line 167 of file PseudoJetStructureBase.cc.
| double fastjet::PseudoJetStructureBase::exclusive_subdmerge | ( | const PseudoJet & | reference, |
| int | nsub | ||
| ) | const [virtual] |
return the dij that was present in the merging nsub+1 -> nsub subjets inside this jet.
By default, throws an Error
Reimplemented in fastjet::ClusterSequenceStructure, and fastjet::WrappedStructure.
Definition at line 175 of file PseudoJetStructureBase.cc.
| double fastjet::PseudoJetStructureBase::exclusive_subdmerge_max | ( | const PseudoJet & | reference, |
| int | nsub | ||
| ) | const [virtual] |
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.
By default, throws an Error
Reimplemented in fastjet::ClusterSequenceStructure, and fastjet::WrappedStructure.
Definition at line 184 of file PseudoJetStructureBase.cc.
| virtual bool fastjet::PseudoJetStructureBase::has_pieces | ( | const PseudoJet & | ) | const [inline, virtual] |
return true if the structure supports pieces.
false by default NB: "reference" is commented to avoid unused-variable compiler warnings
Reimplemented in fastjet::ClusterSequenceStructure, fastjet::CompositeJetStructure, and fastjet::WrappedStructure.
Definition at line 195 of file PseudoJetStructureBase.hh.
| std::vector< PseudoJet > fastjet::PseudoJetStructureBase::pieces | ( | const PseudoJet & | ) | const [virtual] |
retrieve the pieces building the jet.
By default, throws an Error. NB: "reference" is commented to avoid unused-variable compiler warnings
Reimplemented in fastjet::ClusterSequenceStructure, fastjet::CompositeJetStructure, and fastjet::WrappedStructure.
Definition at line 192 of file PseudoJetStructureBase.cc.
| virtual bool fastjet::PseudoJetStructureBase::has_area | ( | ) | const [inline, virtual] |
check if it has a defined area
false by default
Reimplemented in fastjet::ClusterSequenceStructure, fastjet::CompositeJetStructure, and fastjet::WrappedStructure.
Definition at line 214 of file PseudoJetStructureBase.hh.
| double fastjet::PseudoJetStructureBase::area | ( | const PseudoJet & | reference | ) | const [virtual] |
return the jet (scalar) area.
By default, throws an Error
Reimplemented in fastjet::ClusterSequenceStructure, fastjet::CompositeJetStructure, and fastjet::WrappedStructure.
Definition at line 204 of file PseudoJetStructureBase.cc.
| double fastjet::PseudoJetStructureBase::area_error | ( | const PseudoJet & | reference | ) | const [virtual] |
return the error (uncertainty) associated with the determination of the area of this jet.
By default, throws an Error
Reimplemented in fastjet::ClusterSequenceStructure, fastjet::CompositeJetStructure, and fastjet::WrappedStructure.
Definition at line 212 of file PseudoJetStructureBase.cc.
| PseudoJet fastjet::PseudoJetStructureBase::area_4vector | ( | const PseudoJet & | reference | ) | const [virtual] |
return the jet 4-vector area.
By default, throws an Error
Reimplemented in fastjet::ClusterSequenceStructure, fastjet::CompositeJetStructure, and fastjet::WrappedStructure.
Definition at line 219 of file PseudoJetStructureBase.cc.
| bool fastjet::PseudoJetStructureBase::is_pure_ghost | ( | const PseudoJet & | reference | ) | const [virtual] |
true if this jet is made exclusively of ghosts.
By default, throws an Error
Reimplemented in fastjet::ClusterSequenceStructure, fastjet::CompositeJetStructure, and fastjet::WrappedStructure.
Definition at line 226 of file PseudoJetStructureBase.cc.
1.7.4
