base class providing interface for a generic function of a PseudoJet More...
#include <fastjet/FunctionOfPseudoJet.hh>
Public Member Functions | |
| FunctionOfPseudoJet () | |
| default ctor | |
| virtual | ~FunctionOfPseudoJet () |
| default dtor (virtual to allow safe polymorphism) | |
| virtual std::string | description () const |
| returns a description of the function (an empty string by default) | |
| virtual TOut | result (const PseudoJet &pj) const =0 |
| the action of the function this has to be overloaded in derived classes More... | |
| TOut | operator() (const PseudoJet &pj) const |
| apply the function using the "traditional" () operator. More... | |
| std::vector< TOut > | operator() (const std::vector< PseudoJet > &pjs) const |
| apply the function on a vector of PseudoJet, returning a vector of the results. More... | |
Detailed Description
template<typename TOut>
class fastjet::FunctionOfPseudoJet< TOut >
base class providing interface for a generic function of a PseudoJet
This class serves as a base class to provide a standard interface for a function that returns an object of a given (templated) type that depends on a PseudoJet argument. The rationale for using a class (rather than a pointer to a function) is that a class can be constructed with (and store) additional arguments.
Definition at line 48 of file FunctionOfPseudoJet.hh.
Member Function Documentation
◆ result()
|
pure virtual |
the action of the function this has to be overloaded in derived classes
- Parameters
-
pj the PseudoJet input to the function
Implemented in fastjet::BackgroundJetPtMDensity, fastjet::BackgroundJetScalarPtDensity, fastjet::BackgroundJetPtDensity, fastjet::BackgroundRescalingYPolynomial, fastjet::Recluster, fastjet::Subtractor, fastjet::SISConeBasePlugin::UserScaleBase, fastjet::Filter, fastjet::CASubJetTagger, fastjet::Pruner, fastjet::JHTopTagger, fastjet::RestFrameNSubjettinessTagger, fastjet::MassDropTagger, fastjet::Transformer, fastjet::Unboost, and fastjet::Boost.
◆ operator()() [1/2]
|
inline |
apply the function using the "traditional" () operator.
By default, this just calls the apply(...) method above.
- Parameters
-
pj the PseudoJet input to the function
Definition at line 75 of file FunctionOfPseudoJet.hh.
◆ operator()() [2/2]
|
inline |
apply the function on a vector of PseudoJet, returning a vector of the results.
This just calls apply on every PseudoJet in the vector.
- Parameters
-
pjs the vector of PseudoJet inputs to the function
Definition at line 81 of file FunctionOfPseudoJet.hh.
The documentation for this class was generated from the following file:
- include/fastjet/FunctionOfPseudoJet.hh
