/// a class that holds the result of the calculation More...
#include <fastjet/tools/BackgroundEstimatorBase.hh>
Classes | |
| class | Extras |
| base class for extra information More... | |
Public Member Functions | |
| BackgroundEstimate () | |
| ctor wo initialisation | |
for accessing information about the background | |
| double | rho () const |
| background density per unit area | |
| double | sigma () const |
| background fluctuations per unit square-root area must be multipled by sqrt(area) to get fluctuations for a region of a given area. | |
| bool | has_sigma () |
| true if this background estimate has a determination of sigma | |
| double | rho_m () const |
| purely longitudinal (particle-mass-induced) component of the background density per unit area | |
| double | sigma_m () const |
| fluctuations in the purely longitudinal (particle-mass-induced) component of the background density per unit square-root area | |
| bool | has_rho_m () const |
| true if this background estimate has a determination of rho_m. More... | |
| double | mean_area () const |
| mean area of the patches used to compute the background properties | |
| bool | has_extras () const |
| returns true if the background estimate has extra info | |
| template<typename T > | |
| bool | has_extras () const |
| returns true if the background estimate has extra info compatible with the provided template type | |
| template<typename BackgroundEstimator > | |
| const BackgroundEstimator::Extras & | extras () const |
| returns a reference to the extra information associated with a given BackgroundEstimator. More... | |
for setting information about the background (internal FJ use) | |
| void | reset () |
| reset to default | |
| void | set_rho (double rho_in) |
| void | set_sigma (double sigma_in) |
| void | set_has_sigma (bool has_sigma_in) |
| void | set_rho_m (double rho_m_in) |
| void | set_sigma_m (double sigma_m_in) |
| void | set_has_rho_m (bool has_rho_m_in) |
| void | set_mean_area (double mean_area_in) |
| void | apply_rescaling_factor (double rescaling_factor) |
| apply a rescaling factor (to rho, rho_m, sigma, sigma_m) | |
| void | set_extras (Extras *extras_in) |
| sets the extra info based on the provided pointer More... | |
Protected Attributes | |
| double | _rho |
| background estimated density per unit area | |
| double | _sigma |
| background estimated fluctuations | |
| double | _rho_m |
| "mass" background estimated density per unit area | |
| double | _sigma_m |
| "mass" background estimated fluctuations | |
| bool | _has_sigma |
| true if this estimate has a determination of sigma | |
| bool | _has_rho_m |
| true if this estimate has a determination of rho_m | |
| double | _mean_area |
| mean area of the patches used to compute the bkg properties | |
| SharedPtr< Extras > | _extras |
Detailed Description
/// a class that holds the result of the calculation
By default it provides access to the main background properties: rho, rho_m, sigma and sigma_m. If background estimators derived from the base class want to store more information, this can be done using the "Extra" information.
Definition at line 53 of file BackgroundEstimatorBase.hh.
Member Function Documentation
◆ has_rho_m()
|
inline |
true if this background estimate has a determination of rho_m.
Support for sigma_m is automatic if one has sigma and rho_m support.
Definition at line 86 of file BackgroundEstimatorBase.hh.
◆ extras()
|
inline |
returns a reference to the extra information associated with a given BackgroundEstimator.
It assumes that the extra information is reachable with class name BackgroundEstimator::Extras
Definition at line 119 of file BackgroundEstimatorBase.hh.
◆ set_extras()
|
inline |
sets the extra info based on the provided pointer
When calling this method, the BackgroundEstimate class takes ownership of the pointer (and is responsible for deleting it)
Definition at line 155 of file BackgroundEstimatorBase.hh.
The documentation for this class was generated from the following file:
- tools/fastjet/tools/BackgroundEstimatorBase.hh
