BackgroundEstimator.h

Go to the documentation of this file.

#ifndef __FASTJET_BACKGROUND_EXTRACTOR_HH__
#define __FASTJET_BACKGROUND_EXTRACTOR_HH__

#include <fastjet/ClusterSequenceAreaBase.hh>
#include <fastjet/RangeDefinition.hh>
#include <iostream>

namespace fastjet{


 class BackgroundEstimator{
public:
  BackgroundEstimator(const ClusterSequenceAreaBase &csa, const RangeDefinition &range);
  
  ~BackgroundEstimator();

  // retrieving information
  //-----------------------  

  double median_rho(){ 
    _recompute_if_needed();
    return _median_rho;
  }

  double rho() {return median_rho();}

  double sigma() {
    _recompute_if_needed();
    return _sigma;
  }
  
  double mean_area(){
    _recompute_if_needed();
    return _mean_area;
  }
  
  unsigned int n_jets_used(){
    _recompute_if_needed();
    return _n_jets_used;
  }
  
  unsigned int n_jets_excluded(){
    _recompute_if_needed();
    return _n_jets_excluded;
  }
  
  double n_empty_jets(){
    _recompute_if_needed();
    return _n_empty_jets;
  }

  double empty_area(){
    _recompute_if_needed();
    return _empty_area;
  }

  // configuring behaviour
  //----------------------  

  void reset();

  void set_use_area_4vector(bool use_it = true){
    _use_area_4vector = use_it;
  }
  
  void set_included_jets(const std::vector<PseudoJet> &included_jets, bool all_from_inclusive = true){
    _included_jets = included_jets;
    _all_from_inclusive = all_from_inclusive;
    _uptodate = false;
  }
  
  void set_excluded_jets(const std::vector<PseudoJet> &excluded_jets){
    _excluded_jets = excluded_jets;
    _uptodate = false;  
  }
  
private:
  void _compute();
  
  void _recompute_if_needed(){
    if (!_uptodate)
      _compute();
    _uptodate = true;
  }
  
  // the information needed to do the computation
  const ClusterSequenceAreaBase &_csa;      
  const RangeDefinition &_range;            
  std::vector<PseudoJet> _included_jets;    
  std::vector<PseudoJet> _excluded_jets;    
  bool _all_from_inclusive;                 
  bool _use_area_4vector;
  
  // the actual results of the computation
  double _median_rho;                   
  double _sigma;                    
  double _mean_area;                    
  unsigned int _n_jets_used;                
  unsigned int _n_jets_excluded;            
  double _n_empty_jets;                     
  double _empty_area;                       

  // internal variables
  bool _uptodate;                           
};

} // namespace

#endif