Logo ROOT  
Reference Guide
Loading...
Searching...
No Matches
RooStats::HistFactory::Channel Class Reference

This class encapsulates all information for the statistical interpretation of one experiment.

It can be combined with other channels (e.g. for the combination of multiple experiments, or to constrain nuisance parameters with information obtained in a control region). A channel contains one or more samples which describe the contribution from different processes to this measurement.

Definition at line 575 of file Measurement.h.

Public Member Functions

 Channel ()=default
 Channel (std::string Name, std::string InputFile="")
void AddAdditionalData (const RooStats::HistFactory::Data &data)
 add additional data object
void AddSample (RooStats::HistFactory::Sample sample)
bool CheckHistograms () const
void CollectHistograms ()
std::vector< RooStats::HistFactory::Data > & GetAdditionalData ()
 retrieve vector of additional data objects
RooStats::HistFactory::DataGetData ()
 get data object
const RooStats::HistFactory::DataGetData () const
std::string GetHistoPath () const
 get path to histograms in input file
std::string GetInputFile () const
 get name of input file
std::string GetName () const
 get name of channel
std::vector< RooStats::HistFactory::Sample > & GetSamples ()
 get vector of samples for this channel
const std::vector< RooStats::HistFactory::Sample > & GetSamples () const
HistFactory::StatErrorConfigGetStatErrorConfig ()
 get information about threshold for statistical uncertainties and constraint term
const HistFactory::StatErrorConfigGetStatErrorConfig () const
void Print (std::ostream &=std::cout)
void PrintXML (std::string const &directory, std::string const &prefix="") const
void SetData (const RooStats::HistFactory::Data &data)
 set data object
void SetData (double Val)
void SetData (std::string HistoName, std::string InputFile, std::string HistoPath="")
void SetData (TH1 *hData)
void SetHistoPath (const std::string &file)
 set path for histograms in input file
void SetInputFile (const std::string &file)
 set name of input file containing histograms
void SetName (const std::string &Name)
 set name of channel
void SetStatErrorConfig (double RelErrorThreshold, Constraint::Type ConstraintType)
void SetStatErrorConfig (double RelErrorThreshold, std::string ConstraintType)
void SetStatErrorConfig (RooStats::HistFactory::StatErrorConfig Config)
 define treatment of statistical uncertainties

Protected Member Functions

TH1GetHistogram (std::string InputFile, std::string HistoPath, std::string HistoName, std::map< std::string, std::unique_ptr< TFile > > &lsof)
 Open a file and copy a histogram.

Protected Attributes

std::vector< RooStats::HistFactory::DatafAdditionalData
 One can add additional datasets These are simply added to the xml under a different name.
HistFactory::Data fData
std::string fHistoPath
std::string fInputFile
std::string fName
std::vector< RooStats::HistFactory::SamplefSamples
HistFactory::StatErrorConfig fStatErrorConfig

Friends

class Measurement

#include <RooStats/HistFactory/Measurement.h>

Constructor & Destructor Documentation

◆ Channel() [1/2]

RooStats::HistFactory::Channel::Channel ( )
default

◆ Channel() [2/2]

RooStats::HistFactory::Channel::Channel ( std::string Name,
std::string InputFile = "" )

Definition at line 903 of file Measurement.cxx.

Member Function Documentation

◆ AddAdditionalData()

void RooStats::HistFactory::Channel::AddAdditionalData ( const RooStats::HistFactory::Data & data)
inline

add additional data object

Definition at line 606 of file Measurement.h.

◆ AddSample()

void RooStats::HistFactory::Channel::AddSample ( RooStats::HistFactory::Sample sample)

Definition at line 912 of file Measurement.cxx.

◆ CheckHistograms()

bool RooStats::HistFactory::Channel::CheckHistograms ( ) const

Definition at line 1121 of file Measurement.cxx.

◆ CollectHistograms()

void RooStats::HistFactory::Channel::CollectHistograms ( )

Definition at line 1046 of file Measurement.cxx.

◆ GetAdditionalData()

std::vector< RooStats::HistFactory::Data > & RooStats::HistFactory::Channel::GetAdditionalData ( )
inline

retrieve vector of additional data objects

Definition at line 608 of file Measurement.h.

◆ GetData() [1/2]

RooStats::HistFactory::Data & RooStats::HistFactory::Channel::GetData ( )
inline

get data object

Definition at line 602 of file Measurement.h.

◆ GetData() [2/2]

const RooStats::HistFactory::Data & RooStats::HistFactory::Channel::GetData ( ) const
inline

Definition at line 603 of file Measurement.h.

◆ GetHistogram()

TH1 * RooStats::HistFactory::Channel::GetHistogram ( std::string InputFile,
std::string HistoPath,
std::string HistoName,
std::map< std::string, std::unique_ptr< TFile > > & lsof )
protected

Open a file and copy a histogram.

Parameters
InputFileFile where the histogram resides.
HistoPathPath of the histogram in the file.
HistoNameName of the histogram to retrieve.
lsofList of open files. Helps to prevent opening and closing a file hundreds of times.

Definition at line 1223 of file Measurement.cxx.

◆ GetHistoPath()

std::string RooStats::HistFactory::Channel::GetHistoPath ( ) const
inline

get path to histograms in input file

Definition at line 594 of file Measurement.h.

◆ GetInputFile()

std::string RooStats::HistFactory::Channel::GetInputFile ( ) const
inline

get name of input file

Definition at line 590 of file Measurement.h.

◆ GetName()

std::string RooStats::HistFactory::Channel::GetName ( ) const
inline

get name of channel

Definition at line 586 of file Measurement.h.

◆ GetSamples() [1/2]

std::vector< RooStats::HistFactory::Sample > & RooStats::HistFactory::Channel::GetSamples ( )
inline

get vector of samples for this channel

Definition at line 620 of file Measurement.h.

◆ GetSamples() [2/2]

const std::vector< RooStats::HistFactory::Sample > & RooStats::HistFactory::Channel::GetSamples ( ) const
inline

Definition at line 621 of file Measurement.h.

◆ GetStatErrorConfig() [1/2]

HistFactory::StatErrorConfig & RooStats::HistFactory::Channel::GetStatErrorConfig ( )
inline

get information about threshold for statistical uncertainties and constraint term

Definition at line 615 of file Measurement.h.

◆ GetStatErrorConfig() [2/2]

const HistFactory::StatErrorConfig & RooStats::HistFactory::Channel::GetStatErrorConfig ( ) const
inline

Definition at line 616 of file Measurement.h.

◆ Print()

void RooStats::HistFactory::Channel::Print ( std::ostream & stream = std::cout)

Definition at line 920 of file Measurement.cxx.

◆ PrintXML()

void RooStats::HistFactory::Channel::PrintXML ( std::string const & directory,
std::string const & prefix = "" ) const

Definition at line 943 of file Measurement.cxx.

◆ SetData() [1/4]

void RooStats::HistFactory::Channel::SetData ( const RooStats::HistFactory::Data & data)
inline

set data object

Definition at line 597 of file Measurement.h.

◆ SetData() [2/4]

void RooStats::HistFactory::Channel::SetData ( double Val)

Definition at line 1013 of file Measurement.cxx.

◆ SetData() [3/4]

void RooStats::HistFactory::Channel::SetData ( std::string HistoName,
std::string InputFile,
std::string HistoPath = "" )

Definition at line 997 of file Measurement.cxx.

◆ SetData() [4/4]

void RooStats::HistFactory::Channel::SetData ( TH1 * hData)

Definition at line 1007 of file Measurement.cxx.

◆ SetHistoPath()

void RooStats::HistFactory::Channel::SetHistoPath ( const std::string & file)
inline

set path for histograms in input file

Definition at line 592 of file Measurement.h.

◆ SetInputFile()

void RooStats::HistFactory::Channel::SetInputFile ( const std::string & file)
inline

set name of input file containing histograms

Definition at line 588 of file Measurement.h.

◆ SetName()

void RooStats::HistFactory::Channel::SetName ( const std::string & Name)
inline

set name of channel

Definition at line 584 of file Measurement.h.

◆ SetStatErrorConfig() [1/3]

void RooStats::HistFactory::Channel::SetStatErrorConfig ( double RelErrorThreshold,
Constraint::Type ConstraintType )

Definition at line 1032 of file Measurement.cxx.

◆ SetStatErrorConfig() [2/3]

void RooStats::HistFactory::Channel::SetStatErrorConfig ( double RelErrorThreshold,
std::string ConstraintType )

Definition at line 1039 of file Measurement.cxx.

◆ SetStatErrorConfig() [3/3]

void RooStats::HistFactory::Channel::SetStatErrorConfig ( RooStats::HistFactory::StatErrorConfig Config)
inline

define treatment of statistical uncertainties

Definition at line 613 of file Measurement.h.

◆ Measurement

friend class Measurement
friend

Definition at line 578 of file Measurement.h.

Member Data Documentation

◆ fAdditionalData

std::vector<RooStats::HistFactory::Data> RooStats::HistFactory::Channel::fAdditionalData
protected

One can add additional datasets These are simply added to the xml under a different name.

Definition at line 638 of file Measurement.h.

◆ fData

HistFactory::Data RooStats::HistFactory::Channel::fData
protected

Definition at line 634 of file Measurement.h.

◆ fHistoPath

std::string RooStats::HistFactory::Channel::fHistoPath
protected

Definition at line 632 of file Measurement.h.

◆ fInputFile

std::string RooStats::HistFactory::Channel::fInputFile
protected

Definition at line 631 of file Measurement.h.

◆ fName

std::string RooStats::HistFactory::Channel::fName
protected

Definition at line 630 of file Measurement.h.

◆ fSamples

std::vector<RooStats::HistFactory::Sample> RooStats::HistFactory::Channel::fSamples
protected

Definition at line 642 of file Measurement.h.

◆ fStatErrorConfig

HistFactory::StatErrorConfig RooStats::HistFactory::Channel::fStatErrorConfig
protected

Definition at line 640 of file Measurement.h.


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