PXDBackgroundModule Class Reference

PXD Background module. More...

#include <PXDBackgroundModule.h>

Inheritance diagram for PXDBackgroundModule:

Classes
struct	SensorData
	Struct to hold data of an PXD sensor. More...

Public Types
enum	EModulePropFlags {   c_Input = 1 ,   c_Output = 2 ,   c_ParallelProcessingCertified = 4 ,   c_HistogramManager = 8 ,   c_InternalSerializer = 16 ,   c_TerminateInAllProcesses = 32 ,   c_DontCollectStatistics = 64 }
	Each module can be tagged with property flags, which indicate certain features of the module. More...
typedef ModuleCondition::EAfterConditionPath	EAfterConditionPath
	Forward the EAfterConditionPath definition from the ModuleCondition.

Public Member Functions
	PXDBackgroundModule ()
	Constructor.
virtual	~PXDBackgroundModule ()
	Destructor.
virtual void	initialize () override
	Initialize module.
virtual void	beginRun () override
	Start-of-run initializations.
virtual void	event () override
	Event processing.
virtual void	endRun () override
	End-of-run tasks.
virtual void	terminate () override
	Final summary and cleanup.
virtual std::vector< std::string >	getFileNames (bool outputFiles)
	Return a list of output filenames for this modules.
const std::string &	getName () const
	Returns the name of the module.
const std::string &	getType () const
	Returns the type of the module (i.e.
const std::string &	getPackage () const
	Returns the package this module is in.
const std::string &	getDescription () const
	Returns the description of the module.
void	setName (const std::string &name)
	Set the name of the module.
void	setPropertyFlags (unsigned int propertyFlags)
	Sets the flags for the module properties.
LogConfig &	getLogConfig ()
	Returns the log system configuration.
void	setLogConfig (const LogConfig &logConfig)
	Set the log system configuration.
void	setLogLevel (int logLevel)
	Configure the log level.
void	setDebugLevel (int debugLevel)
	Configure the debug messaging level.
void	setAbortLevel (int abortLevel)
	Configure the abort log level.
void	setLogInfo (int logLevel, unsigned int logInfo)
	Configure the printed log information for the given level.
void	if_value (const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	Add a condition to the module.
void	if_false (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to add a condition to the module.
void	if_true (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to set the condition of the module.
bool	hasCondition () const
	Returns true if at least one condition was set for the module.
const ModuleCondition *	getCondition () const
	Return a pointer to the first condition (or nullptr, if none was set)
const std::vector< ModuleCondition > &	getAllConditions () const
	Return all set conditions for this module.
bool	evalCondition () const
	If at least one condition was set, it is evaluated and true returned if at least one condition returns true.
std::shared_ptr< Path >	getConditionPath () const
	Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).
Module::EAfterConditionPath	getAfterConditionPath () const
	What to do after the conditional path is finished.
std::vector< std::shared_ptr< Path > >	getAllConditionPaths () const
	Return all condition paths currently set (no matter if the condition is true or not).
bool	hasProperties (unsigned int propertyFlags) const
	Returns true if all specified property flags are available in this module.
bool	hasUnsetForcedParams () const
	Returns true and prints error message if the module has unset parameters which the user has to set in the steering file.
const ModuleParamList &	getParamList () const
	Return module param list.
template<typename T >
ModuleParam< T > &	getParam (const std::string &name) const
	Returns a reference to a parameter.
bool	hasReturnValue () const
	Return true if this module has a valid return value set.
int	getReturnValue () const
	Return the return value set by this module.
std::shared_ptr< PathElement >	clone () const override
	Create an independent copy of this module.
std::shared_ptr< boost::python::list >	getParamInfoListPython () const
	Returns a python list of all parameters.

Static Public Member Functions
static void	exposePythonAPI ()
	Exposes methods of the Module class to Python.

Static Public Attributes
static const unsigned short	c_reportNone = 0
	No reporting.
static const unsigned short	c_reportSummary = 1
	Summary only.
static const unsigned short	c_reportNTuple = 2
	Summary and NTuple.

Protected Member Functions
virtual void	def_initialize ()
	Wrappers to make the methods without "def_" prefix callable from Python.
virtual void	def_beginRun ()
	Wrapper method for the virtual function beginRun() that has the implementation to be used in a call from Python.
virtual void	def_event ()
	Wrapper method for the virtual function event() that has the implementation to be used in a call from Python.
virtual void	def_endRun ()
	This method can receive that the current run ends as a call from the Python side.
virtual void	def_terminate ()
	Wrapper method for the virtual function terminate() that has the implementation to be used in a call from Python.
void	setDescription (const std::string &description)
	Sets the description of the module.
void	setType (const std::string &type)
	Set the module type.
template<typename T >
void	addParam (const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
	Adds a new parameter to the module.
template<typename T >
void	addParam (const std::string &name, T &paramVariable, const std::string &description)
	Adds a new enforced parameter to the module.
void	setReturnValue (int value)
	Sets the return value for this module as integer.
void	setReturnValue (bool value)
	Sets the return value for this module as bool.
void	setParamList (const ModuleParamList &params)
	Replace existing parameter list.

Private Member Functions
const PXD::SensorInfo &	getInfo (VxdID sensorID) const
	This is a shortcut to getting PXD::SensorInfo from the GeoCache.
double	getSensorThickness (VxdID sensorID) const
	Return thickness of the sensor with the given sensor ID.
double	getSensorMass (VxdID sensorID) const
	Return mass of the sensor with the given sensor ID.
double	getSensorArea (VxdID sensorID) const
	Return area of the sensor with the given sensor ID.
const ROOT::Math::XYZVector &	pointToGlobal (VxdID sensorID, const ROOT::Math::XYZVector &local)
	Convert local sensor coordinates to global.
const ROOT::Math::XYZVector &	vectorToGlobal (VxdID sensorID, const ROOT::Math::XYZVector &local)
	Convert local vector coordinates to global.
int	getNumSensors (int layerNum)
	Get number of sensors in a layer.
int	getTotalSensors ()
	Get total number of sensors.
std::list< ModulePtr >	getModules () const override
	no submodules, return empty list
std::string	getPathString () const override
	return the module name.
void	setParamPython (const std::string &name, const boost::python::object &pyObj)
	Implements a method for setting boost::python objects.
void	setParamPythonDict (const boost::python::dict &dictionary)
	Implements a method for reading the parameter values from a boost::python dictionary.

Private Attributes
const double	c_densitySi = 2.3290 * Unit::g_cm3
	Density of crystalline Silicon.
const double	c_smy = 1.0e7 * Unit::s
	Seconds in snowmass year.
const std::string	c_niel_neutronFile = "/vxd/data/neutrons.csv"
	NIEL-correction file for neutrons.
const std::string	c_niel_protonFile = "/vxd/data/protons.csv"
	NIEL-correction file for protons.
const std::string	c_niel_pionFile = "/vxd/data/pions.csv"
	NIEL-correction file for pions.
const std::string	c_niel_electronFile = "/vxd/data/electrons.csv"
	NIEL-correction file for electrons.
std::string	m_outputDirectoryName
	Path to directory where output data will be stored.
std::string	m_storeFileMetaDataName
	Name of the persistent FileMetaData object.
std::string	m_storeBgMetaDataName
	Name of the persistent BackgroundMetaDta object.
std::string	m_storeMCParticlesName
	MCParticles StoreArray name.
std::string	m_storeSimHitsName
	PXDSimHits StoreArray name.
std::string	m_storeTrueHitsName
	PXDTrueHits StoreArray name.
std::string	m_relParticlesTrueHitsName
	MCParticlesToPXDTrueHits RelationArray name.
std::string	m_storeDigitsName
	PXDDigits StoreArray name.
std::string	m_relDigitsMCParticlesName
	StoreArray name of PXDDigits to MCParticles relation.
std::string	m_relDigitsTrueHitsName
	StoreArray name of PXDDigits to PXDTrueHits relation.
std::string	m_storeClustersName
	PXDClusters StoreArray name.
std::string	m_relClusterDigitName
	PXDClustersToPXDDigits RelationArray name.
std::string	m_relTrueHitsSimHitsName
	PXDTrueHitsToPXDSimHits RelationArray name.
std::string	m_storeEnergyDepositsName
	PXDEnergyDepositEvents StoreArray name.
std::string	m_storeNeutronFluxesName
	PXDNeutronFluxEvents StoreArray name.
std::string	m_storeOccupancyEventsName
	PXDOccupancyEvents StoreArray name.
unsigned short	m_doseReportingLevel
	0 - no data, 1 - summary only, 2 - ntuple
unsigned short	m_nfluxReportingLevel
	0 - no data, 1 - summary only, 2 - ntuple
unsigned short	m_occupancyReportingLevel
	0 - no data, 1 - summary only, 2 - ntuple
std::string	m_componentName
	Name of the current bg component.
double	m_componentTime
	Time of current component.
double	m_integrationTime
	Integration time of PXD.
std::map< VxdID, SensorData >	m_sensorData
	Struct to hold sensor-wise background data.
std::unique_ptr< TNiel >	m_nielNeutrons
	Pointer to Niel table for neutrons.
std::unique_ptr< TNiel >	m_nielProtons
	Pointer to Niel table for protons.
std::unique_ptr< TNiel >	m_nielPions
	Pointer to Niel table for pions.
std::unique_ptr< TNiel >	m_nielElectrons
	Pointer to Niel table for electrons.
std::string	m_name
	The name of the module, saved as a string (user-modifiable)
std::string	m_type
	The type of the module, saved as a string.
std::string	m_package
	Package this module is found in (may be empty).
std::string	m_description
	The description of the module.
unsigned int	m_propertyFlags
	The properties of the module as bitwise or (with |) of EModulePropFlags.
LogConfig	m_logConfig
	The log system configuration of the module.
ModuleParamList	m_moduleParamList
	List storing and managing all parameter of the module.
bool	m_hasReturnValue
	True, if the return value is set.
int	m_returnValue
	The return value.
std::vector< ModuleCondition >	m_conditions
	Module condition, only non-null if set.

Detailed Description

PXD Background module.

This module collects data from Belle II background simulation and produces a report on:

1. PXD radiation exposure: Deposited energy per unit mass of material.
2. PXD neutron flux: flux of non-ionizing damage normalized to 1 MeV neutron in perpendicular direction.
3. Occupancy:
   • total : pixels fired per unit area and time
   • occupancy distribution.

For each item, we tabulate depending on background source and layer.

Definition at line 42 of file PXDBackgroundModule.h.

Member Typedef Documentation

EAfterConditionPath

typedef ModuleCondition::EAfterConditionPath EAfterConditionPath

inherited

Forward the EAfterConditionPath definition from the ModuleCondition.

Definition at line 88 of file Module.h.

Member Enumeration Documentation

EModulePropFlags

enum EModulePropFlags

inherited

Each module can be tagged with property flags, which indicate certain features of the module.

Enumerator
c_Input	This module is an input module (reads data).
c_Output	This module is an output module (writes data).
c_ParallelProcessingCertified	This module can be run in parallel processing mode safely (All I/O must be done through the data store, in particular, the module must not write any files.)
c_HistogramManager	This module is used to manage histograms accumulated by other modules.
c_InternalSerializer	This module is an internal serializer/deserializer for parallel processing.
c_TerminateInAllProcesses	When using parallel processing, call this module's terminate() function in all processes(). This will also ensure that there is exactly one process (single-core if no parallel modules found) or at least one input, one main and one output process.
c_DontCollectStatistics	No statistics is collected for this module.

Definition at line 77 of file Module.h.

                          {
      c_Input                       = 1,  
      c_Output                      = 2,  
      c_ParallelProcessingCertified = 4,  
      c_HistogramManager            = 8, 
      c_InternalSerializer          = 16,  
      c_TerminateInAllProcesses     = 32,  
      c_DontCollectStatistics       = 64,  
    };

Constructor & Destructor Documentation

PXDBackgroundModule()

PXDBackgroundModule

(

)

Constructor.

Definition at line 47 of file PXDBackgroundModule.cc.

                                         :
  Module(), m_outputDirectoryName(""),
  m_doseReportingLevel(c_reportNTuple),
  m_nfluxReportingLevel(c_reportNTuple),
  m_occupancyReportingLevel(c_reportNTuple),
  m_componentName(""), m_componentTime(0), m_integrationTime(20),
  m_nielNeutrons(new TNiel(c_niel_neutronFile)),
  m_nielProtons(new TNiel(c_niel_protonFile)),
  m_nielPions(new TNiel(c_niel_pionFile)),
  m_nielElectrons(new TNiel(c_niel_electronFile))
{
  //Set module properties
  setDescription("PXD background module");
  setPropertyFlags(c_ParallelProcessingCertified);  // specify this flag if you need parallel processing
  // FIXME: This information can in principle be extracted from bg files, though not trivially.
  addParam("componentName", m_componentName, "Background component name to process", m_componentName);
  addParam("componentTime", m_componentTime, "Background component time", m_componentTime);
  addParam("integrationTime", m_integrationTime, "PXD integration time", m_integrationTime);
  addParam("doseReportingLevel", m_doseReportingLevel, "0 - no data, 1 - summary only, 2 - summary + ntuple", m_doseReportingLevel);
  addParam("nfluxReportingLevel", m_nfluxReportingLevel, "0 - no data, 1 - summary only, 2 - summary + ntuple",
           m_nfluxReportingLevel);
  addParam("occupancyReportingLevel", m_occupancyReportingLevel, "0 - no data, 1 - summary only, 2 - summary + ntuple",
           m_occupancyReportingLevel);
  addParam("outputDirectory", m_outputDirectoryName, "Name of output directory", m_outputDirectoryName);
}

~PXDBackgroundModule()

~PXDBackgroundModule ( )

virtual

Destructor.

Definition at line 91 of file PXDBackgroundModule.cc.

{
}

Member Function Documentation

beginRun()

void beginRun ( void  )

overridevirtual

Start-of-run initializations.

Reimplemented from Module.

Definition at line 137 of file PXDBackgroundModule.cc.

{
}

clone()

std::shared_ptr< PathElement > clone ( ) const

overridevirtualinherited

Create an independent copy of this module.

Note that parameters are shared, so changing them on a cloned module will also affect the original module.

Implements PathElement.

Definition at line 179 of file Module.cc.

{
  ModulePtr newModule = ModuleManager::Instance().registerModule(getType());
  newModule->m_moduleParamList.setParameters(getParamList());
  newModule->setName(getName());
  newModule->m_package = m_package;
  newModule->m_propertyFlags = m_propertyFlags;
  newModule->m_logConfig = m_logConfig;
  newModule->m_conditions = m_conditions;
 
  return newModule;
}

def_beginRun()

virtual void def_beginRun ( )

inlineprotectedvirtualinherited

Wrapper method for the virtual function beginRun() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 426 of file Module.h.

{ beginRun(); }

def_endRun()

virtual void def_endRun ( )

inlineprotectedvirtualinherited

This method can receive that the current run ends as a call from the Python side.

For regular C++-Modules that forwards the call to the regular endRun() method.

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

{ endRun(); }

def_event()

virtual void def_event ( )

inlineprotectedvirtualinherited

Wrapper method for the virtual function event() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 432 of file Module.h.

{ event(); }

def_initialize()

virtual void def_initialize ( )

inlineprotectedvirtualinherited

Wrappers to make the methods without "def_" prefix callable from Python.

Overridden in PyModule. Wrapper method for the virtual function initialize() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

{ initialize(); }

def_terminate()

virtual void def_terminate ( )

inlineprotectedvirtualinherited

Wrapper method for the virtual function terminate() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 445 of file Module.h.

{ terminate(); }

endRun()

void endRun ( void  )

overridevirtual

End-of-run tasks.

Reimplemented from Module.

Definition at line 364 of file PXDBackgroundModule.cc.

{
}

evalCondition()

bool evalCondition ( ) const

inherited

If at least one condition was set, it is evaluated and true returned if at least one condition returns true.

If no condition or result value was defined, the method returns false. Otherwise, the condition is evaluated and true returned, if at least one condition returns true. To speed up the evaluation, the condition strings were already parsed in the method if_value().

Returns

True if at least one condition and return value exists and at least one condition expression was evaluated to true.

Definition at line 96 of file Module.cc.

{
  if (m_conditions.empty()) return false;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return true;
    }
  }
  return false;
}

event()

void event ( void  )

overridevirtual

Event processing.

Reimplemented from Module.

Definition at line 141 of file PXDBackgroundModule.cc.

{
  //Register collections
  const StoreObjPtr<FileMetaData> storeFileMetaData(m_storeFileMetaDataName, DataStore::c_Persistent);
  const StoreObjPtr<BackgroundMetaData> storeBgMetaData(m_storeBgMetaDataName, DataStore::c_Persistent);
  const StoreArray<MCParticle> storeMCParticles(m_storeMCParticlesName);
  const StoreArray<PXDSimHit> storeSimHits(m_storeSimHitsName);
  const StoreArray<PXDTrueHit> storeTrueHits(m_storeTrueHitsName);
  const StoreArray<PXDDigit> storeDigits(m_storeDigitsName);
  const StoreArray<PXDCluster> storeClsuters(m_storeClustersName);
 
  // Add two new StoreArrays
  StoreArray<PXDEnergyDepositionEvent> storeEnergyDeposits(m_storeEnergyDepositsName);
  StoreArray<PXDNeutronFluxEvent> storeNeutronFluxes(m_storeNeutronFluxesName);
  StoreArray<PXDOccupancyEvent> storeOccupancyEvents(m_storeOccupancyEventsName);
 
  // Relations
  RelationArray relDigitsMCParticles(storeDigits, storeMCParticles, m_relDigitsMCParticlesName);
  RelationArray relDigitsTrueHits(storeDigits, storeTrueHits, m_relDigitsTrueHitsName);
  RelationArray relTrueHitsSimHits(storeTrueHits, storeSimHits, m_relTrueHitsSimHitsName);
  RelationArray relTrueHitsMCParticles(storeMCParticles, storeTrueHits, m_relParticlesTrueHitsName);
 
  // unsigned long numberOfEvents = storeFileMetaData->getNEvents();
  double currentComponentTime = storeBgMetaData->getRealTime();
  if (currentComponentTime != m_componentTime)
    B2FATAL("Mismatch in component times:\n"
            << "Steering file:   " << m_componentTime << "\n"
            << "Background file: " << currentComponentTime);
 
  VxdID currentSensorID(0);
  double currentSensorThickness(0);
  double currentSensorArea(0);
 
  // Exposition and dose
  if (m_doseReportingLevel > c_reportNone) {
    B2DEBUG(100, "Expo and dose");
    currentSensorID.setID(0);
    double currentSensorMass(0);
    for (const PXDSimHit& hit : storeSimHits) {
      // Update if we have a new sensor
      VxdID sensorID = hit.getSensorID();
      if (sensorID != currentSensorID) {
        currentSensorID = sensorID;
        currentSensorThickness = getSensorThickness(currentSensorID);
        currentSensorMass = getSensorMass(currentSensorID);
        currentSensorArea = getSensorArea(currentSensorID);
      }
      double hitEnergy = hit.getElectrons() * Const::ehEnergy;
      // Dose in Gy/smy, normalize by sensor mass
      m_sensorData[currentSensorID].m_dose +=
        (hitEnergy / Unit::J) / (currentSensorMass / 1000) * (c_smy / currentComponentTime);
      // Exposition in GeV/cm2/s
      m_sensorData[currentSensorID].m_expo += hitEnergy / currentSensorArea / (currentComponentTime / Unit::s);
      if (m_doseReportingLevel == c_reportNTuple) {
        const ROOT::Math::XYZVector localPos = hit.getPosIn();
        const ROOT::Math::XYZVector globalPos = pointToGlobal(currentSensorID, localPos);
        float globalPosXYZ[3];
        globalPos.GetCoordinates(globalPosXYZ);
        storeEnergyDeposits.appendNew(
          sensorID.getLayerNumber(), sensorID.getLadderNumber(), sensorID.getSensorNumber(),
          hit.getPDGcode(), hit.getGlobalTime(),
          localPos.X(), localPos.Y(), globalPosXYZ, hitEnergy,
          (hitEnergy / Unit::J) / (currentSensorMass / 1000) / (currentComponentTime / Unit::s),
          (hitEnergy / Unit::J) / currentSensorArea / (currentComponentTime / Unit::s)
        );
      }
    }
  }
 
  // Neutron flux
  if (m_nfluxReportingLevel > c_reportNone) {
    B2DEBUG(100, "Neutron flux");
    currentSensorID.setID(0);
    for (const PXDTrueHit& hit : storeTrueHits) {
      VxdID sensorID = hit.getSensorID();
      // Update if we are on a new sensor
      if (sensorID != currentSensorID) {
        currentSensorID = sensorID;
        currentSensorThickness = getSensorThickness(currentSensorID);
        currentSensorArea = getSensorArea(currentSensorID);
      }
      // J(TrueHit) = abs(step)/thickness * correctionFactor;
      ROOT::Math::XYZVector entryPos(hit.getEntryU(), hit.getEntryV(), hit.getEntryW());
      ROOT::Math::XYZVector exitPos(hit.getExitU(), hit.getExitV(), hit.getExitW());
      double stepLength = (exitPos - entryPos).R();
      // Identify what particle we've got. We need type and kinetic energy.
      // TODO: TrueHit must carry pdg or SimHit must carry energy.
      // NOTE: MCParticles may get remapped, then SimHits still carry correct pdg.
      const PXDSimHit* simhit = hit.getRelatedTo<PXDSimHit>();
      if (!simhit) { //either something is very wrong, or we just don't have the relation. Try to find an appropriate SimHit manually.
        double minDistance = 1.0e10;
        for (const PXDSimHit& related : storeSimHits) {
          double distance = (entryPos - related.getPosIn()).R();
          if (distance < minDistance) {
            minDistance = distance;
            simhit = &related;
          }
        }
      }
      if (!simhit) {
        B2WARNING("No related PXDSimHit found");
        continue; //skip this true hit if the simhit is still null after setting it manually
      }
      // FIXME: Is there a difference between positrons and electrons wrt. NIEL?
      // We fill neutronFluxBars with summary NIEL deposit for all kinds of particles by layer and component.
      // Fluency plots are by component and are deposition histograms for a particular type of particle and compoonent.
      // Special treatment of corrupt p's in TrueHits:
      ROOT::Math::XYZVector hitMomentum(hit.getMomentum());
      hitMomentum.SetX(std::isfinite(hitMomentum.X()) ? hitMomentum.X() : 0.0);
      hitMomentum.SetY(std::isfinite(hitMomentum.Y()) ? hitMomentum.Y() : 0.0);
      hitMomentum.SetZ(std::isfinite(hitMomentum.Z()) ? hitMomentum.Z() : 0.0);
      int pdg = abs(simhit->getPDGcode());
      double kineticEnergy(0.0);
      double nielWeight(0.0);
      if (pdg == Const::neutron.getPDGCode()) {
        double m0 = Const::neutronMass;
        kineticEnergy = sqrt(hitMomentum.Mag2() + m0 * m0) - m0;
        nielWeight = m_nielNeutrons->getNielFactor(kineticEnergy / Unit::MeV);
      }
      if (pdg == Const::proton.getPDGCode()) {
        double m0 = Const::protonMass;
        kineticEnergy = sqrt(hitMomentum.Mag2() + m0 * m0) - m0;
        nielWeight = m_nielProtons->getNielFactor(kineticEnergy / Unit::MeV);
      }
      if (pdg == Const::pi0.getPDGCode() || pdg == Const::pion.getPDGCode()) {
        double m0 = Const::pi0Mass;
        kineticEnergy = sqrt(hitMomentum.Mag2() + m0 * m0) - m0;
        nielWeight = m_nielPions->getNielFactor(kineticEnergy / Unit::MeV);
      }
      if (pdg == Const::electron.getPDGCode()) {
        double m0 = Const::electronMass;
        kineticEnergy = sqrt(hitMomentum.Mag2() + m0 * m0) - m0;
        nielWeight = m_nielElectrons->getNielFactor(kineticEnergy / Unit::MeV);
      }
      if (pdg == Const::photon.getPDGCode()) {
        double m0 = 0.0;
        kineticEnergy = sqrt(hitMomentum.Mag2() + m0 * m0) - m0;
      }
 
      // Only set weight for supported particles
      nielWeight = std::isfinite(nielWeight) ? nielWeight : 0.0;
      m_sensorData[currentSensorID].m_neutronFlux += nielWeight * stepLength / currentSensorThickness / currentSensorArea /
                                                     currentComponentTime * c_smy;
 
      // Store data in a PXDNeutronFluxEvent object
      if (m_nfluxReportingLevel == c_reportNTuple) {
        ROOT::Math::XYZVector localPos(hit.getU(), hit.getV(), hit.getW());
        const ROOT::Math::XYZVector globalPos = pointToGlobal(currentSensorID, localPos);
        float globalPosXYZ[3];
        globalPos.GetCoordinates(globalPosXYZ);
        ROOT::Math::XYZVector localMom = hit.getMomentum();
        const ROOT::Math::XYZVector globalMom = vectorToGlobal(currentSensorID, localMom);
        float globalMomXYZ[3];
        globalMom.GetCoordinates(globalMomXYZ);
        storeNeutronFluxes.appendNew(
          sensorID.getLayerNumber(), sensorID.getLadderNumber(), sensorID.getSensorNumber(),
          simhit->getPDGcode(), simhit->getGlobalTime(),
          hit.getU(), hit.getV(), globalPosXYZ, globalMomXYZ, kineticEnergy,
          stepLength, nielWeight,
          stepLength / currentSensorThickness / currentSensorArea / (currentComponentTime / Unit::s),
          nielWeight * stepLength / currentSensorThickness / currentSensorArea / (currentComponentTime / Unit::s)
        );
      }
    }
  }
 
  // Occupancy
  if (m_occupancyReportingLevel > c_reportNone) {
    B2DEBUG(100, "Fired pixels");
    currentSensorID.setID(0);
    double currentSensorCut = 0;
    // Store fired pixels: count number of digits over threshold
    std::map<VxdID, std::vector<float> > firedPixels;
    for (const PXDDigit& storeDigit : storeDigits) {
      // Filter out digits with signals below zero-suppression threshold
      // ARE THRE SUCH DIGITS?
      VxdID sensorID = storeDigit.getSensorID();
      if (sensorID != currentSensorID) {
        currentSensorID = sensorID;
        auto info = getInfo(sensorID);
        currentSensorCut = info.getChargeThreshold();
      }
      B2DEBUG(30, "Digit charge: " << storeDigit.getCharge() << " threshold: " << currentSensorCut);
      if (storeDigit.getCharge() <  currentSensorCut) continue;
      B2DEBUG(30, "Passed.");
      firedPixels[sensorID].push_back(storeDigit.getCharge());
    }
    // Process the map
    for (auto idAndSet : firedPixels) {
      VxdID sensorID = idAndSet.first;
      double sensorArea = getSensorArea(sensorID);
      int nFired = idAndSet.second.size();
      double fired = nFired / (currentComponentTime / Unit::s) / sensorArea;
      m_sensorData[sensorID].m_fired += fired;
    }
 
    B2DEBUG(100, "Occupancy");
    currentSensorID.setID(0);
    int nPixels = 0;
    for (auto cluster : storeClsuters) {
      VxdID sensorID = cluster.getSensorID();
      if (currentSensorID != sensorID) {
        currentSensorID = sensorID;
        auto info = getInfo(sensorID);
        nPixels = info.getUCells() * info.getVCells();
      }
 
      double w_acceptance =  m_integrationTime / currentComponentTime;
      double occupancy = 1.0 / nPixels * cluster.getSize();
      m_sensorData[sensorID].m_occupancy +=  w_acceptance * occupancy;
 
      if (m_occupancyReportingLevel == c_reportNTuple) {
        storeOccupancyEvents.appendNew(
          sensorID.getLayerNumber(), sensorID.getLadderNumber(),
          sensorID.getSensorNumber(),
          cluster.getU(), cluster.getV(), cluster.getSize(),
          cluster.getCharge(), occupancy
        );
      }
    }
  }
}

exposePythonAPI()

void exposePythonAPI ( )

staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

{
  // to avoid confusion between std::arg and boost::python::arg we want a shorthand namespace as well
  namespace bp = boost::python;
 
  docstring_options options(true, true, false); //userdef, py sigs, c++ sigs
 
  void (Module::*setReturnValueInt)(int) = &Module::setReturnValue;
 
  enum_<Module::EAfterConditionPath>("AfterConditionPath",
                                     R"(Determines execution behaviour after a conditional path has been executed:
 
.. attribute:: END
 
  End processing of this path after the conditional path. (this is the default for if_value() etc.)
 
.. attribute:: CONTINUE
 
  After the conditional path, resume execution after this module.)")
  .value("END", Module::EAfterConditionPath::c_End)
  .value("CONTINUE", Module::EAfterConditionPath::c_Continue)
  ;
 
  /* Do not change the names of >, <, ... we use them to serialize conditional pathes */
  enum_<Belle2::ModuleCondition::EConditionOperators>("ConditionOperator")
  .value(">", Belle2::ModuleCondition::EConditionOperators::c_GT)
  .value("<", Belle2::ModuleCondition::EConditionOperators::c_ST)
  .value(">=", Belle2::ModuleCondition::EConditionOperators::c_GE)
  .value("<=", Belle2::ModuleCondition::EConditionOperators::c_SE)
  .value("==", Belle2::ModuleCondition::EConditionOperators::c_EQ)
  .value("!=", Belle2::ModuleCondition::EConditionOperators::c_NE)
  ;
 
  enum_<Module::EModulePropFlags>("ModulePropFlags",
                                  R"(Flags to indicate certain low-level features of modules, see :func:`Module.set_property_flags()`, :func:`Module.has_properties()`. Most useful flags are:
 
.. attribute:: PARALLELPROCESSINGCERTIFIED
 
    This module can be run in parallel processing mode safely (All I/O must be done through the data store, in particular, the module must not write any files.)
 
.. attribute:: HISTOGRAMMANAGER
 
  This module is used to manage histograms accumulated by other modules
 
.. attribute:: TERMINATEINALLPROCESSES
 
  When using parallel processing, call this module's terminate() function in all processes. This will also ensure that there is exactly one process (single-core if no parallel modules found) or at least one input, one main and one output process.
)")
  .value("INPUT", Module::EModulePropFlags::c_Input)
  .value("OUTPUT", Module::EModulePropFlags::c_Output)
  .value("PARALLELPROCESSINGCERTIFIED", Module::EModulePropFlags::c_ParallelProcessingCertified)
  .value("HISTOGRAMMANAGER", Module::EModulePropFlags::c_HistogramManager)
  .value("INTERNALSERIALIZER", Module::EModulePropFlags::c_InternalSerializer)
  .value("TERMINATEINALLPROCESSES", Module::EModulePropFlags::c_TerminateInAllProcesses)
  ;
 
  //Python class definition
  class_<Module, PyModule> module("Module", R"(
Base class for Modules.
 
A module is the smallest building block of the framework.
A typical event processing chain consists of a Path containing
modules. By inheriting from this base class, various types of
modules can be created. To use a module, please refer to
:func:`Path.add_module()`.  A list of modules is available by running
``basf2 -m`` or ``basf2 -m package``, detailed information on parameters is
given by e.g. ``basf2 -m RootInput``.
 
The 'Module Development' section in the manual provides detailed information
on how to create modules, setting parameters, or using return values/conditions:
https://confluence.desy.de/display/BI/Software+Basf2manual#Module_Development
 
)");
  module
  .def("__str__", &Module::getPathString)
  .def("name", &Module::getName, return_value_policy<copy_const_reference>(),
       "Returns the name of the module. Can be changed via :func:`set_name() <Module.set_name()>`, use :func:`type() <Module.type()>` for identifying a particular module class.")
  .def("type", &Module::getType, return_value_policy<copy_const_reference>(),
       "Returns the type of the module (i.e. class name minus 'Module')")
  .def("set_name", &Module::setName, args("name"), R"(
Set custom name, e.g. to distinguish multiple modules of the same type.
 
>>> path.add_module('EventInfoSetter')
>>> ro = path.add_module('RootOutput', branchNames=['EventMetaData'])
>>> ro.set_name('RootOutput_metadata_only')
>>> print(path)
[EventInfoSetter -> RootOutput_metadata_only]
 
)")
  .def("description", &Module::getDescription, return_value_policy<copy_const_reference>(),
       "Returns the description of this module.")
  .def("package", &Module::getPackage, return_value_policy<copy_const_reference>(),
       "Returns the package this module belongs to.")
  .def("available_params", &_getParamInfoListPython,
       "Return list of all module parameters as `ModuleParamInfo` instances")
  .def("has_properties", &Module::hasProperties, (bp::arg("properties")),
       R"DOCSTRING(Allows to check if the module has the given properties out of `ModulePropFlags` set.
 
>>> if module.has_properties(ModulePropFlags.PARALLELPROCESSINGCERTIFIED):
>>>     ...
 
Parameters:
  properties (int): bitmask of `ModulePropFlags` to check for.
)DOCSTRING")
  .def("set_property_flags", &Module::setPropertyFlags, args("property_mask"),
       "Set module properties in the form of an OR combination of `ModulePropFlags`.");
  {
    // python signature is too crowded, make ourselves
    docstring_options subOptions(true, false, false); //userdef, py sigs, c++ sigs
    module
    .def("if_value", &Module::if_value,
         (bp::arg("expression"), bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOCSTRING(if_value(expression, condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this
module if the return value set in the module passes the given ``expression``.
 
Modules can define a return value (int or bool) using ``setReturnValue()``,
which can be used in the steering file to split the Path based on this value, for example
 
>>> module_with_condition.if_value("<1", another_path)
 
In case the return value of the ``module_with_condition`` for a given event is
less than 1, the execution will be diverted into ``another_path`` for this event.
 
You could for example set a special return value if an error occurs, and divert
the execution into a path containing :b2:mod:`RootOutput` if it is found;
saving only the data producing/produced by the error.
 
After a conditional path has executed, basf2 will by default stop processing
the path for this event. This behaviour can be changed by setting the
``after_condition_path`` argument.
 
Parameters:
  expression (str): Expression to determine if the conditional path should be executed.
      This should be one of the comparison operators ``<``, ``>``, ``<=``,
      ``>=``, ``==``, or ``!=`` followed by a numerical value for the return value
  condition_path (Path): path to execute in case the expression is fulfilled
  after_condition_path (AfterConditionPath): What to do once the ``condition_path`` has been executed.
)DOCSTRING")
    .def("if_false", &Module::if_false,
         (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOC(if_false(condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this module if
the return value of the module evaluates to False. This is equivalent to
calling `if_value` with ``expression=\"<1\"``)DOC")
    .def("if_true", &Module::if_true,
         (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOC(if_true(condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this module if
the return value of the module evaluates to True. It is equivalent to
calling `if_value` with ``expression=\">=1\"``)DOC");
  }
  module
  .def("has_condition", &Module::hasCondition,
       "Return true if a conditional path has been set for this module "
       "using `if_value`, `if_true` or `if_false`")
  .def("get_all_condition_paths", &_getAllConditionPathsPython,
       "Return a list of all conditional paths set for this module using "
       "`if_value`, `if_true` or `if_false`")
  .def("get_all_conditions", &_getAllConditionsPython,
       "Return a list of all conditional path expressions set for this module using "
       "`if_value`, `if_true` or `if_false`")
  .add_property("logging", make_function(&Module::getLogConfig, return_value_policy<reference_existing_object>()),
                &Module::setLogConfig)

getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const

inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

{
  if (m_conditions.empty()) return EAfterConditionPath::c_End;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return condition.getAfterConditionPath();
    }
  }
 
  return EAfterConditionPath::c_End;
}

getAllConditionPaths()

std::vector< std::shared_ptr< Path > > getAllConditionPaths ( ) const

inherited

Return all condition paths currently set (no matter if the condition is true or not).

Definition at line 150 of file Module.cc.

{
  std::vector<std::shared_ptr<Path>> allConditionPaths;
  for (const auto& condition : m_conditions) {
    allConditionPaths.push_back(condition.getPath());
  }
 
  return allConditionPaths;
}

getAllConditions()

const std::vector< ModuleCondition > & getAllConditions ( ) const

inlineinherited

Return all set conditions for this module.

Definition at line 324 of file Module.h.

    {
      return m_conditions;
    }

getCondition()

const ModuleCondition * getCondition ( ) const

inlineinherited

Return a pointer to the first condition (or nullptr, if none was set)

Definition at line 314 of file Module.h.

    {
      if (m_conditions.empty()) {
        return nullptr;
      } else {
        return &m_conditions.front();
      }
    }

getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const

inherited

Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).

Definition at line 113 of file Module.cc.

{
  PathPtr p;
  if (m_conditions.empty()) return p;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return condition.getPath();
    }
  }
 
  // if none of the conditions were true, return a null pointer.
  return p;
}

getDescription()

const std::string & getDescription ( ) const

inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

{return m_description;}

getFileNames()

virtual std::vector< std::string > getFileNames ( bool  outputFiles )

inlinevirtualinherited

Return a list of output filenames for this modules.

This will be called when basf2 is run with "--dry-run" if the module has set either the c_Input or c_Output properties.

If the parameter outputFiles is false (for modules with c_Input) the list of input filenames should be returned (if any). If outputFiles is true (for modules with c_Output) the list of output files should be returned (if any).

If a module has sat both properties this member is called twice, once for each property.

The module should return the actual list of requested input or produced output filenames (including handling of input/output overrides) so that the grid system can handle input/output files correctly.

This function should return the same value when called multiple times. This is especially important when taking the input/output overrides from Environment as they get consumed when obtained so the finalized list of output files should be stored for subsequent calls.

Reimplemented in RootInputModule, StorageRootOutputModule, and RootOutputModule.

Definition at line 134 of file Module.h.

    {
      return std::vector<std::string>();
    }

getInfo()

const PXD::SensorInfo & getInfo ( VxdID  sensorID ) const

inlineprivate

This is a shortcut to getting PXD::SensorInfo from the GeoCache.

Parameters

sensorID

VxdID of the sensor

Returns

SensorInfo object for the desired sensor.

Definition at line 156 of file PXDBackgroundModule.h.

    {
      return dynamic_cast<const PXD::SensorInfo&>(VXD::GeoCache::getInstance().getSensorInfo(sensorID));
    }

getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

{return m_logConfig;}

getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

{ return std::list<ModulePtr>(); }

getName()

const std::string & getName ( ) const

inlineinherited

Returns the name of the module.

This can be changed via e.g. set_name() in the steering file to give more useful names if there is more than one module of the same type.

For identifying the type of a module, using getType() (or type() in Python) is recommended.

Definition at line 187 of file Module.h.

{return m_name;}

getNumSensors()

int getNumSensors ( int  layerNum )

inlineprivate

Get number of sensors in a layer.

Definition at line 178 of file PXDBackgroundModule.h.

    {
      VxdID layerID;
      layerID.setLayerNumber(layerNum);
      int result = 0;
      for (auto ladderID : VXD::GeoCache::getInstance().getLadders(layerID))
        result += VXD::GeoCache::getInstance().getSensors(ladderID).size();
      return result;
    }

getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

{return m_package;}

getParamInfoListPython()

std::shared_ptr< boost::python::list > getParamInfoListPython ( ) const

inherited

Returns a python list of all parameters.

Each item in the list consists of the name of the parameter, a string describing its type, a python list of all default values and the description of the parameter.

Returns

A python list containing the parameters of this parameter list.

Definition at line 279 of file Module.cc.

{
  return m_moduleParamList.getParamInfoListPython();
}

getParamList()

const ModuleParamList & getParamList ( ) const

inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

{ return m_moduleParamList; }

getPathString()

std::string getPathString ( ) const

overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

{
 
  std::string output = getName();
 
  for (const auto& condition : m_conditions) {
    output += condition.getString();
  }
 
  return output;
}

getReturnValue()

int getReturnValue ( ) const

inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

{ return m_returnValue; }

getSensorArea()

double getSensorArea ( VxdID  sensorID ) const

inlineprivate

Return area of the sensor with the given sensor ID.

Definition at line 172 of file PXDBackgroundModule.h.

    {
      const PXD::SensorInfo& info = getInfo(sensorID);
      return info.getWidth() * info.getLength();
    }

getSensorMass()

double getSensorMass ( VxdID  sensorID ) const

inlineprivate

Return mass of the sensor with the given sensor ID.

Definition at line 166 of file PXDBackgroundModule.h.

    {
      const PXD::SensorInfo& info = getInfo(sensorID);
      return info.getWidth() * info.getLength() * info.getThickness() * c_densitySi;
    }

getSensorThickness()

double getSensorThickness ( VxdID  sensorID ) const

inlineprivate

Return thickness of the sensor with the given sensor ID.

Definition at line 161 of file PXDBackgroundModule.h.

    {
      return getInfo(sensorID).getThickness();
    }

getType()

const std::string & getType ( ) const

inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

{
  if (m_type.empty())
    B2FATAL("Module type not set for " << getName());
  return m_type;
}

hasCondition()

bool hasCondition ( ) const

inlineinherited

Returns true if at least one condition was set for the module.

Definition at line 311 of file Module.h.

{ return not m_conditions.empty(); };

hasProperties()

bool hasProperties ( unsigned int  propertyFlags ) const

inherited

Returns true if all specified property flags are available in this module.

Parameters

propertyFlags

Ored EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

{
  return (propertyFlags & m_propertyFlags) == propertyFlags;
}

hasReturnValue()

bool hasReturnValue ( ) const

inlineinherited

Return true if this module has a valid return value set.

Definition at line 378 of file Module.h.

{ return m_hasReturnValue; }

hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const

inherited

Returns true and prints error message if the module has unset parameters which the user has to set in the steering file.

Definition at line 166 of file Module.cc.

{
  auto missing = m_moduleParamList.getUnsetForcedParams();
  std::string allMissing = "";
  for (const auto& s : missing)
    allMissing += s + " ";
  if (!missing.empty())
    B2ERROR("The following required parameters of Module '" << getName() << "' were not specified: " << allMissing <<
            "\nPlease add them to your steering file.");
  return !missing.empty();
}

if_false()

void if_false ( const std::shared_ptr< Path > &  path, EAfterConditionPath  afterConditionPath = EAfterConditionPath::c_End  )

inherited

A simplified version to add a condition to the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

Please be careful: Avoid creating cyclic paths, e.g. by linking a condition to a path which is processed before the path where this module is located in.

It is equivalent to the if_value() method, using the expression "<1". This method is meant to be used together with the setReturnValue(bool value) method.

Parameters

path	Shared pointer to the Path which will be executed if the return value is false.
afterConditionPath	What to do after executing 'path'.

Definition at line 85 of file Module.cc.

{
  if_value("<1", path, afterConditionPath);
}

if_true()

void if_true ( const std::shared_ptr< Path > &  path, EAfterConditionPath  afterConditionPath = EAfterConditionPath::c_End  )

inherited

A simplified version to set the condition of the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

Please be careful: Avoid creating cyclic paths, e.g. by linking a condition to a path which is processed before the path where this module is located in.

It is equivalent to the if_value() method, using the expression ">=1". This method is meant to be used together with the setReturnValue(bool value) method.

Parameters

path	Shared pointer to the Path which will be executed if the return value is true.
afterConditionPath	What to do after executing 'path'.

Definition at line 90 of file Module.cc.

{
  if_value(">=1", path, afterConditionPath);
}

if_value()

void if_value ( const std::string &  expression, const std::shared_ptr< Path > &  path, EAfterConditionPath  afterConditionPath = EAfterConditionPath::c_End  )

inherited

Add a condition to the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

See https://confluence.desy.de/display/BI/Software+ModCondTut or ModuleCondition for a description of the syntax.

Please be careful: Avoid creating cyclic paths, e.g. by linking a condition to a path which is processed before the path where this module is located in.

Parameters

expression	The expression of the condition.
path	Shared pointer to the Path which will be executed if the condition is evaluated to true.
afterConditionPath	What to do after executing 'path'.

Definition at line 79 of file Module.cc.

{
  m_conditions.emplace_back(expression, path, afterConditionPath);
}

initialize()

void initialize ( void  )

overridevirtual

Initialize module.

Reimplemented from Module.

Definition at line 95 of file PXDBackgroundModule.cc.

{
  //Register collections
  StoreObjPtr<FileMetaData> storeFileMetaData(m_storeFileMetaDataName, DataStore::c_Persistent);
  StoreObjPtr<BackgroundMetaData> storeBgMetaData(m_storeBgMetaDataName, DataStore::c_Persistent);
  StoreArray<MCParticle> storeMCParticles(m_storeMCParticlesName);
  StoreArray<PXDSimHit> storeSimHits(m_storeSimHitsName);
  StoreArray<PXDTrueHit> storeTrueHits(m_storeTrueHitsName);
  StoreArray<PXDDigit> storeDigits(m_storeDigitsName);
  StoreArray<PXDCluster> storeClusters(m_storeClustersName);
 
  RelationArray relDigitsMCParticles(storeDigits, storeMCParticles);
  RelationArray relDigitsTrueHits(storeDigits, storeTrueHits);
  RelationArray relMCParticlesTrueHits(storeMCParticles, storeTrueHits);
  RelationArray relTrueHitsSimHits(storeTrueHits, storeSimHits);
 
  // Add two new StoreArrays
  StoreArray<PXDEnergyDepositionEvent> storeEnergyDeposits(m_storeEnergyDepositsName);
  storeEnergyDeposits.registerInDataStore();
  StoreArray<PXDNeutronFluxEvent> storeNeutronFluxes(m_storeNeutronFluxesName);
  storeNeutronFluxes.registerInDataStore();
  StoreArray<PXDOccupancyEvent> storeOccupancyEvents(m_storeOccupancyEventsName);
  storeOccupancyEvents.registerInDataStore();
 
  //Store names to speed up creation later
  m_storeFileMetaDataName = storeFileMetaData.getName();
  m_storeBgMetaDataName = storeBgMetaData.getName();
  m_storeMCParticlesName = storeMCParticles.getName();
  m_storeSimHitsName = storeSimHits.getName();
  m_storeTrueHitsName = storeTrueHits.getName();
  m_storeDigitsName = storeDigits.getName();
  m_relDigitsMCParticlesName = relDigitsMCParticles.getName();
  m_relDigitsTrueHitsName = relDigitsTrueHits.getName();
  m_relParticlesTrueHitsName = relMCParticlesTrueHits.getName();
  m_relTrueHitsSimHitsName = relTrueHitsSimHits.getName();
  m_storeEnergyDepositsName = storeEnergyDeposits.getName();
  m_storeNeutronFluxesName = storeNeutronFluxes.getName();
 
  m_componentTime *= Unit::us;
  m_integrationTime *= Unit::us;
}

pointToGlobal()

const ROOT::Math::XYZVector & pointToGlobal ( VxdID  sensorID, const ROOT::Math::XYZVector &  local  )

private

Convert local sensor coordinates to global.

Definition at line 73 of file PXDBackgroundModule.cc.

{
  static ROOT::Math::XYZVector result(0, 0, 0);
 
  const PXD::SensorInfo& info = getInfo(sensorID);
  result = info.pointToGlobal(local);
  return result;
}

setAbortLevel()

void setAbortLevel ( int  abortLevel )

inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

{
  m_logConfig.setAbortLevel(static_cast<LogConfig::ELogLevel>(abortLevel));
}

setDebugLevel()

void setDebugLevel ( int  debugLevel )

inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

{
  m_logConfig.setDebugLevel(debugLevel);
}

setDescription()

void setDescription ( const std::string &  description )

protectedinherited

Sets the description of the module.

Parameters

description

A description of the module.

Definition at line 214 of file Module.cc.

{
  m_description = description;
}

setLogConfig()

void setLogConfig ( const LogConfig &  logConfig )

inlineinherited

Set the log system configuration.

Definition at line 230 of file Module.h.

{m_logConfig = logConfig;}

setLogInfo()

void setLogInfo ( int  logLevel, unsigned int  logInfo  )

inherited

Configure the printed log information for the given level.

Parameters

logLevel	The log level (one of LogConfig::ELogLevel)
logInfo	What kind of info should be printed? ORed combination of LogConfig::ELogInfo flags.

Definition at line 73 of file Module.cc.

{
  m_logConfig.setLogInfo(static_cast<LogConfig::ELogLevel>(logLevel), logInfo);
}

setLogLevel()

void setLogLevel ( int  logLevel )

inherited

Configure the log level.

Definition at line 55 of file Module.cc.

{
  m_logConfig.setLogLevel(static_cast<LogConfig::ELogLevel>(logLevel));
}

setName()

void setName ( const std::string &  name )

inlineinherited

Set the name of the module.

Note

The module name is set when using the REG_MODULE macro, but the module can be renamed before calling process() using the set_name() function in your steering file.

Parameters

name	The name of the module

Definition at line 214 of file Module.h.

{ m_name = name; };

setParamList()

void setParamList ( const ModuleParamList &  params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

{ m_moduleParamList = params; }

setParamPython()

void setParamPython ( const std::string &  name, const boost::python::object &  pyObj  )

privateinherited

Implements a method for setting boost::python objects.

The method supports the following types: list, dict, int, double, string, bool The conversion of the python object to the C++ type and the final storage of the parameter value is done in the ModuleParam class.

Parameters

name	The unique name of the parameter.
pyObj	The object which should be converted and stored as the parameter value.

Definition at line 234 of file Module.cc.

{
  LogSystem& logSystem = LogSystem::Instance();
  logSystem.updateModule(&(getLogConfig()), getName());
  try {
    m_moduleParamList.setParamPython(name, pyObj);
  } catch (std::runtime_error& e) {
    throw std::runtime_error("Cannot set parameter '" + name + "' for module '"
                             + m_name + "': " + e.what());
  }
 
  logSystem.updateModule(nullptr);
}

setParamPythonDict()

void setParamPythonDict ( const boost::python::dict &  dictionary )

privateinherited

Implements a method for reading the parameter values from a boost::python dictionary.

The key of the dictionary has to be the name of the parameter and the value has to be of one of the supported parameter types.

Parameters

dictionary

The python dictionary from which the parameter values are read.

Definition at line 249 of file Module.cc.

{
 
  LogSystem& logSystem = LogSystem::Instance();
  logSystem.updateModule(&(getLogConfig()), getName());
 
  boost::python::list dictKeys = dictionary.keys();
  int nKey = boost::python::len(dictKeys);
 
  //Loop over all keys in the dictionary
  for (int iKey = 0; iKey < nKey; ++iKey) {
    boost::python::object currKey = dictKeys[iKey];
    boost::python::extract<std::string> keyProxy(currKey);
 
    if (keyProxy.check()) {
      const boost::python::object& currValue = dictionary[currKey];
      setParamPython(keyProxy, currValue);
    } else {
      B2ERROR("Setting the module parameters from a python dictionary: invalid key in dictionary!");
    }
  }
 
  logSystem.updateModule(nullptr);
}

setPropertyFlags()

void setPropertyFlags ( unsigned int  propertyFlags )

inherited

Sets the flags for the module properties.

Parameters

propertyFlags

bitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

{
  m_propertyFlags = propertyFlags;
}

setReturnValue() [1/2]

void setReturnValue ( bool  value )

protectedinherited

Sets the return value for this module as bool.

The bool value is saved as an integer with the convention 1 meaning true and 0 meaning false. The value can be used in the steering file to divide the analysis chain into several paths.

Parameters

value

The value of the return value.

Definition at line 227 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

setReturnValue() [2/2]

void setReturnValue ( int  value )

protectedinherited

Sets the return value for this module as integer.

The value can be used in the steering file to divide the analysis chain into several paths.

Parameters

value

The value of the return value.

Definition at line 220 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

setType()

void setType ( const std::string &  type )

protectedinherited

Set the module type.

Only for use by internal modules (which don't use the normal REG_MODULE mechanism).

Definition at line 48 of file Module.cc.

{
  if (!m_type.empty())
    B2FATAL("Trying to change module type from " << m_type << " is not allowed, the value is assumed to be fixed.");
  m_type = type;
}

terminate()

void terminate ( void  )

overridevirtual

Final summary and cleanup.

Reimplemented from Module.

Definition at line 369 of file PXDBackgroundModule.cc.

{
  // Write out m_data
  ofstream outfile;
  string outfileName(m_outputDirectoryName + m_componentName + "_summary.txt");
  outfile.open(outfileName.c_str(), ios::out | ios::trunc);
  outfile << "component_name\t"
          << "component_time\t"
          << "layer\t"
          << "ladder\t"
          << "sensor\t"
          << "dose\t"
          << "expo\t"
          << "neutronFlux\t"
          << "fired\t"
          << "occupancy"
          << endl;
  double componentTime = m_componentTime / Unit::us;
  for (auto vxdSensor : m_sensorData) {
    outfile << m_componentName.c_str() << "\t"
            << componentTime << "\t"
            << vxdSensor.first.getLayerNumber() << "\t"
            << vxdSensor.first.getLadderNumber() << "\t"
            << vxdSensor.first.getSensorNumber() << "\t"
            << vxdSensor.second.m_dose << "\t"
            << vxdSensor.second.m_expo << "\t"
            << vxdSensor.second.m_neutronFlux << "\t"
            << vxdSensor.second.m_fired << "\t"
            << vxdSensor.second.m_occupancy
            << endl;
  }
  outfile << endl;
}

vectorToGlobal()

const ROOT::Math::XYZVector & vectorToGlobal ( VxdID  sensorID, const ROOT::Math::XYZVector &  local  )

private

Convert local vector coordinates to global.

Definition at line 82 of file PXDBackgroundModule.cc.

{
  static ROOT::Math::XYZVector result(0, 0, 0);
 
  const PXD::SensorInfo& info = getInfo(sensorID);
  result = info.vectorToGlobal(local);
  return result;
}

Member Data Documentation

c_densitySi

const double c_densitySi = 2.3290 * Unit::g_cm3

private

Density of crystalline Silicon.

Definition at line 84 of file PXDBackgroundModule.h.

c_niel_electronFile

const std::string c_niel_electronFile = "/vxd/data/electrons.csv"

private

NIEL-correction file for electrons.

Definition at line 93 of file PXDBackgroundModule.h.

c_niel_neutronFile

const std::string c_niel_neutronFile = "/vxd/data/neutrons.csv"

private

NIEL-correction file for neutrons.

Definition at line 87 of file PXDBackgroundModule.h.

c_niel_pionFile

const std::string c_niel_pionFile = "/vxd/data/pions.csv"

private

NIEL-correction file for pions.

Definition at line 91 of file PXDBackgroundModule.h.

c_niel_protonFile

const std::string c_niel_protonFile = "/vxd/data/protons.csv"

private

NIEL-correction file for protons.

Definition at line 89 of file PXDBackgroundModule.h.

c_reportNone

const unsigned short c_reportNone = 0

static

No reporting.

Definition at line 47 of file PXDBackgroundModule.h.

c_reportNTuple

const unsigned short c_reportNTuple = 2

static

Summary and NTuple.

Definition at line 49 of file PXDBackgroundModule.h.

c_reportSummary

const unsigned short c_reportSummary = 1

static

Summary only.

Definition at line 48 of file PXDBackgroundModule.h.

c_smy

const double c_smy = 1.0e7 * Unit::s

private

Seconds in snowmass year.

Definition at line 85 of file PXDBackgroundModule.h.

m_componentName

std::string m_componentName

private

Name of the current bg component.

Definition at line 142 of file PXDBackgroundModule.h.

m_componentTime

double m_componentTime

private

Time of current component.

Definition at line 143 of file PXDBackgroundModule.h.

m_conditions

std::vector<ModuleCondition> m_conditions

privateinherited

Module condition, only non-null if set.

Definition at line 521 of file Module.h.

m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.h.

m_doseReportingLevel

unsigned short m_doseReportingLevel

private

0 - no data, 1 - summary only, 2 - ntuple

Definition at line 138 of file PXDBackgroundModule.h.

m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

m_integrationTime

double m_integrationTime

private

Integration time of PXD.

Definition at line 144 of file PXDBackgroundModule.h.

m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

m_moduleParamList

ModuleParamList m_moduleParamList

privateinherited

List storing and managing all parameter of the module.

Definition at line 516 of file Module.h.

m_name

std::string m_name

privateinherited

The name of the module, saved as a string (user-modifiable)

Definition at line 508 of file Module.h.

m_nfluxReportingLevel

unsigned short m_nfluxReportingLevel

private

0 - no data, 1 - summary only, 2 - ntuple

Definition at line 139 of file PXDBackgroundModule.h.

m_nielElectrons

std::unique_ptr<TNiel> m_nielElectrons

private

Pointer to Niel table for electrons.

Definition at line 152 of file PXDBackgroundModule.h.

m_nielNeutrons

std::unique_ptr<TNiel> m_nielNeutrons

private

Pointer to Niel table for neutrons.

Definition at line 149 of file PXDBackgroundModule.h.

m_nielPions

std::unique_ptr<TNiel> m_nielPions

private

Pointer to Niel table for pions.

Definition at line 151 of file PXDBackgroundModule.h.

m_nielProtons

std::unique_ptr<TNiel> m_nielProtons

private

Pointer to Niel table for protons.

Definition at line 150 of file PXDBackgroundModule.h.

m_occupancyReportingLevel

unsigned short m_occupancyReportingLevel

private

0 - no data, 1 - summary only, 2 - ntuple

Definition at line 140 of file PXDBackgroundModule.h.

m_outputDirectoryName

std::string m_outputDirectoryName

private

Path to directory where output data will be stored.

Definition at line 119 of file PXDBackgroundModule.h.

m_package

std::string m_package

privateinherited

Package this module is found in (may be empty).

Definition at line 510 of file Module.h.

m_propertyFlags

unsigned int m_propertyFlags

privateinherited

The properties of the module as bitwise or (with |) of EModulePropFlags.

Definition at line 512 of file Module.h.

m_relClusterDigitName

std::string m_relClusterDigitName

private

PXDClustersToPXDDigits RelationArray name.

Definition at line 131 of file PXDBackgroundModule.h.

m_relDigitsMCParticlesName

std::string m_relDigitsMCParticlesName

private

StoreArray name of PXDDigits to MCParticles relation.

Definition at line 128 of file PXDBackgroundModule.h.

m_relDigitsTrueHitsName

std::string m_relDigitsTrueHitsName

private

StoreArray name of PXDDigits to PXDTrueHits relation.

Definition at line 129 of file PXDBackgroundModule.h.

m_relParticlesTrueHitsName

std::string m_relParticlesTrueHitsName

private

MCParticlesToPXDTrueHits RelationArray name.

Definition at line 126 of file PXDBackgroundModule.h.

m_relTrueHitsSimHitsName

std::string m_relTrueHitsSimHitsName

private

PXDTrueHitsToPXDSimHits RelationArray name.

Definition at line 132 of file PXDBackgroundModule.h.

m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 519 of file Module.h.

m_sensorData

std::map<VxdID, SensorData> m_sensorData

private

Struct to hold sensor-wise background data.

Definition at line 146 of file PXDBackgroundModule.h.

m_storeBgMetaDataName

std::string m_storeBgMetaDataName

private

Name of the persistent BackgroundMetaDta object.

Definition at line 121 of file PXDBackgroundModule.h.

m_storeClustersName

std::string m_storeClustersName

private

PXDClusters StoreArray name.

Definition at line 130 of file PXDBackgroundModule.h.

m_storeDigitsName

std::string m_storeDigitsName

private

PXDDigits StoreArray name.

Definition at line 127 of file PXDBackgroundModule.h.

m_storeEnergyDepositsName

std::string m_storeEnergyDepositsName

private

PXDEnergyDepositEvents StoreArray name.

Definition at line 134 of file PXDBackgroundModule.h.

m_storeFileMetaDataName

std::string m_storeFileMetaDataName

private

Name of the persistent FileMetaData object.

Definition at line 120 of file PXDBackgroundModule.h.

m_storeMCParticlesName

std::string m_storeMCParticlesName

private

MCParticles StoreArray name.

Definition at line 123 of file PXDBackgroundModule.h.

m_storeNeutronFluxesName

std::string m_storeNeutronFluxesName

private

PXDNeutronFluxEvents StoreArray name.

Definition at line 135 of file PXDBackgroundModule.h.

m_storeOccupancyEventsName

std::string m_storeOccupancyEventsName

private

PXDOccupancyEvents StoreArray name.

Definition at line 136 of file PXDBackgroundModule.h.

m_storeSimHitsName

std::string m_storeSimHitsName

private

PXDSimHits StoreArray name.

Definition at line 124 of file PXDBackgroundModule.h.

m_storeTrueHitsName

std::string m_storeTrueHitsName

private

PXDTrueHits StoreArray name.

Definition at line 125 of file PXDBackgroundModule.h.

m_type

std::string m_type

privateinherited

The type of the module, saved as a string.

Definition at line 509 of file Module.h.

---

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

• pxd/modules/pxdBackground/include/PXDBackgroundModule.h
• pxd/modules/pxdBackground/src/PXDBackgroundModule.cc