FastJet  3.0.6
Public Member Functions | Protected Attributes | Static Protected Attributes | List of all members
Subtractor Class Reference

Class that helps perform jet background subtraction. More...

#include <fastjet/tools/Subtractor.hh>

Inherits Transformer.

Public Member Functions

 Subtractor (BackgroundEstimatorBase *bge)
 define a subtractor based on a BackgroundEstimator
 
 Subtractor (double rho)
 define a subtractor that uses a fixed value of rho, the background pt density per unit area (which must be positive)
 
 Subtractor ()
 default constructor
 
virtual ~Subtractor ()
 default dtor
 
virtual PseudoJet result (const PseudoJet &jet) const
 returns a jet that's subtracted More...
 
virtual std::string description () const
 class description
 

Protected Attributes

BackgroundEstimatorBase * _bge
 the tool used to estimate the background if has to be mutable in case its underlying selector takes a reference jet
 
double _rho
 the fixed value of rho to use if the user has selected that option
 

Static Protected Attributes

static const double _invalid_rho = -numeric_limits<double>::infinity()
 a value of rho that is used as a default to label that the stored rho is not valid for subtraction. More...
 

Detailed Description

Class that helps perform jet background subtraction.

This class derives from Transformer and makes use of a pointer to a BackgroundEstimatorBase object in order to determine the background in the vicinity of a given jet and then subtract area*background from the jet. It can also be initialised with a specific fixed value for the background pt density.

Input conditions

The original jet must have area support (4-vector)

Output/structure

The underlying structure of the returned, subtracted jet (i.e. constituents, pieces, etc.) is identical to that of the original jet.

Definition at line 59 of file Subtractor.hh.

Member Function Documentation

◆ result()

PseudoJet Subtractor::result ( const PseudoJet &  jet) const
virtual

returns a jet that's subtracted

Parameters
jetthe jet that is to be subtracted
Returns
the subtracted jet

Definition at line 44 of file Subtractor.cc.

Member Data Documentation

◆ _invalid_rho

FASTJET_BEGIN_NAMESPACE const double Subtractor::_invalid_rho = -numeric_limits<double>::infinity()
staticprotected

a value of rho that is used as a default to label that the stored rho is not valid for subtraction.

Definition at line 99 of file Subtractor.hh.


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