CMS 3D CMS Logo

/data/refman/pasoursint/CMSSW_6_1_2_SLHC4_patch1/src/DataFormats/JetReco/interface/FFTJetPileupSummary.h

Go to the documentation of this file.
00001 
00010 #ifndef DataFormats_JetReco_FFTJetPileupSummary_h
00011 #define DataFormats_JetReco_FFTJetPileupSummary_h
00012 
00013 namespace reco {
00014     class FFTJetPileupSummary
00015     {
00016     public:
00017         inline FFTJetPileupSummary()
00018             : uncalibratedQuantile_(-100000.f), pileupRho_(-1000000.f),
00019               pileupRhoUncert_(-1.0), uncertaintyCode_(-1) {}
00020 
00021         inline FFTJetPileupSummary(const float uncalibrated,
00022                                    const float pileup,
00023                                    const float uncert = -1.f,
00024                                    const int code = -1)
00025             : uncalibratedQuantile_(uncalibrated), pileupRho_(pileup),
00026               pileupRhoUncert_(uncert), uncertaintyCode_(code)  {}
00027 
00028         // The original point at which the pile-up estimate was found.
00029         // This does not use any calibration curve or Neyman construction,
00030         // and can serve as an input to an improved user-defined calibration.
00031         inline float uncalibratedQuantile() const 
00032             {return uncalibratedQuantile_;}
00033 
00034         // The estimate of pile-up transverse energy (or momentum) density
00035         inline float pileupRho() const {return pileupRho_;}
00036 
00037         // Uncertainty of the pile-up density estimate
00038         inline float pileupRhoUncertainty() const {return pileupRhoUncert_;}
00039 
00040         // The "zone" of the uncertainty in the Neyman belt construction.
00041         // Suggested values are as follows:
00042         //
00043         // -1 -- uncertainty is unknown
00044         //
00045         //  0 -- estimated uncertainty does not come from the Neyman belt
00046         //
00047         //  1 -- the estimate does not intersect the belt at all (typically,
00048         //       the uncertainty in this case will be set to 0). This just
00049         //       means that your value of rho is unlikely, and there is no
00050         //       way to come up with a resonable frequentist uncertainty
00051         //       estimate using the adopted ordering principle.
00052         //
00053         //  2 -- the estimate intersects one error band only. The height
00054         //       of that band is used as the uncertainty.
00055         //
00056         //  3 -- the estimate intersects the center of the belt (the
00057         //       calibration curve) and one error band. The distance
00058         //       between the center and the band (one-sided uncertainty)
00059         //       is used as the uncertainty in this summary.
00060         //
00061         //  4 -- the estimate intersects the complete belt. Only in this
00062         //       case one gets a completely meanigful frequentist uncertainty
00063         //       which is typicaly calculated as the belt half-width along
00064         //       the line of intersect.
00065         //
00066         inline int uncertaintyCode() const {return uncertaintyCode_;}
00067 
00068     private:
00069         float uncalibratedQuantile_;
00070         float pileupRho_;
00071         float pileupRhoUncert_;
00072         int uncertaintyCode_;
00073     };
00074 }
00075 
00076 #endif // DataFormats_JetReco_FFTJetPileupSummary_h