background modules

Collaboration diagram for background modules:

Classes
class	BeamBkgGeneratorModule
	Beam background generator based on SAD files. More...
class	BeamBkgHitRateMonitorModule
	A module to monitor detector hit rates of beam background Output is to a flat ntuple. More...
class	BeamBkgMixerModule
	New beam background mixer; this one doesn't need ROF files. More...
class	BeamBkgTagSetterModule
	A module that sets m_backgroundTag variable in SimHits (see BackgroundMetaData.h). More...
class	BGOverlayExecutorModule
	Overlay of measured background with simulated data (Digits or Clusters) More...
class	BGOverlayInputModule
	Beam BG data input, either in form of Digits or raw data. More...

Functions
	BeamBkgGeneratorModule ()
	Constructor.
virtual	~BeamBkgGeneratorModule ()
	Destructor.
virtual void	initialize () override
	Initialize the Module. More...
virtual void	beginRun () override
	Called when entering a new run. More...
virtual void	event () override
	Event processor. More...
virtual void	endRun () override
	End-of-run action. More...
virtual void	terminate () override
	Termination action. More...
int	generateEntry () const
	Pick up particle randomly from the SAD file according to its rate. More...
	BeamBkgHitRateMonitorModule ()
	Constructor.
virtual	~BeamBkgHitRateMonitorModule ()
	Destructor.
virtual void	initialize () override
	Initialize the Module. More...
virtual void	beginRun () override
	Called when entering a new run.
virtual void	event () override
	Event processor.
virtual void	endRun () override
	End-of-run action.
virtual void	terminate () override
	Termination action. More...
bool	isEventSelected ()
	event selection More...
void	collectFileMetaData ()
	Collect file meta data: LFN's, low and high experiment, run and event numbers. More...
void	setFileMetaData ()
	Set output FileMetaData object. More...
	BeamBkgMixerModule ()
	Constructor.
virtual	~BeamBkgMixerModule ()
	Destructor.
virtual void	initialize () override
	Initialize the Module. More...
virtual void	beginRun () override
	Called when entering a new run. More...
virtual void	event () override
	Event processor.
virtual void	endRun () override
	End-of-run action. More...
virtual void	terminate () override
	Termination action. More...
bool	isComponentIncluded (std::vector< std::string > &components, const std::string &component)
	Returns true if a component is found in components or the list is empty. More...
void	appendSample (BackgroundMetaData::BG_TAG bkgTag, const std::string &bkgType, const std::string &fileName, double realTime, BackgroundMetaData::EFileType fileTyp)
	appends background sample to m_backgrounds More...
bool	acceptEvent (TClonesArray *cloneArrayECL)
	Checks for deposited energy of ECLHits and returns true if Edep < m_maxEdepECL. More...
	BeamBkgTagSetterModule ()
	Constructor.
virtual	~BeamBkgTagSetterModule ()
	Destructor.
virtual void	initialize () override
	Initialize the Module. More...
virtual void	beginRun () override
	Called when entering a new run. More...
virtual void	event () override
	Event processor.
virtual void	endRun () override
	End-of-run action. More...
virtual void	terminate () override
	Termination action. More...
	BGOverlayExecutorModule ()
	Constructor.
virtual void	initialize () override
	Initialize the Module. More...
virtual void	event () override
	Event processor.

Detailed Description

Function Documentation

acceptEvent()

bool acceptEvent ( TClonesArray *  cloneArrayECL )

private

Checks for deposited energy of ECLHits and returns true if Edep < m_maxEdepECL.

Parameters

cloneArrayECL

pointer to TClonesArray of ECLHits

Returns

true if all ECLHits have deposited energy below m_maxEdepECL

Definition at line 558 of file BeamBkgMixerModule.cc.

  {
    if (!cloneArrayECL) return true;
    if (m_maxEdepECL == 0) return true;
 
    int numEntries = cloneArrayECL->GetEntriesFast();
    for (int i = 0; i < numEntries; i++) {
      ECLHit* simHit = static_cast<ECLHit*>(cloneArrayECL->AddrAt(i));
      if (simHit->getEnergyDep() > m_maxEdepECL) return false;
    }
    return true;
  }

appendSample()

void appendSample ( BackgroundMetaData::BG_TAG  bkgTag, const std::string &  bkgType, const std::string &  fileName, double  realTime, BackgroundMetaData::EFileType  fileTyp  )

private

appends background sample to m_backgrounds

Parameters

bkgTag	background tag
bkgType	background type
fileName	file name
realTime	real time that corresponds to background sample
fileTyp	file type

Definition at line 536 of file BeamBkgMixerModule.cc.

beginRun() [1/3]

void beginRun ( void  )

overridevirtual

Called when entering a new run.

Set run dependent things like run header parameters, alignment, etc.

Reimplemented from Module.

Definition at line 163 of file BeamBkgGeneratorModule.cc.

  {
  }

beginRun() [2/3]

void beginRun ( void  )

overridevirtual

Called when entering a new run.

Set run dependent things like run header parameters, alignment, etc.

Reimplemented from Module.

Definition at line 351 of file BeamBkgMixerModule.cc.

beginRun() [3/3]

void beginRun ( void  )

overridevirtual

Called when entering a new run.

Set run dependent things like run header parameters, alignment, etc.

Reimplemented from Module.

Definition at line 125 of file BeamBkgTagSetterModule.cc.

  {
  }

collectFileMetaData()

void collectFileMetaData ( )

private

Collect file meta data: LFN's, low and high experiment, run and event numbers.

This code is based on RootOutputModule::event().

Definition at line 297 of file BeamBkgHitRateMonitorModule.cc.

  {
    // add file name to the list
    if (m_fileMetaData.isValid()) {
      std::string lfn = m_fileMetaData->getLfn();
      if (not lfn.empty() and (m_parentLfns.empty() or (m_parentLfns.back() != lfn))) {
        m_parentLfns.push_back(lfn);
      }
    }
 
    // low and high experiment, run and event numbers
    unsigned long experiment =  m_eventMetaData->getExperiment();
    unsigned long run =  m_eventMetaData->getRun();
    unsigned long event = m_eventMetaData->getEvent();
    if (m_experimentLow > m_experimentHigh) { //starting condition
      m_experimentLow = m_experimentHigh = experiment;
      m_runLow = m_runHigh = run;
      m_eventLow = m_eventHigh = event;
    } else {
      if ((experiment < m_experimentLow) or ((experiment == m_experimentLow) and ((run < m_runLow) or ((run == m_runLow)
                                             and (event < m_eventLow))))) {
        m_experimentLow = experiment;
        m_runLow = run;
        m_eventLow = event;
      }
      if ((experiment > m_experimentHigh) or ((experiment == m_experimentHigh) and ((run > m_runHigh) or ((run == m_runHigh)
                                              and (event > m_eventHigh))))) {
        m_experimentHigh = experiment;
        m_runHigh = run;
        m_eventHigh = event;
      }
    }
 
  }

endRun() [1/3]

void endRun ( void  )

overridevirtual

End-of-run action.

Save run-related stuff, such as statistics.

Reimplemented from Module.

Definition at line 256 of file BeamBkgGeneratorModule.cc.

endRun() [2/3]

void endRun ( void  )

overridevirtual

End-of-run action.

Save run-related stuff, such as statistics.

Reimplemented from Module.

Definition at line 500 of file BeamBkgMixerModule.cc.

endRun() [3/3]

void endRun ( void  )

overridevirtual

End-of-run action.

Save run-related stuff, such as statistics.

Reimplemented from Module.

Definition at line 176 of file BeamBkgTagSetterModule.cc.

event()

void event ( void  )

overridevirtual

Event processor.

< Transformation matrix from SAD space into geant4 space.

Reimplemented from Module.

Definition at line 167 of file BeamBkgGeneratorModule.cc.

generateEntry()

int generateEntry ( ) const

private

Pick up particle randomly from the SAD file according to its rate.

Returns

TTree entry number

Definition at line 286 of file BeamBkgGeneratorModule.cc.

initialize() [1/5]

void initialize ( void  )

overridevirtual

Initialize the Module.

This method is called at the beginning of data processing.

Reimplemented from Module.

Definition at line 74 of file BeamBkgGeneratorModule.cc.

initialize() [2/5]

void initialize ( void  )

overridevirtual

Initialize the Module.

This method is called at the beginning of data processing.

Reimplemented from Module.

Definition at line 120 of file BeamBkgHitRateMonitorModule.cc.

initialize() [3/5]

void initialize ( void  )

overridevirtual

Initialize the Module.

This method is called at the beginning of data processing.

Reimplemented from Module.

Definition at line 116 of file BeamBkgMixerModule.cc.

initialize() [4/5]

void initialize ( void  )

overridevirtual

Initialize the Module.

This method is called at the beginning of data processing.

Reimplemented from Module.

Definition at line 73 of file BeamBkgTagSetterModule.cc.

initialize() [5/5]

void initialize ( void  )

overridevirtual

Initialize the Module.

This method is called at the beginning of data processing.

Reimplemented from Module.

Definition at line 71 of file BGOverlayExecutorModule.cc.

  {
    // get name of extension that is used in BGOverlayInput for BG collections
    StoreObjPtr<BackgroundInfo> bkgInfo(m_BackgroundInfoInstanceName, DataStore::c_Persistent);
    if (bkgInfo.isValid()) {
      if (bkgInfo->getMethod() == BackgroundInfo::c_Overlay) {
        m_extensionName = bkgInfo->getExtensionName();
      } else {
        B2ERROR("BGOverlayExecutor: no BGOverlayInput module in the path");
      }
    } else {
      B2ERROR("BGOverlayExecutor: no BGOverlayInput module in the path");
    }
 
    // registration in datastore (all as optional input - see template function)
    registerDigits<PXDDigit>(m_PXDDigitsName);
    registerDigits<SVDShaperDigit>(m_SVDShaperDigitsName);
    registerDigits<CDCHit>(m_CDCHitsName);
    registerDigits<TOPDigit>(m_TOPDigitsName);
    registerDigits<ARICHDigit>(m_ARICHDigitsName);
    registerDigits<KLMDigit>(m_KLMDigitsName);
 
    // toggle ON the components from the list
    if (m_components.empty()) {
      m_addPXD = true;
      m_addSVD = true;
      m_addCDC = true;
      m_addTOP = true;
      m_addARICH = true;
      m_addKLM = true;
    } else {
      for (const auto& component : m_components) {
        if (component == "PXD") m_addPXD = true;
        else if (component == "SVD") m_addSVD = true;
        else if (component == "CDC") m_addCDC = true;
        else if (component == "TOP") m_addTOP = true;
        else if (component == "ARICH") m_addARICH = true;
        else if (component == "ECL") continue; // not relevant - overlay implemented in ECLDigitizer
        else if (component == "KLM") m_addKLM = true;
        else B2ERROR("Unknown detector component '" << component << "'");
      }
    }
 
  }

isComponentIncluded()

bool isComponentIncluded ( std::vector< std::string > &  components, const std::string &  component  )

private

Returns true if a component is found in components or the list is empty.

If found a component is erased from components.

Parameters

components	list of components to be included
component	the name of detector component to check

Returns

true if component found in components

Definition at line 523 of file BeamBkgMixerModule.cc.

isEventSelected()

bool isEventSelected ( )

private

event selection

Returns

true if event is selected

Definition at line 275 of file BeamBkgHitRateMonitorModule.cc.

setFileMetaData()

void setFileMetaData ( )

private

Set output FileMetaData object.

This code is based on RootOutputModule::fillFileMetaData().

Definition at line 333 of file BeamBkgHitRateMonitorModule.cc.

terminate() [1/4]

void terminate ( void  )

overridevirtual

Termination action.

Clean-up, close files, summarize statistics, etc.

Reimplemented from Module.

Definition at line 260 of file BeamBkgGeneratorModule.cc.

terminate() [2/4]

void terminate ( void  )

overridevirtual

Termination action.

Clean-up, close files, summarize statistics, etc.

Reimplemented from Module.

Definition at line 262 of file BeamBkgHitRateMonitorModule.cc.

terminate() [3/4]

void terminate ( void  )

overridevirtual

Termination action.

Clean-up, close files, summarize statistics, etc.

Reimplemented from Module.

Definition at line 504 of file BeamBkgMixerModule.cc.

terminate() [4/4]

void terminate ( void  )

overridevirtual

Termination action.

Clean-up, close files, summarize statistics, etc.

Reimplemented from Module.

Definition at line 180 of file BeamBkgTagSetterModule.cc.