MultiDataset Class Reference

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

#include <Dataset.h>

Inheritance diagram for MultiDataset:

Public Member Functions
	MultiDataset (const GeneralOptions &general_options, const std::vector< std::vector< float > > &input, const std::vector< std::vector< float > > &spectators, const std::vector< float > &targets={}, const std::vector< float > &weights={})
	Constructs a new MultiDataset.
virtual unsigned int	getNumberOfFeatures () const override
	Returns the number of features in this dataset.
virtual unsigned int	getNumberOfSpectators () const override
	Returns the number of spectators in this dataset.
virtual unsigned int	getNumberOfEvents () const override
	Returns the number of events in this dataset.
virtual void	loadEvent (unsigned int iEvent) override
	Does nothing in the case of a single dataset, because the only event is already loaded.
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.

Private Attributes
std::vector< std::vector< float > >	m_matrix
	Feature matrix.
std::vector< std::vector< float > >	m_spectator_matrix
	Spectator matrix.
std::vector< float >	m_targets
	target vector
std::vector< float >	m_weights
	weight vector

Detailed Description

Wraps the data of a multiple event into a Dataset.

Mostly useful if one wants to apply an Expert to a feature matrix

Definition at line 186 of file Dataset.h.

Constructor & Destructor Documentation

MultiDataset()

MultiDataset	(	const GeneralOptions &	general_options,
		const std::vector< std::vector< float > > &	input,
		const std::vector< std::vector< float > > &	spectators,
		const std::vector< float > &	targets = {},
		const std::vector< float > &	weights = {}
	)

Constructs a new MultiDataset.

Parameters

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

Definition at line 145 of file Dataset.cc.

                                                                                                 : Dataset(general_options),  m_matrix(input),
      m_spectator_matrix(spectators),
      m_targets(targets), m_weights(weights)
    {
 
      if (m_targets.size() > 0 and m_matrix.size() != m_targets.size()) {
        B2ERROR("Feature matrix and target vector need same number of elements in MultiDataset, got " << m_targets.size() << " and " <<
                m_matrix.size());
      }
      if (m_weights.size() > 0 and m_matrix.size() != m_weights.size()) {
        B2ERROR("Feature matrix and weight vector need same number of elements in MultiDataset, got " << m_weights.size() << " and " <<
                m_matrix.size());
      }
      if (m_spectator_matrix.size() > 0 and m_matrix.size() != m_spectator_matrix.size()) {
        B2ERROR("Feature matrix and spectator matrix need same number of elements in MultiDataset, got " << m_spectator_matrix.size() <<
                " and " <<
                m_matrix.size());
      }
    }

Member Function Documentation

getFeature()

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

virtualinherited

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 )

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.

Implements Dataset.

Definition at line 214 of file Dataset.h.

{ return m_matrix.size(); }

getNumberOfFeatures()

virtual unsigned int getNumberOfFeatures ( ) const

inlineoverridevirtual

Returns the number of features in this dataset.

Implements Dataset.

Definition at line 204 of file Dataset.h.

{ return m_input.size(); }

getNumberOfSpectators()

virtual unsigned int getNumberOfSpectators ( ) const

inlineoverridevirtual

Returns the number of spectators in this dataset.

Implements Dataset.

Definition at line 209 of file Dataset.h.

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

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

virtualinherited

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 )

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

void loadEvent ( unsigned int  iEvent )

overridevirtual

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

Implements Dataset.

Definition at line 168 of file Dataset.cc.

    {
      m_input = m_matrix[iEvent];
 
      if (m_spectator_matrix.size() > 0) {
        m_spectators = m_spectator_matrix[iEvent];
      }
 
      if (m_targets.size() > 0) {
        m_target = m_targets[iEvent];
        m_isSignal = std::lround(m_target) == m_general_options.m_signal_class;
      }
 
      if (m_weights.size() > 0)
        m_weight = m_weights[iEvent];
 
    }

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_matrix

std::vector<std::vector<float> > m_matrix

private

Feature matrix.

Definition at line 223 of file Dataset.h.

m_spectator_matrix

std::vector<std::vector<float> > m_spectator_matrix

private

Spectator matrix.

Definition at line 224 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_targets

std::vector<float> m_targets

private

target vector

Definition at line 225 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.

m_weights

std::vector<float> m_weights

private

weight vector

Definition at line 226 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