Class that defines the file names of various files being written across the project. More...

#include <FileNameBuilder.h>

Collaboration diagram for FileNameBuilder:

Public Member Functions
	FileNameBuilder (OptParser *arg, TString name="gammacombo")
	Constructor. More...

TString	getAsimovCombinerNameAddition (int id)
	Define the addition to combiner names for Asimov combiners. More...

TString	getBaseName ()
	Get base name, e.g. More...

TString	getCLsNameAddition ()
	Define the addition for cls plots. More...

TString	getFileBaseName (const Combiner *c)
	Compute the file base name of individual combinations. More...

TString	getFileBaseName (const MethodAbsScan *s)

TString	getFileNameAsimovPar (const Combiner *c)
	Compute the file name of the parameter file defining the Asimov point where the Asimov toy is generated at. More...

TString	getFileNameAsimovPar (const MethodAbsScan *s)

TString	getFileNamePar (const Combiner *c)
	Compute the file name of the parameter file. More...

TString	getFileNamePar (const MethodAbsScan *s)
	Compute the file name of the parameter file. More...

TString	getFileNamePlot (const vector< Combiner *> &cmb)
	Compute the file name for plots. More...

TString	getFileNamePlotSingle (const vector< Combiner *> &cmb, int cId)
	Compute the file name for plots holding a single combiner, in particular the full likelihood plots. More...

TString	getFileNameScanner (const MethodAbsScan *s)
	Compute the file name of the file to which a scanner gets saved. More...

TString	getFileNameSolution (const MethodAbsScan *s)
	Compute the file name of the file to which a solution gets saved. More...

TString	getFileNameStartPar (const Combiner *c)
	Compute the file name of the start parameter file. More...

TString	getFileNameStartPar (const MethodAbsScan *s)

TString	getPluginNameAddition ()
	Define the addition for plugin plots. More...

TString	getPluginOnlyNameAddition ()
	Define the addition for plugin-only plots. More...

TString	getPreliminaryNameAddition ()
	Define the addition for preliminary plots. More...

	~FileNameBuilder ()

Private Attributes
OptParser *	m_arg
	command line arguments More...

TString	m_asimov
	literal naming Asimov combiners More...

TString	m_basename
	the base name, e.g. "gammacombo" More...

Detailed Description

Class that defines the file names of various files being written across the project.

Definition at line 27 of file FileNameBuilder.h.

Constructor & Destructor Documentation

§ FileNameBuilder()

FileNameBuilder::FileNameBuilder	(	OptParser *	arg,
		TString	name = `"gammacombo"`
	)

Constructor.

Parameters

arg	- command line parsing object
name	- the base name, e.g. "gammacombo"

Definition at line 13 of file FileNameBuilder.cpp.

§ ~FileNameBuilder()

FileNameBuilder::~FileNameBuilder ( )

Definition at line 21 of file FileNameBuilder.cpp.

Member Function Documentation

§ getAsimovCombinerNameAddition()

TString FileNameBuilder::getAsimovCombinerNameAddition ( int id )

Define the addition to combiner names for Asimov combiners.

Definition at line 227 of file FileNameBuilder.cpp.

§ getBaseName()

TString FileNameBuilder::getBaseName ( )

Get base name, e.g.

"gammacombo". The base name is set in the constructor.

Returns: - the base name

Definition at line 30 of file FileNameBuilder.cpp.

§ getCLsNameAddition()

TString FileNameBuilder::getCLsNameAddition ( )

Define the addition for cls plots.

Definition at line 259 of file FileNameBuilder.cpp.

§ getFileBaseName() [1/2]

TString FileNameBuilder::getFileBaseName ( const Combiner * c )

Compute the file base name of individual combinations.

Format of returned filename:

basename_combinername[_+N][_-N]_var1[_var2]

Parameters

c	- Combiner object

Returns: - filename

Definition at line 43 of file FileNameBuilder.cpp.

§ getFileBaseName() [2/2]

TString FileNameBuilder::getFileBaseName ( const MethodAbsScan * s )

Definition at line 51 of file FileNameBuilder.cpp.

§ getFileNameAsimovPar() [1/2]

TString FileNameBuilder::getFileNameAsimovPar ( const Combiner * c )

Compute the file name of the parameter file defining the Asimov point where the Asimov toy is generated at.

The combiner name will be followed by the Asimov addition (getAsimovCombinerNameAddition()), but without the number denoting the Asimov point in the file, as the file contains all points. Format of returned filename:

plots/par/basename_combinernameAsimov[_+N][_-N]_var1[_var2]_genpoints.dat

Parameters

c	- Combiner object

Returns: - filename

Definition at line 89 of file FileNameBuilder.cpp.

§ getFileNameAsimovPar() [2/2]

TString FileNameBuilder::getFileNameAsimovPar ( const MethodAbsScan * s )

Definition at line 102 of file FileNameBuilder.cpp.

§ getFileNamePar() [1/2]

TString FileNameBuilder::getFileNamePar ( const Combiner * c )

Compute the file name of the parameter file.

Format of returned filename:

plots/par/basename_combinername[_+N][_-N]_var1[_var2].dat

Parameters

c	- Combiner object

Returns: - filename

Definition at line 116 of file FileNameBuilder.cpp.

§ getFileNamePar() [2/2]

TString FileNameBuilder::getFileNamePar ( const MethodAbsScan * s )

Compute the file name of the parameter file.

Format of returned filename:

plots/par/basename_combinername[_+N][_-N]_var1[_var2].dat

Parameters

s	- Scanner object

Returns: - filename

Definition at line 133 of file FileNameBuilder.cpp.

§ getFileNamePlot()

TString FileNameBuilder::getFileNamePlot ( const vector< Combiner *> & cmb )

Compute the file name for plots.

It can contain multiple combiners in the name. Format of the file name:

basename_combiner1name[_+/-N][_combiner2name[_+/-N]_var1[_var2][_pluginonly]

Returns: - the filename

Definition at line 182 of file FileNameBuilder.cpp.

§ getFileNamePlotSingle()

TString FileNameBuilder::getFileNamePlotSingle	(	const vector< Combiner *> &	cmb,
		int	cId
	)

Compute the file name for plots holding a single combiner, in particular the full likelihood plots.

Format of the file name:

basename_combinername[_+/-N]_var1[_var2][_pluginonly]

Returns: - the filename

Definition at line 212 of file FileNameBuilder.cpp.

§ getFileNameScanner()

TString FileNameBuilder::getFileNameScanner ( const MethodAbsScan * c )

Compute the file name of the file to which a scanner gets saved.

Format of returned filename:

plots/scanner/scanner_scannername[_Plugin]_var1[_var2].root

Returns: - filename

Definition at line 146 of file FileNameBuilder.cpp.

§ getFileNameSolution()

TString FileNameBuilder::getFileNameSolution ( const MethodAbsScan * c )

Compute the file name of the file to which a solution gets saved.

Format of returned filename:

plots/latex/combo_solution[_Plugin]_var1[_var2].root

Returns: - filename

Definition at line 164 of file FileNameBuilder.cpp.

§ getFileNameStartPar() [1/2]

TString FileNameBuilder::getFileNameStartPar ( const Combiner * c )

Compute the file name of the start parameter file.

Format of returned filename:

plots/par/basename_combinername[_+N][_-N]_var1[_var2]_start.dat

Parameters

c	- Combiner object

Returns: - filename

Definition at line 65 of file FileNameBuilder.cpp.

§ getFileNameStartPar() [2/2]

TString FileNameBuilder::getFileNameStartPar ( const MethodAbsScan * s )

Definition at line 72 of file FileNameBuilder.cpp.

§ getPluginNameAddition()

TString FileNameBuilder::getPluginNameAddition ( )

Define the addition for plugin plots.

Definition at line 235 of file FileNameBuilder.cpp.

§ getPluginOnlyNameAddition()

TString FileNameBuilder::getPluginOnlyNameAddition ( )

Define the addition for plugin-only plots.

Definition at line 243 of file FileNameBuilder.cpp.

§ getPreliminaryNameAddition()

TString FileNameBuilder::getPreliminaryNameAddition ( )

Define the addition for preliminary plots.

Definition at line 251 of file FileNameBuilder.cpp.

Member Data Documentation

§ m_arg

OptParser* FileNameBuilder::m_arg

private

command line arguments

Definition at line 54 of file FileNameBuilder.h.

§ m_asimov

TString FileNameBuilder::m_asimov

private

literal naming Asimov combiners

Definition at line 56 of file FileNameBuilder.h.

§ m_basename

TString FileNameBuilder::m_basename

private

the base name, e.g. "gammacombo"

Definition at line 55 of file FileNameBuilder.h.

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

/Users/matt/Scratch/lhcb/CombinationCode/gammacombo/core/include/FileNameBuilder.h
/Users/matt/Scratch/lhcb/CombinationCode/gammacombo/core/src/FileNameBuilder.cpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

§ FileNameBuilder()

§ ~FileNameBuilder()

Member Function Documentation

§ getAsimovCombinerNameAddition()

§ getBaseName()

§ getCLsNameAddition()

§ getFileBaseName() [1/2]

§ getFileBaseName() [2/2]

§ getFileNameAsimovPar() [1/2]

§ getFileNameAsimovPar() [2/2]

§ getFileNamePar() [1/2]

§ getFileNamePar() [2/2]

§ getFileNamePlot()

§ getFileNamePlotSingle()

§ getFileNameScanner()

§ getFileNameSolution()

§ getFileNameStartPar() [1/2]

§ getFileNameStartPar() [2/2]

§ getPluginNameAddition()

§ getPluginOnlyNameAddition()

§ getPreliminaryNameAddition()

Member Data Documentation

§ m_arg

§ m_asimov

§ m_basename