Wraps the data of a single event into a Dataset. More...

#include <Dataset.h>

Inheritance diagram for SingleDataset:

Public Member Functions
	SingleDataset (const GeneralOptions &general_options, const std::vector< float > &input, float target=1.0, const std::vector< float > &spectators=std::vector< float >())
	Constructs a new SingleDataset.

virtual unsigned int	getNumberOfFeatures () const override
	Returns the number of features in this dataset.

virtual unsigned int	getNumberOfSpectators () const override
	Returns the number of features in this dataset.

virtual unsigned int	getNumberOfEvents () const override
	Returns the number of events in this dataset which is always one.

virtual void	loadEvent (unsigned int) override
	Does nothing in the case of a single dataset, because the only event is already loaded.

virtual std::vector< float >	getFeature (unsigned int iFeature) override
	Returns all values (in this case only one) of one feature in a std::vector<float>

virtual std::vector< float >	getSpectator (unsigned int iSpectator) override
	Returns all values (in this case only one) of one spectator in a std::vector<float>

virtual float	getSignalFraction ()
	Returns the signal fraction of the whole sample.

virtual unsigned int	getFeatureIndex (const std::string &feature)
	Return index of feature with the given name.

virtual unsigned int	getSpectatorIndex (const std::string &spectator)
	Return index of spectator with the given name.

virtual std::vector< float >	getWeights ()
	Returns all weights.

virtual std::vector< float >	getTargets ()
	Returns all targets.

virtual std::vector< bool >	getSignals ()
	Returns all is Signals.

Public Attributes
GeneralOptions	m_general_options
	GeneralOptions passed to this dataset.

std::vector< float >	m_input
	Contains all feature values of the currently loaded event.

std::vector< float >	m_spectators
	Contains all spectators values of the currently loaded event.

float	m_weight
	Contains the weight of the currently loaded event.

float	m_target
	Contains the target value of the currently loaded event.

bool	m_isSignal
	Defines if the currently loaded event is signal or background.

Detailed Description

Wraps the data of a single event into a Dataset.

Mostly useful if one wants to apply an Expert to a single feature vector

Definition at line 135 of file Dataset.h.

Constructor & Destructor Documentation

◆ SingleDataset()

SingleDataset	(	const GeneralOptions &	general_options,
		const std::vector< float > &	input,
		float	target = `1.0`,
		const std::vector< float > &	spectators = `std::vector<float>()`
	)

Constructs a new SingleDataset.

Parameters

general_options	which defines e.g. number of variables
input	feature values of the single event
spectators	spectator values of the single event
target	target value of the single event (defaults to 1, because often this is not known if one wants to apply an expert)

Definition at line 135 of file Dataset.cc.

                                                                     : Dataset(general_options)
    {
      m_input = input;
      m_spectators = spectators;
      m_target = target;
      m_weight = 1.0;
      m_isSignal = std::lround(target) == m_general_options.m_signal_class;
    }

Member Function Documentation

◆ getFeature()

virtual std::vector< float > getFeature ( unsigned int iFeature )

inlineoverridevirtual

Returns all values (in this case only one) of one feature in a std::vector<float>

Parameters

iFeature the position of the feature to return

Reimplemented from Dataset.

Definition at line 172 of file Dataset.h.

172{ return std::vector<float> {m_input[iFeature]}; }

◆ getFeatureIndex()

unsigned int getFeatureIndex ( const std::string & feature )

virtualinherited

Return index of feature with the given name.

Parameters

feature name of the feature

Definition at line 50 of file Dataset.cc.

    {
 
      auto it = std::find(m_general_options.m_variables.begin(), m_general_options.m_variables.end(), feature);
      if (it == m_general_options.m_variables.end()) {
        B2ERROR("Unknown feature named " << feature);
        return 0;
      }
      return std::distance(m_general_options.m_variables.begin(), it);
 
    }

◆ getNumberOfEvents()

virtual unsigned int getNumberOfEvents ( ) const

inlineoverridevirtual

Returns the number of events in this dataset which is always one.

Implements Dataset.

Definition at line 161 of file Dataset.h.

161{ return 1; }

◆ getNumberOfFeatures()

virtual unsigned int getNumberOfFeatures ( ) const

inlineoverridevirtual

Returns the number of features in this dataset.

Implements Dataset.

Definition at line 151 of file Dataset.h.

151{ return m_input.size(); }

◆ getNumberOfSpectators()

virtual unsigned int getNumberOfSpectators ( ) const

inlineoverridevirtual

Returns the number of features in this dataset.

Implements Dataset.

Definition at line 156 of file Dataset.h.

156{ return m_spectators.size(); }

◆ getSignalFraction()

float getSignalFraction ( )

virtualinherited

Returns the signal fraction of the whole sample.

Reimplemented in SPlotDataset.

Definition at line 35 of file Dataset.cc.

    {
 
      double signal_weight_sum = 0;
      double weight_sum = 0;
      for (unsigned int i = 0; i < getNumberOfEvents(); ++i) {
        loadEvent(i);
        weight_sum += m_weight;
        if (m_isSignal)
          signal_weight_sum += m_weight;
      }
      return signal_weight_sum / weight_sum;
 
    }

◆ getSignals()

std::vector< bool > getSignals ( )

virtualinherited

Returns all is Signals.

Reimplemented in ReweightingDataset.

Definition at line 122 of file Dataset.cc.

    {
 
      std::vector<bool> result(getNumberOfEvents());
      for (unsigned int iEvent = 0; iEvent < getNumberOfEvents(); ++iEvent) {
        loadEvent(iEvent);
        result[iEvent] = m_isSignal;
      }
      return result;
 
    }

◆ getSpectator()

virtual std::vector< float > getSpectator ( unsigned int iSpectator )

inlineoverridevirtual

Returns all values (in this case only one) of one spectator in a std::vector<float>

Parameters

iSpectator the position of the spectator to return

Reimplemented from Dataset.

Definition at line 178 of file Dataset.h.

178{ return std::vector<float> {m_spectators[iSpectator]}; }

◆ getSpectatorIndex()

unsigned int getSpectatorIndex ( const std::string & spectator )

virtualinherited

Return index of spectator with the given name.

Parameters

spectator name of the spectator

Definition at line 62 of file Dataset.cc.

    {
 
      auto it = std::find(m_general_options.m_spectators.begin(), m_general_options.m_spectators.end(), spectator);
      if (it == m_general_options.m_spectators.end()) {
        B2ERROR("Unknown spectator named " << spectator);
        return 0;
      }
      return std::distance(m_general_options.m_spectators.begin(), it);
 
    }

◆ getTargets()

std::vector< float > getTargets ( )

virtualinherited

Returns all targets.

Reimplemented in RegressionDataSet, and ReweightingDataset.

Definition at line 110 of file Dataset.cc.

    {
 
      std::vector<float> result(getNumberOfEvents());
      for (unsigned int iEvent = 0; iEvent < getNumberOfEvents(); ++iEvent) {
        loadEvent(iEvent);
        result[iEvent] = m_target;
      }
      return result;
 
    }

◆ getWeights()

std::vector< float > getWeights ( )

virtualinherited

Returns all weights.

Reimplemented in ROOTDataset, RegressionDataSet, and ReweightingDataset.

Definition at line 98 of file Dataset.cc.

    {
 
      std::vector<float> result(getNumberOfEvents());
      for (unsigned int iEvent = 0; iEvent < getNumberOfEvents(); ++iEvent) {
        loadEvent(iEvent);
        result[iEvent] = m_weight;
      }
      return result;
 
    }

◆ loadEvent()

virtual void loadEvent ( unsigned int )

inlineoverridevirtual

Does nothing in the case of a single dataset, because the only event is already loaded.

Implements Dataset.

Definition at line 166 of file Dataset.h.

166{ };

Member Data Documentation

◆ m_general_options

GeneralOptions m_general_options

inherited

GeneralOptions passed to this dataset.

Definition at line 122 of file Dataset.h.

◆ m_input

std::vector<float> m_input

inherited

Contains all feature values of the currently loaded event.

Definition at line 123 of file Dataset.h.

◆ m_isSignal

bool m_isSignal

inherited

Defines if the currently loaded event is signal or background.

Definition at line 127 of file Dataset.h.

◆ m_spectators

std::vector<float> m_spectators

inherited

Contains all spectators values of the currently loaded event.

Definition at line 124 of file Dataset.h.

◆ m_target

float m_target

inherited

Contains the target value of the currently loaded event.

Definition at line 126 of file Dataset.h.

◆ m_weight

float m_weight

inherited

Contains the weight of the currently loaded event.

Definition at line 125 of file Dataset.h.

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

mva/interface/include/Dataset.h
mva/interface/src/Dataset.cc

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SingleDataset()

Member Function Documentation

◆ getFeature()

◆ getFeatureIndex()

◆ getNumberOfEvents()

◆ getNumberOfFeatures()

◆ getNumberOfSpectators()

◆ getSignalFraction()

◆ getSignals()

◆ getSpectator()

◆ getSpectatorIndex()

◆ getTargets()

◆ getWeights()

◆ loadEvent()

Member Data Documentation

◆ m_general_options

◆ m_input

◆ m_isSignal

◆ m_spectators

◆ m_target

◆ m_weight