Belle II Software  release-08-01-10
SPlotDataset Class Reference

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:
Collaboration diagram for SPlotDataset:

Public Member Functions

 SPlotDataset (const GeneralOptions &general_options, Dataset &dataset, const std::vector< float > &weights, float signalFraction)
 Constructs a new SPlotDataset. More...
 
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. More...
 
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. More...
 
virtual unsigned int getSpectatorIndex (const std::string &spectator)
 Return index of spectator with the given name. More...
 
virtual std::vector< float > getFeature (unsigned int iFeature)
 Returns all values of one feature in a std::vector<float> More...
 
virtual std::vector< float > getSpectator (unsigned int iSpectator)
 Returns all values of one spectator in a std::vector<float> More...
 
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

Datasetm_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_optionsshared options defining the dataset (variables, ...)
datasetcontaining the data-points
weightssPlot weights
signalFractionoriginal signal fraction

Definition at line 153 of file DataDriven.cc.

Member Function Documentation

◆ getFeature()

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

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

Parameters
iFeaturethe position of the feature to return

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

Definition at line 74 of file Dataset.cc.

◆ getFeatureIndex()

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

Return index of feature with the given name.

Parameters
featurename of the feature

Definition at line 50 of file Dataset.cc.

◆ getSpectator()

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

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

Parameters
iSpectatorthe position of the feature to return

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

Definition at line 86 of file Dataset.cc.

◆ getSpectatorIndex()

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

Return index of spectator with the given name.

Parameters
spectatorname of the spectator

Definition at line 62 of file Dataset.cc.

◆ loadEvent()

void loadEvent ( unsigned int  event)
overridevirtual

Load the event number iEvent.

Parameters
eventevent number to load

Implements Dataset.

Definition at line 162 of file DataDriven.cc.


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