FastJet  3.3.0
Public Member Functions | List of all members
fastjet::SelectorWorker Class Referenceabstract

default selector worker is an abstract virtual base class More...

#include <fastjet/Selector.hh>

Inherited by fastjet::SW_BinaryOperator, fastjet::SW_Identity, fastjet::SW_IsPureGhost, fastjet::SW_IsZero, fastjet::SW_NHardest, fastjet::SW_Not, fastjet::SW_PhiRange, fastjet::SW_QuantityMax< QuantityType >, fastjet::SW_QuantityMin< QuantityType >, fastjet::SW_QuantityRange< QuantityType >, fastjet::SW_RangeDefinition, fastjet::SW_WithReference, SW_IsPi0Gamma, fastjet::SW_QuantityMax< QuantityAbsRap >, fastjet::SW_QuantityMax< QuantityRap >, fastjet::SW_QuantityMin< QuantityRap >, fastjet::SW_QuantityRange< QuantityAbsRap >, fastjet::SW_QuantityRange< QuantityRap >, and SW_VertexNumber.

Public Member Functions

virtual ~SelectorWorker ()
 default dtor
 
virtual bool pass (const PseudoJet &jet) const =0
 returns true if a given object passes the selection criterion, and is the main function that needs to be overloaded by derived workers. More...
 
virtual void terminator (std::vector< const PseudoJet *> &jets) const
 For each jet that does not pass the cuts, this routine sets the pointer to 0. More...
 
virtual bool applies_jet_by_jet () const
 returns true if this can be applied jet by jet
 
virtual std::string description () const
 returns a description of the worker
 
virtual bool takes_reference () const
 returns true if the worker is defined with respect to a reference jet
 
virtual void set_reference (const PseudoJet &)
 sets the reference jet for the selector NB: "reference" is commented to avoid unused-variable compiler warnings
 
virtual SelectorWorkercopy ()
 return a copy of the current object. More...
 
virtual void get_rapidity_extent (double &rapmin, double &rapmax) const
 returns the rapidity range for which it may return "true"
 
virtual bool is_geometric () const
 check if it is a geometric selector (i.e. More...
 
virtual bool has_finite_area () const
 check if it has a finite area
 
virtual bool has_known_area () const
 check if it has an analytically computable area
 
virtual double known_area () const
 if it has a computable area, return it
 

Detailed Description

default selector worker is an abstract virtual base class

The Selector class is only an interface, it is the SelectorWorker that really does the work. To implement various selectors, one thus has to overload this class.

Definition at line 59 of file Selector.hh.

Member Function Documentation

◆ pass()

virtual bool fastjet::SelectorWorker::pass ( const PseudoJet jet) const
pure virtual

returns true if a given object passes the selection criterion, and is the main function that needs to be overloaded by derived workers.

NB: this function is used only if applies_jet_by_jet() returns true. If it does not, then derived classes are expected to (re)implement the terminator function()

◆ terminator()

virtual void fastjet::SelectorWorker::terminator ( std::vector< const PseudoJet *> &  jets) const
inlinevirtual

For each jet that does not pass the cuts, this routine sets the pointer to 0.

It does not assume that the PseudoJet* passed as argument are not NULL

Definition at line 84 of file Selector.hh.

◆ copy()

virtual SelectorWorker* fastjet::SelectorWorker::copy ( )
inlinevirtual

return a copy of the current object.

This function is only called for objects that take a reference and need not be reimplemented otherwise.

Definition at line 114 of file Selector.hh.

◆ is_geometric()

virtual bool fastjet::SelectorWorker::is_geometric ( ) const
inlinevirtual

check if it is a geometric selector (i.e.

only puts constraints on rapidity and azimuthal angle)

Definition at line 130 of file Selector.hh.


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