NTupleFCN Class Reference

#include <NTupleFCN.h>

Inheritance diagram for NTupleFCN:

[legend]Collaboration diagram for NTupleFCN:

[legend]List of all members.

Detailed Description

A derived class of StatedFCN This class gets its data points from a DataSource.

It derives from StatedFCN to access the stated model function.

Author:: Paul F. Kunz <Paul_Kunz@slac.stanford.edu>

Definition at line 33 of file NTupleFCN.h.

Public Member Functions

virtual StatedFCN * clone () const =0

Makes a copy of the derived class object.

virtual int degreesOfFreedom () const

Calculates the number of degrees of freedom.

virtual double errorDef () const

void fillFreeDerivatives (std::vector< double > &, double x)

Clears and fills the vector with the derivatives of the function a coordinate value x.

void fillFreeParameters (std::vector< double > &free_parms) const

Fills the vector with the values of the free parameters.

const std::vector< int > & getFixedFlags () const

Returns the vector of which of the model function's parameters are considered fixed and not to be changed during minimization of this objective function.

unsigned int getNumberFreeParms () const

Returns the number of free parameters.

const std::vector< double > & getParameters () const

Returns the current state of the model function's parameters.

const std::vector< std::string > & getParmNames () const

Returns the names of the model function's parameters.

bool hasFunction () const

Returns true if model function has been set, otherwise returns false.

virtual bool needsIntegrated () const =0

Returns true if data points were integrated.

NTupleFCN (const DataSource *ntuple, FunctionBase *function)

The following constructor takes a pair of iterators to the data and a pointer to the function to be fitted.

virtual double objectiveValue () const =0

Returns the value of the objective function.

virtual double operator() (const std::vector< double > &parms) const

Sets the model function parameters to parms and returns the objective value.

virtual void setDataSource (const DataSource *source, int dimension, const std::vector< int > &)

Sets the data source, dimension, and indices into the columns.

void setDataSource (const DataSource *source)

Sets the data source.

virtual void setFitCut (TupleCut *cut)

Sets the cut to limit range of fitting.

virtual void setFitRange (bool yes=true)

Sets use of a fitting range on or off.

virtual void setFixedFlags (const std::vector< int > &flags)

Sets the parameters that are to be held fixed during minimization of this objective function.

virtual void setFreeParameters (const std::vector< double > &parms)

Sets the free parameters from the vector parms.

void setFunction (FunctionBase *function)

Sets the model function.

void setParameters (const std::vector< double > &parms)

Sets the values of the model function's parameters.

virtual bool setUseErrors (bool yes=true)

Sets the use of errors on the data point.

virtual double up () const =0

Protected Member Functions

bool acceptRow (unsigned int row) const

Returns true if the DataSource row row is within the fit Range.

virtual void calcAlphaBeta (std::vector< std::vector< double > > &alpha, std::vector< double > &beta)

Calculates alpha and beta.

int getErrorColumn () const

Returns the index to the column containing error on the value coordinate.

NTupleFCN (const NTupleFCN &)

The copy constructor.

NTupleFCN ()

The default constructor.

Protected Attributes

unsigned int m_dimen

The dimension of the coordinate.

FunctionBase * m_function

A pointer to the model function to be used in fitting.

bool m_has_errors

Error use flag.

std::vector< int > m_indices

The indexes into the DataSource.

const DataSource * m_ntuple

The ntuple containing the data points for the fitter.

Private Member Functions

bool hasErrors () const

Examines state of error bars.

void reset (std::vector< std::vector< double > > &alpha, std::vector< double > &beta, unsigned int size)

Resets the matrix alpha and the vector beta.

Private Attributes

TupleCut * m_fit_cut

The cut that manages the range on X to be used for fitting.

bool m_fit_range

Set to true if the fitting range is turn on.

Constructor & Destructor Documentation

NTupleFCN::NTupleFCN ( ) [protected]

The default constructor.
The default constructor which initializes points to objects it uses to the null pointer.
Definition at line 36 of file NTupleFCN.cxx.

NTupleFCN::NTupleFCN ( const NTupleFCN & ) [protected]

The copy constructor.
The copy constructor makes a copy of the pointer to the NTuple object containing the data.
Definition at line 44 of file NTupleFCN.cxx.

NTupleFCN::NTupleFCN ( const DataSource * ntuple,

FunctionBase * function

)

The following constructor takes a pair of iterators to the data and a pointer to the function to be fitted.

Definition at line 53 of file NTupleFCN.cxx.

Member Function Documentation

bool NTupleFCN::acceptRow ( unsigned int row ) const [protected]

Returns true if the DataSource row row is within the fit Range.

Definition at line 249 of file NTupleFCN.cxx.
References m_fit_cut, m_fit_range, and m_ntuple.
Referenced by calcAlphaBeta(), NTuplePearsonFCN::objectiveValue(), NTupleLikeliHoodFCN::objectiveValue(), and NTupleChiSqFCN::objectiveValue().

void NTupleFCN::calcAlphaBeta ( std::vector< std::vector< double > > & alpha,

std::vector< double > & beta

) [protected, virtual]

Calculates alpha and beta.
Calculates the matrix alpha and the vector beta based on the data and the function values and derivatives. Resizes them if required.

Requests:
Find out what these really are and document them.
They might be the gradients.
Implements StatedFCN.
Definition at line 190 of file NTupleFCN.cxx.
References acceptRow(), StatedFCN::fillFreeDerivatives(), StatedFCN::getNumberFreeParms(), StatedFCN::m_function, StatedFCN::m_has_errors, m_indices, m_ntuple, StatedFCN::operator()(), reset(), hippodraw::Axes::X, hippodraw::Axes::Y, and hippodraw::DataPoint2DTuple::YERR.

virtual StatedFCN* StatedFCN::clone ( ) const [pure virtual, inherited]

Makes a copy of the derived class object.

Implemented in NTupleChiSqFCN, NTupleLikeliHoodFCN, and NTuplePearsonFCN.

int NTupleFCN::degreesOfFreedom ( ) const [virtual]

Calculates the number of degrees of freedom.
Calculates the number of degrees of freedom. If the data points have error measurements, then points with zero error are ignored.
See also:
operator().

Implements StatedFCN.
Definition at line 154 of file NTupleFCN.cxx.
References std::count(), getErrorColumn(), StatedFCN::getNumberFreeParms(), StatedFCN::m_has_errors, and m_ntuple.

void StatedFCN::fillFreeDerivatives ( std::vector< double > & ,

double x

) [inherited]

Clears and fills the vector with the derivatives of the function a coordinate value x.

Definition at line 149 of file StatedFCN.cxx.
References StatedFCN::getParameters(), StatedFCN::m_fixed_flags, StatedFCN::m_function, and num_util::size().
Referenced by calcAlphaBeta().

void StatedFCN::fillFreeParameters ( std::vector< double > & free_parms ) const [inherited]

Fills the vector with the values of the free parameters.

Definition at line 89 of file StatedFCN.cxx.
References StatedFCN::getParameters(), StatedFCN::m_fixed_flags, StatedFCN::m_function, and num_util::size().

int NTupleFCN::getErrorColumn ( ) const [protected]

Returns the index to the column containing error on the value coordinate.

Bug:
Should make it general, not just 1 or 2 dimensional.

Definition at line 105 of file NTupleFCN.cxx.
References m_dimen, m_indices, hippodraw::DataPoint2DTuple::YERR, and hippodraw::DataPoint3DTuple::ZERR.
Referenced by degreesOfFreedom(), and hasErrors().

const vector< int > & StatedFCN::getFixedFlags ( ) const [inherited]

Returns the vector of which of the model function's parameters are considered fixed and not to be changed during minimization of this objective function.

Definition at line 116 of file StatedFCN.cxx.
References StatedFCN::m_fixed_flags.

unsigned int StatedFCN::getNumberFreeParms ( ) const [inherited]

Returns the number of free parameters.

Definition at line 103 of file StatedFCN.cxx.
References StatedFCN::m_fixed_flags, and num_util::size().
Referenced by calcAlphaBeta(), and degreesOfFreedom().

const vector< double > & StatedFCN::getParameters ( ) const [inherited]

Returns the current state of the model function's parameters.

Definition at line 75 of file StatedFCN.cxx.
References StatedFCN::m_function.
Referenced by StatedFCN::fillFreeDerivatives(), StatedFCN::fillFreeParameters(), and StatedFCN::setFreeParameters().

const vector< string > & StatedFCN::getParmNames ( ) const [inherited]

Returns the names of the model function's parameters.

Definition at line 68 of file StatedFCN.cxx.
References StatedFCN::m_function.

bool NTupleFCN::hasErrors ( ) const [private]

Examines state of error bars.
Returns true if at least one data point in has non zero error, otherwise returns false.
Definition at line 119 of file NTupleFCN.cxx.
References std::bind2nd(), std::find_if(), getErrorColumn(), and m_ntuple.
Referenced by setUseErrors().

bool StatedFCN::hasFunction ( ) const [inherited]

Returns true if model function has been set, otherwise returns false.

Definition at line 48 of file StatedFCN.cxx.
References StatedFCN::m_function.

virtual bool StatedFCN::needsIntegrated ( ) const [pure virtual, inherited]

Returns true if data points were integrated.
Return true if the FCN function needs data points were integrated over a range. An example would be a histogram. Returns false if the integrated data points are not needed.
Implemented in NTupleChiSqFCN, NTupleLikeliHoodFCN, and NTuplePearsonFCN.

virtual double StatedFCN::objectiveValue ( ) const [pure virtual, inherited]

Returns the value of the objective function.
Returns the value of the objective function for the current state of the function. The state of the function's parameters is set by operator(). Other states the function may have is set by calling member functions of the function directly.
Implemented in NTupleChiSqFCN, NTupleLikeliHoodFCN, and NTuplePearsonFCN.
Referenced by hippodraw::Python::export_StatedFCN(), and StatedFCN::operator()().

double StatedFCN::operator() ( const std::vector< double > & parms ) const [virtual, inherited]

Sets the model function parameters to parms and returns the objective value.

Implements FCNBase.
Definition at line 165 of file StatedFCN.cxx.
References StatedFCN::m_function, StatedFCN::objectiveValue(), and StatedFCN::setParameters().
Referenced by calcAlphaBeta(), NTuplePearsonFCN::objectiveValue(), and NTupleChiSqFCN::objectiveValue().

void NTupleFCN::reset ( std::vector< std::vector< double > > & alpha,

std::vector< double > & beta,

unsigned int size

) [private]

Resets the matrix alpha and the vector beta.
Resets the matrix and vector to the appropriate size, if needed, and sets the elements to zero.
Definition at line 171 of file NTupleFCN.cxx.
Referenced by calcAlphaBeta().

void NTupleFCN::setDataSource ( const DataSource * source,

int dimension,

const std::vector< int > &

) [virtual]

Sets the data source, dimension, and indices into the columns.
Sets the data source, dimension and indices into the column. For one dimensional data source, the order of the indices are as in The hippodraw::DataPoint2DTuple enumeration. For two dimensional data source as with hippodraw::DataPoint3DTuple enumeration. For higher dimensions, the pattern should repeat. A negative index value indicates that the variable is not used.
Implements StatedFCN.
Definition at line 94 of file NTupleFCN.cxx.
References m_dimen, m_indices, and m_ntuple.

void NTupleFCN::setDataSource ( const DataSource * source ) [virtual]

Sets the data source.
Sets the data source and uses indexes for one dimensional function from hippodraw::DataPoint2DTuple.
Implements StatedFCN.
Definition at line 66 of file NTupleFCN.cxx.
References hippodraw::DataPoint2DTuple::SIZE, num_util::size(), hippodraw::Axes::X, hippodraw::DataPoint2DTuple::XERR, hippodraw::Axes::Y, hippodraw::DataPoint2DTuple::YERR, hippodraw::Axes::Z, and hippodraw::DataPoint3DTuple::ZERR.
Referenced by hippodraw::Python::export_NTupleFCN().

void NTupleFCN::setFitCut ( TupleCut * cut ) [virtual]

Sets the cut to limit range of fitting.

Bug:
Works only for one dimensional coordinate.

Implements StatedFCN.
Definition at line 232 of file NTupleFCN.cxx.
References m_fit_cut, m_indices, and hippodraw::Axes::X.

void NTupleFCN::setFitRange ( bool yes = true ) [virtual]

Sets use of a fitting range on or off.

Implements StatedFCN.
Definition at line 242 of file NTupleFCN.cxx.
References m_fit_range.

void StatedFCN::setFixedFlags ( const std::vector< int > & flags ) [virtual, inherited]

Sets the parameters that are to be held fixed during minimization of this objective function.

Definition at line 124 of file StatedFCN.cxx.
References StatedFCN::m_fixed_flags.

void StatedFCN::setFreeParameters ( const std::vector< double > & parms ) [virtual, inherited]

Sets the free parameters from the vector parms.

Definition at line 131 of file StatedFCN.cxx.
References StatedFCN::getParameters(), StatedFCN::m_fixed_flags, StatedFCN::m_function, StatedFCN::setParameters(), and num_util::size().

void StatedFCN::setFunction ( FunctionBase * function ) [inherited]

Sets the model function.
Sets the model function object to function.
Definition at line 55 of file StatedFCN.cxx.
References StatedFCN::m_fixed_flags, StatedFCN::m_function, and num_util::size().
Referenced by hippodraw::Python::export_StatedFCN(), and StatedFCN::StatedFCN().

void StatedFCN::setParameters ( const std::vector< double > & parms ) [inherited]

Sets the values of the model function's parameters.

Definition at line 82 of file StatedFCN.cxx.
References StatedFCN::m_function.
Referenced by StatedFCN::operator()(), and StatedFCN::setFreeParameters().

bool NTupleFCN::setUseErrors ( bool yes = true ) [virtual]

Sets the use of errors on the data point.
If the data points contained in the NTuple contains errors, then set the use of errors on and return true. If the data points do not contain errors, then set the use of errors off and return true. If yes is false, then always set use of errors off and return true.
Implements StatedFCN.
Definition at line 135 of file NTupleFCN.cxx.
References hasErrors(), and StatedFCN::m_has_errors.

Member Data Documentation

unsigned int NTupleFCN::m_dimen [protected]

The dimension of the coordinate.

Definition at line 70 of file NTupleFCN.h.
Referenced by getErrorColumn(), NTupleChiSqFCN::objectiveValue(), and setDataSource().

TupleCut* NTupleFCN::m_fit_cut [private]

The cut that manages the range on X to be used for fitting.

Definition at line 39 of file NTupleFCN.h.
Referenced by acceptRow(), and setFitCut().

bool NTupleFCN::m_fit_range [private]

Set to true if the fitting range is turn on.

Definition at line 43 of file NTupleFCN.h.
Referenced by acceptRow(), and setFitRange().

FunctionBase* StatedFCN::m_function [protected, inherited]

A pointer to the model function to be used in fitting.
This object does not own the function.
Definition at line 64 of file StatedFCN.h.
Referenced by calcAlphaBeta(), StatedFCN::fillFreeDerivatives(), StatedFCN::fillFreeParameters(), StatedFCN::getParameters(), StatedFCN::getParmNames(), StatedFCN::hasFunction(), NTuplePearsonFCN::objectiveValue(), NTupleLikeliHoodFCN::objectiveValue(), NTupleChiSqFCN::objectiveValue(), StatedFCN::operator()(), StatedFCN::setFreeParameters(), StatedFCN::setFunction(), and StatedFCN::setParameters().

bool StatedFCN::m_has_errors [protected, inherited]

Error use flag.
A flag set to true, if errors on measured points are to be used. When set true, only data points with non-zero errors are used. When set false, all error on data points is set to 1.0
Definition at line 71 of file StatedFCN.h.
Referenced by calcAlphaBeta(), degreesOfFreedom(), NTuplePearsonFCN::objectiveValue(), NTupleChiSqFCN::objectiveValue(), and setUseErrors().

std::vector< int > NTupleFCN::m_indices [protected]

The indexes into the DataSource.
The first set are the coordinate variables. The next to last is the value and the last is the error on the value, or -1 if no errors available. Thus the size of the vector should be at least 3 and can be more for multi-dimensional coordinates.
Definition at line 66 of file NTupleFCN.h.
Referenced by calcAlphaBeta(), getErrorColumn(), NTuplePearsonFCN::objectiveValue(), NTupleLikeliHoodFCN::objectiveValue(), NTupleChiSqFCN::objectiveValue(), setDataSource(), and setFitCut().

const DataSource* NTupleFCN::m_ntuple [protected]

The ntuple containing the data points for the fitter.

Definition at line 74 of file NTupleFCN.h.
Referenced by acceptRow(), calcAlphaBeta(), degreesOfFreedom(), hasErrors(), NTuplePearsonFCN::objectiveValue(), NTupleLikeliHoodFCN::objectiveValue(), NTupleChiSqFCN::objectiveValue(), and setDataSource().

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

Generated for HippoDraw-1.14.8.5 by

1.4.3


Public Member Functions
virtual StatedFCN *	clone () const =0
	Makes a copy of the derived class object.
virtual int	degreesOfFreedom () const
	Calculates the number of degrees of freedom.
virtual double	errorDef () const
void	fillFreeDerivatives (std::vector< double > &, double x)
	Clears and fills the vector with the derivatives of the function a coordinate value x.
void	fillFreeParameters (std::vector< double > &free_parms) const
	Fills the vector with the values of the free parameters.
const std::vector< int > &	getFixedFlags () const
	Returns the vector of which of the model function's parameters are considered fixed and not to be changed during minimization of this objective function.
unsigned int	getNumberFreeParms () const
	Returns the number of free parameters.
const std::vector< double > &	getParameters () const
	Returns the current state of the model function's parameters.
const std::vector< std::string > &	getParmNames () const
	Returns the names of the model function's parameters.
bool	hasFunction () const
	Returns `true` if model function has been set, otherwise returns `false`.
virtual bool	needsIntegrated () const =0
	Returns `true` if data points were integrated.
	NTupleFCN (const DataSource ntuple, FunctionBase function)
	The following constructor takes a pair of iterators to the data and a pointer to the function to be fitted.
virtual double	objectiveValue () const =0
	Returns the value of the objective function.
virtual double	operator() (const std::vector< double > &parms) const
	Sets the model function parameters to parms and returns the objective value.
virtual void	setDataSource (const DataSource *source, int dimension, const std::vector< int > &)
	Sets the data source, dimension, and indices into the columns.
void	setDataSource (const DataSource *source)
	Sets the data source.
virtual void	setFitCut (TupleCut *cut)
	Sets the cut to limit range of fitting.
virtual void	setFitRange (bool yes=true)
	Sets use of a fitting range on or off.
virtual void	setFixedFlags (const std::vector< int > &flags)
	Sets the parameters that are to be held fixed during minimization of this objective function.
virtual void	setFreeParameters (const std::vector< double > &parms)
	Sets the free parameters from the vector parms.
void	setFunction (FunctionBase *function)
	Sets the model function.
void	setParameters (const std::vector< double > &parms)
	Sets the values of the model function's parameters.
virtual bool	setUseErrors (bool yes=true)
	Sets the use of errors on the data point.
virtual double	up () const =0
Protected Member Functions
bool	acceptRow (unsigned int row) const
	Returns true if the DataSource row row is within the fit Range.
virtual void	calcAlphaBeta (std::vector< std::vector< double > > &alpha, std::vector< double > &beta)
	Calculates alpha and beta.
int	getErrorColumn () const
	Returns the index to the column containing error on the value coordinate.
	NTupleFCN (const NTupleFCN &)
	The copy constructor.
	NTupleFCN ()
	The default constructor.
Protected Attributes
unsigned int	m_dimen
	The dimension of the coordinate.
FunctionBase *	m_function
	A pointer to the model function to be used in fitting.
bool	m_has_errors
	Error use flag.
std::vector< int >	m_indices
	The indexes into the DataSource.
const DataSource *	m_ntuple
	The ntuple containing the data points for the fitter.
Private Member Functions
bool	hasErrors () const
	Examines state of error bars.
void	reset (std::vector< std::vector< double > > &alpha, std::vector< double > &beta, unsigned int size)
	Resets the matrix alpha and the vector beta.
Private Attributes
TupleCut *	m_fit_cut
	The cut that manages the range on X to be used for fitting.
bool	m_fit_range
	Set to `true` if the fitting range is turn on.