#include <PdfBase.h>

Inheritance diagram for GooFit::PdfBase:

Public Types
enum	Specials { ForceSeparateNorm = 1, ForceCommonNorm = 2 }

Public Member Functions
template<typename... Args>
	PdfBase (std::string n, Args... args)

virtual	~PdfBase ()=default

virtual __host__ double	calculateNLL () const =0

virtual __host__ fptype	normalize () const =0

__host__ void	initializeIndices (std::vector< unsigned int > pindices)

__host__ void	addSpecialMask (int m)

__host__ void	copyParams (const std::vector< double > &pars) const

__host__ void	copyParams ()

__host__ void	copyNormFactors () const

__host__ void	generateNormRange ()

__host__ std::string	getName () const

virtual __host__ std::vector< Observable >	getObservables () const

virtual __host__ std::vector< Variable >	getParameters () const

__host__ Variable *	getParameterByName (std::string n)

__host__ int	getSpecialMask () const

__host__ void	setData (DataSet *data)

__host__ DataSet *	getData ()

virtual __host__ void	setFitControl (std::shared_ptr< FitControl >)=0

virtual __host__ bool	hasAnalyticIntegral () const

__host__ ROOT::Minuit2::FunctionMinimum	fitTo (DataSet *data, int verbosity=3)
	RooFit style fitting shortcut. More...

__host__ unsigned int	getFunctionIndex () const

__host__ unsigned int	getParameterIndex () const

__host__ unsigned int	registerParameter (Variable var)

__host__ unsigned int	registerConstants (unsigned int amount)

virtual __host__ void	recursiveSetNormalisation (fptype norm=1) const

__host__ void	unregisterParameter (Variable var)

__host__ void	registerObservable (Observable obs)

__host__ void	setIntegrationFineness (int i)

__host__ void	printProfileInfo (bool topLevel=true)

__host__ bool	parametersChanged () const

__host__ void	checkInitStatus (std::vector< std::string > &unInited) const

void	clearCurrentFit ()

__host__ void	SigGenSetIndices ()

Protected Member Functions
void	setNumPerTask (PdfBase *p, const int &c)
	This needs to be set before a call to setData. More...

Protected Attributes
DataSet *	data_ = nullptr

fptype	numEvents {0}

unsigned int	numEntries {0}

fptype *	normRanges

unsigned int	parameters {0}

unsigned int	cIndex {1}

std::vector< Observable >	observables

std::vector< Variable >	parameterList

std::shared_ptr< FitControl >	fitControl

std::vector< PdfBase * >	components

int	integrationBins {-1}

int	specialMask {0}

bool	properlyInitialised {true}

unsigned int	functionIdx {0}

int	m_iEventsPerTask {0}

Detailed Description

Definition at line 69 of file PdfBase.h.

Member Enumeration Documentation

◆ Specials

enum GooFit::PdfBase::Specials

Enumerator
ForceSeparateNorm
ForceCommonNorm

Definition at line 82 of file PdfBase.h.

82 { ForceSeparateNorm = 1, ForceCommonNorm = 2 };

GooFit::PdfBase::ForceSeparateNorm

Definition: PdfBase.h:82

GooFit::PdfBase::ForceCommonNorm

Definition: PdfBase.h:82

Constructor & Destructor Documentation

◆ PdfBase()

template<typename... Args>

GooFit::PdfBase::PdfBase	(	std::string	n,
		Args...	args
	)

inlineexplicit

Definition at line 72 of file PdfBase.h.

         : name(std::move(n)) {
         std::vector<Observable> obs;
         filter_arguments(obs, args...);
         for(auto &ob : obs)
             registerObservable(ob);
     }

◆ ~PdfBase()

virtual GooFit::PdfBase::~PdfBase ( )

virtualdefault

Member Function Documentation

◆ addSpecialMask()

__host__ void GooFit::PdfBase::addSpecialMask ( int m )

inline

Definition at line 88 of file PdfBase.h.

Referenced by makeBackground3DalitzParam(), makeBackground4DalitzParam(), makeBkg2DalitzPdf(), makeBkg3DalitzPdf(), makeBkg4DalitzPdf(), makeOverallSignal(), and runToyFit().

88 { specialMask |= m; }

GooFit::PdfBase::specialMask

int specialMask

Definition: PdfBase.h:139

◆ calculateNLL()

virtual __host__ double GooFit::PdfBase::calculateNLL ( ) const

pure virtual

Implemented in GooFit::GooPdf.

Referenced by GooFit::Minuit1::Eval(), and GooFit::FCN::operator()().

◆ checkInitStatus()

__host__ void GooFit::PdfBase::checkInitStatus ( std::vector< std::string > & unInited ) const

Definition at line 37 of file PdfBase.cpp.

References components, getName(), and properlyInitialised.

                                                                            {
     if(!properlyInitialised)
         unInited.push_back(getName());
 
     for(auto component : components) {
         component->checkInitStatus(unInited);
     }
 }

◆ clearCurrentFit()

void GooFit::PdfBase::clearCurrentFit ( )

◆ copyNormFactors()

__host__ void GooFit::PdfBase::copyNormFactors ( ) const

◆ copyParams() [1/2]

__host__ void GooFit::PdfBase::copyParams ( const std::vector< double > & pars ) const

Referenced by GooFit::Minuit1::Eval(), GooFit::Params::from_minuit_vector(), and GooFit::Minuit1::Minuit1().

◆ copyParams() [2/2]

__host__ void GooFit::PdfBase::copyParams ( )

◆ fitTo()

__host__ ROOT::Minuit2::FunctionMinimum GooFit::PdfBase::fitTo	(	DataSet *	data,
		int	verbosity = `3`
	)

RooFit style fitting shortcut.

Definition at line 159 of file PdfBase.cpp.

References setData(), and GooFit::FitManagerMinuit2::setVerbosity().

                                                                                {
     setData(data);
     FitManager fitter{this};
     fitter.setVerbosity(verbosity);
     return fitter.fit();
 }

◆ generateNormRange()

__host__ void GooFit::PdfBase::generateNormRange ( )

Referenced by setIntegrationFineness().

◆ getData()

__host__ DataSet* GooFit::PdfBase::getData ( )

Referenced by GooFit::fillDataSetMC1D().

◆ getFunctionIndex()

__host__ unsigned int GooFit::PdfBase::getFunctionIndex ( ) const

inline

Definition at line 110 of file PdfBase.h.

110 { return functionIdx; }

GooFit::PdfBase::functionIdx

unsigned int functionIdx

Definition: PdfBase.h:142

◆ getName()

__host__ std::string GooFit::PdfBase::getName ( ) const

inline

Definition at line 93 of file PdfBase.h.

Referenced by GooFit::abort(), checkInitStatus(), GooFit::SpinFactor::operator==(), GooFit::Lineshape::operator==(), registerObservable(), registerParameter(), and unregisterParameter().

93 { return name; }

◆ getObservables()

__host__ std::vector< Observable > GooFit::PdfBase::getObservables ( ) const

virtual

Definition at line 111 of file PdfBase.cpp.

References components, and observables.

Referenced by makeDalitzPlots().

                                                              {
     std::vector<Observable> ret;
     for(const Observable &obs : observables)
         ret.push_back(obs);
 
     for(const PdfBase *comp : components) {
         for(const Observable &sub_comp : comp->getObservables())
             if(!find_in(ret, sub_comp))
                 ret.push_back(sub_comp);
     }
 
     return ret;
 }

◆ getParameterByName()

__host__ Variable * GooFit::PdfBase::getParameterByName ( std::string n )

Definition at line 95 of file PdfBase.cpp.

References components, and parameterList.

Referenced by runCanonicalFit().

                                                           {
     for(Variable &p : parameterList) {
         if(p.getName() == n)
             return &p;
     }
 
     for(auto component : components) {
         Variable *cand = component->getParameterByName(n);
 
         if(cand != nullptr)
             return cand;
     }
 
     return nullptr;
 }

◆ getParameterIndex()

__host__ unsigned int GooFit::PdfBase::getParameterIndex ( ) const

inline

Definition at line 111 of file PdfBase.h.

111 { return parameters; }

GooFit::PdfBase::parameters

unsigned int parameters

Definition: PdfBase.h:132

◆ getParameters()

__host__ std::vector< Variable > GooFit::PdfBase::getParameters ( ) const

virtual

Definition at line 81 of file PdfBase.cpp.

References components, and parameterList.

Referenced by GooFit::abort(), GooFit::Params::Params(), GooFit::readFromFile(), and GooFit::writeToFile().

                                                           {
     std::vector<Variable> ret;
     for(const Variable &param : parameterList)
         ret.push_back(param);
 
     for(const PdfBase *comp : components) {
         for(const Variable &sub_comp : comp->getParameters())
             if(!find_in(ret, sub_comp))
                 ret.push_back(sub_comp);
     }
 
     return ret;
 }

◆ getSpecialMask()

__host__ int GooFit::PdfBase::getSpecialMask ( ) const

inline

Definition at line 99 of file PdfBase.h.

References data, and getData().

99 { return specialMask; }

GooFit::PdfBase::specialMask

int specialMask

Definition: PdfBase.h:139

◆ hasAnalyticIntegral()

virtual __host__ bool GooFit::PdfBase::hasAnalyticIntegral ( ) const

inlinevirtual

Reimplemented in GooFit::GooPdf, GooFit::ExpPdf, GooFit::EventWeightedAddPdf, GooFit::AddPdf, GooFit::ArgusPdf, GooFit::GaussianPdf, GooFit::JohnsonSUPdf, GooFit::StepPdf, GooFit::ProdPdf, GooFit::KinLimitBWPdf, and GooFit::ScaledGaussianPdf.

Definition at line 105 of file PdfBase.h.

105 { return false; }

◆ initializeIndices()

__host__ void GooFit::PdfBase::initializeIndices ( std::vector< unsigned int > pindices )

◆ normalize()

virtual __host__ fptype GooFit::PdfBase::normalize ( ) const

pure virtual

Implemented in GooFit::TddpPdf, GooFit::GooPdf, GooFit::DPPdf, GooFit::TDDP4, GooFit::DalitzPlotPdf, GooFit::IncoherentSumPdf, GooFit::CompositePdf, GooFit::SmoothHistogramPdf, GooFit::EventWeightedAddPdf, GooFit::ConvolutionPdf, GooFit::AddPdf, GooFit::MappedPdf, and GooFit::ProdPdf.

◆ parametersChanged()

__host__ bool GooFit::PdfBase::parametersChanged ( ) const

Definition at line 147 of file PdfBase.cpp.

References GooFit::Variable::getChanged(), and parameterList.

                                                {
     return std::any_of(
         std::begin(parameterList), std::end(parameterList), [](const Variable &v) { return v.getChanged(); });
 }

◆ printProfileInfo()

__host__ void GooFit::PdfBase::printProfileInfo ( bool topLevel = true )

Referenced by runCanonicalFit().

◆ recursiveSetNormalisation()

__host__ void GooFit::PdfBase::recursiveSetNormalisation ( fptype norm = 1 ) const

virtual

Definition at line 46 of file PdfBase.cpp.

References components, and parameters.

                                                                   {
     host_normalisation[parameters] = norm;
 
     for(auto component : components) {
         component->recursiveSetNormalisation(norm);
     }
 }

◆ registerConstants()

__host__ unsigned int GooFit::PdfBase::registerConstants ( unsigned int amount )

Definition at line 125 of file PdfBase.cpp.

References cIndex, GooFit::maxParams, and GooFit::totalConstants.

                                                                     {
     if(totalConstants + amount >= maxParams)
         throw GooFit::GeneralError(
             "totalConstants {} + amount {} can not be more than {}", totalConstants, amount, maxParams);
     cIndex = totalConstants;
     totalConstants += amount;
     return cIndex;
 }

◆ registerObservable()

void GooFit::PdfBase::registerObservable ( Observable obs )

Definition at line 134 of file PdfBase.cpp.

References GooFit::Indexable::getName(), getName(), GOOFIT_DEBUG, and observables.

                                                {
     if(find_in(observables, obs))
         return;
 
     GOOFIT_DEBUG("{}: Registering o:{} for {}", getName(), observables.size(), obs.getName());
     observables.push_back(obs);
 }

◆ registerParameter()

__host__ unsigned int GooFit::PdfBase::registerParameter ( Variable var )

Definition at line 54 of file PdfBase.cpp.

References GooFit::Indexable::getIndex(), GooFit::Indexable::getName(), getName(), GOOFIT_DEBUG, parameterList, and GooFit::Indexable::setIndex().

                                                              {
     static int unique_param = 0;
 
     if(find_in(parameterList, var))
         return static_cast<unsigned int>(var.getIndex());
 
     if(var.getIndex() < 0) {
         GOOFIT_DEBUG("{}: Registering p:{} for {}", getName(), unique_param, var.getName());
         var.setIndex(unique_param++);
     }
 
     parameterList.push_back(var);
     return static_cast<unsigned int>(var.getIndex());
 }

◆ setData()

__host__ void GooFit::PdfBase::setData ( DataSet * data )

Referenced by GooFit::fillDataSetMC1D(), fitAndPlot(), fitRatio(), fitTo(), main(), make1BinSigmaMap(), make4BinSigmaMap(), makeDalitzPlots(), makeOverallSignal(), makeSigmaMap(), makeToyDalitzPlots(), runBackgroundDalitzFit(), runBackgroundSigmaFit(), runCanonicalFit(), runEfficiencyFit(), runGeneratedMCFit(), runSigmaFit(), runToyFit(), and runTruthMCFit().

◆ setFitControl()

virtual __host__ void GooFit::PdfBase::setFitControl ( std::shared_ptr< FitControl > )

pure virtual

Implemented in GooFit::GooPdf.

◆ setIntegrationFineness()

__host__ void GooFit::PdfBase::setIntegrationFineness ( int i )

Definition at line 142 of file PdfBase.cpp.

References generateNormRange(), and integrationBins.

                                                    {
     integrationBins = i;
     generateNormRange();
 }

◆ setNumPerTask()

__host__ void GooFit::PdfBase::setNumPerTask	(	PdfBase *	p,
		const int &	c
	)

protected

This needs to be set before a call to setData.

Definition at line 152 of file PdfBase.cpp.

References m_iEventsPerTask.

                                                              {
     if(p == nullptr)
         return;
 
     m_iEventsPerTask = c;
 }

◆ SigGenSetIndices()

__host__ void GooFit::PdfBase::SigGenSetIndices ( )

inline

Definition at line 124 of file PdfBase.h.

124 { setIndices(); }

◆ unregisterParameter()

__host__ void GooFit::PdfBase::unregisterParameter ( Variable var )

Definition at line 69 of file PdfBase.cpp.

References components, GooFit::Indexable::getName(), getName(), GOOFIT_DEBUG, and GooFit::Indexable::setIndex().

                                                        {
     GOOFIT_DEBUG("{}: Removing {}", getName(), var.getName());
 
     for(PdfBase *comp : components) {
         comp->unregisterParameter(var);
     }
 
     var.setIndex(-1);
     // Once copies are used, this might able to be unregistred from a lower PDF only
     // For now, it gets completely cleared.
 }

Member Data Documentation

◆ cIndex

unsigned int GooFit::PdfBase::cIndex {1}

protected

Definition at line 133 of file PdfBase.h.

Referenced by registerConstants().

◆ components

std::vector<PdfBase *> GooFit::PdfBase::components

protected

Definition at line 137 of file PdfBase.h.

Referenced by checkInitStatus(), getObservables(), getParameterByName(), getParameters(), recursiveSetNormalisation(), and unregisterParameter().

◆ data_

DataSet* GooFit::PdfBase::data_ = nullptr

protected

Definition at line 127 of file PdfBase.h.

◆ fitControl

std::shared_ptr<FitControl> GooFit::PdfBase::fitControl

protected

Definition at line 136 of file PdfBase.h.

◆ functionIdx

unsigned int GooFit::PdfBase::functionIdx {0}

protected

Definition at line 142 of file PdfBase.h.

◆ integrationBins

int GooFit::PdfBase::integrationBins {-1}

protected

Definition at line 138 of file PdfBase.h.

Referenced by setIntegrationFineness().

◆ m_iEventsPerTask

int GooFit::PdfBase::m_iEventsPerTask {0}

protected

Definition at line 144 of file PdfBase.h.

Referenced by setNumPerTask().

◆ normRanges

fptype* GooFit::PdfBase::normRanges

protected

Initial value:

{

nullptr}

Definition at line 130 of file PdfBase.h.

◆ numEntries

unsigned int GooFit::PdfBase::numEntries {0}

protected

Definition at line 129 of file PdfBase.h.

◆ numEvents

fptype GooFit::PdfBase::numEvents {0}

protected

Definition at line 128 of file PdfBase.h.

Referenced by GooFit::DPPdf::setGenerationOffset(), and GooFit::TDDP4::setMaxWeight().

◆ observables

std::vector<Observable> GooFit::PdfBase::observables

protected

Definition at line 134 of file PdfBase.h.

Referenced by getObservables(), and registerObservable().

◆ parameterList

std::vector<Variable> GooFit::PdfBase::parameterList

protected

Definition at line 135 of file PdfBase.h.

Referenced by getParameterByName(), getParameters(), parametersChanged(), and registerParameter().

◆ parameters

unsigned int GooFit::PdfBase::parameters {0}

protected

Definition at line 132 of file PdfBase.h.

Referenced by GooFit::ExpPdf::hasAnalyticIntegral(), recursiveSetNormalisation(), and GooFit::ResonancePdf::setConstantIndex().

◆ properlyInitialised

bool GooFit::PdfBase::properlyInitialised {true}

protected

Definition at line 140 of file PdfBase.h.

Referenced by checkInitStatus().

◆ specialMask

int GooFit::PdfBase::specialMask {0}

protected

Definition at line 139 of file PdfBase.h.

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

/home/travis/build/GooFit/GooFit/include/goofit/PdfBase.h
/home/travis/build/GooFit/GooFit/src/goofit/PdfBase.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ Specials

Constructor & Destructor Documentation

◆ PdfBase()

◆ ~PdfBase()

Member Function Documentation

◆ addSpecialMask()

◆ calculateNLL()

◆ checkInitStatus()

◆ clearCurrentFit()

◆ copyNormFactors()

◆ copyParams() [1/2]

◆ copyParams() [2/2]

◆ fitTo()

◆ generateNormRange()

◆ getData()

◆ getFunctionIndex()

◆ getName()

◆ getObservables()

◆ getParameterByName()

◆ getParameterIndex()

◆ getParameters()

◆ getSpecialMask()

◆ hasAnalyticIntegral()

◆ initializeIndices()

◆ normalize()

◆ parametersChanged()

◆ printProfileInfo()

◆ recursiveSetNormalisation()

◆ registerConstants()

◆ registerObservable()

◆ registerParameter()

◆ setData()

◆ setFitControl()

◆ setIntegrationFineness()

◆ setNumPerTask()

◆ SigGenSetIndices()

◆ unregisterParameter()

Member Data Documentation

◆ cIndex

◆ components

◆ data_

◆ fitControl

◆ functionIdx

◆ integrationBins

◆ m_iEventsPerTask

◆ normRanges

◆ numEntries

◆ numEvents

◆ observables

◆ parameterList

◆ parameters

◆ properlyInitialised

◆ specialMask