AlgorithmCalibration< T, CO > Class Template Reference

#include <AlgorithmCalibration.h>

Inheritance diagram for AlgorithmCalibration< T, CO >:

Public Types
typedef XERCES_CPP_NAMESPACE::DOMElement	DOMElement
typedef XERCES_CPP_NAMESPACE::DOMNode	DOMNode

Public Member Functions
	AlgorithmCalibration (const std::string &fileName)
void	saveCalibration (const std::string &fileName)
void	startCalibration ()
void	updateCalibration (const typename T::Input &calibrationInput)
template<class CI >
void	updateCalibration (const typename T::Input &calibrationInputForCategory, const CI &inputForCalibration)
	~AlgorithmCalibration ()
Public Member Functions inherited from CalibrationInterface< T, CO >
int	addCategoryDefinition (const T &categoryDefinition)
int	addEntry (const T &categoryDefinition, const CO &data)
	CalibrationInterface ()
const std::vector< std::pair< T, CO > > &	categoriesWithData () const
CO *	getCalibData (const typename T ::Input &calibrationInput)
const CO *	getCalibData (const typename T ::Input &calibrationInput) const
CO *	getCalibData (int index)
const CO *	getCalibData (int index) const
const T *	getCategoryDefinition (int index) const
int	getIndex (const typename T ::Input &calibrationInput) const
void	setCalibData (int index, const CO &data)
int	size () const
	~CalibrationInterface ()

Protected Member Functions
DOMElement *	dom ()
bool	readCategories ()
CO *	readObject (DOMNode *)

Private Attributes
std::string	m_filename
CalibrationXML *	m_xml

Detailed Description

template<class T, class CO>
class AlgorithmCalibration< T, CO >

The AlgorithmCalibration class is the interface between user code and calibration framework developed for BReco subsytem. Both the analysis programs and the calibration programs should only access calibration information via that class.

An algorithm is supposed to keep a single instance of that class to avoid the reload of XML for every event (during analysis) and because you want to accumulate over all events the data to perform a new calibration in the calibration program.

The class is templated on the Category T and on the CalibratedObject CO

Definition at line 38 of file AlgorithmCalibration.h.

Member Typedef Documentation

DOMElement

template<class T , class CO >

typedef XERCES_CPP_NAMESPACE::DOMElement AlgorithmCalibration< T, CO >::DOMElement

Definition at line 41 of file AlgorithmCalibration.h.

DOMNode

template<class T , class CO >

typedef XERCES_CPP_NAMESPACE::DOMNode AlgorithmCalibration< T, CO >::DOMNode

Definition at line 42 of file AlgorithmCalibration.h.

Constructor & Destructor Documentation

AlgorithmCalibration()

template<class T , class CO >

AlgorithmCalibration< T, CO >::AlgorithmCalibration

(

const std::string &

fileName

)

Create an AlgorithmCalibration class and load from fileName the cateogries and their objects.

Definition at line 88 of file AlgorithmCalibration.h.

                                                                           : m_filename(filename), m_xml(nullptr) {
  readCategories();
  if (m_xml) {
    m_xml->closeFile();
  }
}

References CalibrationXML::closeFile(), AlgorithmCalibration< T, CO >::m_xml, and AlgorithmCalibration< T, CO >::readCategories().

~AlgorithmCalibration()

template<class T , class CO >

AlgorithmCalibration< T, CO >::~AlgorithmCalibration

(

)

Definition at line 96 of file AlgorithmCalibration.h.

                                                   {
  if (m_xml)
    delete m_xml;
}

Member Function Documentation

dom()

template<class T , class CO >

DOMElement* AlgorithmCalibration< T, CO >::dom ( )

inlineprotected

Definition at line 74 of file AlgorithmCalibration.h.

                    {
    if (m_xml == nullptr) {
      m_xml = new CalibrationXML();
      m_xml->openFile(m_filename);
    }
    return m_xml->calibrationDOM();
  }

References CalibrationXML::calibrationDOM(), AlgorithmCalibration< T, CO >::m_filename, AlgorithmCalibration< T, CO >::m_xml, and CalibrationXML::openFile().

readCategories()

template<class T , class CO >

bool AlgorithmCalibration< T, CO >::readCategories ( )

protected

Definition at line 102 of file AlgorithmCalibration.h.

                                                 {
  if (dom() == nullptr)
    return false;
 
  DOMNode *n1 = dom()->getFirstChild();
  while (n1) {
    if (n1->getNodeType() == DOMNode::ELEMENT_NODE) {
      T *cat = new T();
      cat->readFromDOM((DOMElement *)n1);
      CO *obj = readObject(n1->getFirstChild());
      if (obj) {
        this->addEntry(*cat, *obj);
        delete obj;
      }
      delete cat;
    }
    n1 = n1->getNextSibling();
  }
 
  return true;
}

References eostools::cat(), contentValuesFiles::dom, and getGTfromDQMFile::obj.

Referenced by AlgorithmCalibration< T, CO >::AlgorithmCalibration().

readObject()

template<class T , class CO >

CO * AlgorithmCalibration< T, CO >::readObject ( DOMNode *  dom )

protected

Definition at line 124 of file AlgorithmCalibration.h.

                                                        {
  DOMNode *n1 = dom;
  while (n1) {
    if (n1->getNodeType() == DOMNode::ELEMENT_NODE)
      break;
    n1 = n1->getNextSibling();
  }
 
  if (n1 == nullptr)
    return nullptr;  //Cannot find any calibrated objects
 
  CO *co = new CO();
  co->read((DOMElement *)n1);
  return co;
}

References cms::cuda::co, and contentValuesFiles::dom.

saveCalibration()

template<class T , class CO >

void AlgorithmCalibration< T, CO >::saveCalibration

(

const std::string &

fileName

)

Finalize and save the calibration run to fileName

startCalibration()

template<class T , class CO >

void AlgorithmCalibration< T, CO >::startCalibration

(

)

Prepare for a new calibration run

updateCalibration() [1/2]

template<class T , class CO >

void AlgorithmCalibration< T, CO >::updateCalibration

(

const typename T::Input &

calibrationInput

)

Accumulate information to calibrate.

updateCalibration() [2/2]

template<class T , class CO >

template<class CI >

void AlgorithmCalibration< T, CO >::updateCalibration	(	const typename T::Input &	calibrationInputForCategory,
		const CI &	inputForCalibration
	)

Member Data Documentation

m_filename

template<class T , class CO >

std::string AlgorithmCalibration< T, CO >::m_filename

private

Definition at line 83 of file AlgorithmCalibration.h.

Referenced by AlgorithmCalibration< T, CO >::dom().

m_xml

template<class T , class CO >

CalibrationXML* AlgorithmCalibration< T, CO >::m_xml

private

Definition at line 84 of file AlgorithmCalibration.h.

Referenced by AlgorithmCalibration< T, CO >::AlgorithmCalibration(), and AlgorithmCalibration< T, CO >::dom().