CMS 3D CMS Logo

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
List of all members | Public Member Functions | Private Attributes
hitfit::Chisq_Constrainer_Args Class Reference

Hold on to parameters for the Chisq_Constrainer class. More...

#include <Chisq_Constrainer.h>

Public Member Functions

const Base_Constrainer_Argsbase_constrainer_args () const
 
 Chisq_Constrainer_Args (const Defaults &defs)
 Constructor, creates an instance of Chisq_Constrainer_Args from a Defaults object. More...
 
double chisq_diff_eps () const
 
double chisq_test_eps () const
 
double constraint_sum_eps () const
 
double cutsize () const
 
unsigned max_cut () const
 
unsigned maxit () const
 
double min_tot_cutsize () const
 
bool printfit () const
 
bool use_G () const
 

Private Attributes

const Base_Constrainer_Args _base_constrainer_args
 
double _chisq_diff_eps
 
double _chisq_test_eps
 
double _constraint_sum_eps
 
double _cutsize
 
int _max_cut
 
int _maxit
 
double _min_tot_cutsize
 
bool _printfit
 
bool _use_G
 

Detailed Description

Hold on to parameters for the Chisq_Constrainer class.

Definition at line 84 of file Chisq_Constrainer.h.

Constructor & Destructor Documentation

hitfit::Chisq_Constrainer_Args::Chisq_Constrainer_Args ( const Defaults defs)

Constructor, creates an instance of Chisq_Constrainer_Args from a Defaults object.

Parameters
defsThe Defaults instance from which to instantiate. The instance must contain variables of type and name:
  • bool use_G.
  • bool printfit.
  • double constraint_sum_eps.
  • double chisq_diff_eps.
  • int maxit.
  • int max_cut.
  • double cutsize.
  • double min_tot_cutsize.
  • double chisq_test_eps.

Definition at line 61 of file Chisq_Constrainer.cc.

Member Function Documentation

const Base_Constrainer_Args & hitfit::Chisq_Constrainer_Args::base_constrainer_args ( ) const

Return the argument for the Base_Constrainer class.

Definition at line 173 of file Chisq_Constrainer.cc.

double hitfit::Chisq_Constrainer_Args::chisq_diff_eps ( ) const

Return the chisq_diff_eps parameter.

Definition at line 112 of file Chisq_Constrainer.cc.

double hitfit::Chisq_Constrainer_Args::chisq_test_eps ( ) const

Return the chisq_test_eps parameter.

Definition at line 162 of file Chisq_Constrainer.cc.

double hitfit::Chisq_Constrainer_Args::constraint_sum_eps ( ) const

Return the constraint_sum_eps parameter.

Definition at line 102 of file Chisq_Constrainer.cc.

double hitfit::Chisq_Constrainer_Args::cutsize ( ) const

Return the cutsize parameter.

Definition at line 142 of file Chisq_Constrainer.cc.

unsigned hitfit::Chisq_Constrainer_Args::max_cut ( ) const

Return the max_cut parameter.

Definition at line 132 of file Chisq_Constrainer.cc.

unsigned hitfit::Chisq_Constrainer_Args::maxit ( ) const

Return the maxit parameter.

Definition at line 122 of file Chisq_Constrainer.cc.

double hitfit::Chisq_Constrainer_Args::min_tot_cutsize ( ) const

Return the min_tot_cutsize parameter.

Definition at line 152 of file Chisq_Constrainer.cc.

bool hitfit::Chisq_Constrainer_Args::printfit ( ) const

Return the printfit parameter.

Definition at line 82 of file Chisq_Constrainer.cc.

bool hitfit::Chisq_Constrainer_Args::use_G ( ) const

Return the use_G parameter.

Definition at line 92 of file Chisq_Constrainer.cc.

Member Data Documentation

const Base_Constrainer_Args hitfit::Chisq_Constrainer_Args::_base_constrainer_args
private

Parameters for the underlying base class Base_Constrainer.

Definition at line 240 of file Chisq_Constrainer.h.

double hitfit::Chisq_Constrainer_Args::_chisq_diff_eps
private

Convergence threshold for change in $\chi^{2}$.

Definition at line 208 of file Chisq_Constrainer.h.

double hitfit::Chisq_Constrainer_Args::_chisq_test_eps
private

When use_G is true, the maximum relative difference between the $\chi^{2}$ calculations.

Definition at line 234 of file Chisq_Constrainer.h.

double hitfit::Chisq_Constrainer_Args::_constraint_sum_eps
private

Convergence threshold for sum of constraints.

Definition at line 203 of file Chisq_Constrainer.h.

double hitfit::Chisq_Constrainer_Args::_cutsize
private

Fraction by which to cut steps.

Definition at line 223 of file Chisq_Constrainer.h.

int hitfit::Chisq_Constrainer_Args::_max_cut
private

Maximum number of cut steps permitted.

Definition at line 218 of file Chisq_Constrainer.h.

int hitfit::Chisq_Constrainer_Args::_maxit
private

Maxium number of iterations permitted.

Definition at line 213 of file Chisq_Constrainer.h.

double hitfit::Chisq_Constrainer_Args::_min_tot_cutsize
private

Smallest fractional cut step permitted.

Definition at line 228 of file Chisq_Constrainer.h.

bool hitfit::Chisq_Constrainer_Args::_printfit
private

If true, print a trace of the fit to std::cout.

Definition at line 191 of file Chisq_Constrainer.h.

bool hitfit::Chisq_Constrainer_Args::_use_G
private

If true, check the $\chi^{2}$ formula by computing the $\chi^{2}$ directly from ${\bf G}$. This requires that ${\bf G}_{i}$ be invertible.

Definition at line 198 of file Chisq_Constrainer.h.