TrivialOptions Class Reference

Options for the Trivial MVA method. More...

#include <Trivial.h>

Inheritance diagram for TrivialOptions:

Collaboration diagram for TrivialOptions:

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
double	m_output = 0.5
	Output of the trivial method.
std::vector< double >	m_multiple_output = {}
	Output of the trivial method.
bool	m_passthrough = false
	Flag for passthrough setting.

Detailed Description

Options for the Trivial MVA method.

Used for debugging and testing

Definition at line 28 of file Trivial.h.

Member Function Documentation

getDescription()

po::options_description getDescription ( )

overridevirtual

Returns a program options description for all available options.

Implements Options.

Definition at line 49 of file Trivial.cc.

    {
      po::options_description description("Trivial options");
      description.add_options()
      ("output", po::value<double>(&m_output),
       "Outputs this value for all predictions in binary classification (unless passthrough is enabled).");
      description.add_options()
      ("multiple_output", po::value<std::vector<double>>(&m_multiple_output)->multitoken(),
       "Outputs these values for their respective classes in multiclass classification (unless passthrough is enabled).");
      description.add_options()
      ("passthrough", po::value<bool>(&m_passthrough),
       "If enabled, the method returns the value of the input variable. For binary classification this option requires the presence of only one input variable. For multiclass classification we require either one input variable which is returned for all classes, or an input variable per class.");
      return description;
    }

getMethod()

virtual std::string getMethod ( ) const

inlineoverridevirtual

Return method name.

Implements SpecificOptions.

Definition at line 51 of file Trivial.h.

{ return "Trivial"; }

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.

Definition at line 20 of file Trivial.cc.

    {
      int version = pt.get<int>("Trivial_version");
      if (version != 1) {
        B2ERROR("Unknown weightfile version " << std::to_string(version));
        throw std::runtime_error("Unknown weightfile version " + std::to_string(version));
      }
      m_output = pt.get<double>("Trivial_output");
 
      auto numberOfOutputs = pt.get<unsigned int>("Trivial_number_of_multiple_outputs", 0u);
      m_multiple_output.resize(numberOfOutputs);
      for (unsigned int i = 0; i < numberOfOutputs; ++i) {
        m_multiple_output[i] = pt.get<double>(std::string("Trivial_multiple_output") + std::to_string(i));
      }
 
      m_passthrough = pt.get<bool>("Trivial_passthrough", false);
    }

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.

Definition at line 38 of file Trivial.cc.

    {
      pt.put("Trivial_version", 1);
      pt.put("Trivial_output", m_output);
      pt.put("Trivial_number_of_multiple_outputs", m_multiple_output.size());
      for (unsigned int i = 0; i < m_multiple_output.size(); ++i) {
        pt.put(std::string("Trivial_multiple_output") + std::to_string(i), m_multiple_output[i]);
      }
      pt.put("Trivial_passthrough", m_passthrough);
    }

Member Data Documentation

m_multiple_output

std::vector<double> m_multiple_output = {}

Output of the trivial method.

Definition at line 54 of file Trivial.h.

m_output

double m_output = 0.5

Output of the trivial method.

Definition at line 53 of file Trivial.h.

m_passthrough

bool m_passthrough = false

Flag for passthrough setting.

Definition at line 55 of file Trivial.h.

---

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

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