siscone is hosted by Hepforge, IPPP Durham

The SISCone Jet Algorithm

Version 3.0.6



SISCone 3.0.6
siscone_spherical::CSphsplit_merge::Cuser_scale_base Class Referenceabstract

base class for user-defined ordering of stable cones More...

#include <split_merge.h>

Public Member Functions

virtual ~Cuser_scale_base ()
 empty virtual dtor More...
 
virtual double operator() (const CSphjet &jet) const =0
 the scale associated with a given jet More...
 
virtual bool is_larger (const CSphjet &a, const CSphjet &b) const
 returns true when the scale associated with jet a is larger than the scale associated with jet b More...
 

Detailed Description

base class for user-defined ordering of stable cones

derived classes have to implement the () operator that returns the scale associated with a given jet.

Definition at line 245 of file split_merge.h.

Constructor & Destructor Documentation

◆ ~Cuser_scale_base()

virtual siscone_spherical::CSphsplit_merge::Cuser_scale_base::~Cuser_scale_base ( )
inlinevirtual

empty virtual dtor

Definition at line 248 of file split_merge.h.

Member Function Documentation

◆ is_larger()

virtual bool siscone_spherical::CSphsplit_merge::Cuser_scale_base::is_larger ( const CSphjet a,
const CSphjet b 
) const
inlinevirtual

returns true when the scale associated with jet a is larger than the scale associated with jet b

By default this does a simple direct comparison but it can be overloaded for higher precision [recommended if possible]

This function assumes that a.sm_var2 and b.sm_var2 have been correctly initialised with the signed squared output of operator(), as is by default the case when is_larger is called from within siscone.

Definition at line 266 of file split_merge.h.

References siscone_spherical::CSphjet::sm_var2.

Referenced by siscone_spherical::CSphsplit_merge::add_hardest_protocone_to_jets().

◆ operator()()

virtual double siscone_spherical::CSphsplit_merge::Cuser_scale_base::operator() ( const CSphjet jet) const
pure virtual

the scale associated with a given jet

"progressive removal" iteratively removes the stable cone with the largest scale


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

The SISCone project has been developed by Gavin Salam and Gregory Soyez
Documentation generated on Tue Jun 20 2023 18:08:37 for SISCone by  Doxygen 1.9.4