This class stores the information about what background was mixed or overlayed. More...

#include <BackgroundInfo.h>

Inheritance diagram for BackgroundInfo:

Classes
struct	BackgroundDescr
	Structure for background description. More...

Public Types
enum	EMethod { c_Unknown = 0 , c_Mixing = 1 , c_Overlay = 2 }
	enum for methods used to add BG More...

Public Member Functions
	BELLE2_DEFINE_EXCEPTION (BackgroundInfoNotMergeable, "BackgroundInfo: objects cannot be merged")
	Exception definition.

	BackgroundInfo ()
	Default constructor.

	~BackgroundInfo ()
	Destructor.

void	setMethod (EMethod method)
	Set method that is used to add BG.

unsigned	appendBackgroundDescr (const BackgroundDescr &bgDescr)
	Append background description of a sample.

void	setComponents (const std::vector< std::string > &components)
	Set components included.

void	setMinTime (double minTime)
	Set lower edge of the narrow time window.

void	setMaxTime (double maxTime)
	Set upper edge of the narrow time window.

void	setMinTimeECL (double minTimeECL)
	Set lower edge of ECL time window.

void	setMaxTimeECL (double maxTimeECL)
	Set upper edge of ECL time window.

void	setMinTimePXD (double minTimePXD)
	Set lower edge of PXD time window.

void	setMaxTimePXD (double maxTimePXD)
	Set upper edge of PXD time window.

void	setWrapAround (bool wrapAround)
	Set wrap-around flag.

void	setMaxEdepECL (double maxEdepECL)
	Set maximal alowed energy deposited in ECL to use BG events.

void	setExtensionName (const std::string &name)
	Set name that is added to default branch names of background collections Used primarily to pass this name from BGOverlayInput to BGOverlayExecutor module.

void	incrementReusedCounter (unsigned index)
	Increments sample reused counter.

EMethod	getMethod () const
	Returns method enum used to add BG.

const std::vector< BackgroundDescr > &	getBackgrounds () const
	Returns background descriptions.

const std::vector< std::string > &	getComponents () const
	Returns included components.

double	getMinTime () const
	Returns lower edge of the narrow time window.

double	getMaxTime () const
	Returns upper edge of the narrow time window.

double	getMinTimeECL () const
	Returns lower edge of ECL time window.

double	getMaxTimeECL () const
	Returns upper edge of ECL time window.

double	getMinTimePXD () const
	Returns lower edge of PXD time window.

double	getMaxTimePXD () const
	Returns upper edge of PXD time window.

bool	getWrapAround () const
	Returns wrap-around flag.

double	getMaxEdepECL () const
	Returns maximal alowed energy deposited in ECL to use BG events.

const std::string &	getExtensionName () const
	Returns name added to default branch names of background collections Used primarily to pass this name from BGOverlayInput to BGOverlayExecutor module.

virtual void	merge (const Mergeable *other) override
	Implementation of abstract class function.

virtual void	clear () override
	Implementation of abstract class function.

void	print () const
	Print the info.

virtual void	removeSideEffects ()
	An ugly little method that is called before event() for input and worker processes.

virtual Long64_t	Merge (TCollection *hlist)
	Allow merging using TFileMerger if saved directly to a file.

virtual void	Reset ()
	Root-like Reset function for "template compatibility" with ROOT objects.

virtual void	SetDirectory (TDirectory *)
	Root-like SetDirectory function for "template compatibility" with ROOT objects.

Private Member Functions
bool	canBeMerged (const BackgroundInfo *other)
	Checks if other object can be merged with this object.

void	printForMixing () const
	Print info when BG mixing is used.

void	printForOverlay () const
	Print info when BG overlay is used.

	ClassDefOverride (BackgroundInfo, 5)
	Class definition.

	ClassDef (Mergeable, 0)
	Abstract base class for objects that can be merged.

Private Attributes
EMethod	m_method = c_Unknown
	method

std::vector< BackgroundDescr >	m_backgrounds
	background descriptions

std::vector< std::string >	m_components
	detector components included

double	m_minTime = 0
	minimal time shift of background event

double	m_maxTime = 0
	maximal time shift of background event

double	m_minTimeECL = 0
	minimal time shift of background event for ECL

double	m_maxTimeECL = 0
	maximal time shift of background event for ECL

double	m_minTimePXD = 0
	minimal time shift of background event for PXD

double	m_maxTimePXD = 0
	maximal time shift of background event for PXD

bool	m_wrapAround = false
	wrap around events in the tail after maxTime

double	m_maxEdepECL = 0
	maximal allowed deposited energy in ECL

std::string	m_extensionName
	name added to default branch names of background

Detailed Description

This class stores the information about what background was mixed or overlayed.

Definition at line 26 of file BackgroundInfo.h.

Member Enumeration Documentation

◆ EMethod

enum EMethod

enum for methods used to add BG

Enumerator
c_Unknown	unknown
c_Mixing	BG mixing.
c_Overlay	BG overlay.

Definition at line 39 of file BackgroundInfo.h.

                 {c_Unknown = 0, 
                  c_Mixing  = 1, 
                  c_Overlay = 2  
                 };

Constructor & Destructor Documentation

◆ BackgroundInfo()

BackgroundInfo ( )

inline

Default constructor.

Definition at line 63 of file BackgroundInfo.h.

64 {}

◆ ~BackgroundInfo()

~BackgroundInfo ( )

inline

Destructor.

Definition at line 69 of file BackgroundInfo.h.

69{}

Member Function Documentation

◆ appendBackgroundDescr()

unsigned appendBackgroundDescr ( const BackgroundDescr & bgDescr )

inline

Append background description of a sample.

Parameters

bgDescr description

Returns: index of appended element in std::vector

Definition at line 82 of file BackgroundInfo.h.

    {
      m_backgrounds.push_back(bgDescr);
      return m_backgrounds.size() - 1;
    }

◆ canBeMerged()

bool canBeMerged ( const BackgroundInfo * other )

private

Checks if other object can be merged with this object.

Parameters

other object to be merged with this object

Returns: true, if can be merged

Definition at line 18 of file BackgroundInfo.cc.

{
 
  if (otherObj->getMethod() != m_method) {
    B2ERROR("BackgroundInfo: objects cannot be merged (different method)");
    return false;
  }
 
  std::unordered_set<int> bgThis;
  for (const auto& bg : m_backgrounds) {
    int key = bg.tag * 16 + bg.fileType;
    bgThis.emplace(key);
  }
  std::unordered_set<int> bgOther;
  for (const auto& bg : otherObj->getBackgrounds()) {
    int key = bg.tag * 16 + bg.fileType;
    bgOther.emplace(key);
  }
  if (bgOther != bgThis) {
    B2ERROR("BackgroundInfo: objects cannot be merged (different backgrounds)");
    return false;
  }
 
  auto compThis = m_components;
  std::sort(compThis.begin(), compThis.end());
  auto compOther = otherObj->getComponents();
  std::sort(compOther.begin(), compOther.end());
  if (compOther != compThis) {
    B2ERROR("BackgroundInfo: objects cannot be merged (different components)");
    return false;
  }
 
  if (otherObj->getMinTime() != m_minTime) {
    B2ERROR("BackgroundInfo: objects cannot be merged (different minTime)");
    return false;
  }
 
  if (otherObj->getMaxTime() != m_maxTime) {
    B2ERROR("BackgroundInfo: objects cannot be merged (different maxTime)");
    return false;
  }
 
  if (otherObj->getMinTimeECL() != m_minTimeECL) {
    B2ERROR("BackgroundInfo: objects cannot be merged (different minTimeECL)");
    return false;
  }
 
  if (otherObj->getMaxTimeECL() != m_maxTimeECL) {
    B2ERROR("BackgroundInfo: objects cannot be merged (different maxTimeECL)");
    return false;
  }
 
  if (otherObj->getMinTimePXD() != m_minTimePXD) {
    B2ERROR("BackgroundInfo: objects cannot be merged (different minTimePXD)");
    return false;
  }
 
  if (otherObj->getMaxTimePXD() != m_maxTimePXD) {
    B2ERROR("BackgroundInfo: objects cannot be merged (different maxTimePXD)");
    return false;
  }
 
  if (otherObj->getWrapAround() != m_wrapAround) {
    B2ERROR("BackgroundInfo: objects cannot be merged (different wrapAround)");
    return false;
  }
 
  if (otherObj->getMaxEdepECL() != m_maxEdepECL) {
    B2ERROR("BackgroundInfo: objects cannot be merged (different maxEdepECL)");
    return false;
  }
 
  return true;
}

◆ clear()

void clear ( )

overridevirtual

Implementation of abstract class function.

Implements Mergeable.

Definition at line 130 of file BackgroundInfo.cc.

{
 
  for (auto& bg : m_backgrounds) {
    bg.reused = 0;
  }
 
}

◆ getBackgrounds()

const std::vector< BackgroundDescr > & getBackgrounds ( ) const

inline

Returns background descriptions.

Returns: descriptions

Definition at line 171 of file BackgroundInfo.h.

171{return m_backgrounds;}

◆ getComponents()

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

inline

Returns included components.

Returns: vector of component names

Definition at line 177 of file BackgroundInfo.h.

177{return m_components;}

◆ getExtensionName()

const std::string & getExtensionName ( ) const

inline

Returns name added to default branch names of background collections Used primarily to pass this name from BGOverlayInput to BGOverlayExecutor module.

Returns: extension name

Definition at line 232 of file BackgroundInfo.h.

232{return m_extensionName;}

Belle2::BackgroundInfo::m_extensionName

std::string m_extensionName

name added to default branch names of background

Definition: BackgroundInfo.h:279

◆ getMaxEdepECL()

double getMaxEdepECL ( ) const

inline

Returns maximal alowed energy deposited in ECL to use BG events.

Returns: energy cut [GeV]

Definition at line 225 of file BackgroundInfo.h.

225{return m_maxEdepECL;}

◆ getMaxTime()

double getMaxTime ( ) const

inline

Returns upper edge of the narrow time window.

Returns: upper edge

Definition at line 189 of file BackgroundInfo.h.

189{return m_maxTime;}

◆ getMaxTimeECL()

double getMaxTimeECL ( ) const

inline

Returns upper edge of ECL time window.

Returns: upper edge

Definition at line 201 of file BackgroundInfo.h.

201{return m_maxTimeECL;}

◆ getMaxTimePXD()

double getMaxTimePXD ( ) const

inline

Returns upper edge of PXD time window.

Returns: upper edge

Definition at line 213 of file BackgroundInfo.h.

213{return m_maxTimePXD;}

◆ getMethod()

EMethod getMethod ( ) const

inline

Returns method enum used to add BG.

Returns: method

Definition at line 165 of file BackgroundInfo.h.

165{return m_method;}

◆ getMinTime()

double getMinTime ( ) const

inline

Returns lower edge of the narrow time window.

Returns: lower edge

Definition at line 183 of file BackgroundInfo.h.

183{return m_minTime;}

◆ getMinTimeECL()

double getMinTimeECL ( ) const

inline

Returns lower edge of ECL time window.

Returns: lower edge

Definition at line 195 of file BackgroundInfo.h.

195{return m_minTimeECL;}

◆ getMinTimePXD()

double getMinTimePXD ( ) const

inline

Returns lower edge of PXD time window.

Returns: lower edge

Definition at line 207 of file BackgroundInfo.h.

207{return m_minTimePXD;}

◆ getWrapAround()

bool getWrapAround ( ) const

inline

Returns wrap-around flag.

Returns: flag

Definition at line 219 of file BackgroundInfo.h.

219{return m_wrapAround;}

◆ incrementReusedCounter()

void incrementReusedCounter ( unsigned index )

inline

Increments sample reused counter.

Parameters

index element index in std::vector

Definition at line 156 of file BackgroundInfo.h.

    {
      if (index < m_backgrounds.size()) m_backgrounds[index].reused++;
    }

◆ merge()

void merge ( const Mergeable * other )

overridevirtual

Implementation of abstract class function.

Implements Mergeable.

Definition at line 94 of file BackgroundInfo.cc.

{
 
  auto otherObj = static_cast<const BackgroundInfo*>(other);
 
  if (otherObj->getMethod() == c_Unknown and otherObj->getBackgrounds().empty())
    return; // no merge for empty object
 
  if (m_method == c_Unknown and m_backgrounds.empty()) { // empty, replace it with other
    *this = *otherObj;
    return;
  }
 
  if (!canBeMerged(otherObj)) throw BackgroundInfoNotMergeable();
 
  for (const auto& otherBg : otherObj->getBackgrounds()) {
    bool added{false};
    for (auto& bg : m_backgrounds) {
      if (otherBg.tag != bg.tag) continue;
      if (otherBg.fileType != bg.fileType) continue;
      if (otherBg.runNumber != bg.runNumber) continue;
      if (otherBg.fileNames == bg.fileNames) {
        if (otherBg.scaleFactor != bg.scaleFactor) {
          B2ERROR("BackgroundInfo: objects cannot be merged (different scaleFactor)");
          throw BackgroundInfoNotMergeable();
        }
        bg.reused += otherBg.reused;
        added = true;
        break;
      }
    }
    if (!added) m_backgrounds.push_back(otherBg);
  }
 
}

◆ Merge()

Long64_t Merge ( TCollection * hlist )

virtualinherited

Allow merging using TFileMerger if saved directly to a file.

Note: dictionaries containing your Mergeable class need to be loaded, so 'hadd' will not work currently.

Definition at line 14 of file Mergeable.cc.

{
  Long64_t nMerged = 0;
  if (hlist) {
    const Mergeable* xh = nullptr;
    TIter nxh(hlist);
    while ((xh = dynamic_cast<Mergeable*>(nxh()))) {
      // Add xh to me
      merge(xh);
      ++nMerged;
    }
  }
  return nMerged;
}

◆ print()

void print ( ) const

Print the info.

Definition at line 140 of file BackgroundInfo.cc.

{
  switch (m_method) {
    case c_Mixing:
      cout << "Method: BG mixing" << endl;
      printForMixing();
      break;
    case c_Overlay:
      cout << "Method: BG overlay" << endl;
      printForOverlay();
      break;
    default:
      cout << "Method: unknown" << endl;
      printForMixing();
  }
}

◆ printForMixing()

void printForMixing ( ) const

private

Print info when BG mixing is used.

Definition at line 158 of file BackgroundInfo.cc.

{
  cout << "Components: ";
  if (m_components.empty()) {
    cout << "all ";
  } else {
    for (const auto& component : m_components) cout << component << " ";
  }
  cout << endl;
 
  cout << "Time window: ";
  cout << "PXD [" << m_minTimePXD << ", " << m_maxTimePXD << "] ns, ";
  cout << "ECL [" << m_minTimeECL << ", " << m_maxTimeECL << "] ns, ";
  cout << "other components [" << m_minTime << ", " << m_maxTime << "] ns";
  cout << endl;
 
  cout << "Wrapping around: ";
  if (m_wrapAround) {
    cout << "enabled";
  } else {
    cout << "disabled";
  }
  cout << endl;
 
  cout << "ECL deposited energy cut: " << m_maxEdepECL << " GeV" << endl;
 
  cout << "Samples: " << endl;
  for (const auto& bkg : m_backgrounds) {
    cout << " " << bkg.type << endl;
    cout << " equivalent time: " << bkg.realTime / 1000000 << " ms";
    cout << ", events: " << bkg.numEvents;
    cout << ", scale factor: " << bkg.scaleFactor;
    cout << ", rate: " << bkg.rate << " GHz";
    cout << ", re-used: " << bkg.reused << " times";
    cout << endl;
 
    for (const auto& fileName : bkg.fileNames) cout << " " << fileName << endl;
    cout << endl;
 
  }
 
}

◆ printForOverlay()

void printForOverlay ( ) const

private

Print info when BG overlay is used.

Definition at line 201 of file BackgroundInfo.cc.

{
  cout << "Components: ";
  if (m_components.empty()) {
    cout << "all ";
  } else {
    for (const auto& component : m_components) cout << component << " ";
  }
  cout << endl;
 
  cout << "Samples: " << endl;
  for (const auto& bkg : m_backgrounds) {
    cout << " " << bkg.type << endl;
    cout << " run number: " << bkg.runNumber << endl;
    cout << " events: " << bkg.numEvents;
    cout << ", re-used: " << bkg.reused << " times";
    cout << endl;
 
    for (const auto& fileName : bkg.fileNames) cout << " " << fileName << endl;
    cout << endl;
  }
}

◆ removeSideEffects()

virtual void removeSideEffects ( )

inlinevirtualinherited

An ugly little method that is called before event() for input and worker processes.

Main use case is to detach any attached TFile from this object. In the output process, it can stay attached (and grow as much as it likes).

Reimplemented in RootMergeable< T >.

Definition at line 58 of file Mergeable.h.

58{}

◆ Reset()

virtual void Reset ( )

inlinevirtualinherited

Root-like Reset function for "template compatibility" with ROOT objects.

Alias for clear().

Definition at line 66 of file Mergeable.h.

66{clear();}

Belle2::Mergeable::clear

virtual void clear()=0

Clear content of this object (e.g.

◆ setComponents()

void setComponents ( const std::vector< std::string > & components )

inline

Set components included.

Parameters

components vector of component names

Definition at line 92 of file BackgroundInfo.h.

    {
      m_components = components;
    }

◆ SetDirectory()

virtual void SetDirectory ( TDirectory * )

inlinevirtualinherited

Root-like SetDirectory function for "template compatibility" with ROOT objects.

Does nothing.

Definition at line 68 of file Mergeable.h.

68{}

◆ setExtensionName()

void setExtensionName ( const std::string & name )

inline

Set name that is added to default branch names of background collections Used primarily to pass this name from BGOverlayInput to BGOverlayExecutor module.

Parameters

name	extension name

Definition at line 150 of file BackgroundInfo.h.

150{m_extensionName = name;}

◆ setMaxEdepECL()

void setMaxEdepECL ( double maxEdepECL )

inline

Set maximal alowed energy deposited in ECL to use BG events.

Parameters

maxEdepECL energy cut [GeV]

Definition at line 143 of file BackgroundInfo.h.

143{m_maxEdepECL = maxEdepECL;}

◆ setMaxTime()

void setMaxTime ( double maxTime )

inline

Set upper edge of the narrow time window.

Parameters

maxTime upper edge

Definition at line 107 of file BackgroundInfo.h.

107{m_maxTime = maxTime;}

◆ setMaxTimeECL()

void setMaxTimeECL ( double maxTimeECL )

inline

Set upper edge of ECL time window.

Parameters

maxTimeECL upper edge

Definition at line 119 of file BackgroundInfo.h.

119{m_maxTimeECL = maxTimeECL;}

◆ setMaxTimePXD()

void setMaxTimePXD ( double maxTimePXD )

inline

Set upper edge of PXD time window.

Parameters

maxTimePXD upper edge

Definition at line 131 of file BackgroundInfo.h.

131{m_maxTimePXD = maxTimePXD;}

◆ setMethod()

void setMethod ( EMethod method )

inline

Set method that is used to add BG.

Parameters

method enum for method

Definition at line 75 of file BackgroundInfo.h.

75{m_method = method;}

◆ setMinTime()

void setMinTime ( double minTime )

inline

Set lower edge of the narrow time window.

Parameters

minTime lower edge

Definition at line 101 of file BackgroundInfo.h.

101{m_minTime = minTime;}

◆ setMinTimeECL()

void setMinTimeECL ( double minTimeECL )

inline

Set lower edge of ECL time window.

Parameters

minTimeECL lower edge

Definition at line 113 of file BackgroundInfo.h.

113{m_minTimeECL = minTimeECL;}

◆ setMinTimePXD()

void setMinTimePXD ( double minTimePXD )

inline

Set lower edge of PXD time window.

Parameters

minTimePXD lower edge

Definition at line 125 of file BackgroundInfo.h.

125{m_minTimePXD = minTimePXD;}

◆ setWrapAround()

void setWrapAround ( bool wrapAround )

inline

Set wrap-around flag.

Parameters

wrapAround flag

Definition at line 137 of file BackgroundInfo.h.

137{m_wrapAround = wrapAround;}

Member Data Documentation

◆ m_backgrounds

std::vector<BackgroundDescr> m_backgrounds

private

background descriptions

Definition at line 269 of file BackgroundInfo.h.

◆ m_components

std::vector<std::string> m_components

private

detector components included

Definition at line 270 of file BackgroundInfo.h.

◆ m_extensionName

std::string m_extensionName

private

name added to default branch names of background

Definition at line 279 of file BackgroundInfo.h.

◆ m_maxEdepECL

double m_maxEdepECL = 0

private

maximal allowed deposited energy in ECL

Definition at line 278 of file BackgroundInfo.h.

◆ m_maxTime

double m_maxTime = 0

private

maximal time shift of background event

Definition at line 272 of file BackgroundInfo.h.

◆ m_maxTimeECL

double m_maxTimeECL = 0

private

maximal time shift of background event for ECL

Definition at line 274 of file BackgroundInfo.h.

◆ m_maxTimePXD

double m_maxTimePXD = 0

private

maximal time shift of background event for PXD

Definition at line 276 of file BackgroundInfo.h.

◆ m_method

EMethod m_method = c_Unknown

private

method

Definition at line 268 of file BackgroundInfo.h.

◆ m_minTime

double m_minTime = 0

private

minimal time shift of background event

Definition at line 271 of file BackgroundInfo.h.

◆ m_minTimeECL

double m_minTimeECL = 0

private

minimal time shift of background event for ECL

Definition at line 273 of file BackgroundInfo.h.

◆ m_minTimePXD

double m_minTimePXD = 0

private

minimal time shift of background event for PXD

Definition at line 275 of file BackgroundInfo.h.

◆ m_wrapAround

bool m_wrapAround = false

private

wrap around events in the tail after maxTime

Definition at line 277 of file BackgroundInfo.h.

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

framework/dataobjects/include/BackgroundInfo.h
framework/dataobjects/src/BackgroundInfo.cc

Classes

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ EMethod

Constructor & Destructor Documentation

◆ BackgroundInfo()

◆ ~BackgroundInfo()

Member Function Documentation

◆ appendBackgroundDescr()

◆ canBeMerged()

◆ clear()

◆ getBackgrounds()

◆ getComponents()

◆ getExtensionName()

◆ getMaxEdepECL()

◆ getMaxTime()

◆ getMaxTimeECL()

◆ getMaxTimePXD()

◆ getMethod()

◆ getMinTime()

◆ getMinTimeECL()

◆ getMinTimePXD()

◆ getWrapAround()

◆ incrementReusedCounter()

◆ merge()

◆ Merge()

◆ print()

◆ printForMixing()

◆ printForOverlay()

◆ removeSideEffects()

◆ Reset()

◆ setComponents()

◆ SetDirectory()

◆ setExtensionName()

◆ setMaxEdepECL()

◆ setMaxTime()

◆ setMaxTimeECL()

◆ setMaxTimePXD()

◆ setMethod()

◆ setMinTime()

◆ setMinTimeECL()

◆ setMinTimePXD()

◆ setWrapAround()

Member Data Documentation

◆ m_backgrounds

◆ m_components

◆ m_extensionName

◆ m_maxEdepECL

◆ m_maxTime

◆ m_maxTimeECL

◆ m_maxTimePXD

◆ m_method

◆ m_minTime

◆ m_minTimeECL

◆ m_minTimePXD

◆ m_wrapAround