|
FastJet 3.0.2
|
|
FastJet 3.0.2
|
This wraps a (shared) pointer to an underlying structure. More...
#include <fastjet/WrappedStructure.hh>
Public Member Functions | |
| WrappedStructure (const SharedPtr< PseudoJetStructureBase > &to_be_shared) | |
| default ctor the argument is the structure we need to wrap | |
| virtual | ~WrappedStructure () |
| 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 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< PseudoJet > | pieces (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. | |
Protected Attributes | |
| SharedPtr< PseudoJetStructureBase > | _structure |
| the wrapped structure | |
This wraps a (shared) pointer to an underlying structure.
The typical use-case is when a PseusoJet needs to share its structure with another PseudoJet but also include extra information in its structure. For the memory management to be handled properly, it should hold a shared pointer to the shared structure. This is what this class ensures. Deriving a structure from this class would then allow for the implementation of the extra features.
Definition at line 51 of file WrappedStructure.hh.
| virtual bool fastjet::WrappedStructure::has_valid_cluster_sequence | ( | ) | const [inline, virtual] |
returns true if this PseudoJet has an associated and still valid ClusterSequence.
Reimplemented from fastjet::PseudoJetStructureBase.
Definition at line 88 of file WrappedStructure.hh.
| virtual bool fastjet::WrappedStructure::has_partner | ( | const PseudoJet & | reference, |
| PseudoJet & | partner | ||
| ) | const [inline, 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 from fastjet::PseudoJetStructureBase.
Definition at line 120 of file WrappedStructure.hh.
| virtual bool fastjet::WrappedStructure::has_child | ( | const PseudoJet & | reference, |
| PseudoJet & | child | ||
| ) | const [inline, 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 from fastjet::PseudoJetStructureBase.
Definition at line 129 of file WrappedStructure.hh.
| virtual bool fastjet::WrappedStructure::has_parents | ( | const PseudoJet & | reference, |
| PseudoJet & | parent1, | ||
| PseudoJet & | parent2 | ||
| ) | const [inline, 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 from fastjet::PseudoJetStructureBase.
Definition at line 138 of file WrappedStructure.hh.
| virtual bool fastjet::WrappedStructure::object_in_jet | ( | const PseudoJet & | reference, |
| const PseudoJet & | jet | ||
| ) | const [inline, virtual] |
check if the reference PseudoJet is contained the second one passed as argument.
By default, throws an Error
Reimplemented from fastjet::PseudoJetStructureBase.
Definition at line 146 of file WrappedStructure.hh.
| virtual bool fastjet::WrappedStructure::has_constituents | ( | ) | const [inline, virtual] |
return true if the structure supports constituents.
false by default
Reimplemented from fastjet::PseudoJetStructureBase.
Definition at line 154 of file WrappedStructure.hh.
| virtual std::vector<PseudoJet> fastjet::WrappedStructure::constituents | ( | const PseudoJet & | reference | ) | const [inline, virtual] |
retrieve the constituents.
By default, throws an Error
Reimplemented from fastjet::PseudoJetStructureBase.
Definition at line 161 of file WrappedStructure.hh.
| virtual std::vector<PseudoJet> fastjet::WrappedStructure::exclusive_subjets | ( | const PseudoJet & | reference, |
| const double & | dcut | ||
| ) | const [inline, 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 from fastjet::PseudoJetStructureBase.
Definition at line 180 of file WrappedStructure.hh.
| virtual int fastjet::WrappedStructure::n_exclusive_subjets | ( | const PseudoJet & | reference, |
| const double & | dcut | ||
| ) | const [inline, 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 from fastjet::PseudoJetStructureBase.
Definition at line 189 of file WrappedStructure.hh.
| virtual std::vector<PseudoJet> fastjet::WrappedStructure::exclusive_subjets_up_to | ( | const PseudoJet & | reference, |
| int | nsub | ||
| ) | const [inline, virtual] |
return the list of subjets obtained by unclustering the supplied jet down to n subjets (or all constituents if there are fewer than n).
By default, throws an Error
Reimplemented from fastjet::PseudoJetStructureBase.
Definition at line 198 of file WrappedStructure.hh.
| virtual double fastjet::WrappedStructure::exclusive_subdmerge | ( | const PseudoJet & | reference, |
| int | nsub | ||
| ) | const [inline, virtual] |
return the dij that was present in the merging nsub+1 -> nsub subjets inside this jet.
By default, throws an Error
Reimplemented from fastjet::PseudoJetStructureBase.
Definition at line 206 of file WrappedStructure.hh.
| virtual double fastjet::WrappedStructure::exclusive_subdmerge_max | ( | const PseudoJet & | reference, |
| int | nsub | ||
| ) | const [inline, 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 from fastjet::PseudoJetStructureBase.
Definition at line 215 of file WrappedStructure.hh.
| virtual bool fastjet::WrappedStructure::has_pieces | ( | const PseudoJet & | reference | ) | const [inline, virtual] |
return true if the structure supports pieces.
false by default
Reimplemented from fastjet::PseudoJetStructureBase.
Definition at line 226 of file WrappedStructure.hh.
| virtual std::vector<PseudoJet> fastjet::WrappedStructure::pieces | ( | const PseudoJet & | reference | ) | const [inline, virtual] |
retrieve the pieces building the jet.
By default, throws an Error
Reimplemented from fastjet::PseudoJetStructureBase.
Definition at line 233 of file WrappedStructure.hh.
| virtual bool fastjet::WrappedStructure::has_area | ( | ) | const [inline, virtual] |
check if it has a defined area
false by default
Reimplemented from fastjet::PseudoJetStructureBase.
Definition at line 244 of file WrappedStructure.hh.
| virtual double fastjet::WrappedStructure::area | ( | const PseudoJet & | reference | ) | const [inline, virtual] |
return the jet (scalar) area.
By default, throws an Error
Reimplemented from fastjet::PseudoJetStructureBase.
Definition at line 251 of file WrappedStructure.hh.
| virtual double fastjet::WrappedStructure::area_error | ( | const PseudoJet & | reference | ) | const [inline, virtual] |
return the error (uncertainty) associated with the determination of the area of this jet.
By default, throws an Error
Reimplemented from fastjet::PseudoJetStructureBase.
Definition at line 259 of file WrappedStructure.hh.
| virtual PseudoJet fastjet::WrappedStructure::area_4vector | ( | const PseudoJet & | reference | ) | const [inline, virtual] |
return the jet 4-vector area.
By default, throws an Error
Reimplemented from fastjet::PseudoJetStructureBase.
Definition at line 266 of file WrappedStructure.hh.
| virtual bool fastjet::WrappedStructure::is_pure_ghost | ( | const PseudoJet & | reference | ) | const [inline, virtual] |
true if this jet is made exclusively of ghosts.
By default, throws an Error
Reimplemented from fastjet::PseudoJetStructureBase.
Definition at line 273 of file WrappedStructure.hh.
1.7.4
