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

#include <BackgroundInfo.h>

Inheritance diagram for BackgroundInfo:

Collaboration diagram for BackgroundInfo:

[legend]

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. More...

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

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

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

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

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

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

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

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

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

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

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. More...

void	incrementReusedCounter (unsigned index)
	Increments sample reused counter. More...

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

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

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

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

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

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

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

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

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

bool	getWrapAround () const
	Returns wrap-around flag. More...

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

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. More...

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. More...

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

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

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

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

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

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

	ClassDefOverride (BackgroundInfo, 4)
	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 36 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 49 of file BackgroundInfo.h.

                            {
       BackgroundMetaData::BG_TAG tag = BackgroundMetaData::bg_none;  
       std::string type; 
       BackgroundMetaData::EFileType fileType = BackgroundMetaData::c_Usual; 

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 91 of file BackgroundInfo.h.

◆ 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 20 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;
 }

◆ getBackgrounds()

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

inline

Returns background descriptions.

Returns: descriptions

Definition at line 180 of file BackgroundInfo.h.

◆ getComponents()

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

inline

Returns included components.

Returns: vector of component names

Definition at line 186 of file BackgroundInfo.h.

◆ 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 241 of file BackgroundInfo.h.

◆ getMaxEdepECL()

double getMaxEdepECL ( ) const

inline

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

Returns: energy cut [GeV]

Definition at line 234 of file BackgroundInfo.h.

◆ getMaxTime()

double getMaxTime ( ) const

inline

Returns upper edge of the narrow time window.

Returns: upper edge

Definition at line 198 of file BackgroundInfo.h.

◆ getMaxTimeECL()

double getMaxTimeECL ( ) const

inline

Returns upper edge of ECL time window.

Returns: upper edge

Definition at line 210 of file BackgroundInfo.h.

◆ getMaxTimePXD()

double getMaxTimePXD ( ) const

inline

Returns upper edge of PXD time window.

Returns: upper edge

Definition at line 222 of file BackgroundInfo.h.

◆ getMethod()

EMethod getMethod ( ) const

inline

Returns method enum used to add BG.

Returns: method

Definition at line 174 of file BackgroundInfo.h.

◆ getMinTime()

double getMinTime ( ) const

inline

Returns lower edge of the narrow time window.

Returns: lower edge

Definition at line 192 of file BackgroundInfo.h.

◆ getMinTimeECL()

double getMinTimeECL ( ) const

inline

Returns lower edge of ECL time window.

Returns: lower edge

Definition at line 204 of file BackgroundInfo.h.

◆ getMinTimePXD()

double getMinTimePXD ( ) const

inline

Returns lower edge of PXD time window.

Returns: lower edge

Definition at line 216 of file BackgroundInfo.h.

◆ getWrapAround()

bool getWrapAround ( ) const

inline

Returns wrap-around flag.

Returns: flag

Definition at line 228 of file BackgroundInfo.h.

◆ incrementReusedCounter()

void incrementReusedCounter ( unsigned index )

inline

Increments sample reused counter.

Parameters

index element index in std::vector

Definition at line 165 of file BackgroundInfo.h.

◆ 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 7 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;
 }

◆ 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 60 of file Mergeable.h.

60 {}

◆ Reset()

virtual void Reset ( )

inlinevirtualinherited

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

Alias for clear().

Definition at line 68 of file Mergeable.h.

◆ setComponents()

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

inline

Set components included.

Parameters

components vector of component names

Definition at line 101 of file BackgroundInfo.h.

◆ SetDirectory()

virtual void SetDirectory ( TDirectory * )

inlinevirtualinherited

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

Does nothing.

Definition at line 70 of file Mergeable.h.

◆ 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 159 of file BackgroundInfo.h.

◆ 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 152 of file BackgroundInfo.h.

◆ setMaxTime()

void setMaxTime ( double maxTime )

inline

Set upper edge of the narrow time window.

Parameters

maxTime upper edge

Definition at line 116 of file BackgroundInfo.h.

◆ setMaxTimeECL()

void setMaxTimeECL ( double maxTimeECL )

inline

Set upper edge of ECL time window.

Parameters

maxTimeECL upper edge

Definition at line 128 of file BackgroundInfo.h.

◆ setMaxTimePXD()

void setMaxTimePXD ( double maxTimePXD )

inline

Set upper edge of PXD time window.

Parameters

maxTimePXD upper edge

Definition at line 140 of file BackgroundInfo.h.

◆ setMethod()

void setMethod ( EMethod method )

inline

Set method that is used to add BG.

Parameters

method enum for method

Definition at line 84 of file BackgroundInfo.h.

◆ setMinTime()

void setMinTime ( double minTime )

inline

Set lower edge of the narrow time window.

Parameters

minTime lower edge

Definition at line 110 of file BackgroundInfo.h.

◆ setMinTimeECL()

void setMinTimeECL ( double minTimeECL )

inline

Set lower edge of ECL time window.

Parameters

minTimeECL lower edge

Definition at line 122 of file BackgroundInfo.h.

◆ setMinTimePXD()

void setMinTimePXD ( double minTimePXD )

inline

Set lower edge of PXD time window.

Parameters

minTimePXD lower edge

Definition at line 134 of file BackgroundInfo.h.

◆ setWrapAround()

void setWrapAround ( bool wrapAround )

inline

Set wrap-around flag.

Parameters

wrapAround flag

Definition at line 146 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

Member Function Documentation

◆ appendBackgroundDescr()

◆ canBeMerged()

◆ getBackgrounds()

◆ getComponents()

◆ getExtensionName()

◆ getMaxEdepECL()

◆ getMaxTime()

◆ getMaxTimeECL()

◆ getMaxTimePXD()

◆ getMethod()

◆ getMinTime()

◆ getMinTimeECL()

◆ getMinTimePXD()

◆ getWrapAround()

◆ incrementReusedCounter()

◆ Merge()

◆ removeSideEffects()

◆ Reset()

◆ setComponents()

◆ SetDirectory()

◆ setExtensionName()

◆ setMaxEdepECL()

◆ setMaxTime()

◆ setMaxTimeECL()

◆ setMaxTimePXD()

◆ setMethod()

◆ setMinTime()

◆ setMinTimeECL()

◆ setMinTimePXD()

◆ setWrapAround()