Detailed Description

This class is meant to compute the log odds for different datasets.

TRestDataSetOdds performs the log odds of the different observables given in the config file and for a particular dataSet. To perform the log odds first the probability density funcion (PDF) is obtained for a set of observables in the desired range. Later on, the log odds is computed as log(1. - odds) - log(odds) obtaining a number which is proportional to how likely is an event with respect the desired distribution; lower the number, more likely is the event to the input distribution. New observables are created in the output dataSet odds_obserbable and the addition of all of them in odds_total. If an input odds file is provided, the different PDFs are retrieved from the input file.

A summary of the basic parameters is described below:

dataSetName: Name of the dataSet to be computed
oddsFile: Name of the input odds file to be used for the definition of the different PDFs.

The different observables, range and nBins are added as follow:

name: Name of the observable PDF to be computed
range: Range of the observable PDF to be used
nBins: Number of bins for the observable PDF

In addition a TRestCut is used as input for the generation of PDFs, check TRestCut class for more info.

Examples

Example of RML config file:

    <TRestDataSetOdds name="LogOdds" verboseLevel="info">
   <observable name="tckAna_MaxTrack_XYZ_SigmaZ2" range="(0,20)" nBins="100"/>
   <observable name="tckAna_MaxTrackEnergyBalanceXY" range="(-5,5)" nBins="100"/>
   <observable name="tckAna_MaxTrack_XZ_nHits" range="(0,20)" nBins="20" />
   <observable name="tckAna_MaxTrack_YZ_nHits" range="(0,20)" nBins="20" />
   <observable name="tckAna_MaxTrackEnergyRatio" range="(0,0.1)" nBins="100" />
   <observable name="tckAna_MaxTrack_XZ_SigmaX" range="(0,10)" nBins="100" />
   <observable name="tckAna_MaxTrack_YZ_SigmaY" range="(0,10)" nBins="100" />
   <observable name="tckAna_MaxTrackxySigmaBalance" range="(-1,1)" nBins="25"/>
   <TRestCut name="EnergyCut" verboseLevel="info">
     <cut name="c1" variable="calib_Energy" condition=">4" />
     <cut name="c2" variable="calib_Energy" condition="<8" />
   </TRestCut>
   <parameter name="dataSetName" value="myDataSet.root"/>
</TRestDataSetOdds>

Example to compute the the odds over a dataSet using restRoot:

[0] TRestDataSetOdds odds ("odds.rml");
[1] odds.SetDataSetName("myDataSet.root");
[2] odds.SetOutputFileName("myComputedOddsDataSet.root");
[3] odds.ComputeLogOdds();

Example to compute the the odds over a dataSet with input odds file using restRoot:

[0] TRestDataSetOdds odds ("odds.rml");
[1] odds.SetDataSetName("myDataSet.root");
[2] odds.SetOutputFileName("myComputedOddsDataSet.root");
[3] odds.odds.SetOddsFile("myOddsDataSet.root");
[4] odds.ComputeLogOdds();

REST-for-Physics - Software for Rare Event Searches Toolkit

History of developments:

2023-03: First implementation of TRestDataSetOdds JuanAn Garcia

Author: : JuanAn Garcia e-mail: juana.nosp@m.ngp@.nosp@m.uniza.nosp@m.r.es

Definition at line 31 of file TRestDataSetOdds.h.

#include <TRestDataSetOdds.h>

Inheritance diagram for TRestDataSetOdds:

Public Member Functions
void	AddOddsObservable (const std::string &name, const TVector2 &range, int nbins)

	ClassDefOverride (TRestDataSetOdds, 1)

void	ComputeLogOdds ()
	This function computes the log odds for a given dataSet. If no calibration odds file is provided it computes the PDF for the given observables. Otherwise, it takes the PDF from the input file. This function generate different observables odds_obsName and the addition of all of them for a further processing, which is stored in odds_total observable. More...

TRestCut *	GetCut ()

std::string	GetDataSetName ()

std::string	GetOddsFile ()

std::vector< std::tuple< std::string, TVector2, int > >	GetOddsObservables ()

std::string	GetOutputFileName ()

void	PrintMetadata () override
	Prints on screen the information about the metadata members of TRestDataSetOdds. More...

void	SetCut (TRestCut *cut)

void	SetDataSetName (const std::string &dSName)

void	SetOddsFile (const std::string &oddsFile)

void	SetOddsObservables (const std::vector< std::tuple< std::string, TVector2, int > > &obs)

void	SetOutputFileName (const std::string &outName)

	TRestDataSetOdds ()
	Default constructor. More...

	TRestDataSetOdds (const char *configFilename, std::string name="")
	Constructor loading data from a config file. More...

	~TRestDataSetOdds ()
	Default destructor. More...

Public Member Functions inherited from TRestMetadata
void	AddLog (std::string log="", bool print=true)
	Add logs to messageBuffer. More...

void	DoNotStore ()
	If this method is called the metadata information will not be stored in disk. More...

TVector2	Get2DVectorParameterWithUnits (std::string parName, TVector2 defaultValue=TVector2(-1, -1))

TVector3	Get3DVectorParameterWithUnits (std::string parName, TVector3 defaultValue=TVector3(-1, -1, -1))

TString	GetCommit ()
	Returns the REST commit value stored in fCommit. More...

std::string	GetConfigBuffer ()
	Returns the config section of this class. More...

std::string	GetDataMemberValue (std::string memberName)
	Get the value of data member as string. More...

std::vector< std::string >	GetDataMemberValues (std::string memberName, Int_t precision=0)
	Get the value of datamember as a vector of strings. More...

TString	GetDataPath ()
	Returns a std::string with the path used for data storage. More...

Double_t	GetDblParameterWithUnits (std::string parName, Double_t defaultValue=PARAMETER_NOT_FOUND_DBL)
	Gets the value of the parameter name parName, after applying unit conversion. More...

Bool_t	GetError () const
	It returns true if an error was identified by a derived metadata class. More...

TString	GetErrorMessage ()
	Returns a std::string containing the error message. More...

TString	GetLibraryVersion ()
	Returns the REST libraty version stored in fLibraryVersion. More...

TString	GetMainDataPath ()
	Gets a std::string with the path used for data storage. More...

Int_t	GetNumberOfErrors () const

Int_t	GetNumberOfWarnings () const

std::string	GetParameter (std::string parName, TString defaultValue=PARAMETER_NOT_FOUND_STR)
	Returns corresponding REST Metadata parameter from multiple sources. More...

std::string	GetSectionName ()
	Returns the section name of this class, defined at the beginning of fSectionName. More...

TRestStringOutput::REST_Verbose_Level	GetVerboseLevel ()
	returns the verboselevel in type of REST_Verbose_Level enumerator More...

TString	GetVerboseLevelString ()
	returns the verbose level in type of TString More...

TString	GetVersion ()
	Returns the REST version stored in fVersion. More...

Int_t	GetVersionCode ()

UInt_t	GetVersionMajor () const

UInt_t	GetVersionMinor () const

UInt_t	GetVersionPatch () const

Bool_t	GetWarning () const
	It returns true if an error was identified by a derived metadata class. More...

TString	GetWarningMessage ()
	Returns a std::string containing the warning message. More...

virtual void	Initialize ()
	Making default settings. More...

TRestMetadata *	InstantiateChildMetadata (int index, std::string pattern="")
	This method will retrieve a new TRestMetadata instance of a child element of the present TRestMetadata instance based on the `index` given by argument, which defines the element order to be retrieved, 0 for first element found, 1 for the second element found, etc. More...

TRestMetadata *	InstantiateChildMetadata (std::string pattern="", std::string name="")
	This method will retrieve a new TRestMetadata instance of a child element of the present TRestMetadata instance based on the `name` given by argument. More...

Bool_t	isCleanState () const

Bool_t	isOfficialRelease () const

Int_t	LoadConfigFromBuffer ()
	Initialize data from a string element buffer. More...

Int_t	LoadConfigFromElement (TiXmlElement eSectional, TiXmlElement eGlobal, std::map< std::string, std::string > envs={})
	Main starter method. More...

Int_t	LoadConfigFromFile (const std::string &configFilename, const std::string &sectionName="")
	Give the file name, find out the corresponding section. Then call the main starter. More...

virtual void	Merge (const TRestMetadata &)

TRestMetadata &	operator= (const TRestMetadata &)

void	Print ()
	Implementing TObject::Print() method. More...

void	PrintConfigBuffer ()
	Print the config xml section stored in the class. More...

void	PrintMessageBuffer ()
	Print the buffered message. More...

virtual void	PrintMetadata ()
	Implemented it in the derived metadata class to print out specific metadata information. More...

void	PrintTimeStamp (Double_t timeStamp)
	Print the current time on local machine. More...

void	SetConfigFile (std::string configFilename)
	set config file path from external More...

void	SetError (std::string message="", bool print=true, int maxPrint=5)
	A metadata class may use this method to signal that something went wrong. More...

void	SetHostmgr (TRestManager *m)
	Set the host manager for this class. More...

void	SetSectionName (std::string sName)
	set the section name, clear the section content More...

void	SetVerboseLevel (TRestStringOutput::REST_Verbose_Level v)
	sets the verbose level More...

void	SetWarning (std::string message="", bool print=true, int maxPrint=5)
	A metadata class may use this method to signal that something went wrong. More...

void	Store ()
	If this method is called the metadata information will be stored in disk. More...

	TRestMetadata (const TRestMetadata &)

virtual void	UpdateMetadataMembers ()
	Method to allow implementation of specific metadata members updates at inherited classes. More...

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
	overwriting the write() method with fStore considered More...

void	WriteConfigBuffer (std::string fName)
	Writes the config buffer to a file in append mode. More...

	~TRestMetadata ()
	TRestMetadata default destructor. More...

Private Member Functions
void	InitFromConfigFile () override
	Function to initialize some variables from configfile. More...

void	Initialize () override
	Function to initialize input/output event members and define the section name. More...

Private Attributes
TRestCut *	fCut = nullptr
	Cuts over the dataset for PDF selection. More...

std::string	fDataSetName = ""
	Name of the dataSet inside the config file. More...

std::map< std::string, TH1F * >	fHistos
	Map containing the PDF of the different observables. More...

std::vector< std::string >	fObsName
	Vector containing different obserbable names. More...

std::vector< int >	fObsNbins
	Vector containing number of bins for the different observables. More...

std::vector< TVector2 >	fObsRange
	Vector containing different obserbable ranges. More...

std::string	fOddsFile = ""
	Name of the odds file to be used to get the PDF. More...

std::string	fOutputFileName = ""
	Name of the output file. More...

Additional Inherited Members
Protected Member Functions inherited from TRestMetadata
std::string	ElementToString (TiXmlElement *ele)
	Convert an TiXmlElement object to string. More...

TVector2	Get2DVectorParameterWithUnits (std::string parName, TiXmlElement *e, TVector2 defaultValue=TVector2(-1, -1))

TVector3	Get3DVectorParameterWithUnits (std::string parName, TiXmlElement *e, TVector3 defaultValue=TVector3(-1, -1, -1))

Double_t	GetDblParameterWithUnits (std::string parName, TiXmlElement *e, Double_t defaultVal=PARAMETER_NOT_FOUND_DBL)

TiXmlElement *	GetElement (std::string eleDeclare, TiXmlElement *e=nullptr)
	Get an xml element from a given parent element, according to its declaration. More...

TiXmlElement *	GetElementFromFile (std::string configFilename, std::string NameOrDecalre="")
	Open an xml encoded file and find its element. More...

TiXmlElement *	GetElementWithName (std::string eleDeclare, std::string eleName)
	Get an xml element from the default location, according to its declaration and its field "name". More...

TiXmlElement *	GetElementWithName (std::string eleDeclare, std::string eleName, TiXmlElement *e)
	Get an xml element from a given parent element, according to its declaration and its field "name". More...

std::string	GetFieldValue (std::string fieldName, std::string definition, size_t fromPosition=0)
	Gets field value in an xml element string by parsing it as TiXmlElement. More...

std::string	GetFieldValue (std::string parName, TiXmlElement *e)
	Returns the field value of an xml element which has the specified name. More...

std::string	GetKEYDefinition (std::string keyName)
	Gets the first key definition for keyName found inside buffer starting at fromPosition. More...

std::string	GetKEYDefinition (std::string keyName, size_t &Position)

std::string	GetKEYDefinition (std::string keyName, size_t &Position, std::string buffer)

std::string	GetKEYDefinition (std::string keyName, std::string buffer)

std::string	GetKEYStructure (std::string keyName)
	Gets the first key structure for keyName found inside buffer after fromPosition. More...

std::string	GetKEYStructure (std::string keyName, size_t &Position)

std::string	GetKEYStructure (std::string keyName, size_t &Position, std::string buffer)

std::string	GetKEYStructure (std::string keyName, size_t &Position, TiXmlElement *ele)

std::string	GetKEYStructure (std::string keyName, std::string buffer)

TiXmlElement *	GetNextElement (TiXmlElement *e)
	Get the next sibling xml element of this element, with same eleDeclare. More...

std::string	GetParameter (std::string parName, size_t &pos, std::string inputString)
	Returns the value for the parameter name parName found in inputString. More...

std::string	GetParameter (std::string parName, TiXmlElement *e, TString defaultValue=PARAMETER_NOT_FOUND_STR)
	Returns the value for the parameter named parName in the given section. More...

std::pair< std::string, std::string >	GetParameterAndUnits (std::string parname, TiXmlElement *e=nullptr)
	Returns the unit string of the given parameter of the given xml section. More...

std::map< std::string, std::string >	GetParametersList ()
	It retrieves a map of all parameter:value found in the metadata class. More...

TString	GetSearchPath ()

virtual void	InitFromConfigFile ()
	To make settings from rml file. This method must be implemented in the derived class. More...

virtual void	InitFromRootFile ()
	Method called after the object is retrieved from root file. More...

virtual Int_t	LoadSectionMetadata ()
	This method does some preparation of xml section. More...

void	ReadAllParameters ()
	Reflection methods, Set value of a datamember in class according to TRestMetadata::fElement. More...

void	ReadParametersList (std::map< std::string, std::string > &list)
	It reads a parameter list and associates it to its corresponding metadata member. par0 --> fPar0. More...

std::string	ReplaceConstants (const std::string buffer)
	Identifies "constants" in the input buffer, and replace them with corresponding value. More...

std::string	ReplaceVariables (const std::string buffer)
	Identifies environmental variable replacing marks in the input buffer, and replace them with corresponding value. More...

void	ReSetVersion ()
	Resets the version of TRestRun to REST_RELEASE. Only TRestRun is allowed to update version. More...

std::string	SearchFile (std::string filename)
	Search files in current directory and directories specified in "searchPath" section. More...

void	SetLibraryVersion (TString version)
	Set the library version of this metadata class. More...

TiXmlElement *	StringToElement (std::string definition)
	Parsing a string into TiXmlElement object. More...

	TRestMetadata ()
	TRestMetadata default constructor. More...

	TRestMetadata (const char *configFilename)
	constructor More...

void	UnSetVersion ()
	Resets the version of TRestRun to -1, in case the file is old REST file. Only TRestRun is allowed to update version. More...

Protected Attributes inherited from TRestMetadata
std::string	configBuffer
	The buffer where the corresponding metadata section is stored. Filled only during Write() More...

std::string	fConfigFileName
	Full name of the rml file. More...

std::map< std::string, std::string >	fConstants
	Saving a list of rml constants. name-value std::pair. Constants are temporary for this class only. More...

TiXmlElement *	fElement
	Saving the sectional element together with global element. More...

TiXmlElement *	fElementGlobal
	Saving the global element, to be passed to the resident class, if necessary. More...

Bool_t	fError = false
	It can be used as a way to identify that something went wrong using SetError method. More...

TString	fErrorMessage = ""
	A std::string to store an optional error message through method SetError. More...

TRestManager *	fHostmgr
	All metadata classes can be initialized and managed by TRestManager. More...

Int_t	fNErrors = 0
	It counts the number of errors notified. More...

Int_t	fNWarnings = 0
	It counts the number of warnings notified. More...

std::string	fSectionName
	Section name given in the constructor of the derived metadata class. More...

Bool_t	fStore
	This variable is used to determine if the metadata structure should be stored in the ROOT file. More...

std::map< std::string, std::string >	fVariables
	Saving a list of rml variables. name-value std::pair. More...

TRestStringOutput::REST_Verbose_Level	fVerboseLevel
	Verbose level used to print debug info. More...

Bool_t	fWarning = false
	It can be used as a way to identify that something went wrong using SetWarning method. More...

TString	fWarningMessage = ""
	It can be used as a way to identify that something went wrong using SetWarning method. More...

std::string	messageBuffer
	The buffer to store the output message through TRestStringOutput in this class. More...

endl_t	RESTendl
	Termination flag object for TRestStringOutput. More...

Constructor & Destructor Documentation

◆ TRestDataSetOdds() [1/2]

TRestDataSetOdds::TRestDataSetOdds ( )

Default constructor.

Definition at line 112 of file TRestDataSetOdds.cxx.

◆ TRestDataSetOdds() [2/2]

TRestDataSetOdds::TRestDataSetOdds	(	const char *	configFilename,
		std::string	name = `""`
	)

Constructor loading data from a config file.

If no configuration path is defined using TRestMetadata::SetConfigFilePath the path to the config file must be specified using full path, absolute or relative.

The default behaviour is that the config file must be specified with full path, absolute or relative.

Parameters

configFilename	A const char* that defines the RML filename.
name	The name of the metadata section. It will be used to find the corresponding TRestDataSetOdds section inside the RML.

Definition at line 128 of file TRestDataSetOdds.cxx.

◆ ~TRestDataSetOdds()

TRestDataSetOdds::~TRestDataSetOdds ( )

Default destructor.

Definition at line 139 of file TRestDataSetOdds.cxx.

Member Function Documentation

◆ AddOddsObservable()

void TRestDataSetOdds::AddOddsObservable	(	const std::string &	name,
		const TVector2 &	range,
		int	nbins
	)

Definition at line 296 of file TRestDataSetOdds.cxx.

◆ ComputeLogOdds()

void TRestDataSetOdds::ComputeLogOdds ( )

This function computes the log odds for a given dataSet. If no calibration odds file is provided it computes the PDF for the given observables. Otherwise, it takes the PDF from the input file. This function generate different observables odds_obsName and the addition of all of them for a further processing, which is stored in odds_total observable.

Definition at line 204 of file TRestDataSetOdds.cxx.

◆ GetCut()

TRestCut * TRestDataSetOdds::GetCut ( )

inline

Definition at line 69 of file TRestDataSetOdds.h.

◆ GetDataSetName()

std::string TRestDataSetOdds::GetDataSetName ( )

inline

Definition at line 67 of file TRestDataSetOdds.h.

◆ GetOddsFile()

std::string TRestDataSetOdds::GetOddsFile ( )

inline

Definition at line 66 of file TRestDataSetOdds.h.

◆ GetOddsObservables()

std::vector< std::tuple< std::string, TVector2, int > > TRestDataSetOdds::GetOddsObservables ( )

Definition at line 284 of file TRestDataSetOdds.cxx.

◆ GetOutputFileName()

std::string TRestDataSetOdds::GetOutputFileName ( )

inline

Definition at line 68 of file TRestDataSetOdds.h.

◆ InitFromConfigFile()

void TRestDataSetOdds::InitFromConfigFile ( )

overrideprivatevirtual

Function to initialize some variables from configfile.

Reimplemented from TRestMetadata.

Definition at line 151 of file TRestDataSetOdds.cxx.

◆ Initialize()

void TRestDataSetOdds::Initialize ( )

overrideprivatevirtual

Function to initialize input/output event members and define the section name.

Reimplemented from TRestMetadata.

Definition at line 145 of file TRestDataSetOdds.cxx.

◆ PrintMetadata()

void TRestDataSetOdds::PrintMetadata ( )

overridevirtual

Prints on screen the information about the metadata members of TRestDataSetOdds.

Reimplemented from TRestMetadata.

Definition at line 312 of file TRestDataSetOdds.cxx.

◆ SetCut()

void TRestDataSetOdds::SetCut ( TRestCut * cut )

inline

Definition at line 74 of file TRestDataSetOdds.h.

◆ SetDataSetName()

void TRestDataSetOdds::SetDataSetName ( const std::string & dSName )

inline

Definition at line 71 of file TRestDataSetOdds.h.

◆ SetOddsFile()

void TRestDataSetOdds::SetOddsFile ( const std::string & oddsFile )

inline

Definition at line 73 of file TRestDataSetOdds.h.

◆ SetOddsObservables()

void TRestDataSetOdds::SetOddsObservables ( const std::vector< std::tuple< std::string, TVector2, int > > & obs )

Definition at line 302 of file TRestDataSetOdds.cxx.

◆ SetOutputFileName()

void TRestDataSetOdds::SetOutputFileName ( const std::string & outName )

inline

Definition at line 72 of file TRestDataSetOdds.h.

Field Documentation

◆ fCut

TRestCut* TRestDataSetOdds::fCut = nullptr

private

Cuts over the dataset for PDF selection.

Definition at line 52 of file TRestDataSetOdds.h.

◆ fDataSetName

std::string TRestDataSetOdds::fDataSetName = ""

private

Name of the dataSet inside the config file.

Definition at line 37 of file TRestDataSetOdds.h.

◆ fHistos

std::map<std::string, TH1F*> TRestDataSetOdds::fHistos

private

Map containing the PDF of the different observables.

Definition at line 55 of file TRestDataSetOdds.h.

◆ fObsName

std::vector<std::string> TRestDataSetOdds::fObsName

private

Vector containing different obserbable names.

Definition at line 40 of file TRestDataSetOdds.h.

◆ fObsNbins

std::vector<int> TRestDataSetOdds::fObsNbins

private

Vector containing number of bins for the different observables.

Definition at line 46 of file TRestDataSetOdds.h.

◆ fObsRange

std::vector<TVector2> TRestDataSetOdds::fObsRange

private

Vector containing different obserbable ranges.

Definition at line 43 of file TRestDataSetOdds.h.

◆ fOddsFile

std::string TRestDataSetOdds::fOddsFile = ""

private

Name of the odds file to be used to get the PDF.

Definition at line 49 of file TRestDataSetOdds.h.

◆ fOutputFileName

std::string TRestDataSetOdds::fOutputFileName = ""

private

Name of the output file.

Definition at line 34 of file TRestDataSetOdds.h.

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

Detailed Description

Examples

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ TRestDataSetOdds() [1/2]

◆ TRestDataSetOdds() [2/2]

◆ ~TRestDataSetOdds()

Member Function Documentation

◆ AddOddsObservable()

◆ ComputeLogOdds()

◆ GetCut()

◆ GetDataSetName()

◆ GetOddsFile()

◆ GetOddsObservables()

◆ GetOutputFileName()

◆ InitFromConfigFile()

◆ Initialize()

◆ PrintMetadata()

◆ SetCut()

◆ SetDataSetName()

◆ SetOddsFile()

◆ SetOddsObservables()

◆ SetOutputFileName()

Field Documentation

◆ fCut

◆ fDataSetName

◆ fHistos

◆ fObsName

◆ fObsNbins

◆ fObsRange

◆ fOddsFile

◆ fOutputFileName