Analysis::CalibrationDataHistogramContainer Class Reference

#include <CalibrationDataContainer.h>

Inheritance diagram for Analysis::CalibrationDataHistogramContainer:
Analysis::CalibrationDataContainer Analysis::CalibrationDataMappedHistogramContainer

List of all members.

Public Member Functions

 CalibrationDataHistogramContainer (const char *name="default")
virtual CalibrationStatus getResult (const CalibrationDataVariables &x, double &result, TObject *obj=0, bool extrapolate=false) const
virtual CalibrationStatus getStatUncertainty (const CalibrationDataVariables &x, double &result) const
virtual CalibrationStatus getUncertainty (const std::string &unc, const CalibrationDataVariables &x, UncertaintyResult &result, TObject *obj=0) const
bool isBinCorrelated (const std::string &unc) const
void setUncorrelated (const std::string &unc)
void setInterpolated (bool doInterpolate)
virtual bool isInterpolated () const
virtual int getTagWeightAxis () const
virtual std::vector< double > getBinBoundaries (unsigned int vartype) const
virtual int getEigenvectorReduction (unsigned int choice) const

Protected Attributes

std::map< unsigned int,
std::vector< double > > 
m_binBoundaries

Detailed Description

This is the class holding information for histogram-based calibration results.


Member Function Documentation

std::vector< double > CalibrationDataHistogramContainer::getBinBoundaries ( unsigned int  vartype  )  const [virtual]

Retrieve the bin boundaries for the specified variable type (which should be a CalibrationParametrization enum). An empty vector will be returned if the specified variable is not actually used.

Reimplemented in Analysis::CalibrationDataMappedHistogramContainer.

int CalibrationDataHistogramContainer::getEigenvectorReduction ( unsigned int  choice  )  const [virtual]

Retrieve the number of eigenvectors to be retained for the purpose of eigenvector variation reduction strategies.

Parameters:
choice specification of the reduction option (integer corresponding to the CalibrationDataInterfaceROOT::EVReductionStrategy enum)
Returns:
number of eigenvector variations to be retained; -1 if the required information is lacking
CalibrationStatus CalibrationDataHistogramContainer::getResult ( const CalibrationDataVariables x,
double &  result,
TObject *  obj = 0,
bool  extrapolate = false 
) const [virtual]

retrieve the calibration result.

Parameters:
x user-supplied (kinematic or other) variables
result requested result
obj object holding the requested result (it will be computed if not provided)
extrapolate flag that extrapolation applies (should only be relevant when using eigenvector variations)
Returns:
status code (see above)

Implements Analysis::CalibrationDataContainer.

Reimplemented in Analysis::CalibrationDataMappedHistogramContainer.

CalibrationStatus CalibrationDataHistogramContainer::getStatUncertainty ( const CalibrationDataVariables x,
double &  result 
) const [virtual]

retrieve the calibration statistical uncertainty.

Parameters:
x user-supplied (kinematic or other) variables
result requested statistical uncertainty
Returns:
status code (see above) Note the changed signature compared to getUncertainty(), getResult() etc.: this is because the statistical uncertainty computation always needs the result object, and only in case of the function interface also the covariance matrix

Implements Analysis::CalibrationDataContainer.

Reimplemented in Analysis::CalibrationDataMappedHistogramContainer.

int CalibrationDataHistogramContainer::getTagWeightAxis (  )  const [virtual]

Test whether this calibration object is one for "continuous" calibration (this has some subtle consequences for the treatment of bin-to-bin correlations). The return value will be -1 in case this is not a "continuous" calibration object, and the axis number (0 for X, 1 for Y, 2 for Z) otherwise.

Reimplemented in Analysis::CalibrationDataMappedHistogramContainer.

CalibrationStatus CalibrationDataHistogramContainer::getUncertainty ( const std::string &  unc,
const CalibrationDataVariables x,
UncertaintyResult &  result,
TObject *  obj = 0 
) const [virtual]

retrieve the calibration uncertainty due to the given source.

Parameters:
x user-supplied (kinematic or other) variables
unc uncertainty specification
result requested uncertainty (for both positive and negative variation, if available)
obj object holding the requested uncertainty information (it will be computed if not provided)
Returns:
status code (see above)

Implements Analysis::CalibrationDataContainer.

Reimplemented in Analysis::CalibrationDataMappedHistogramContainer.

bool CalibrationDataHistogramContainer::isBinCorrelated ( const std::string &  unc  )  const

Indicate whether the given uncertainty is correlated from bin to bin or not (note that this function is to be used only for _systematic_ uncertainties)

bool CalibrationDataHistogramContainer::isInterpolated (  )  const [virtual]

Indicate whether histogram interpolation is used or not

Reimplemented in Analysis::CalibrationDataMappedHistogramContainer.

void CalibrationDataHistogramContainer::setInterpolated ( bool  doInterpolate  ) 

Indicate whether results are to be interpolated between bins or not (this feature is thought to be useful mostly for MC efficiencies)

void CalibrationDataHistogramContainer::setUncorrelated ( const std::string &  unc  ) 

Indicate that the given uncertainty is to be treated uncorrelated from bin to bin (note that the default is for all systematic uncertainties to be treated as correlated)


Member Data Documentation

std::map<unsigned int, std::vector<double> > Analysis::CalibrationDataHistogramContainer::m_binBoundaries [mutable, protected]

Cache for bin boundary information


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 1 Dec 2017 for RootCore Packages by  doxygen 1.6.1