A class describing a physics channel. More...

#include <BCMTFChannel.h>

Public Member Functions
Constructors and destructors
	BCMTFChannel (const char *name)

	~BCMTFChannel ()

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

BCMTFTemplate *	GetData ()

BCMTFTemplate *	GetTemplate (int index)

BCMTFSystematicVariation *	GetSystematicVariation (int index)

bool	GetFlagChannelActive ()

TH2D *	GetHistUncertaintyBandExpectation ()

TH2D *	GetHistUncertaintyBandPoisson ()

double	GetRangeYMin ()

double	GetRangeYMax ()

Member functions (set)
void	SetName (const char *name)

void	SetData (BCMTFTemplate *bctemplate)

void	SetHistUncertaintyBandExpectation (TH2D *hist)

void	SetHistUncertaintyBandPoisson (TH2D *hist)

void	SetFlagChannelActive (bool flag)

void	SetRangeY (double min, double max)

Member functions (miscellaneous methods)
void	AddTemplate (BCMTFTemplate *bctemplate)

void	AddSystematicVariation (BCMTFSystematicVariation *variation)

void	CalculateHistUncertaintyBandPoisson ()

TH1D *	CalculateUncertaintyBandPoisson (double minimum, double maximumm, int color)

Member functions (output methods)
void	PrintTemplates (std::string filename)

void	PrintTemplate (int index, const char *filename)

void	PrintHistUncertaintyBandExpectation (const char *filename)

void	PrintHistUncertaintyBandPoisson (const char filename, const char options="COLZ")

void	PrintHistCumulativeUncertaintyBandPoisson (const char *filename)

void	PrintUncertaintyBandPoisson (const char *filename, double minimum, double maximum, int color)

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 33 of file BCMTFChannel.h.

Constructor & Destructor Documentation

BCMTFChannel::BCMTFChannel ( const char * 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 162 of file BCMTFChannel.h.

void BCMTFChannel::AddTemplate ( BCMTFTemplate * bctemplate )

inline

Add a template.

Parameters

bctemplate The template.

Definition at line 156 of file BCMTFChannel.h.

void BCMTFChannel::CalculateHistUncertaintyBandPoisson ( )

Calculate histogram for uncertainty band calculation.

Definition at line 222 of file BCMTFChannel.cxx.

TH1D * BCMTFChannel::CalculateUncertaintyBandPoisson	(	double	minimum,
		double	maximumm,
		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 255 of file BCMTFChannel.cxx.

BCMTFTemplate* BCMTFChannel::GetData ( )

inline

Returns: The data.

Definition at line 61 of file BCMTFChannel.h.

bool BCMTFChannel::GetFlagChannelActive ( )

inline

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

Definition at line 80 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 87 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 93 of file BCMTFChannel.h.

std::string BCMTFChannel::GetName ( )

inline

Returns: The name of the channel.

Definition at line 56 of file BCMTFChannel.h.

double BCMTFChannel::GetRangeYMax ( )

inline

Returns: The maximal y-range for printing.

Definition at line 103 of file BCMTFChannel.h.

double BCMTFChannel::GetRangeYMin ( )

inline

Returns: The minimal y-range for printing.

Definition at line 98 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 75 of file BCMTFChannel.h.

BCMTFTemplate* BCMTFChannel::GetTemplate ( int index )

inline

Return a template

Parameters

index The template index.

Returns: The template.

Definition at line 68 of file BCMTFChannel.h.

void BCMTFChannel::PrintHistCumulativeUncertaintyBandPoisson ( const char * filename )

Print cumulative histogram for uncertainty band calculation.

Parameters

filename The name of the file.

Definition at line 292 of file BCMTFChannel.cxx.

void BCMTFChannel::PrintHistUncertaintyBandExpectation ( const char * filename )

Print histogram for uncertainty band calculation.

Parameters

filename The name of the file.

Definition at line 204 of file BCMTFChannel.cxx.

void BCMTFChannel::PrintHistUncertaintyBandPoisson	(	const char *	filename,
		const char *	options = `"COLZ"`
	)

Print histogram for uncertainty band calculation.

Parameters

filename The name of the file.

Definition at line 330 of file BCMTFChannel.cxx.

void BCMTFChannel::PrintTemplate	(	int	index,
		const char *	filename
	)

Print a particular template with systematics.

Parameters

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

Definition at line 136 of file BCMTFChannel.cxx.

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

Print the templates in this channel.

Parameters

filename The name of the file.

Definition at line 56 of file BCMTFChannel.cxx.

void BCMTFChannel::PrintUncertaintyBandPoisson	(	const char *	filename,
		double	minimum,
		double	maximum,
		int	color
	)

Print uncertainty band.

Parameters

filename The name of the file.

Definition at line 351 of file BCMTFChannel.cxx.

void BCMTFChannel::SetData ( BCMTFTemplate * bctemplate )

inline

Set the data set.

Parameters

bctemplate The data set.

Definition at line 119 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 138 of file BCMTFChannel.h.

void BCMTFChannel::SetHistUncertaintyBandExpectation ( TH2D * hist )

inline

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

Parameters

hist	The histogram.

Definition at line 126 of file BCMTFChannel.h.

void BCMTFChannel::SetHistUncertaintyBandPoisson ( TH2D * hist )

inline

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

Parameters

The	histogram.

Definition at line 132 of file BCMTFChannel.h.

void BCMTFChannel::SetName ( const char * name )

inline

Set the name of the channel.

Parameters

name	The name of the channel.

Definition at line 113 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 145 of file BCMTFChannel.h.

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

/home/beaujean/workspace/bat/models/mtf/BCMTFChannel.h
/home/beaujean/workspace/bat/models/mtf/BCMTFChannel.cxx

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation