fastjet::SISConeBaseExtras Class Reference

Class that provides extra information about a SISCone clustering the only thing that needs to be done for thee derived classes is to define '_jet_def_plugin', implement jet_def_plugin(); and add the corresponding plugin class as a friend. More...

#include <SISConeBasePlugin.hh>

Inheritance diagram for fastjet::SISConeBaseExtras:

Collaboration diagram for fastjet::SISConeBaseExtras:

List of all members.

Public Member Functions
	SISConeBaseExtras (int nparticles)
	constructor
virtual	~SISConeBaseExtras ()=0
	purely virtual destructor
const std::vector< PseudoJet > &	stable_cones () const
	returns a reference to the vector of stable cones (aka protocones)
const std::vector< PseudoJet > &	protocones () const
	an old name for getting the vector of stable cones (aka protocones)
int	pass (const PseudoJet &jet) const
	return the # of the pass at which a given jet was found; will return -1 if the pass is invalid
std::string	description () const
	return a brief summary of the contents of the extras object (specifically, the number of protocones.
double	most_ambiguous_split () const
	return the smallest difference in squared distance encountered during splitting between a particle and two overlapping protojets.
Protected Attributes
std::vector< PseudoJet >	_protocones
std::vector< int >	_pass
double	_most_ambiguous_split
const SISConeBasePlugin *	_jet_def_plugin

---

Detailed Description

Class that provides extra information about a SISCone clustering the only thing that needs to be done for thee derived classes is to define '_jet_def_plugin', implement jet_def_plugin(); and add the corresponding plugin class as a friend.

Definition at line 131 of file SISConeBasePlugin.hh.

---

Constructor & Destructor Documentation

fastjet::SISConeBaseExtras::SISConeBaseExtras

(

int

nparticles

)

[inline]

constructor

Definition at line 136 of file SISConeBasePlugin.hh.

: _pass(nparticles*2,-1) {}

fastjet::SISConeBaseExtras::~SISConeBaseExtras

(

)

[inline, pure virtual]

purely virtual destructor

give the destructor its required implementation

Definition at line 173 of file SISConeBasePlugin.hh.

{}

---

Member Function Documentation

std::string fastjet::SISConeBaseExtras::description

(

)

const [inline, virtual]

return a brief summary of the contents of the extras object (specifically, the number of protocones.

Reimplemented from fastjet::ClusterSequence::Extras.

Definition at line 153 of file SISConeBasePlugin.hh.

                               {
    std::ostringstream ostr;
    ostr << "This SISCone clustering found " << protocones().size()
         << " stable protocones";
    return ostr.str();
  };

double fastjet::SISConeBaseExtras::most_ambiguous_split

(

)

const [inline]

return the smallest difference in squared distance encountered during splitting between a particle and two overlapping protojets.

Definition at line 163 of file SISConeBasePlugin.hh.

Referenced by main().

{return _most_ambiguous_split;}

int fastjet::SISConeBaseExtras::pass

(

const PseudoJet &

jet

)

const [inline]

return the # of the pass at which a given jet was found; will return -1 if the pass is invalid

Definition at line 149 of file SISConeBasePlugin.hh.

References fastjet::PseudoJet::cluster_hist_index().

Referenced by main().

{return _pass[jet.cluster_hist_index()];}

const std::vector<PseudoJet>& fastjet::SISConeBaseExtras::protocones

(

)

const [inline]

an old name for getting the vector of stable cones (aka protocones)

Definition at line 145 of file SISConeBasePlugin.hh.

{return _protocones;}

const std::vector<PseudoJet>& fastjet::SISConeBaseExtras::stable_cones

(

)

const [inline]

returns a reference to the vector of stable cones (aka protocones)

Definition at line 142 of file SISConeBasePlugin.hh.

Referenced by main().

{return _protocones;}

---

Member Data Documentation

const SISConeBasePlugin* fastjet::SISConeBaseExtras::_jet_def_plugin [protected]

Definition at line 169 of file SISConeBasePlugin.hh.

Referenced by fastjet::SISConeSphericalPlugin::run_clustering(), and fastjet::SISConePlugin::run_clustering().

double fastjet::SISConeBaseExtras::_most_ambiguous_split [protected]

Definition at line 168 of file SISConeBasePlugin.hh.

Referenced by fastjet::SISConeSphericalPlugin::run_clustering(), and fastjet::SISConePlugin::run_clustering().

std::vector<int> fastjet::SISConeBaseExtras::_pass [protected]

Definition at line 167 of file SISConeBasePlugin.hh.

Referenced by fastjet::SISConeSphericalPlugin::run_clustering(), and fastjet::SISConePlugin::run_clustering().

std::vector<PseudoJet> fastjet::SISConeBaseExtras::_protocones [protected]

Definition at line 166 of file SISConeBasePlugin.hh.

Referenced by fastjet::SISConeSphericalPlugin::run_clustering(), and fastjet::SISConePlugin::run_clustering().

---

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

• plugins/SISCone/fastjet/SISConeBasePlugin.hh