A class describing a physics channel. More...

#include <BCMTFChannel.h>

Public Member Functions
Constructors and destructors
	BCMTFChannel (const std::string &name)
	The default constructor. More...

	~BCMTFChannel ()
	The default destructor. More...

Member functions (get)
const std::string &	GetName () const

const std::string &	GetSafeName () const

BCMTFTemplate *	GetData ()

BCMTFTemplate *	GetTemplate (int index)
	Return a template. More...

BCMTFSystematicVariation *	GetSystematicVariation (int index)
	Return a systematic variation. More...

bool	GetFlagChannelActive ()

TH2D *	GetHistUncertaintyBandExpectation ()
	Return a histogram ued for the calculation of the error band of the expectation. More...

TH2D *	GetHistUncertaintyBandPoisson ()
	Return a histogram used for the calculation of the Poisson fluctuations. More...

double	GetRangeYMin ()

double	GetRangeYMax ()

Member functions (set)
void	SetName (const std::string &name)
	Set the name of the channel. More...

void	SetData (BCMTFTemplate *bctemplate)
	Set the data set. More...

void	SetHistUncertaintyBandExpectation (TH2D *hist)
	Set a histogram ued for the calculation of the error band of the expectation. More...

void	SetHistUncertaintyBandPoisson (TH2D *hist)
	Set a histogram used for the calculation of the Poisson fluctuations. More...

void	SetFlagChannelActive (bool flag)
	Set flag to define if the channel is active or not. More...

void	SetRangeY (double min, double max)
	Set the y-ranges for printing. More...

Member functions (miscellaneous methods)
void	AddTemplate (BCMTFTemplate *bctemplate)
	Add a template. More...

void	AddSystematicVariation (BCMTFSystematicVariation *variation)
	Add a systematic variation. More...

void	CalculateHistUncertaintyBandPoisson ()
	Calculate histogram for uncertainty band calculation. More...

TH1D *	CalculateUncertaintyBandPoisson (double minimum, double maximum, int color)
	Calculate histogram for uncertainty band calculation and return a TH1D. More...

Member functions (output methods)
void	PrintTemplates (const std::string &filename)
	Print the templates in this channel. More...

void	PrintTemplate (int index, const std::string &filename)
	Print a particular template with systematics. More...

void	PrintHistUncertaintyBandExpectation (const std::string &filename)
	Print histogram for uncertainty band calculation. More...

void	PrintHistUncertaintyBandPoisson (const std::string &filename, const std::string &options="COLZ")
	Print histogram for uncertainty band calculation. More...

void	PrintHistCumulativeUncertaintyBandPoisson (const std::string &filename)
	Print cumulative histogram for uncertainty band calculation. More...

void	PrintUncertaintyBandPoisson (const std::string &filename, double minimum, double maximum, int color)
	Print uncertainty band. More...

Detailed Description

A class describing a physics channel.

Author: Daniel Kollar; Kevin Kröninger

Version: 1.1

Date: 06.2012

This class describes a physics channel.

Definition at line 36 of file BCMTFChannel.h.

Constructor & Destructor Documentation

BCMTFChannel::BCMTFChannel ( const std::string & name )

The default constructor.

Parameters

name	The name of the channel.

Definition at line 25 of file BCMTFChannel.cxx.

BCMTFChannel::~BCMTFChannel ( )

The default destructor.

Definition at line 35 of file BCMTFChannel.cxx.

Member Function Documentation

void BCMTFChannel::AddSystematicVariation ( BCMTFSystematicVariation * variation )

inline

Add a systematic variation.

Parameters

variation The variation.

Definition at line 174 of file BCMTFChannel.h.

void BCMTFChannel::AddTemplate ( BCMTFTemplate * bctemplate )

inline

Add a template.

Parameters

bctemplate The template.

Definition at line 168 of file BCMTFChannel.h.

void BCMTFChannel::CalculateHistUncertaintyBandPoisson ( )

Calculate histogram for uncertainty band calculation.

Definition at line 224 of file BCMTFChannel.cxx.

TH1D * BCMTFChannel::CalculateUncertaintyBandPoisson	(	double	minimum,
		double	maximum,
		int	color
	)

Calculate histogram for uncertainty band calculation and return a TH1D.

Parameters

minimum	The minimum value on the expectation.
maximum	The maximum value on the expectation.
color	The color scheme.

Returns: A TH1D histogram.

Definition at line 257 of file BCMTFChannel.cxx.

BCMTFTemplate* BCMTFChannel::GetData ( )

inline

Returns: The data.

Definition at line 69 of file BCMTFChannel.h.

bool BCMTFChannel::GetFlagChannelActive ( )

inline

Returns: Flag defining if the channel is active or not.

Definition at line 88 of file BCMTFChannel.h.

TH2D* BCMTFChannel::GetHistUncertaintyBandExpectation ( )

inline

Return a histogram ued for the calculation of the error band of the expectation.

Returns: The histogram.

Definition at line 95 of file BCMTFChannel.h.

TH2D* BCMTFChannel::GetHistUncertaintyBandPoisson ( )

inline

Return a histogram used for the calculation of the Poisson fluctuations.

Returns: The histogram.

Definition at line 101 of file BCMTFChannel.h.

const std::string& BCMTFChannel::GetName ( ) const

inline

Returns: The name of the channel.

Definition at line 59 of file BCMTFChannel.h.

double BCMTFChannel::GetRangeYMax ( )

inline

Returns: The maximal y-range for printing.

Definition at line 111 of file BCMTFChannel.h.

double BCMTFChannel::GetRangeYMin ( )

inline

Returns: The minimal y-range for printing.

Definition at line 106 of file BCMTFChannel.h.

const std::string& BCMTFChannel::GetSafeName ( ) const

inline

Returns: The name of the channel.

Definition at line 64 of file BCMTFChannel.h.

BCMTFSystematicVariation* BCMTFChannel::GetSystematicVariation ( int index )

inline

Return a systematic variation.

Parameters

index The systematic index.

Returns: The systematic variation.

Definition at line 83 of file BCMTFChannel.h.

BCMTFTemplate* BCMTFChannel::GetTemplate ( int index )

inline

Return a template.

Parameters

index The template index.

Returns: The template.

Definition at line 76 of file BCMTFChannel.h.

void BCMTFChannel::PrintHistCumulativeUncertaintyBandPoisson ( const std::string & filename )

Print cumulative histogram for uncertainty band calculation.

Parameters

filename The name of the file.

Definition at line 298 of file BCMTFChannel.cxx.

void BCMTFChannel::PrintHistUncertaintyBandExpectation ( const std::string & filename )

Print histogram for uncertainty band calculation.

Parameters

filename The name of the file.

Definition at line 206 of file BCMTFChannel.cxx.

void BCMTFChannel::PrintHistUncertaintyBandPoisson	(	const std::string &	filename,
		const std::string &	options = `"COLZ"`
	)

Print histogram for uncertainty band calculation.

Parameters

filename	The name of the file.
options	Options used when plotting the histogram.

Definition at line 336 of file BCMTFChannel.cxx.

void BCMTFChannel::PrintTemplate	(	int	index,
		const std::string &	filename
	)

Print a particular template with systematics.

Parameters

index	The template index.
filename	The name of the file.

Definition at line 138 of file BCMTFChannel.cxx.

void BCMTFChannel::PrintTemplates ( const std::string & filename )

Print the templates in this channel.

Parameters

filename The name of the file.

Definition at line 59 of file BCMTFChannel.cxx.

void BCMTFChannel::PrintUncertaintyBandPoisson	(	const std::string &	filename,
		double	minimum,
		double	maximum,
		int	color
	)

Print uncertainty band.

Parameters

filename	The name of the file.
minimum	The minimum value on the expectation.
maximum	The maximum value on the expectation.
color	The color scheme.

Definition at line 357 of file BCMTFChannel.cxx.

void BCMTFChannel::SetData ( BCMTFTemplate * bctemplate )

inline

Set the data set.

Parameters

bctemplate The data set.

Definition at line 127 of file BCMTFChannel.h.

void BCMTFChannel::SetFlagChannelActive ( bool flag )

inline

Set flag to define if the channel is active or not.

Parameters

flag The flag.

Definition at line 147 of file BCMTFChannel.h.

void BCMTFChannel::SetHistUncertaintyBandExpectation ( TH2D * hist )

Set a histogram ued for the calculation of the error band of the expectation.

Parameters

hist	The histogram.

Definition at line 50 of file BCMTFChannel.cxx.

void BCMTFChannel::SetHistUncertaintyBandPoisson ( TH2D * hist )

inline

Set a histogram used for the calculation of the Poisson fluctuations.

Parameters

hist	The histogram.

Definition at line 139 of file BCMTFChannel.h.

void BCMTFChannel::SetName ( const std::string & name )

inline

Set the name of the channel.

Parameters

name	The name of the channel.

Definition at line 121 of file BCMTFChannel.h.

void BCMTFChannel::SetRangeY	(	double	min,
		double	max
	)

inline

Set the y-ranges for printing.

Parameters

min	The minimum range.
max	The maximum range.

Definition at line 154 of file BCMTFChannel.h.

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

/root/bat/models/mtf/BCMTFChannel.h
/root/bat/models/mtf/BCMTFChannel.cxx

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation