30 #ifndef __FASTJET_PSEUDOJET_HH__ 31 #define __FASTJET_PSEUDOJET_HH__ 38 #include "fastjet/internal/numconsts.hh" 39 #include "fastjet/internal/IsBase.hh" 40 #include "fastjet/SharedPtr.hh" 41 #include "fastjet/Error.hh" 42 #include "fastjet/PseudoJetStructureBase.hh" 44 FASTJET_BEGIN_NAMESPACE
54 const double pseudojet_invalid_rap = -1e200;
77 PseudoJet() : _px(0), _py(0), _pz(0), _E(0) {_finish_init(); _reset_indices();}
80 PseudoJet(
const double px,
const double py,
const double pz,
const double E);
83 template <
class L>
PseudoJet(
const L & some_four_vector);
99 inline double E()
const {
return _E;}
100 inline double e()
const {
return _E;}
101 inline double px()
const {
return _px;}
102 inline double py()
const {
return _py;}
103 inline double pz()
const {
return _pz;}
106 inline double phi()
const {
return phi_02pi();}
110 _ensure_valid_rap_phi();
111 return _phi > pi ? _phi-twopi : _phi;}
115 _ensure_valid_rap_phi();
121 inline double rap()
const {
122 _ensure_valid_rap_phi();
131 double pseudorapidity()
const;
132 double eta()
const {
return pseudorapidity();}
135 inline double pt2()
const {
return _kt2;}
137 inline double pt()
const {
return sqrt(_kt2);}
139 inline double perp2()
const {
return _kt2;}
141 inline double perp()
const {
return sqrt(_kt2);}
143 inline double kt2()
const {
return _kt2;}
146 inline double m2()
const {
return (_E+_pz)*(_E-_pz)-_kt2;}
149 inline double m()
const;
152 inline double mperp2()
const {
return (_E+_pz)*(_E-_pz);}
154 inline double mperp()
const {
return sqrt(std::abs(mperp2()));}
156 inline double mt2()
const {
return (_E+_pz)*(_E-_pz);}
158 inline double mt()
const {
return sqrt(std::abs(mperp2()));}
161 inline double modp2()
const {
return _kt2+_pz*_pz;}
163 inline double modp()
const {
return sqrt(_kt2+_pz*_pz);}
166 inline double Et()
const {
return (_kt2==0) ? 0.0 : _E/sqrt(1.0+_pz*_pz/_kt2);}
168 inline double Et2()
const {
return (_kt2==0) ? 0.0 : _E*_E/(1.0+_pz*_pz/_kt2);}
171 double operator () (
int i)
const ;
173 inline double operator [] (
int i)
const {
return (*
this)(i); };
178 double kt_distance(
const PseudoJet & other)
const;
181 double plain_distance(
const PseudoJet & other)
const;
185 return plain_distance(other);}
190 return sqrt(squared_distance(other));
195 double delta_phi_to(
const PseudoJet & other)
const;
207 std::valarray<double> four_mom()
const;
212 enum { X=0, Y=1, Z=2, T=3, NUM_COORDINATES=4, SIZE=NUM_COORDINATES };
226 void operator*=(
double);
227 void operator/=(
double);
233 inline void reset(
double px,
double py,
double pz,
double E);
249 template <
class L>
inline void reset(
const L & some_four_vector) {
261 const PseudoJet * pj = fastjet::cast_if_derived<const PseudoJet>(&some_four_vector);
266 reset(some_four_vector[0], some_four_vector[1],
267 some_four_vector[2], some_four_vector[3]);
274 inline void reset_PtYPhiM(
double pt_in,
double y_in,
double phi_in,
double m_in=0.0) {
275 reset_momentum_PtYPhiM(pt_in, y_in, phi_in, m_in);
282 inline void reset_momentum(
double px,
double py,
double pz,
double E);
287 inline void reset_momentum(
const PseudoJet & pj);
291 void reset_momentum_PtYPhiM(
double pt,
double y,
double phi,
double m=0.0);
297 reset_momentum(some_four_vector[0], some_four_vector[1],
298 some_four_vector[2], some_four_vector[3]);
313 void set_cached_rap_phi(
double rap,
double phi);
386 _user_info.reset(user_info_in);
420 return dynamic_cast<const L &
>(* _user_info.get());
425 return _user_info.get();
432 return _user_info.get() &&
dynamic_cast<const L *
>(_user_info.get());
437 if (!_user_info())
return NULL;
438 return _user_info.get();
476 std::string description()
const;
490 bool has_associated_cluster_sequence()
const;
496 bool has_valid_cluster_sequence()
const;
504 const ClusterSequence* associated_cs()
const {
return associated_cluster_sequence();}
509 return validated_cs();
518 return validated_csab();
541 bool has_structure()
const;
575 template<
typename StructureType>
576 const StructureType & structure()
const;
581 template<
typename TransformerType>
582 bool has_structure_of()
const;
589 template<
typename TransformerType>
590 const typename TransformerType::StructureType & structure_of()
const;
609 virtual bool has_partner(
PseudoJet &partner)
const;
617 virtual bool has_child(
PseudoJet &child)
const;
632 virtual bool contains(
const PseudoJet &constituent)
const;
639 virtual bool is_inside(
const PseudoJet &jet)
const;
643 virtual bool has_constituents()
const;
649 virtual std::vector<PseudoJet> constituents()
const;
653 virtual bool has_exclusive_subjets()
const;
666 std::vector<PseudoJet> exclusive_subjets (
const double & dcut)
const;
674 int n_exclusive_subjets(
const double & dcut)
const;
684 std::vector<PseudoJet> exclusive_subjets (
int nsub)
const;
694 std::vector<PseudoJet> exclusive_subjets_up_to (
int nsub)
const;
701 double exclusive_subdmerge(
int nsub)
const;
709 double exclusive_subdmerge_max(
int nsub)
const;
719 virtual bool has_pieces()
const;
725 virtual std::vector<PseudoJet> pieces()
const;
734 virtual bool has_area()
const;
738 virtual double area()
const;
743 virtual double area_error()
const;
751 virtual bool is_pure_ghost()
const;
770 return cluster_hist_index();}
774 set_cluster_hist_index(index);}
786 double _px,_py,_pz,_E;
787 mutable double _phi, _rap;
789 int _cluster_hist_index, _user_index;
794 void _reset_indices();
798 inline void _ensure_valid_rap_phi()
const {
803 void _set_rap_phi()
const;
833 return a.E()*b.E() - a.px()*b.px() - a.py()*b.py() - a.pz()*b.pz();
847 std::vector<PseudoJet>
sorted_by_pt(
const std::vector<PseudoJet> & jets);
853 std::vector<PseudoJet>
sorted_by_E(
const std::vector<PseudoJet> & jets);
856 std::vector<PseudoJet>
sorted_by_pz(
const std::vector<PseudoJet> & jets);
863 void sort_indices(std::vector<int> & indices,
864 const std::vector<double> & values);
871 const std::vector<double> & values);
878 class IndexedSortHelper {
880 inline IndexedSortHelper (
const std::vector<double> * reference_values) {
881 _ref_values = reference_values;
883 inline int operator() (
const int & i1,
const int & i2)
const {
884 return (*_ref_values)[i1] < (*_ref_values)[i2];
887 const std::vector<double> * _ref_values;
895 template <
class L>
inline PseudoJet::PseudoJet(
const L & some_four_vector) {
896 reset(some_four_vector);
900 inline void PseudoJet::_reset_indices() {
901 set_cluster_hist_index(-1);
909 inline double PseudoJet::m()
const {
911 return mm < 0.0 ? -std::sqrt(-mm) : std::sqrt(mm);
915 inline void PseudoJet::reset(
double px_in,
double py_in,
double pz_in,
double E_in) {
924 inline void PseudoJet::reset_momentum(
double px_in,
double py_in,
double pz_in,
double E_in) {
932 inline void PseudoJet::reset_momentum(
const PseudoJet & pj) {
951 template<
typename StructureType>
952 const StructureType & PseudoJet::structure()
const{
953 return dynamic_cast<const StructureType &
>(* validated_structure_ptr());
959 template<
typename TransformerType>
960 bool PseudoJet::has_structure_of()
const{
961 if (!_structure())
return false;
963 return dynamic_cast<const typename TransformerType::StructureType *
>(_structure.get()) != 0;
969 template<
typename TransformerType>
970 const typename TransformerType::StructureType & PseudoJet::structure_of()
const{
972 throw Error(
"Trying to access the structure of a PseudoJet without an associated structure");
974 return dynamic_cast<const typename TransformerType::StructureType &
>(*_structure);
991 PseudoJet join(
const std::vector<PseudoJet> & pieces);
1007 FASTJET_END_NAMESPACE
1009 #endif // __FASTJET_PSEUDOJET_HH__ PseudoJet PtYPhiM(double pt, double y, double phi, double m)
return a pseudojet with the given pt, y, phi and mass
void reset_momentum(const L &some_four_vector)
reset the 4-momentum according to the supplied generic 4-vector (accessible via indexing, [0]==px,...[3]==E), but leave all other information (indices, user info, etc.) untouched
double Et2() const
return the transverse energy squared
double m2() const
returns the squared invariant mass // like CLHEP
double mt2() const
returns the squared transverse mass = kt^2+m^2
vector< PseudoJet > sorted_by_pt(const vector< PseudoJet > &jets)
return a vector of jets sorted into decreasing kt2
const ClusterSequence * validated_cluster_sequence() const
if the jet has a valid associated cluster sequence then return a pointer to it; otherwise throw an er...
void set_user_index(const int index)
set the user_index, intended to allow the user to add simple identifying information to a particle/je...
double Et() const
return the transverse energy
const double MaxRap
Used to protect against parton-level events where pt can be zero for some partons, giving rapidity=infinity.
void reset(const PseudoJet &psjet)
reset the PseudoJet to be equal to psjet (including its indices); NB if the argument is derived from ...
int cluster_sequence_history_index() const
alternative name for cluster_hist_index() [perhaps more meaningful]
void reset(const L &some_four_vector)
reset the 4-momentum according to the supplied generic 4-vector (accessible via indexing, [0]==px,...[3]==E) and put the user and history indices back to their default values.
bool has_valid_cs() const
shorthand for has_valid_cluster_sequence()
const UserInfoBase * user_info_ptr() const
retrieve a pointer to the (const) user information
Selector operator*(const Selector &s1, const Selector &s2)
successive application of 2 selectors
vector< PseudoJet > sorted_by_pz(const vector< PseudoJet > &jets)
return a vector of jets sorted into increasing pz
double phi_02pi() const
returns phi in the range 0..2pi
double squared_distance(const PseudoJet &other) const
returns squared cylinder (rap-phi) distance between this jet and another
void reset_PtYPhiM(double pt_in, double y_in, double phi_in, double m_in=0.0)
reset the PseudoJet according to the specified pt, rapidity, azimuth and mass (also resetting indices...
void set_user_info(UserInfoBase *user_info_in)
sets the internal shared pointer to the user information.
vector< PseudoJet > sorted_by_rapidity(const vector< PseudoJet > &jets)
return a vector of jets sorted into increasing rapidity
double pt() const
returns the scalar transverse momentum
double rapidity() const
the same as rap()
Contains any information related to the clustering that should be directly accessible to PseudoJet...
void set_cluster_sequence_history_index(const int index)
alternative name for set_cluster_hist_index(...) [perhaps more meaningful]
bool has_user_info() const
returns true if the PseudoJet has user information than can be cast to the template argument type...
double phi_std() const
returns phi in the range -pi..pi
vector< T > objects_sorted_by_values(const vector< T > &objects, const vector< double > &values)
given a vector of values with a one-to-one correspondence with the vector of objects, sort objects into an order such that the associated values would be in increasing order
double modp2() const
return the squared 3-vector modulus = px^2+py^2+pz^2
bool operator==(const PseudoJet &a, const PseudoJet &b)
returns true if the 4 momentum components of the two PseudoJets are identical and all the internal in...
const SharedPtr< UserInfoBase > & user_info_shared_ptr() const
retrieve a (const) shared pointer to the user information
virtual ~PseudoJet()
default (virtual) destructor
double perp() const
returns the scalar transverse momentum
void set_cluster_hist_index(const int index)
set the cluster_hist_index, intended to be used by clustering routines.
bool has_associated_cs() const
shorthand for has_associated_cluster_sequence()
base class that sets interface for extensions of ClusterSequence that provide information about the a...
error class to be thrown if accessing user info when it doesn't exist
vector< PseudoJet > sorted_by_E(const vector< PseudoJet > &jets)
return a vector of jets sorted into decreasing energy
bool has_user_info() const
returns true if the PseudoJet has user information
base class corresponding to errors that can be thrown by FastJet
double kt2() const
returns the squared transverse momentum
int cluster_hist_index() const
return the cluster_hist_index, intended to be used by clustering routines.
double perp2() const
returns the squared transverse momentum
double delta_R(const PseudoJet &other) const
return the cylinder (rap-phi) distance between this jet and another, .
an implementation of C++0x shared pointers (or boost's)
bool operator!=(const PseudoJet &a, const PseudoJet &b)
inequality test which is exact opposite of operator==
double phi() const
returns phi (in the range 0..2pi)
double rap() const
returns the rapidity or some large value when the rapidity is infinite
double modp() const
return the 3-vector modulus = sqrt(px^2+py^2+pz^2)
const L & user_info() const
returns a reference to the dynamic cast conversion of user_info to type L.
bool have_same_momentum(const PseudoJet &jeta, const PseudoJet &jetb)
returns true if the momenta of the two input jets are identical
double mt() const
returns the transverse mass = sqrt(kt^2+m^2)
a base class to hold extra user information in a PseudoJet
double mperp() const
returns the transverse mass = sqrt(kt^2+m^2)
double pt2() const
returns the squared transverse momentum
PseudoJet()
default constructor, which as of FJ3.0 provides an object for which all operations are now valid and ...
const double pseudojet_invalid_phi
default value for phi, meaning it (and rapidity) have yet to be calculated)
Class to contain pseudojets, including minimal information of use to jet-clustering routines...
const ClusterSequenceAreaBase * validated_cluster_sequence_area_base() const
if the jet has valid area information then return a pointer to the associated ClusterSequenceAreaBase...
int user_index() const
return the user_index,
double beam_distance() const
returns distance between this jet and the beam
SharedPtr< UserInfoBase > & user_info_shared_ptr()
retrieve a (non-const) shared pointer to the user information; you can use this, for example...
double mperp2() const
returns the squared transverse mass = kt^2+m^2