source: trunk/MagicSoft/Mars/mhist/MHEffectiveOnTime.cc@ 4934

/* ======================================================================== *\
!
! *
! * This file is part of MARS, the MAGIC Analysis and Reconstruction
! * Software. It is distributed to you in the hope that it can be a useful
! * and timesaving tool in analysing Data of imaging Cerenkov telescopes.
! * It is distributed WITHOUT ANY WARRANTY.
! *
! * Permission to use, copy, modify and distribute this software and its
! * documentation for any purpose is hereby granted without fee,
! * provided that the above copyright notice appear in all copies and
! * that both that copyright notice and this permission notice appear
! * in supporting documentation. It is provided "as is" without express
! * or implied warranty.
! *
!
!
!   Author(s): Thomas Bretz, 8/2002 <mailto:tbretz@astro.uni-wuerzburg.de>
!   Author(s): Wolfgang Wittek, 1/2002 <mailto:wittek@mppmu.mpg.de>
!
!   Copyright: MAGIC Software Development, 2000-2004
!
!
\* ======================================================================== */

//////////////////////////////////////////////////////////////////////////////
//
//  MHEffectiveOnTime
//
//  Filling this you will get the effective on-time versus theta and
//  observation time.
//
//  From this histogram the effective on-time is determined by a fit.
//  The result of the fit (see Fit()) and the fit-parameters (like chi^2)
//  are stored in corresponding histograms
//
//  To determin the efective on time a poisson fit is done. For more details
//  please have a look into the source code of FitH() it should be simple
//  to understand. In this function a Delta-T distribution is fitted, while
//  Delta-T is the time between two consecutive events.
//
//  The fit is done for projections of a 2D histogram in Theta and Delta T.
//  So you get the effective on time versus theta.
//
//  To get the effective on-time versus time a histogram is filled with
//  the Delta-T distribution of a number of events set by SetNumEvents().
//  The default is 12000 (roughly 1min at 200Hz)
//
//  For each "time-bin" the histogram is fitted and the resulting effective
//  on-time is stored in the fHEffOnTime histogram. Each entry in this
//  histogram is the effective observation time between the upper and
//  lower edges of the bins.
//
//  In addition the calculated effective on time is stored in a
//  "MEffectiveOnTime [MParameterDerr]" and the corresponding time-stamp
//  (the upper edge of the bin) "MTimeEffectiveOnTime [MTime]"
//
//  The class takes two binnings from the Parameter list; if these binnings
//  are not available the defaultbinning is used:
//      MBinning("BinningDeltaT"); // Units of seconds
//      MBinning("BinningTheta");  // Units of degrees
//
//
//  Usage:
//  ------
//    MFillH fill("MHEffectiveOnTime", "MTime");
//    tlist.AddToList(&fill);
//
//
//  Input Container:
//    MPointingPos
//
//  Output Container:
//    MEffectiveOnTime [MParameterDerr]
//    MTimeEffectiveOnTime [MTime]
//
//////////////////////////////////////////////////////////////////////////////
#include "MHEffectiveOnTime.h"

#include <TF1.h>
#include <TMinuit.h>
#include <TRandom.h>

#include <TLatex.h>
#include <TCanvas.h>
#include <TPaveStats.h>

#include "MTime.h"
#include "MParameters.h"
#include "MPointingPos.h"

#include "MBinning.h"
#include "MParList.h"

#include "MLog.h"
#include "MLogManip.h"

ClassImp(MHEffectiveOnTime);

using namespace std;

// --------------------------------------------------------------------------
//
// Default Constructor. It initializes all histograms.
//
MHEffectiveOnTime::MHEffectiveOnTime(const char *name, const char *title)
    : fPointPos(0), fTime(0), fParam(0), fIsFinalized(kFALSE), 
    fNumEvents(200*60), fNameProjDeltaT(Form("DeltaT_%p", this)),
    fNameProjTheta(Form("Theta_%p", this))
{
    //
    //   set the name and title of this object
    //
    fName  = name  ? name  : "MHEffectiveOnTime";
    fTitle = title ? title : "Histogram to determin effective On-Time vs Time and Zenith Angle";

    // Main histogram
    fH2DeltaT.SetName("DeltaT");
    fH2DeltaT.SetXTitle("\\Delta t [s]");
    fH2DeltaT.SetYTitle("\\Theta [\\circ]");
    fH2DeltaT.SetZTitle("Count");
    fH2DeltaT.UseCurrentStyle();
    fH2DeltaT.SetDirectory(NULL);

    // Main histogram
    fH1DeltaT.SetName("DeltaT");
    fH1DeltaT.SetXTitle("\\Delta t [s]");
    fH1DeltaT.SetYTitle("Counts");
    fH1DeltaT.UseCurrentStyle();
    fH1DeltaT.SetDirectory(NULL);

    // effective on time versus theta
    fHEffOnTheta.SetName("EffOnTheta");
    fHEffOnTheta.SetTitle("Effective On Time T_{eff}");
    fHEffOnTheta.SetXTitle("\\Theta [\\circ]");
    fHEffOnTheta.SetYTitle("T_{eff} [s]");
    fHEffOnTheta.UseCurrentStyle();
    fHEffOnTheta.SetDirectory(NULL);
    fHEffOnTheta.GetYaxis()->SetTitleOffset(1.2);
    //fHEffOn.Sumw2();

    // effective on time versus time
    fHEffOnTime.SetName("EffOnTime");
    fHEffOnTime.SetTitle("Effective On Time T_{eff}");
    fHEffOnTime.SetXTitle("Time");
    fHEffOnTime.SetYTitle("T_{eff} [s]");
    fHEffOnTime.UseCurrentStyle();
    fHEffOnTime.SetDirectory(NULL);
    fHEffOnTime.GetYaxis()->SetTitleOffset(1.2);
    fHEffOnTime.GetXaxis()->SetLabelSize(0.033);
    fHEffOnTime.GetXaxis()->SetTimeFormat("%H:%M:%S %F1995-01-01 00:00:00 GMT");
    fHEffOnTime.GetXaxis()->SetTimeDisplay(1);
    fHEffOnTime.Sumw2();

    // chi2 probability
    fHProbTheta.SetName("ProbTheta");
    fHProbTheta.SetTitle("\\chi^{2} Probability of Fit");
    fHProbTheta.SetXTitle("\\Theta [\\circ]");
    fHProbTheta.SetYTitle("p [%]");
    fHProbTheta.UseCurrentStyle();
    fHProbTheta.SetDirectory(NULL);
    fHProbTheta.GetYaxis()->SetTitleOffset(1.2);
    fHProbTheta.SetMaximum(101);

    // chi2 probability
    fHProbTime.SetName("ProbTime");
    fHProbTime.SetTitle("\\chi^{2} Probability of Fit");
    fHProbTime.SetXTitle("Time");
    fHProbTime.SetYTitle("p [%]");
    fHProbTime.UseCurrentStyle();
    fHProbTime.SetDirectory(NULL);
    fHProbTime.GetYaxis()->SetTitleOffset(1.2);
    fHProbTime.GetXaxis()->SetLabelSize(0.033);
    fHProbTime.GetXaxis()->SetTimeFormat("%H:%M:%S %F1995-01-01 00:00:00 GMT");
    fHProbTime.GetXaxis()->SetTimeDisplay(1);
    fHProbTime.SetMaximum(101);

    // lambda versus theta
    fHLambda.SetName("lambda");
    fHLambda.SetTitle("lambda of Effective On Time Fit");
    fHLambda.SetXTitle("\\Theta [\\circ]");
    fHLambda.SetYTitle("\\lambda [Hz]");
    fHLambda.UseCurrentStyle();
    fHLambda.SetDirectory(NULL);
    // fHLambda.Sumw2();

    // N0 versus theta
    fHN0.SetName("N0");
    fHN0.SetTitle("Ideal number of events N_{0}");
    fHN0.SetXTitle("\\Theta [\\circ]");
    fHN0.SetYTitle("N_{0}");
    fHN0.UseCurrentStyle();
    fHN0.SetDirectory(NULL);
    //fHN0del.Sumw2();

    // chi2/NDF versus theta
    /*
     fHChi2.SetName("Chi2/NDF");
     fHChi2.SetTitle("\\chi^{2}/NDF of Effective On Time Fit");
     fHChi2.SetXTitle("\\Theta [\\circ]");
     fHChi2.SetYTitle("\\chi^{2}/NDF");
     fHChi2.UseCurrentStyle();
     fHChi2.SetDirectory(NULL);
     fHChi2.GetYaxis()->SetTitleOffset(1.2);
     //fHChi2.Sumw2();
     */

    // setup binning
    MBinning btheta("BinningTheta");
    btheta.SetEdgesCos(101, 0, 60);

    MBinning btime("BinningDeltaT");
    btime.SetEdges(50, 0, 0.1);

    MH::SetBinning(&fH2DeltaT, &btime, &btheta);

    btime.Apply(fH1DeltaT);

    btheta.Apply(fHEffOnTheta);
    btheta.Apply(fHLambda);
    btheta.Apply(fHN0);
    btheta.Apply(fHProbTheta);
    //btheta.Apply(fHChi2);
}

// --------------------------------------------------------------------------
//
// Set the binnings and prepare the filling of the histogram
//
Bool_t MHEffectiveOnTime::SetupFill(const MParList *plist)
{
   fPointPos = (MPointingPos*)plist->FindObject("MPointingPos");
   if (!fPointPos)
   {
       *fLog << err << dbginf << "MPointingPos not found... aborting." << endl;
       return kFALSE;
   }

   // FIXME: Remove const-qualifier from base-class!
   fTime = (MTime*)const_cast<MParList*>(plist)->FindCreateObj("MTime", "MTimeEffectiveOnTime");
   if (!fTime)
       return kFALSE;
   fParam = (MParameterDerr*)const_cast<MParList*>(plist)->FindCreateObj("MParameterDerr", "MEffectiveOnTime");
   if (!fParam)
       return kFALSE;

   const MBinning* binsdtime = (MBinning*)plist->FindObject("BinningDeltaT");
   const MBinning* binstheta = (MBinning*)plist->FindObject("BinningTheta");
   if (binsdtime)
       binsdtime->Apply(fH1DeltaT);
   if (binstheta)
   {
       binstheta->Apply(fHEffOnTheta);
       binstheta->Apply(fHLambda);
       binstheta->Apply(fHN0);
       binstheta->Apply(fHProbTheta);
       //binstheta->Apply(fHChi2);
   }
   if (binstheta && binsdtime)
       SetBinning(&fH2DeltaT, binsdtime, binstheta);

   return kTRUE;
}

// --------------------------------------------------------------------------
//
// Fit a single Delta-T distribution. See source code for more details
//
Bool_t MHEffectiveOnTime::FitH(TH1D *h, Double_t *res, Bool_t paint) const
{
    const Double_t Nm = h->Integral();

    // FIXME: Do fit only if contents of bin has changed
    if (Nm<=0)
        return kFALSE;

    // determine range (yq[0], yq[1]) of time differences
    // where fit should be performed;
    // require a fraction >=xq[0] of all entries to lie below yq[0]
    //     and a fraction <=xq[1] of all entries to lie below yq[1];
    // within the range (yq[0], yq[1]) there must be no empty bin;
    // choose pedestrian approach as long as GetQuantiles is not available
    Double_t xq[2] = { 0.05, 0.95 };
    Double_t yq[2];
    h->GetQuantiles(2, yq, xq);

    // Nmdel = Nm * binwidth,  with Nm = number of observed events
    const Double_t Nmdel = h->Integral("width");

    //
    // Setup Poisson function for the fit:
    // lambda [Hz], N0 = ideal no of evts, del = bin width of dt
    //
    // parameter 0 = lambda
    // parameter 1 = N0*del
    //
    TF1 func("Poisson", " [1]*[2] * [0] * exp(-[0] *x)", yq[0], yq[1]);
    func.SetParNames("lambda", "N0", "del");

    func.SetParameter(0, 100);       // Hz
    func.SetParameter(1, Nm);
    func.FixParameter(2, Nmdel/Nm);

    // options : 0  do not plot the function
    //           I  use integral of function in bin rather than value at bin center
    //           R  use the range specified in the function range
    //           Q  quiet mode
    h->Fit(&func, "0IRQ");

    const Double_t chi2 = func.GetChisquare();
    const Int_t    NDF  = func.GetNDF();

    // was fit successful ?
    const Bool_t ok = NDF>0 && chi2<2.5*NDF;

    if (paint)
    {
        func.SetLineWidth(2);
        func.SetLineColor(ok ? kGreen : kRed);
        func.Paint("same");
    }

    if (!ok)
        return kFALSE;

    const Double_t lambda = func.GetParameter(0);
    const Double_t N0     = func.GetParameter(1);
    const Double_t prob   = func.GetProb();

    /*
     *fLog << all << "Nm/lambda=" << Nm/lambda << "  chi2/NDF=";
     *fLog << (NDF ? chi2/NDF : 0.0) << "  lambda=";
     *fLog << lambda << "  N0=" << N0 << endl;
     */

    Double_t emat[2][2];
    gMinuit->mnemat((Double_t*)emat, 2);

    const Double_t dldl  = emat[0][0];
    //const Double_t dN0dN0 = emat[1][1];

    const Double_t teff  = Nm/lambda;
    const Double_t dteff = teff * TMath::Sqrt(dldl/(lambda*lambda) + 1.0/Nm);
    const Double_t dl    = TMath::Sqrt(dldl);

    //const Double_t kappa  = Nm/N0;
    //const Double_t Rdead  = 1.0 - kappa;
    //const Double_t dRdead = kappa * TMath::Sqrt(dN0dN0/(N0*N0) + 1.0/Nm);

    // the effective on time is Nm/lambda
    res[0] = teff;
    res[1] = dteff;

    // plot chi2-probability of fit
    res[2] = prob*100;

    // plot chi2/NDF of fit
    //res[3] = NDF ? chi2/NDF : 0.0;

    // lambda of fit
    res[3] = lambda;
    res[4] = dl;

    // N0 of fit
    res[5] = N0;

    // Rdead (from fit) is the fraction from real time lost by the dead time
    //fHRdead.SetBinContent(i, Rdead);
    //fHRdead.SetBinError  (i,dRdead);

    return kTRUE;
}

// --------------------------------------------------------------------------
//
// Fit a all bins of the distribution in theta. Store the result in the
// Theta-Histograms
//
void MHEffectiveOnTime::FitThetaBins()
{
    fHEffOnTheta.Reset();
    fHProbTheta.Reset();
    fHLambda.Reset();
    fHN0.Reset();

    const TString name = Form("CalcTheta%d", (UInt_t)gRandom->Uniform(999999999));

    // nbins = number of Theta bins
    const Int_t nbins = fH2DeltaT.GetNbinsY();

    TH1D *h=0;
    for (int i=1; i<=nbins; i++)
    {
        //        TH1D &h = *hist->ProjectionX("Calc-theta", i, i);
        h = fH2DeltaT.ProjectionX(name, i, i, "E");

        Double_t res[6];
        if (!FitH(h, res))
            continue;

        // the effective on time is Nm/lambda
        fHEffOnTheta.SetBinContent(i, res[0]);
        fHEffOnTheta.SetBinError  (i, res[1]);

        // plot chi2-probability of fit
        fHProbTheta.SetBinContent(i, res[2]);

        // plot chi2/NDF of fit
        //fHChi2.SetBinContent(i, res[3]);

        // lambda of fit
        fHLambda.SetBinContent(i, res[3]);
        fHLambda.SetBinError  (i, res[4]);

        // N0 of fit
        fHN0.SetBinContent(i, res[5]);

        // Rdead (from fit) is the fraction from real time lost by the dead time
        //fHRdead.SetBinContent(i, Rdead);
        //fHRdead.SetBinError  (i,dRdead);
    }

    // Histogram is reused via gROOT->FindObject()
    // Need to be deleted only once
    if (h)
        delete h;
}

// --------------------------------------------------------------------------
//
// Fit the single-time-bin histogram. Store the result in the
// Time-Histograms
//
void MHEffectiveOnTime::FitTimeBin()
{
    //
    // Fit histogram
    //
    Double_t res[6];
    if (!FitH(&fH1DeltaT, res))
        return;

    // Reset Histogram
    fH1DeltaT.Reset();

    //
    // Prepare Histogram
    //

    // Get x-axis
    TAxis &x = *fHEffOnTime.GetXaxis();

    // Get number of bins
    const Int_t n = x.GetNbins();

    // Enhance binning
    MBinning bins;
    bins.SetEdges(x);
    bins.AddEdge(fLastTime.GetAxisTime());
    bins.Apply(fHEffOnTime);
    bins.Apply(fHProbTime);

    //
    // Fill histogram
    //
    fHEffOnTime.SetBinContent(n, res[0]);
    fHEffOnTime.SetBinError(n, res[1]);

    fHProbTime.SetBinContent(n, res[2]);

    //
    // Now prepare output
    //
    fParam->SetVal(res[0], res[1]);
    fParam->SetReadyToSave();

    *fTime = fLastTime;

    // Include the current event
    fTime->Plus1ns();

    *fLog << fLastTime << ":  Val=" << res[0] << "  Err=" << res[1] << endl;
}

// --------------------------------------------------------------------------
//
//  Fill the histogram
//
Bool_t MHEffectiveOnTime::Fill(const MParContainer *par, const Stat_t w)
{
    const MTime *time = dynamic_cast<const MTime*>(par);
    if (!time)
    {
        *fLog << err << "ERROR - MHEffectiveOnTime::Fill without argument or container doesn't inherit from MTime... abort." << endl;
        return kFALSE;
    }

    //
    // If this is the first call we have to initialize the time-histogram
    //
    if (fLastTime==MTime())
    {
        MBinning bins;
        bins.SetEdges(2, time->GetAxisTime()-fNumEvents/200, time->GetAxisTime());
        bins.Apply(fHEffOnTime);
        bins.Apply(fHProbTime);

        fParam->SetVal(0, 0);
        fParam->SetReadyToSave();

        *fTime = *time;

        // Make this 1ns before the first event!
        fTime->Minus1ns();
    }

    //
    // Fill time difference into the histograms
    //
    const Double_t dt = *time-fLastTime;

    fH2DeltaT.Fill(dt, fPointPos->GetZd(), w);
    fH1DeltaT.Fill(dt, w);

    fLastTime = *time;

    //
    // If we reached the event number limit for the time-bins fit the histogram
    //
    if (fH1DeltaT.GetEntries()>=fNumEvents)
        FitTimeBin();

    return kTRUE;
}

// --------------------------------------------------------------------------
//
//  Fit the theta projections of the 2D histogram and the 1D Delta-T
// distribution
//
Bool_t MHEffectiveOnTime::Finalize()
{
    FitThetaBins();
    FitTimeBin();

    fIsFinalized = kTRUE;

    return kTRUE;
}

// --------------------------------------------------------------------------
//
//  Paint the integral and the error on top of the histogram
//
void MHEffectiveOnTime::PaintText(Double_t val, Double_t error) const
{
    TLatex text(0.45, 0.94, Form("T_{eff} = %.1fs \\pm %.1fs", val, error));
    text.SetBit(TLatex::kTextNDC);
    text.SetTextSize(0.04);
    text.Paint();
}

// --------------------------------------------------------------------------
//
//  Prepare painting the histograms
//
void MHEffectiveOnTime::Paint(Option_t *opt)
{
    TH1D *h=0;
    TPaveStats *st=0;

    TString o(opt);
    if (o==(TString)"fit")
    {
        TVirtualPad *pad = gPad;

        for (int x=0; x<2; x++)
            for (int y=0; y<3; y++)
            {
                TVirtualPad *p=gPad->GetPad(x+1)->GetPad(y+1);
                if ((st = (TPaveStats*)p->GetPrimitive("stats")))
                {
                    if (st->GetOptStat()==11)
                        continue;

                    const Double_t y1 = st->GetY1NDC();
                    const Double_t y2 = st->GetY2NDC();
                    const Double_t x1 = st->GetX1NDC();
                    const Double_t x2 = st->GetX2NDC();

                    st->SetY1NDC((y2-y1)/3+y1);
                    st->SetX1NDC((x2-x1)/3+x1);
                    st->SetOptStat(11);
                }
            }

        pad->GetPad(1)->cd(1);
        if ((h = (TH1D*)gPad->FindObject(fNameProjDeltaT)))
        {
            h = fH2DeltaT.ProjectionX(fNameProjDeltaT, -1, 9999, "E");
            if (h->GetEntries()>0)
                gPad->SetLogy();
        }

        pad->GetPad(2)->cd(1);
        if ((h = (TH1D*)gPad->FindObject(fNameProjTheta)))
            fH2DeltaT.ProjectionY(fNameProjTheta, -1, 9999, "E");

        if (!fIsFinalized)
            FitThetaBins();
        return;
    }
    if (o==(TString)"paint")
    {
        if ((h = (TH1D*)gPad->FindObject(fNameProjDeltaT)))
        {
            Double_t res[6];
            if (FitH(h, res, kTRUE))
                PaintText(res[0], res[1]);
        }
        return;
    }

    h=0;
    if (o==(TString)"theta")
        h = &fHEffOnTheta;
    if (o==(TString)"time")
        h = &fHEffOnTime;

    if (!h)
        return;

    Double_t error = 0;
    for (int i=0; i<h->GetXaxis()->GetNbins(); i++)
        error += h->GetBinError(i);

    PaintText(h->Integral(), error);
}

// --------------------------------------------------------------------------
//
// Draw the histogram
//
void MHEffectiveOnTime::Draw(Option_t *opt)
{
    TVirtualPad *pad = gPad ? gPad : MakeDefCanvas(this);
    pad->SetBorderMode(0);

    AppendPad("fit");

    pad->Divide(2, 1, 0, 0);

    TH1 *h;

    pad->cd(1);
    gPad->SetBorderMode(0);
    gPad->Divide(1, 3, 0, 0);
    pad->GetPad(1)->cd(1);
    gPad->SetBorderMode(0);
    h = fH2DeltaT.ProjectionX(fNameProjDeltaT, -1, 9999, "E");
    h->SetTitle("Distribution of \\Delta t [s]");
    h->SetXTitle("\\Delta t [s]");
    h->SetYTitle("Counts");
    h->SetDirectory(NULL);
    h->SetMarkerStyle(kFullDotMedium);
    h->SetBit(kCanDelete);
    h->Draw();
    AppendPad("paint");

    pad->GetPad(1)->cd(2);
    gPad->SetBorderMode(0);
    fHProbTime.Draw();
    AppendPad("paint");

    pad->GetPad(1)->cd(3);
    gPad->SetBorderMode(0);
    fHEffOnTime.Draw();
    AppendPad("time");

    pad->cd(2);
    gPad->SetBorderMode(0);
    gPad->Divide(1, 3, 0, 0);

    pad->GetPad(2)->cd(1);
    gPad->SetBorderMode(0);
    h = fH2DeltaT.ProjectionY(fNameProjTheta, -1, 9999, "E");
    h->SetTitle("Distribution of  \\Theta [\\circ]");
    h->SetXTitle("\\Theta [\\circ]");
    h->SetYTitle("Counts");
    h->SetDirectory(NULL);
    h->SetMarkerStyle(kFullDotMedium);
    h->SetBit(kCanDelete);
    h->GetYaxis()->SetTitleOffset(1.1);
    h->Draw();

    pad->GetPad(2)->cd(2);
    gPad->SetBorderMode(0);
    fHProbTheta.Draw();

    pad->GetPad(2)->cd(3);
    gPad->SetBorderMode(0);
    fHEffOnTheta.Draw();
    AppendPad("theta");
}