RefHistObject Class Reference

Class to keep track of reference histograms with the original histograms copy (run type dependent, loaded on run start) and possible scaled copies. More...

#include <RefHistObject.h>

Public Member Functions
	RefHistObject (void)
	Constructor.
	RefHistObject (RefHistObject &&other) noexcept
	Move constructor.
RefHistObject &	operator= (RefHistObject &&other) noexcept
	Move assignment operator.
void	setRefHist (TH1 *refHist)
	set reference histogram pointer, takes ownership
void	setRefCopy (TH1 *refCopy)
	set scaled reference histogram pointer, takes ownership
TH1 *	getReference (void)
	Get reference histogram pointer the pointer is to a freshly made copy, which can be modified by the caller (scaled) without changing the original stored reference histogram.

Public Attributes
std::string	m_orghist_name
	online histogram name TODO this is not used
std::string	m_refhist_name
	reference histogram name TODO this is not used
std::unique_ptr< TH1 >	m_refHist
	Pointer to reference histogram.
std::unique_ptr< TH1 >	m_refCopy
	Pointer to scaled reference histogram.

Private Member Functions
void	makeReferenceCopy (void)
	Make a copy of the underlying reference histogram which can be used for scaling.

Detailed Description

Class to keep track of reference histograms with the original histograms copy (run type dependent, loaded on run start) and possible scaled copies.

Definition at line 23 of file RefHistObject.h.

Constructor & Destructor Documentation

RefHistObject() [1/2]

RefHistObject ( void )

inline

Constructor.

Definition at line 34 of file RefHistObject.h.

: m_orghist_name(""), m_refhist_name(""), m_refHist(nullptr), m_refCopy(nullptr) {};

RefHistObject() [2/2]

RefHistObject ( RefHistObject && other )

inlinenoexcept

Move constructor.

Definition at line 38 of file RefHistObject.h.

      : m_orghist_name(std::move(other.m_orghist_name)),
        m_refhist_name(std::move(other.m_refhist_name)),
        m_refHist(std::move(other.m_refHist)),
        m_refCopy(std::move(other.m_refCopy))
    {
      // Reset the moved-from object
      other.m_refHist = nullptr;
      other.m_refCopy = nullptr;
    }

Member Function Documentation

getReference()

TH1 * getReference

(

void

)

Get reference histogram pointer the pointer is to a freshly made copy, which can be modified by the caller (scaled) without changing the original stored reference histogram.

Ownership stays in this class.

Returns

reference histogram pointer

Definition at line 41 of file RefHistObject.cc.

{
  // make a new copy
  makeReferenceCopy();
  // now the caller can modify (e.g. scale) the copy without interference
  return m_refCopy.get();
}

makeReferenceCopy()

void makeReferenceCopy ( void )

private

Make a copy of the underlying reference histogram which can be used for scaling.

Definition at line 13 of file RefHistObject.cc.

{
  auto orgref = m_refHist.get();
  if (m_refCopy != nullptr) {
    // if it exists already (->second call), we clear it only.
    // thus the pointer is not changed!
    m_refCopy->Reset();
    m_refCopy->Add(orgref);
  } else {
    // is orgref is nullptr (not existing yet), make a copy of the original histogram
    // but, as we want to have scaling, we may need to change the type to the next larger float.
    if (orgref && (orgref->InheritsFrom("TH1C") or orgref->InheritsFrom("TH1S"))) {
      m_refCopy = std::make_unique<TH1F>();  // we want it a float for better scaling
      orgref->Copy(*m_refCopy.get());
    } else if (orgref && (orgref->InheritsFrom("TH1I") or orgref->InheritsFrom("TH1L"))) {
      m_refCopy = std::make_unique<TH1D>();  // we want it a float for better scaling
      orgref->Copy(*m_refCopy.get());
    } else {
      // keep TProfile, TH1F or TH1D
      m_refCopy = std::unique_ptr<TH1> (static_cast<TH1*>(orgref->Clone()));
    }
    m_refCopy->SetLineStyle(2);
    m_refCopy->SetLineColor(3);
    m_refCopy->SetFillColor(0);
    m_refCopy->SetStats(kFALSE);
  }
}

operator=()

RefHistObject & operator= ( RefHistObject && other )

inlinenoexcept

Move assignment operator.

Definition at line 51 of file RefHistObject.h.

    {
      if (this != &other) {
        m_orghist_name = std::move(other.m_orghist_name);
        m_refhist_name = std::move(other.m_refhist_name);
        m_refHist = std::move(other.m_refHist);
        m_refCopy = std::move(other.m_refCopy);
 
        // Reset the moved-from object
        other.m_refHist = nullptr;
        other.m_refCopy = nullptr;
      }
      return *this;
    }

setRefCopy()

void setRefCopy ( TH1 * refCopy )

inline

set scaled reference histogram pointer, takes ownership

Parameters

refCopy

scaled reference histogram pointer

Definition at line 89 of file RefHistObject.h.

    {
      m_refCopy.reset(refCopy);  // Assumes ownership of refCopy
    }

setRefHist()

void setRefHist ( TH1 * refHist )

inline

set reference histogram pointer, takes ownership

Parameters

refHist

reference histogram pointer

Definition at line 81 of file RefHistObject.h.

    {
      m_refHist.reset(refHist);  // Assumes ownership of refHist
    }

Member Data Documentation

m_orghist_name

std::string m_orghist_name

online histogram name TODO this is not used

Definition at line 25 of file RefHistObject.h.

m_refCopy

std::unique_ptr<TH1> m_refCopy

Pointer to scaled reference histogram.

Definition at line 28 of file RefHistObject.h.

m_refHist

std::unique_ptr<TH1> m_refHist

Pointer to reference histogram.

Definition at line 27 of file RefHistObject.h.

m_refhist_name

std::string m_refhist_name

reference histogram name TODO this is not used

Definition at line 26 of file RefHistObject.h.

---

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

• dqm/core/include/RefHistObject.h
• dqm/core/src/RefHistObject.cc