TMVAOptions Class Reference

Options for the TMVA MVA method. More...

#include <TMVA.h>

Inheritance diagram for TMVAOptions:

Public Member Functions
virtual void	load (const boost::property_tree::ptree &pt) override
	Load mechanism to load Options from a xml tree.
virtual void	save (boost::property_tree::ptree &pt) const override
	Save mechanism to store Options in a xml tree.
virtual po::options_description	getDescription () override
	Returns a program options description for all available options.
virtual std::string	getMethod () const override
	Return method name.

Public Attributes
std::string	m_method = "BDT"
	tmva method name
std::string	m_type = "BDT"
	tmva method type
std::string	m_config
	TMVA config string for the chosen method.
std::string	m_factoryOption = "!V:!Silent:Color:DrawProgressBar"
	Factory options passed to tmva factory.
std::string	m_prepareOption = "SplitMode=random:!V"
	Prepare options passed to prepareTrainingAndTestTree method.
std::string	m_workingDirectory = ""
	Working directory of TMVA, if empty a temporary directory is used.
std::string	m_prefix = "TMVA"
	Prefix used for all files generated by TMVA.

Detailed Description

Options for the TMVA MVA method.

Definition at line 34 of file TMVA.h.

Member Function Documentation

getDescription()

po::options_description getDescription ( )

overridevirtual

Returns a program options description for all available options.

Implements Options.

Reimplemented in TMVAOptionsClassification, and TMVAOptionsMulticlass.

Definition at line 55 of file TMVA.cc.

    {
      po::options_description description("TMVA options");
      description.add_options()
      ("tmva_method", po::value<std::string>(&m_method), "TMVA Method Name")
      ("tmva_type", po::value<std::string>(&m_type), "TMVA Method Type (e.g. Plugin, BDT, ...)")
      ("tmva_config", po::value<std::string>(&m_config), "TMVA Configuration string for the method")
      ("tmva_working_directory", po::value<std::string>(&m_workingDirectory), "TMVA working directory which stores e.g. TMVA.root")
      ("tmva_factory", po::value<std::string>(&m_factoryOption), "TMVA Factory options passed to TMVAFactory constructor")
      ("tmva_prepare", po::value<std::string>(&m_prepareOption),
       "TMVA Preprare options passed to prepareTrainingAndTestTree function");
      return description;
    }

getMethod()

virtual std::string getMethod ( ) const

inlineoverridevirtual

Return method name.

Implements SpecificOptions.

Reimplemented in TMVAOptionsClassification, TMVAOptionsMulticlass, and TMVAOptionsRegression.

Definition at line 57 of file TMVA.h.

{ return "TMVA"; }

load()

void load ( const boost::property_tree::ptree &  pt )

overridevirtual

Load mechanism to load Options from a xml tree.

Parameters

pt

xml tree

Implements Options.

Reimplemented in TMVAOptionsClassification, and TMVAOptionsMulticlass.

Definition at line 27 of file TMVA.cc.

    {
      int version = pt.get<int>("TMVA_version");
      if (version != 1) {
        B2ERROR("Unknown weightfile version " << std::to_string(version));
        throw std::runtime_error("Unknown weightfile version " + std::to_string(version));
      }
      m_method = pt.get<std::string>("TMVA_method");
      m_type = pt.get<std::string>("TMVA_type");
      m_config = pt.get<std::string>("TMVA_config");
      m_factoryOption = pt.get<std::string>("TMVA_factoryOption");
      m_prepareOption = pt.get<std::string>("TMVA_prepareOption");
      m_workingDirectory = pt.get<std::string>("TMVA_workingDirectory");
      m_prefix = pt.get<std::string>("TMVA_prefix");
    }

save()

void save ( boost::property_tree::ptree &  pt ) const

overridevirtual

Save mechanism to store Options in a xml tree.

Parameters

pt

xml tree

Implements Options.

Reimplemented in TMVAOptionsClassification, and TMVAOptionsMulticlass.

Definition at line 43 of file TMVA.cc.

    {
      pt.put("TMVA_version", 1);
      pt.put("TMVA_method", m_method);
      pt.put("TMVA_type", m_type);
      pt.put("TMVA_config", m_config);
      pt.put("TMVA_factoryOption", m_factoryOption);
      pt.put("TMVA_prepareOption", m_prepareOption);
      pt.put("TMVA_workingDirectory", m_workingDirectory);
      pt.put("TMVA_prefix", m_prefix);
    }

Member Data Documentation

m_config

std::string m_config

Initial value:

=
        "!H:!V:CreateMVAPdfs:NTrees=400:BoostType=Grad:Shrinkage=0.1:UseBaggedBoost:BaggedSampleFraction=0.5:nCuts=1024:MaxDepth=3:IgnoreNegWeightsInTraining"

TMVA config string for the chosen method.

Definition at line 66 of file TMVA.h.

m_factoryOption

std::string m_factoryOption = "!V:!Silent:Color:DrawProgressBar"

Factory options passed to tmva factory.

Definition at line 71 of file TMVA.h.

m_method

std::string m_method = "BDT"

tmva method name

Definition at line 60 of file TMVA.h.

m_prefix

std::string m_prefix = "TMVA"

Prefix used for all files generated by TMVA.

Definition at line 74 of file TMVA.h.

m_prepareOption

std::string m_prepareOption = "SplitMode=random:!V"

Prepare options passed to prepareTrainingAndTestTree method.

Definition at line 72 of file TMVA.h.

m_type

std::string m_type = "BDT"

tmva method type

Definition at line 61 of file TMVA.h.

m_workingDirectory

std::string m_workingDirectory = ""

Working directory of TMVA, if empty a temporary directory is used.

Definition at line 73 of file TMVA.h.

---

The documentation for this class was generated from the following files:

• mva/methods/include/TMVA.h
• mva/methods/src/TMVA.cc