Abstract base class of all Datasets given to the MVA interface The current event can always be accessed via the public members of this class. More...

#include <Dataset.h>

Inheritance diagram for Dataset:

Public Member Functions
	Dataset (const GeneralOptions &general_options)
	Constructs a new dataset given the general options.

virtual	~Dataset ()=default
	Virtual default destructor.

	Dataset (const Dataset &)=delete
	Specify no copy constructor.

Dataset &	operator= (const Dataset &)=delete
	Specify no assignment operator.

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

virtual unsigned int	getNumberOfSpectators () const =0
	Returns the number of spectators in this dataset.

virtual unsigned int	getNumberOfEvents () const =0
	Returns the number of events in this dataset.

virtual void	loadEvent (unsigned int iEvent)=0
	Load the event number iEvent.

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 >	getFeature (unsigned int iFeature)
	Returns all values of one feature in a std::vector<float>

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

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

Abstract base class of all Datasets given to the MVA interface The current event can always be accessed via the public members of this class.

Definition at line 33 of file Dataset.h.

Constructor & Destructor Documentation

◆ Dataset()

Dataset ( const GeneralOptions & general_options )

explicit

Constructs a new dataset given the general options.

Parameters

general_options which defines e.g. number of variables

Definition at line 26 of file Dataset.cc.

                                                          : m_general_options(general_options)
    {
      m_input.resize(m_general_options.m_variables.size(), 0);
      m_spectators.resize(m_general_options.m_spectators.size(), 0);
      m_target = 0.0;
      m_weight = 1.0;
      m_isSignal = false;
    }

Member Function Documentation

◆ getFeature()

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

virtual

Returns all values of one feature in a std::vector<float>

Parameters

iFeature the position of the feature to return

Reimplemented in SingleDataset, SubDataset, CombinedDataset, ROOTDataset, RegressionDataSet, ReweightingDataset, and SidebandDataset.

Definition at line 74 of file Dataset.cc.

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

◆ getFeatureIndex()

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

virtual

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

pure virtual

Returns the number of events in this dataset.

Implemented in SingleDataset, MultiDataset, SubDataset, CombinedDataset, ROOTDataset, RegressionDataSet, ReweightingDataset, SidebandDataset, and SPlotDataset.

◆ getNumberOfFeatures()

virtual unsigned int getNumberOfFeatures ( ) const

pure virtual

Returns the number of features in this dataset.

Implemented in SingleDataset, MultiDataset, SubDataset, CombinedDataset, ROOTDataset, RegressionDataSet, ReweightingDataset, SidebandDataset, and SPlotDataset.

◆ getNumberOfSpectators()

virtual unsigned int getNumberOfSpectators ( ) const

pure virtual

Returns the number of spectators in this dataset.

Implemented in SingleDataset, MultiDataset, SubDataset, CombinedDataset, ROOTDataset, RegressionDataSet, ReweightingDataset, SidebandDataset, and SPlotDataset.

◆ getSignalFraction()

float getSignalFraction ( )

virtual

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 ( )

virtual

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()

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

virtual

Returns all values of one spectator in a std::vector<float>

Parameters

iSpectator the position of the feature to return

Reimplemented in SingleDataset, SubDataset, CombinedDataset, ROOTDataset, RegressionDataSet, ReweightingDataset, and SidebandDataset.

Definition at line 86 of file Dataset.cc.

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

◆ getSpectatorIndex()

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

virtual

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 ( )

virtual

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 ( )

virtual

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 iEvent )

pure virtual

Load the event number iEvent.

Parameters

iEvent event number to load

Implemented in ROOTDataset, ReweightingDataset, SidebandDataset, SPlotDataset, MultiDataset, SubDataset, CombinedDataset, RegressionDataSet, and SingleDataset.

Member Data Documentation

◆ m_general_options

GeneralOptions m_general_options

GeneralOptions passed to this dataset.

Definition at line 122 of file Dataset.h.

◆ m_input

std::vector<float> m_input

Contains all feature values of the currently loaded event.

Definition at line 123 of file Dataset.h.

◆ m_isSignal

bool m_isSignal

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

Contains all spectators values of the currently loaded event.

Definition at line 124 of file Dataset.h.

◆ m_target

float m_target

Contains the target value of the currently loaded event.

Definition at line 126 of file Dataset.h.

◆ m_weight

float m_weight

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

◆ Dataset()

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