Dataset for sPlot Wraps a dataset and provides each data-point twice, once as signal and once as background. More...

#include <DataDriven.h>

Inheritance diagram for SPlotDataset:

Public Member Functions
	SPlotDataset (const GeneralOptions &general_options, Dataset &dataset, const std::vector< float > &weights, float signalFraction)
	Constructs a new SPlotDataset.

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.

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

virtual float	getSignalFraction () override
	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
Dataset &	m_dataset
	Wrapped dataset.

std::vector< float >	m_weights
	sPlot weights

float	m_signalFraction
	Signal fraction.

Detailed Description

Dataset for sPlot Wraps a dataset and provides each data-point twice, once as signal and once as background.

Definition at line 161 of file DataDriven.h.

Constructor & Destructor Documentation

◆ SPlotDataset()

SPlotDataset	(	const GeneralOptions &	general_options,
		Dataset &	dataset,
		const std::vector< float > &	weights,
		float	signalFraction
	)

Constructs a new SPlotDataset.

Parameters

general_options	shared options defining the dataset (variables, ...)
dataset	containing the data-points
weights	sPlot weights
signalFraction	original signal fraction

Definition at line 153 of file DataDriven.cc.

154 : Dataset(general_options), m_dataset(dataset), m_weights(weights), m_signalFraction(signalFraction) { }

Belle2::MVA::Dataset::Dataset

Dataset(const GeneralOptions &general_options)

Constructs a new dataset given the general options.

Definition: Dataset.cc:26

Belle2::MVA::SPlotDataset::m_weights

std::vector< float > m_weights

sPlot weights

Definition: DataDriven.h:201

Belle2::MVA::SPlotDataset::m_dataset

Dataset & m_dataset

Wrapped dataset.

Definition: DataDriven.h:200

Belle2::MVA::SPlotDataset::m_signalFraction

float m_signalFraction

Signal fraction.

Definition: DataDriven.h:202

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 186 of file DataDriven.h.

186{ return 2 * m_dataset.getNumberOfEvents(); };

◆ getNumberOfFeatures()

virtual unsigned int getNumberOfFeatures ( ) const

inlineoverridevirtual

Returns the number of features in this dataset.

Implements Dataset.

Definition at line 176 of file DataDriven.h.

176{ return m_dataset.getNumberOfFeatures(); }

Belle2::MVA::Dataset::getNumberOfFeatures

virtual unsigned int getNumberOfFeatures() const =0

Returns the number of features in this dataset.

◆ getNumberOfSpectators()

virtual unsigned int getNumberOfSpectators ( ) const

inlineoverridevirtual

Returns the number of features in this dataset.

Implements Dataset.

Definition at line 181 of file DataDriven.h.

181{ return m_dataset.getNumberOfSpectators(); }

Belle2::MVA::Dataset::getNumberOfSpectators

virtual unsigned int getNumberOfSpectators() const =0

Returns the number of spectators in this dataset.

◆ getSignalFraction()

float getSignalFraction ( )

overridevirtual

Returns the signal fraction of the whole sample.

Reimplemented from Dataset.

Definition at line 157 of file DataDriven.cc.

    {
      return m_signalFraction;
    }

◆ 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 event )

overridevirtual

Load the event number iEvent.

Parameters

event event number to load

Implements Dataset.

Definition at line 162 of file DataDriven.cc.

    {
      m_dataset.loadEvent(event / 2);
      for (unsigned int iFeature = 0; iFeature < getNumberOfFeatures(); ++iFeature) {
        m_input[iFeature] = m_dataset.m_input[iFeature];
      }
 
      if (event % 2 == 1) {
        m_isSignal = false;
        m_target = 0.0;
        m_weight = m_weights[event] * m_dataset.m_weight;
      } else {
        m_isSignal = true;
        m_target = 1.0;
        m_weight = m_weights[event] * m_dataset.m_weight;
      }
    }

Member Data Documentation

◆ m_dataset

Dataset& m_dataset

private

Wrapped dataset.

Definition at line 200 of file DataDriven.h.

◆ 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_signalFraction

float m_signalFraction

private

Signal fraction.

Definition at line 202 of file DataDriven.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.

◆ m_weights

std::vector<float> m_weights

private

sPlot weights

Definition at line 201 of file DataDriven.h.

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

mva/utility/include/DataDriven.h
mva/utility/src/DataDriven.cc

Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SPlotDataset()

Member Function Documentation

◆ getFeature()

◆ getFeatureIndex()

◆ getNumberOfEvents()

◆ getNumberOfFeatures()

◆ getNumberOfSpectators()

◆ getSignalFraction()

◆ getSignals()

◆ getSpectator()

◆ getSpectatorIndex()

◆ getTargets()

◆ getWeights()

◆ loadEvent()

Member Data Documentation

◆ m_dataset

◆ m_general_options

◆ m_input

◆ m_isSignal

◆ m_signalFraction

◆ m_spectators

◆ m_target

◆ m_weight

◆ m_weights