MethodPlugins.cxx

Go to the documentation of this file.

// @(#)root/tmva $Id$ 
// Author: Andreas Hoecker, Joerg Stelzer, Helge Voss, Kai Voss 

/**********************************************************************************
 * Project: TMVA - a Root-integrated toolkit for multivariate Data analysis       *
 * Package: TMVA                                                                  *
 * Class  : TMVA::MethodPlugins                                                *
 * Web    : http://tmva.sourceforge.net                                           *
 *                                                                                *
 * Description:                                                                   *
 *      Implementation (see header for description)                               *
 *                                                                                *
 * Authors (alphabetical):                                                        *
 *      Andreas Hoecker <Andreas.Hocker@cern.ch> - CERN, Switzerland              *
 *      Joerg Stelzer   <stelzer@cern.ch>        - DESY, Germany                  *
 *      Peter Speckmayer <peter.speckmayer@cern.ch> - CERN, Switzerland           *
 *      Jan Therhaag          <Jan.Therhaag@cern.ch>   - U of Bonn, Germany       *
 *      Eckhard v. Toerne     <evt@uni-bonn.de>        - U of Bonn, Germany       *
 *      Helge Voss      <Helge.Voss@cern.ch>     - MPI-K Heidelberg, Germany      *
 *      Daniel Martscheit  <martschei@ekp.uni-karlsruhe.de> -KIT Karlsruhe, Ger.  *
 *                                                                                *
 * Copyright (c) 2005-2011:                                                       *
 *      CERN, Switzerland                                                         *
 *      U. of Victoria, Canada                                                    *
 *      MPI-K Heidelberg, Germany                                                 *
 *      U. of Bonn, Germany                                                       *
 *                                                                                *
 * Redistribution and use in source and binary forms, with or without             *
 * modification, are permitted according to the terms listed in LICENSE           *
 * (http://tmva.sourceforge.net/LICENSE)                                          *
 **********************************************************************************/

////////////////////////////////////////////////////////////////////////////////

/* Begin_Html

   Plugins analysis                       
  
   <p>
   The MethodPlugins is actually not a real method, but it is just a wrapper to call the TPluginsManager of ROOT and find 
   a external method which can be used to extend TMVA by another classifier. The only methods which are actually really implemented are the 
   constructors which fulfill the plugins handling. The others will produce FATAL warnings and stop TMVA execution.
   <p>
   Right after the constructor, the additional method 'getPlugedinMethod()' is called, which returns the method loaded by the plugin manager,
   and the MethodPlugins object is already deleted.

   End_Html */
//_______________________________________________________________________

#include "TPluginManager.h"
#include "TROOT.h"

#include "TMVA/ClassifierFactory.h"
#include "TMVA/Ranking.h"
#include "TMVA/Tools.h"
#include "TMVA/Types.h"

#include <cstdio>
#include <iostream>

namespace 
{ 
   TMVA::IMethod* CreateMethodPlugins(const TString& jobName, const TString& methodTitle, TMVA::DataSetInfo& theData, const TString& theOption)
   { 
      //std::cout << "CreateMethodPlugins is called with options : '" << jobName << "', '" << methodTitle<< "', " << theOption<< "'" << std::endl;
      TPluginManager *pluginManager(0);
      TPluginHandler *pluginHandler(0);
      pluginManager = gROOT->GetPluginManager();
      //An empty methodTitle is a Problem for the PluginHandler, so we need to fiddle it out of the weightsfilename
      TString myMethodTitle;
      if(jobName=="" && methodTitle=="") { //This is most likely a call to the Classifier (not for training)
         myMethodTitle = theOption.Copy();
         Ssiz_t firstUnderscore = myMethodTitle.First('_');
         Ssiz_t firstPoint      = myMethodTitle.Last('.');
         myMethodTitle.Remove(firstPoint,myMethodTitle.Length() - firstPoint);
         myMethodTitle.Remove(0,firstUnderscore-1); //leave the underscore
      }
      else myMethodTitle = methodTitle;
      pluginHandler = pluginManager->FindHandler("TMVA@@MethodBase", myMethodTitle);
      if(!pluginHandler)
         { 
            std::cerr <<  "Couldn't find plugin handler for TMVA@@MethodBase and " << methodTitle << std::endl;
            return 0;
         }
      //std::cout << "pluginHandler found myMethodTitle=" << myMethodTitle<<std::endl;
      if (pluginHandler->LoadPlugin() == 0) {
         if(jobName=="" && methodTitle=="") { 
            //std::cout << "Calling ExpertPlugin " << std::endl;
            return (TMVA::IMethod*) pluginHandler->ExecPlugin(2, &theData, &theOption);
         } else {  
            //std::cout << "Calling TeacherPlugin " << std::endl;
            // pluginHandler->Print("a");
            return (TMVA::IMethod*) pluginHandler->ExecPlugin(4, &jobName, &methodTitle, &theData, &theOption);
         }  
      }
      //std::cout << "plugin done" << std::endl;
      return 0; // end of function should never be reached. This is here to silence the compiler
   }

   struct registration { 
      registration() { 
         TMVA::ClassifierFactory::Instance().Register("Plugins", CreateMethodPlugins);
         TMVA::Types::Instance().AddTypeMapping(TMVA::Types::kPlugins, "Plugins"); 
      } 
   } instance;
}