FastJet
3.0.2
|
Base (abstract) class for a jet transformer. More...
#include <fastjet/tools/Transformer.hh>
Public Types | |
typedef PseudoJetStructureBase | StructureType |
A typedef that is needed to ensure that the PseudoJet::structure_of() template function works. | |
Public Member Functions | |
Transformer () | |
default ctor | |
virtual | ~Transformer () |
default dtor | |
virtual PseudoJet | result (const PseudoJet &original) const =0 |
the result of the Transformer acting on the PseudoJet. | |
virtual std::string | description () const =0 |
This should be overloaded to return a description of the Transformer. |
Base (abstract) class for a jet transformer.
A transformer, when it acts on a jet, returns a modified version of that jet, one that may have a different momentum and/or different internal structure.
The typical usage of a class derived from Transformer is
SomeTransformer transformer(...);
PseudoJet transformed_jet = transformer(original_jet);
// or
vector<PseudoJet> transformed_jets = transformer(original_jets);
For many transformers, the transformed jets have transformer-specific information that can be accessed through the
transformed_jet.structure_of<SomeTransformer>().transformer_specific_info();
See the description of the Filter class for a more detailed usage example. See the FastJet manual to find out how to implement new transformers.
Definition at line 69 of file Transformer.hh.
virtual PseudoJet fastjet::Transformer::result | ( | const PseudoJet & | original | ) | const [pure virtual] |
the result of the Transformer acting on the PseudoJet.
this _has_ to be overloaded in derived classes
original | the PseudoJet input to the Transformer |
Implements fastjet::FunctionOfPseudoJet< PseudoJet >.
Implemented in fastjet::CASubJetTagger, fastjet::Filter, fastjet::JHTopTagger, fastjet::Pruner, fastjet::RestFrameNSubjettinessTagger, and fastjet::MassDropTagger.