StatSample.hpp

Go to the documentation of this file.

#ifndef CAFE_STATSAMPLE_HPP__
#define CAFE_STATSAMPLE_HPP__

#include "cafe/Event.hpp" 
#include "cafe/StatWeight.hpp" 

#include <string>
#include <vector>

namespace cafe {
  
  struct  StatWeightNotFoundException {
    std::string _weight_name ;
    StatWeightNotFoundException(std::string weight_name): _weight_name(weight_name) {}
  };

  /* \brief
     Class to collect number of events for the one sample of statistics.
     This class is used internally by the Stat class.
     
     \authors  Viatcheslav Shary (shary@fnal.gov), Yann Coadou (yann@fnal.gov)
     
\ingroup group_cafe
  */
  class StatSample {
    
    std::string _name ; //< sample name
    std::vector<std::string> _tags ; //< tags used to add events to the sample (ANY)
    std::vector<std::string> _tags_and ; //< tags requiered with AND 
    std::vector<StatWeight*> _events; //< selected events and associated global events weight for each selection 
    StatWeight* _weight ; //< the global event weight is a product of all weight applied to the event up to the current selection 

  public: 
    
    StatSample(const std::string& sample="data") ;
    virtual ~StatSample() ;
    
    const std::string& name() const {return _name ;}
    const std::vector<std::string>& tags() const {return _tags ;}
    const std::vector<std::string>& tagsAnd() const {return _tags_and ;}
    
    void AddTags(const std::string& tag) {_tags.push_back(tag);}
    
    void AddTags(const std::vector<std::string>& tags) ;
    
    void AddAndTags(const std::vector<std::string>& tags) ;
    
    void AddAndTags(const std::string& tag) {_tags_and.push_back(tag);}
    
    //return false if events does not have tags used for this sample
    bool tagged(const cafe::Event* event) const  ;
    
    unsigned int size() const { return _events.size();} 
    
    unsigned long nevents(unsigned int n = 0) const ;
    
    unsigned long nevents(const std::string& name) const ;
    
    double eff(unsigned int n = 0) const ;
    
    double eff(const std::string& name) const ;
    
    double effGlob(unsigned int n = 0) const ;
    
    double effGlob(const std::string& name) const ;

    double correctedEfficiency(unsigned int n = 0) const ;
    
    double correctedEfficiency(const std::string& name) const ;
    
    double effErr(unsigned int n = 0) const ;
    
    double effErr(const std::string& name) const ;
    
    double effErrGlob(unsigned int n = 0) const ;
    
    double effErrGlob(const std::string& name) const ;
    
    double correctedEffErr(unsigned int n = 0) const ;
    
    double correctedEffErr(const std::string& name) const ;
    
    const StatWeight* eventSelection(unsigned int n = 0) const ;
    
    const StatWeight* eventSelection(const std::string& name) const ;
    
    const StatWeight* eventWeight(unsigned int n) const ;

    const StatWeight*  eventWeight(const std::string& name="global") const ;
    
    Collection<EventWeight> ListEventWeights() const ;

    bool compareNames(const StatSample& sample) const ;

    unsigned long add(cafe::Event* event, const std::string& name="Initial") ;
    
    double applyWeight(cafe::Event* event, const std::string& name, 
                       double weight, double weight_pos, double weight_neg) ;

    void Clear() ; 

    ostream& HtmlTable(ostream& os) const ;

    ostream& print_tex (ostream& os, const std::string title) const ;

    static std::string tex(const std::string& init) ;

  public:
       ClassDef(StatSample, 0);     

   } ;
  
}

#endif // CAFE_STATSAMPLE_HPP__

---