Loading...
Searching...
No Matches
Transformer.hh
//FJSTARTHEADER
// $Id$
//
// Copyright (c) 2005-2021, Matteo Cacciari, Gavin P. Salam and Gregory Soyez
//
//----------------------------------------------------------------------
// This file is part of FastJet.
//
// FastJet is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// The algorithms that underlie FastJet have required considerable
// development. They are described in the original FastJet paper,
// hep-ph/0512210 and in the manual, arXiv:1111.6097. If you use
// FastJet as part of work towards a scientific publication, please
// quote the version you use and include a citation to the manual and
// optionally also to hep-ph/0512210.
//
// FastJet is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with FastJet. If not, see <http://www.gnu.org/licenses/>.
//----------------------------------------------------------------------
//FJENDHEADER
#ifndef __FASTJET_TRANSFORMER_HH__
#define __FASTJET_TRANSFORMER_HH__
#include "fastjet/PseudoJet.hh"
#include "fastjet/FunctionOfPseudoJet.hh"
#include "fastjet/PseudoJetStructureBase.hh"
FASTJET_BEGIN_NAMESPACE // defined in fastjet/internal/base.hh
// forward declarations of what we will have down here
class Transformer;
/// @ingroup tools_generic
/// \class 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
/// \code
/// SomeTransformer transformer(...);
/// PseudoJet transformed_jet = transformer(original_jet);
/// // or
/// vector<PseudoJet> transformed_jets = transformer(original_jets);
/// \endcode
///
/// For many transformers, the transformed jets have
/// transformer-specific information that can be accessed through the
///
/// \code
/// transformed_jet.structure_of<SomeTransformer>().transformer_specific_info();
/// \endcode
///
/// 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.
///
class Transformer : public FunctionOfPseudoJet<PseudoJet>{
public:
/// default ctor
Transformer(){}
/// default dtor
virtual ~Transformer(){}
/// the result of the Transformer acting on the PseudoJet.
/// this _has_ to be overloaded in derived classes
/// \param original the PseudoJet input to the Transformer
virtual PseudoJet result(const PseudoJet & original) const = 0;
/// This should be overloaded to return a description of the
/// Transformer
virtual std::string description() const = 0;
/// A typedef that is needed to ensure that the
/// PseudoJet::structure_of() template function works
//
// Make sure you reimplement this appropriately in any
// derived classes
typedef PseudoJetStructureBase StructureType;
};
FASTJET_END_NAMESPACE // defined in fastjet/internal/base.hh
#endif // __FASTJET_TRANSFORMER_HH__
fastjet::FunctionOfPseudoJet< PseudoJet >::FunctionOfPseudoJet
FunctionOfPseudoJet()
Definition FunctionOfPseudoJet.hh:51
fastjet::PseudoJetStructureBase
Contains any information related to the clustering that should be directly accessible to PseudoJet.
Definition PseudoJetStructureBase.hh:59
fastjet::PseudoJet
Class to contain pseudojets, including minimal information of use to jet-clustering routines.
Definition PseudoJet.hh:68
fastjet::Transformer::description
virtual std::string description() const =0
This should be overloaded to return a description of the Transformer.
fastjet::Transformer::result
virtual PseudoJet result(const PseudoJet &original) const =0
the result of the Transformer acting on the PseudoJet.
fastjet::Transformer::Transformer
Transformer()
default ctor
Definition Transformer.hh:74
fastjet::Transformer::StructureType
PseudoJetStructureBase StructureType
A typedef that is needed to ensure that the PseudoJet::structure_of() template function works.
Definition Transformer.hh:93
fastjet::Transformer::~Transformer
virtual ~Transformer()
default dtor
Definition Transformer.hh:77