PDFOptions Class Reference

Options for the PDF MVA method. More...

#include <PDF.h>

Inheritance diagram for PDFOptions:

Collaboration diagram for PDFOptions:

Public Member Functions
virtual void	load (const boost::property_tree::ptree &pt) override
	Load mechanism (used by Weightfile) to load Options from a xml tree.
virtual void	save (boost::property_tree::ptree &pt) const override
	Save mechanism (used by Weightfile) 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_binning = "frequency"
	which type of binning is performed e.g.
std::string	m_mode = "probability"
	mode which defines the final output e.g.
unsigned int	m_nBins = 100
	number of bins used to bin the data

Detailed Description

Options for the PDF MVA method.

Definition at line 29 of file PDF.h.

Member Function Documentation

getDescription()

po::options_description getDescription ( )

overridevirtual

Returns a program options description for all available options.

Implements Options.

Definition at line 40 of file PDF.cc.

    {
      po::options_description description("PDF options");
      description.add_options()
      ("binning", po::value<std::string>(&m_binning), "Binning used to bin the data  (frequency|equidistant)")
      ("nBins", po::value<unsigned int>(&m_nBins), "Number of bins used to bin the data")
      ("mode", po::value<std::string>(&m_mode), "Mode used to calculate return value of expert");
      return description;
    }

getMethod()

virtual std::string getMethod ( ) const

inlineoverridevirtual

Return method name.

Implements SpecificOptions.

Definition at line 52 of file PDF.h.

{ return "PDF"; }

load()

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

overridevirtual

Load mechanism (used by Weightfile) to load Options from a xml tree.

Parameters

pt

xml tree

Implements Options.

Definition at line 19 of file PDF.cc.

    {
      int version = pt.get<int>("PDF_version");
      if (version != 1) {
        B2ERROR("Unknown weightfile version " << std::to_string(version));
        throw std::runtime_error("Unknown weightfile version " + std::to_string(version));
      }
      m_binning = pt.get<std::string>("PDF_binning");
      m_mode = pt.get<std::string>("PDF_mode");
      m_nBins = pt.get<unsigned int>("PDF_nBins");
 
    }

save()

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

overridevirtual

Save mechanism (used by Weightfile) to store Options in a xml tree.

Parameters

pt

xml tree

Implements Options.

Definition at line 32 of file PDF.cc.

    {
      pt.put("PDF_version", 1);
      pt.put("PDF_binning", m_binning);
      pt.put("PDF_mode", m_mode);
      pt.put("PDF_nBins", m_nBins);
    }

Member Data Documentation

m_binning

std::string m_binning = "frequency"

which type of binning is performed e.g.

frequency or equidistant

Definition at line 54 of file PDF.h.

m_mode

std::string m_mode = "probability"

mode which defines the final output e.g.

probability

Definition at line 55 of file PDF.h.

m_nBins

unsigned int m_nBins = 100

number of bins used to bin the data

Definition at line 56 of file PDF.h.

---

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

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