A class for creating a RooFit-based task process for simultaneous/combined fits. More...

#include <LauRooFitTask.hh>

Inheritance diagram for LauRooFitTask:

Public Member Functions
	LauRooFitTask (RooAbsPdf &model, const Bool_t extended, const RooArgSet &vars, const TString &weightVarName="")
	Constructor.

virtual	~LauRooFitTask ()
	Destructor.

virtual void	initialise ()
	Initialise the fit model.

virtual void	setParsFromMinuit (Double_t *par, Int_t npar)
	This function sets the parameter values from Minuit. More...

virtual Double_t	getTotNegLogLikelihood ()
	Calculates the total negative log-likelihood.

Public Member Functions inherited from LauSimFitTask
	LauSimFitTask ()
	Constructor.

virtual	~LauSimFitTask ()
	Destructor.

UInt_t	nTasks () const
	Obtain the number of tasks.

UInt_t	taskId () const
	Obtain the ID number of this task.

virtual void	runTask (const TString &dataFileName, const TString &dataTreeName, const TString &histFileName, const TString &tableFileName="", const TString &addressCoordinator="localhost", const UInt_t portCoordinator=9090)
	Start the task process for simultaneous fitting. More...

Public Member Functions inherited from LauFitObject
virtual	~LauFitObject ()=default
	Destructor.

void	useAsymmFitErrors (Bool_t useAsymmErrors)
	Turn on or off the computation of asymmetric errors (e.g. MINOS routine in Minuit) More...

Bool_t	useAsymmFitErrors () const
	Report whether or not calculation of asymmetric errors is enabled.

void	twoStageFit (Bool_t doTwoStageFit)
	Turn on or off the two stage fit. More...

Bool_t	twoStageFit () const
	Report whether the two-stage fit is enabled.

virtual void	withinAsymErrorCalc (const Bool_t inAsymErrCalc)
	Mark that the fit is calculating asymmetric errors. More...

Bool_t	withinAsymErrorCalc () const
	Query whether the fit is calculating the asymmetric errors. More...

void	setNExpts (UInt_t nExperiments, UInt_t firstExperiment, Bool_t toyExpts)
	Set the number of experiments, the first experiment, and whether this is toy. More...

UInt_t	eventsPerExpt () const
	Obtain the total number of events in the current experiment.

UInt_t	nExpt () const
	Obtain the number of experiments.

UInt_t	firstExpt () const
	Obtain the number of the first experiment.

UInt_t	iExpt () const
	Obtain the number of the current experiment.

Bool_t	toyExpts () const
	Obtain whether this is toy.

void	addConstraint (const TString &formula, const std::vector< TString > &pars, const Double_t mean, const Double_t width)
	Store constraint information for fit parameters. More...

void	addFormulaConstraint (const TString &formula, const std::vector< TString > &pars, const Double_t mean, const Double_t width)
	Store constraint information for fit parameters. More...

void	addMultiDimConstraint (const std::vector< TString > &pars, const TVectorD &means, const TMatrixD &covMat)
	Store n-dimensional constraint information for fit parameters. More...

Protected Member Functions
virtual void	prepareInitialParArray (TObjArray &array)
	Package the initial fit parameters for transmission to the coordinator. More...

LauParameter *	convertToLauParameter (const RooRealVar *rooParameter) const
	Convert a RooRealVar into a LauParameter. More...

std::vector< std::pair< RooRealVar , LauParameter > >	convertToLauParameters (const RooFormulaVar *rooFormula) const
	Convert a RooFormulaVar into LauParameters. More...

virtual void	finaliseExperiment (const LauAbsFitter::FitStatus &fitStat, const TObjArray parsFromCoordinator, const TMatrixD covMat, TObjArray &parsToCoordinator)
	Perform all finalisation actions. More...

virtual Bool_t	verifyFitData (const TString &dataFileName, const TString &dataTreeName)
	Open the input file and verify that all required variables are present. More...

virtual UInt_t	readExperimentData ()
	Read in the data for the current experiment. More...

virtual void	cacheInputFitVars ()
	Cache the input data values to calculate the likelihood during the fit.

Protected Member Functions inherited from LauSimFitTask
const LauFitNtuple *	fitNtuple () const
	Const access to the fit ntuple.

LauFitNtuple *	fitNtuple ()
	Access to the fit ntuple.

void	connectToCoordinator (const TString &addressCoordinator, const UInt_t portCoordinator)
	Establish the connection to the coordinator process. More...

void	processCoordinatorRequests ()
	Listen for requests from the coordinator and act accordingly.

virtual void	setupResultsOutputs (const TString &histFileName, const TString &tableFileName)
	Setup saving of fit results to ntuple/LaTeX table etc. More...

virtual void	writeOutAllFitResults ()
	Write out any fit results.

Protected Member Functions inherited from LauFitObject
	LauFitObject ()
	Constructor.

Bool_t	checkRepetition (const std::vector< TString > &names, const ConstraintType conType)
	Check if parameters names for constraints have already been used elsewhere. More...

void	generateConstraintMeans (std::vector< LauAbsRValue * > &conVars)
	Generate per-experiment mean for each Gaussian constraint. More...

const std::vector< FormulaConstraint > &	formulaConstraints () const
	Const access to the formula constraints store.

std::vector< FormulaConstraint > &	formulaConstraints ()
	Access to the formula constraints store.

const std::vector< MultiDimConstraint > &	multiDimConstraints () const
	Const access to the ND constraints store.

std::vector< MultiDimConstraint > &	multiDimConstraints ()
	Access to the ND constraints store.

const std::set< TString > &	formulaConstrainedPars () const
	Const access to the parameter names used in formula constraints.

std::set< TString > &	formulaConstrainedPars ()
	Access to the parameter names used in formula constraints.

const std::set< TString > &	multiDimConstrainedPars () const
	Const access to the parameter names used in ND constraints.

std::set< TString > &	multiDimConstrainedPars ()
	Access to the parameter names used in ND constraints.

void	resetFitCounters ()
	Reset the good/bad fit counters.

void	setCurrentExperiment (const UInt_t curExpt)
	Set the ID of the current experiment. More...

void	startNewFit (const UInt_t nPars, const UInt_t nFreePars)
	Indicate the start of a new fit. More...

void	eventsPerExpt (UInt_t nEvents)
	Set the number of events in the current experiment.

Double_t	worstLogLike () const
	Access the worst log likelihood found so far.

void	worstLogLike (const Double_t newWorstLogLike)
	Set a new value for the worst log likelihood. More...

void	storeFitStatus (const LauAbsFitter::FitStatus &status, const TMatrixD &covMatrix)
	Store fit status information. More...

UInt_t	nTotParams () const
	Access the total number of fit parameters.

UInt_t	nFreeParams () const
	Access the total number of fit parameters.

const LauAbsFitter::FitStatus &	fitStatus () const
	Access the fit status information.

Double_t	nll () const
	Access the current NLL value.

Double_t	edm () const
	Access the current EDM value.

Int_t	statusCode () const
	Access the fit status code.

const TMatrixD &	covarianceMatrix () const
	Access the fit covariance matrix.

UInt_t	numberOKFits () const
	Access the number of successful fits.

UInt_t	numberBadFits () const
	Access the number of failed fits.

Private Member Functions
void	cleanData ()
	Cleanup the data.

	LauRooFitTask (const LauRooFitTask &rhs)
	Copy constructor (not implemented)

LauRooFitTask &	operator= (const LauRooFitTask &rhs)
	Copy assignment operator (not implemented)

Private Attributes
RooAbsPdf &	model_
	The model.

RooArgSet	dataVars_
	The dataset variables.

TString	weightVarName_
	The name of the (optional) weight variable in the dataset.

TFile *	dataFile_
	The data file.

TTree *	dataTree_
	The data tree.

RooAbsData *	exptData_
	The data for the current experiment.

const Bool_t	extended_
	Is the PDF extended?

std::set< UInt_t >	iExptSet_
	The experiment category variable.

RooNLLVar *	nllVar_
	The NLL variable.

std::vector< RooRealVar * >	fitVars_
	The fit parameters (as RooRealVar's)

std::vector< LauParameter * >	fitPars_
	The fit parameters (as LauParameter's)

Additional Inherited Members
Protected Types inherited from LauFitObject
enum	ConstraintType { ConstraintType::Formula, ConstraintType::MultDim }
	Enumeration of the different types of constraint. More...

Detailed Description

A class for creating a RooFit-based task process for simultaneous/combined fits.

Implementation of the JFit method described in arXiv:1409.5080 [physics.data-an].

Definition at line 57 of file LauRooFitTask.hh.

Member Function Documentation

◆ convertToLauParameter()

LauParameter * LauRooFitTask::convertToLauParameter ( const RooRealVar * rooParameter ) const

protected

Convert a RooRealVar into a LauParameter.

Parameters

[in] rooParameter the RooRealVar to be converted

Returns: the newly created LauParameter

Definition at line 240 of file LauRooFitTask.cc.

◆ convertToLauParameters()

std::vector< std::pair< RooRealVar *, LauParameter * > > LauRooFitTask::convertToLauParameters ( const RooFormulaVar * rooFormula ) const

protected

Convert a RooFormulaVar into LauParameters.

Parameters

[in] rooFormula the RooFormulaVar to be converted

Returns: the vector of pointers to the RooRealVars and newly created LauParameters

Definition at line 249 of file LauRooFitTask.cc.

◆ finaliseExperiment()

void LauRooFitTask::finaliseExperiment	(	const LauAbsFitter::FitStatus &	fitStat,
		const TObjArray *	parsFromCoordinator,
		const TMatrixD *	covMat,
		TObjArray &	parsToCoordinator
	)

protectedvirtual

Perform all finalisation actions.

Receive the results of the fit from the coordinator
Perform any finalisation routines
Package the finalised fit parameters for transmission back to the coordinator

Parameters

[in]	fitStat	the status of the fit, e.g. status code, EDM, NLL
[in]	parsFromCoordinator	the parameters at the fit minimum
[in]	covMat	the fit covariance matrix
[out]	parsToCoordinator	the array to be filled with the finalised LauParameter objects

Implements LauSimFitTask.

Definition at line 384 of file LauRooFitTask.cc.

◆ prepareInitialParArray()

void LauRooFitTask::prepareInitialParArray ( TObjArray & array )

protectedvirtual

Package the initial fit parameters for transmission to the coordinator.

Parameters

[out] array the array to be filled with the LauParameter objects

Implements LauSimFitTask.

Definition at line 168 of file LauRooFitTask.cc.

◆ readExperimentData()

UInt_t LauRooFitTask::readExperimentData ( )

protectedvirtual

Read in the data for the current experiment.

Returns: the number of events read in

Implements LauSimFitTask.

Definition at line 333 of file LauRooFitTask.cc.

◆ setParsFromMinuit()

void LauRooFitTask::setParsFromMinuit	(	Double_t *	par,
		Int_t	npar
	)

virtual

This function sets the parameter values from Minuit.

Parameters

[in]	par	an array storing the various parameter values
[in]	npar	the number of free parameters

Implements LauSimFitTask.

Definition at line 300 of file LauRooFitTask.cc.

◆ verifyFitData()

Bool_t LauRooFitTask::verifyFitData	(	const TString &	dataFileName,
		const TString &	dataTreeName
	)

protectedvirtual

Open the input file and verify that all required variables are present.

Parameters

[in]	dataFileName	the name of the input file
[in]	dataTreeName	the name of the input tree

Implements LauSimFitTask.

Definition at line 107 of file LauRooFitTask.cc.

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

/home/epp/phsdba/Development/Laura++/master-dev/laura/inc/LauRooFitTask.hh
/home/epp/phsdba/Development/Laura++/master-dev/laura/src/LauRooFitTask.cc

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ convertToLauParameter()

◆ convertToLauParameters()

◆ finaliseExperiment()

◆ prepareInitialParArray()

◆ readExperimentData()

◆ setParsFromMinuit()

◆ verifyFitData()