source: trunk/MagicSoft/Mars/mjtrain/MJTrainEnergy.cc@ 8708

/* ======================================================================== *\
!
! *
! * 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 11/2005 <mailto:tbretz@astro.uni-wuerzburg.de>
!
!   Copyright: MAGIC Software Development, 2005
!
!
\* ======================================================================== */

/////////////////////////////////////////////////////////////////////////////
//
// MJTrainEnergy
//
//
// Example:
// --------
//
//    // SequencesOn are used for training, SequencesOff for Testing
//    MDataSet set("mctesttrain.txt");
//    set.SetNumAnalysis(1);  // Must have a number
//    MJTrainEnergy opt;
//    //opt.SetDebug();
//    opt.AddParameter("MHillas.fSize");
//    opt.AddParameter("MHillasSrc.fDist");
//    MStatusDisplay *d = new MStatusDisplay;
//    opt.SetDisplay(d);
//    opt.AddPreCut("MHillasSrc.fDCA*MGeomCam.fConvMm2Deg<0.3");
//    opt.Train("rf-energy.root", set, 30000); // Number of train events
//
// Random Numbers:
// ---------------
//   Use:
//         if(gRandom)
//             delete gRandom;
//         gRandom = new TRandom3();
//   in advance to change the random number generator.
//
////////////////////////////////////////////////////////////////////////////
#include "MJTrainEnergy.h"

#include "MHMatrix.h"

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

// tools
#include "MDataSet.h"
#include "MTFillMatrix.h"
#include "MStatusDisplay.h"

// eventloop
#include "MParList.h"
#include "MTaskList.h"
#include "MEvtLoop.h"

// tasks
#include "MReadMarsFile.h"
#include "MContinue.h"
#include "MFillH.h"
#include "MRanForestCalc.h"

// histograms
#include "MHn.h"
#include "MBinning.h"
#include "MHEnergyEst.h"

// filter
#include "MFilterList.h"

ClassImp(MJTrainEnergy);

using namespace std;

Bool_t MJTrainEnergy::Train(const char *out, const MDataSet &set, Int_t num)
{
    SetTitle(Form("TrainEnergy: %s", out));

    if (fDisplay)
        fDisplay->SetTitle(fTitle);

    if (!set.IsValid())
    {
        *fLog << err << "ERROR - DataSet invalid!" << endl;
        return kFALSE;
    }

    if (!HasWritePermission(out))
        return kFALSE;

    *fLog << inf;
    fLog->Separator(GetDescriptor());

    // --------------------- Setup files --------------------
    MReadMarsFile readtrn("Events");
    MReadMarsFile readtst("Events");
    readtrn.DisableAutoScheme();
    readtst.DisableAutoScheme();

    if (!set.AddFilesOn(readtrn))
    {
        *fLog << err << "ERROR - Adding SequencesOn." << endl;
        return kFALSE;
    }
    if (!set.AddFilesOff(readtst))
    {
        *fLog << err << "ERROR - Adding SequencesOff." << endl;
        return kFALSE;
    }

    // ----------------------- Setup Matrix ------------------
    MHMatrix train("Train");
    train.AddColumns(fRules);
    if (fEnableWeights)
        train.AddColumn("MWeight.fVal");
    train.AddColumn("MMcEvt.fImpact/100");
    train.AddColumn("MMcEvt.fTelescopeTheta*TMath::RadToDeg()");
    train.AddColumn(fTrainParameter);


    // ----------------------- Fill Matrix RF ----------------------
    MTFillMatrix fill(fTitle);
    fill.SetDisplay(fDisplay);
    fill.SetLogStream(fLog);
    fill.SetDestMatrix1(&train, num);
    fill.SetReader(&readtrn);
    fill.AddPreCuts(fPreCuts);
    fill.AddPreCuts(fTrainCuts);
    fill.AddPreTasks(fPreTasks);
    fill.AddPostTasks(fPostTasks);
    if (!fill.Process())
        return kFALSE;

    // ------------------------ Train RF --------------------------
    MRanForestCalc rf("TrainEnergy", fTitle);
    rf.SetNumTrees(fNumTrees);
    rf.SetNdSize(fNdSize);
    rf.SetNumTry(fNumTry);
    rf.SetNumObsoleteVariables(3);
    rf.SetLastDataColumnHasWeights(fEnableWeights);
    rf.SetDisplay(fDisplay);
    rf.SetLogStream(fLog);
    rf.SetFileName(out);
    rf.SetDebug(fDebug>1);
    rf.SetNameOutput("MEnergyEst");
    rf.SetFunction(fResultFunction);

    /*
    MBinning b(32, 10, 100000, "BinningEnergyEst", "log");

    if (!rf.TrainMultiRF(train, b.GetEdgesD()))    // classification with one tree per bin
        return;

    if (!rf.TrainSingleRF(train, b.GetEdgesD()))   // classification into different bins
        return;
    */
    if (!rf.TrainRegression(train))                  // regression (best choice)
        return kFALSE;

    // --------------------- Display result ----------------------

    gLog.Separator("Test");

    MParList  plist;
    MTaskList tlist;
    plist.AddToList(this);
    plist.AddToList(&tlist);
    //plist.AddToList(&b);

    MFilterList list;
    if (!list.AddToList(fPreCuts))
        *fLog << err << "ERROR - Calling MFilterList::AddToList for fPreCuts failed!" << endl;
    if (!list.AddToList(fTestCuts))
        *fLog << err << "ERROR - Calling MFilterList::AddToList for fTestCuts failed!" << endl;

    MContinue cont(&list);
    cont.SetInverted();

    // -------------------------------------------------------------
    MBinning binsS(50, 10,     100000, "BinningSize",           "log");
    MBinning binsE(70, 10,     31623,  "BinningEnergy",         "log");
    MBinning binsG(50,-10,     10,     "BinningSlope",          "lin");
    MBinning binsR(50, -1,     1,      "BinningEnergyResidual", "lin");
    MBinning binsL(50,  0,     0.3,    "BinningLeakage",        "lin");
    MBinning binsT(51, -0.005, 0.505,  "BinningTheta",          "asin");
    MBinning binsD(50,  0,     1.6,    "BinningDist",           "lin");
    MBinning binsC(50,  1e-2,  1,      "BinningConc",           "log");

    plist.AddToList(&binsG);
    plist.AddToList(&binsS);
    plist.AddToList(&binsR);
    plist.AddToList(&binsE);
    plist.AddToList(&binsL);
    plist.AddToList(&binsT);
    plist.AddToList(&binsD);
    plist.AddToList(&binsC);

    MHEnergyEst hist;

    // To speed it up we could precalculate it.
    const char *res = "log10(MEnergyEst.fVal)-log10(MMcEvt.fEnergy)";

    MHn hres1("Energy1", "Energy Residual (lg E_{est} - lg E_{mc})");
    hres1.AddHist("MHillas.fSize", res);
    hres1.InitName("ResSize;Size;EnergyResidual");
    hres1.InitTitle(";S [phe];\\Delta lg E;");
    hres1.SetDrawOption("colz profx");
    hres1.AddHist("MHillasExt.fSlopeLong*sign(MHillasSrc.fCosDeltaAlpha)/3.37e-3", res);
    hres1.InitName("ResSlope;Slope;EnergyResidual");
    hres1.InitTitle(";Slope;\\Delta lg E;");
    hres1.SetDrawOption("colz profx");
    hres1.AddHist("MNewImagePar.fLeakage1", res);
    hres1.InitName("ResLeak;Leakage;EnergyResidual");
    hres1.InitTitle(";Leak;\\Delta lg E;");
    hres1.SetDrawOption("colz profx");
    hres1.AddHist("MHillasSrc.fDist*3.37e-3", res);
    hres1.InitName("ResDist;Dist;EnergyResidual");
    hres1.InitTitle(";D [\\circ];\\Delta lg E;");
    hres1.SetDrawOption("colz profx");

    MHn hres2("Energy2", "Energy Residual (lg E_{est} - lg E_{mc})");
    hres2.AddHist("MMcEvt.fEnergy", res);
    hres2.InitName("ResEmc;Energy;EnergyResidual");
    hres2.InitTitle(";E_{mc} [GeV];\\Delta lg E;");
    hres2.SetDrawOption("colz profx");
    hres2.SetAutoRange(kFALSE, kFALSE, kFALSE);
    hres2.AddHist("MPointingPos.fZd", res);
    hres2.InitName("ResTheta;Theta;EnergyResidual");
    hres2.InitTitle(";Zd [\\circ];\\Delta lg E;");
    hres2.SetDrawOption("colz profx");
    hres2.AddHist("MEnergyEst.fVal", res);
    hres2.InitName("ResEest;Energy;EnergyResidual");
    hres2.InitTitle(";E_{est} [GeV];\\Delta lg E;");
    hres2.SetDrawOption("colz profx");
    hres2.SetAutoRange(kFALSE, kFALSE, kFALSE);
    hres2.AddHist("MNewImagePar.fConc1", res);
    hres2.InitName("ResConc1;Conc;EnergyResidual");
    hres2.InitTitle(";C;\\Delta lg E;");
    hres2.SetDrawOption("colz profx");

    MFillH fillh(&hist);
    MFillH fillh1(&hres1, "", "FillResiduals1");
    MFillH fillh2(&hres2, "", "FillResiduals2");

    if (fEnableWeights)
    {
        fillh.SetWeight();
        fillh1.SetWeight();
        fillh2.SetWeight();
    }

    tlist.AddToList(&readtst);
    tlist.AddToList(fPreTasks);
    tlist.AddToList(&cont);
    tlist.AddToList(&rf);
    tlist.AddToList(fPostTasks);
    tlist.AddToList(&fillh);
    tlist.AddToList(&fillh1);
    tlist.AddToList(&fillh2);
    tlist.AddToList(fTestTasks);

    MEvtLoop loop(fTitle);
    loop.SetLogStream(fLog);
    loop.SetDisplay(fDisplay);
    loop.SetParList(&plist);
    //if (!SetupEnv(loop))
    //   return kFALSE;

    if (!loop.Eventloop())
        return kFALSE;

    SetPathOut(out);
    if (!WriteDisplay(0, "UPDATE"))
        return kFALSE;

    return kTRUE;
}