PXDPerformanceCollectorModule Class Reference

Collector module for PXD gain calibration and PXD calibration validation. More...

#include <PXDPerformanceCollectorModule.h>

Inheritance diagram for PXDPerformanceCollectorModule:

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
	PXDPerformanceCollectorModule ()
	Constructor: Sets the description, the properties and the parameters of the module.
void	prepare () override final
	Prepare.
void	collect () override final
	Collect.
void	startRun () override final
	Start run.
void	collectFromTrack (const PXD2TrackEvent::baseType &track)
	Collect info on track level.
void	collectDeltaIP (const PXD2TrackEvent &event)
	Collect info for impact parameter study on event level.
void	initialize () final
	Set up a default RunRange object in datastore and call prepare()
void	event () final
	Check current experiment and run and update if needed, fill into RunRange and collect()
void	beginRun () final
	Reset the m_runCollectOnRun flag, if necessary, to begin collection again.
void	endRun () final
	Write the current collector objects to a file and clear their memory.
void	terminate () final
	Write the final objects to the file.
void	defineHisto () final
	Runs due to HistoManager, allows us to discover the correct file.
template<class T >
void	registerObject (std::string name, T *obj)
	Register object with a name, takes ownership, do not access the pointer beyond prepare()
template<class T >
T *	getObjectPtr (std::string name)
	Calls the CalibObjManager to get the requested stored collector data.
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.

Protected Member Functions
virtual void	closeRun ()
	Replacement for endRun(). Do anything you would normally do in endRun here.
virtual void	finish ()
	Replacement for terminate(). Do anything you would normally do in terminate here.
virtual void	inDefineHisto ()
	Replacement for defineHisto(). Do anything you would normally do in defineHisto here.
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.

Protected Attributes
TDirectory *	m_dir
	The top TDirectory that collector objects for this collector will be stored beneath.
CalibObjManager	m_manager
	Controls the creation, collection and access to calibration objects.
RunRange *	m_runRange
	Overall list of runs processed.
Calibration::ExpRun	m_expRun
	Current ExpRun for object retrieval (becomes -1,-1 for granularity=all)
StoreObjPtr< EventMetaData >	m_emd
	Current EventMetaData.

Private Member Functions
bool	getPreScaleChoice ()
	I'm a little worried about floating point precision when comparing to 0.0 and 1.0 as special values.
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
StoreArray< PXD2TrackEvent >	m_pxd2TrackEvents
	Required input PXD2TrackEvent
StoreObjPtr< EventMetaData >	m_evtMetaData
	Required input EventMetaData.
std::string	m_store2TrackEventsName
	Name of the collection to use for PXD2TrackEvents.
float	m_minPt4Eff
	Minimum pt cut for efficiency monitoring.
float	m_maxAbsVx
	Maximum absolute value for x coordinate of vertex.
float	m_maxAbsVy
	Maximum absolute value for y coordinate of vertex.
float	m_maxAbsVz
	Maximum absolute value for z coordinate of vertex.
float	m_minPt4Res
	Minimum pt cut for resolution monitoring.
int	m_minSVDHits
	Minimum number of SVD hits for resolution.
int	m_minCDCHits
	Minimum number of CDC hits for resolution.
float	m_maxAbsLambda
	Maximum absolute dip angle (lambda)
float	m_minPBetaSinTheta3o2
	Minimum p*Beta*sin(theta_0)^{3/2}.
float	m_maxAbsZ0
	Maximum abs(z0)
float	m_maxAbsD0
	Maximum abs(d0)
float	m_minPt
	Minimum pt cut.
int	m_minClusterCharge
	Minimum cluster charge cut
int	m_minClusterSize
	Minimum cluster size cut.
int	m_maxClusterSize
	Maximum cluster size cut.
int	m_nBinsU
	Number of corrections per sensor along u side.
int	m_nBinsV
	Number of corrections per sensor along v side.
std::string	m_gainName
	Payload name for Gain to be read from DB.
bool	m_fillChargeRatioHistogram
	Flag to fill cluster charge ratio (relative to expected MPV) histograms.
bool	m_fillChargeTree
	Flag to fill cluster charge and its estimated MPV in TTree.
bool	m_fillEventTree
	Flag to fill event tree for validation.
bool	m_selectedEff
	Flag of selection for efficiency validation.
bool	m_selectedRes
	Flag of selection for resolution validation.
PXD2TrackEvent	m_pxd2TrackEvent
	Event holder.
float	m_deltaD0oSqrt2
	(d0_p + d0_m)/sqrt(2)
float	m_deltaZ0oSqrt2
	(z0_p - z0_m)/sqrt(2)
int	m_signal
	Cluster charge in ADU.
float	m_estimated
	Estimated cluster charge in ADU.
int	m_run
	Run number to be stored in dbtree.
int	m_exp
	Experiment number to be stored in dbtree.
PXDGainMapPar	m_gainMap
	GainMap to be stored in dbtree.
std::string	m_granularity
	Granularity of data collection = run|all(= no granularity, exp,run=-1,-1)
int	m_maxEventsPerRun
	Maximum number of events to be collected at the start of each run (-1 = no maximum)
float	m_preScale
	Prescale module parameter, this fraction of events will have collect() run on them [0.0 -> 1.0].
bool	m_runCollectOnRun = true
	Whether or not we will run the collect() at all this run, basically skips the event() function if false.
std::map< Calibration::ExpRun, int >	m_expRunEvents
	How many events processed for each ExpRun so far, stops counting up once max is hit Only used/incremented if m_maxEventsPerRun > -1.
int *	m_eventsCollectedInRun
	Will point at correct value in m_expRunEvents.
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

Collector module for PXD gain calibration and PXD calibration validation.

PXD2TrackEvent data store is required to fill TTree objects or histograms used in gain calibration or the validation algorithm.

For gain calibration, track clusters are already selected in the event class. Further selections based on cluster size/charge and track properties are available. As in the ClusterChargeCollector, this collector also creates a grid of rectangular regions on each sensor (granularity is steerable with nBinsU and nBinsV) and creates TTree objects for each grid region. Cluster charge values and the expected ones are filled into these trees. The gain is later estimated with the MPV of the ratio, cluster charge / expected value, in the calibration algorithm.

Definition at line 46 of file PXDPerformanceCollectorModule.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

PXDPerformanceCollectorModule()

PXDPerformanceCollectorModule

(

)

Constructor: Sets the description, the properties and the parameters of the module.

Definition at line 39 of file PXDPerformanceCollectorModule.cc.

                                                             : CalibrationCollectorModule()
  , m_selectedEff(true), m_selectedRes(true)
  , m_pxd2TrackEvent()
  , m_deltaD0oSqrt2(0.0), m_deltaZ0oSqrt2(0.0)
  , m_signal(0), m_estimated(0.0)
  , m_run(0), m_exp(0)
{
  // Set module properties
  setDescription("Calibration collector module for CDST data.");
  setPropertyFlags(c_ParallelProcessingCertified);
 
  addParam("minPt", m_minPt, "Minimum pt cut", float(1.0));
  addParam("minClusterCharge", m_minClusterCharge, "Minimum cluster charge cut", int(0));
  addParam("minClusterSize", m_minClusterSize, "Minimum cluster size cut ", int(2));
  addParam("maxClusterSize", m_maxClusterSize, "Maximum cluster size cut ", int(6));
  addParam("nBinsU", m_nBinsU, "Number of gain corrections per sensor along u side", int(4));
  addParam("nBinsV", m_nBinsV, "Number of gain corrections per sensor along v side", int(6));
  addParam("gainPayloadName", m_gainName, "Payload name for Gain to be read from DB", string(""));
  addParam("fillChargeRatioHistogram", m_fillChargeRatioHistogram,
           "Flag to fill Ratio (cluster charge to the expected MPV) histograms", bool(true));
  addParam("fillChargeTree", m_fillChargeTree, "Flag to fill cluster charge with the estimated MPV to TTree", bool(false));
  addParam("fillEventTree", m_fillEventTree, "Flag to fill event tree for validation", bool(false));
 
  // additional parameters for validation. Considering modularAnalysis for more flexible controls.
  addParam("minPt4Eff", m_minPt4Eff, "Minimum pt cut for efficiency validation", float(2.0));
  addParam("maxAbsVx", m_maxAbsVx, "Minimum abs(Vx) cut in cm for efficiency validation", float(0.03));
  addParam("maxAbsVy", m_maxAbsVy, "Minimum abs(Vy) cut in cm for efficiency validation", float(0.03));
  addParam("maxAbsVz", m_maxAbsVz, "Minimum abs(Vz) cut in cm for efficiency validation", float(0.155));
 
  addParam("minPt4Res", m_minPt4Res, "Minimum pt cut for resolution validation", float(1.0));
  addParam("minSVDHits", m_minSVDHits, "Minimum number of SVD hits foor resolution validation", int(8));
  addParam("minCDCHits", m_minCDCHits, "Minimum number of CDC hits foor resolution validation", int(21));
  addParam("maxAbsLambda", m_maxAbsLambda, "Maximum absolute dip angle (lambda)", float(0.5));
  addParam("minPBetaSinTheta3o2", m_minPBetaSinTheta3o2, "Minimum p*Beta*sin(theta_0)^{3/2}", float(2));
  addParam("maxAbsZ0", m_maxAbsZ0, "Maximum abs(z0)", float(1));
  addParam("maxAbsD0", m_maxAbsD0, "Maximum abs(d0)", float(0.3));
 
 
}

Member Function Documentation

beginRun()

void beginRun ( void  )

finalvirtualinherited

Reset the m_runCollectOnRun flag, if necessary, to begin collection again.

It seems that the beginRun() function is called in each basf2 subprocess when the run changes in each process. This is nice because it allows us to write the new (exp,run) object creation in the beginRun function as though the other processes don't exist.

Reimplemented from HistoModule.

Definition at line 77 of file CalibrationCollectorModule.cc.

{
  // Current (Exp,Run)
  ExpRun expRun = make_pair(m_emd->getExperiment(), m_emd->getRun());
  m_runRange->add(expRun.first, expRun.second);
 
  // Do we care about the number of events collected in each (input data) ExpRun?
  // If so, we want to create values for the events collected map
  if (m_maxEventsPerRun > -1) {
    // Do we have a count for this ExpRun yet? If not create one
    auto i_eventsInExpRun = m_expRunEvents.find(expRun);
    if (i_eventsInExpRun == m_expRunEvents.end()) {
      m_expRunEvents[expRun] = 0;
    }
 
    // Set our pointer to the correct location for this ExpRun
    m_eventsCollectedInRun = &m_expRunEvents[expRun];
    // Want to reset our flag to start collection if necessary
    if ((*m_eventsCollectedInRun) < m_maxEventsPerRun) {
      B2INFO("New run has had less events than the maximum collected so far ("
             << (*m_eventsCollectedInRun)
             << " < "
             << m_maxEventsPerRun
             << "). Turning on collection.");
      m_runCollectOnRun = true;
    } else {
      B2INFO("New run has had more events than the maximum collected so far ("
             << (*m_eventsCollectedInRun)
             << " >= "
             << m_maxEventsPerRun
             << "). Turning off collection.");
      m_runCollectOnRun = false;
    }
  }
  // Granularity=all removes data splitting by runs by setting
  // always the same exp, run for calibration data objects
  if (m_granularity == "all") {
    m_expRun = { -1, -1};
  } else {
    m_expRun = expRun;
  }
  m_manager.createExpRunDirectories(m_expRun);
  // Run the user's startRun() implementation if there is one
  startRun();
}

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

closeRun()

virtual void closeRun ( )

inlineprotectedvirtualinherited

Replacement for endRun(). Do anything you would normally do in endRun here.

Reimplemented in TOPValidationCollectorModule, MillepedeCollectorModule, CaTestModule, CDCCrudeT0CollectorModule, eclAutocovarianceCalibrationC1CollectorModule, eclAutocovarianceCalibrationC3CollectorModule, eclAutocovarianceCalibrationC4CollectorModule, eclWaveformTemplateCalibrationC1CollectorModule, KLMChannelStatusCollectorModule, KLMStripEfficiencyCollectorModule, SVDCrossTalkCalibrationsCollectorModule, and SVDOccupancyCalibrationsCollectorModule.

Definition at line 77 of file CalibrationCollectorModule.h.

{}

collect()

void collect ( )

finaloverridevirtual

Collect.

Reimplemented from CalibrationCollectorModule.

Definition at line 231 of file PXDPerformanceCollectorModule.cc.

{
  // If no input, nothing to do
  if (!m_pxd2TrackEvents) return;
 
  // Beam spot
  DBObjPtr<BeamSpot> beamSpotDB;
  auto ip = ROOT::Math::XYZVector(beamSpotDB->getIPPosition());
 
  // Actually only one event holder / event
  for (auto& pxd2TrackEvent : m_pxd2TrackEvents) {
    m_selectedRes = true;
    m_selectedEff = true;
 
    auto vertex = pxd2TrackEvent.getVertex();
    vertex -= ip; // correct vertex relative to ip
    if (fabs(vertex.X()) > m_maxAbsVx ||
        fabs(vertex.Y()) > m_maxAbsVy ||
        fabs(vertex.Z()) > m_maxAbsVz)
      m_selectedEff = false;
 
    // track level selection and collection
    collectFromTrack(pxd2TrackEvent.getTrackP());
    collectFromTrack(pxd2TrackEvent.getTrackM());
 
    // event level collection
    collectDeltaIP(pxd2TrackEvent);
 
    if (m_fillEventTree) {
      m_pxd2TrackEvent = pxd2TrackEvent;
      getObjectPtr<TTree>("pxd")->Fill();
    }
  }
 
}

collectDeltaIP()

void collectDeltaIP

(

const PXD2TrackEvent &

event

)

Collect info for impact parameter study on event level.

Parameters

event

PXD2TrackEvent

Definition at line 267 of file PXDPerformanceCollectorModule.cc.

{
  if (!m_selectedRes) return;
  auto d0p_1 = event.getTrackP().d0p;
  auto d0p_2 = event.getTrackM().d0p;
  auto z0p_1 = event.getTrackP().z0p;
  auto z0p_2 = event.getTrackM().z0p;
  m_deltaD0oSqrt2 = (d0p_1 + d0p_2) / sqrt(2.);
  m_deltaZ0oSqrt2 = (z0p_1 - z0p_2) / sqrt(2.);
 
  // Fill the tree of impact parameters
  getObjectPtr<TTree>("tree_d0z0")->Fill();
}

collectFromTrack()

void collectFromTrack

(

const PXD2TrackEvent::baseType &

track

)

Collect info on track level.

Parameters

track

the track struct defined in PXD2TrackEvent

Definition at line 281 of file PXDPerformanceCollectorModule.cc.

{
  auto gTools = VXD::GeoCache::getInstance().getGeoTools();
  bool selected4Gain = true;
  bool selected4Eff  = true;
 
  if (track.pt < m_minPt) selected4Gain = false;
  if (track.pt < m_minPt4Eff) selected4Eff = false;  // just applied on track level
 
  // Track level filtering for resolution validation
  if (track.pt < m_minPt4Res) m_selectedRes = false;
  if (track.nPXDHits < 1 || track.nCDCHits < m_minCDCHits || track.nSVDHits < m_minSVDHits)
    m_selectedRes = false;
  if (fabs(track.d0p) > m_maxAbsD0 || fabs(track.z0p) > m_maxAbsZ0)
    m_selectedRes = false;
  auto lambda0 = atan(track.tanLambda);
  if (fabs(lambda0) > m_maxAbsLambda)
    m_selectedRes = false;
  auto sinTheta0 = 1. / sqrt(1. + pow(track.tanLambda, 2));
  auto pBetaSinTheta3o2 = track.pt * 1.0 * sqrt(sinTheta0);
  if (pBetaSinTheta3o2 < m_minPBetaSinTheta3o2)
    m_selectedRes = false;
 
  for (auto& trackCluster : track.trackClusters) {
    bool selectedCluster = true;
    auto cluster = trackCluster.cluster;
    auto intersection = trackCluster.intersection;
    auto usedInTrack = trackCluster.usedInTrack;
 
    // Check for valid cluster and intersection
    if (!usedInTrack || intersection.chargeMPV <= 0)
      selectedCluster = false;
 
    // Apply cluster selection cuts
    if (cluster.charge < m_minClusterCharge || cluster.size < m_minClusterSize || cluster.size > m_maxClusterSize)
      selectedCluster = false;
 
    if (cluster.pxdID <= 0) {
      B2FATAL("Unexpected cluster module id : " << cluster.pxdID);
 
    }
 
    // Fill tree or histograms for gain calibration
    if (selected4Gain && selectedCluster) {
 
      // Compute variables from cluster needed for gain estimation
      m_signal = cluster.charge;
      m_estimated = intersection.chargeMPV;
 
      VxdID sensorID = PXD::getVxdIDFromPXDModuleID(cluster.pxdID);
      const PXD::SensorInfo& Info = dynamic_cast<const PXD::SensorInfo&>(VXD::GeoCache::getInstance().getSensorInfo(sensorID));
      auto uID = Info.getUCellID(cluster.posU);
      auto vID = Info.getVCellID(cluster.posV);
      auto iSensor = gTools->getPXDSensorIndex(sensorID);
      auto layerNumber = sensorID.getLayerNumber();
      auto ladderNumber = sensorID.getLadderNumber();
      auto sensorNumber = sensorID.getSensorNumber();
      auto uBin = PXD::PXDGainCalibrator::getInstance().getBinU(sensorID, uID, vID, m_nBinsU);
      auto vBin = PXD::PXDGainCalibrator::getInstance().getBinV(sensorID, vID, m_nBinsV);
      // Calculate bin ID based on iSensor, uBin, vBin and number of bins in u/v
      int binID = iSensor * m_nBinsU * m_nBinsV + uBin * m_nBinsV + vBin;
 
      // Increment the counter
      getObjectPtr<TH1I>("PXDClusterCounter")->Fill(binID);
 
      // Fill variabels into tree
      if (m_fillChargeTree) {
        string treename = str(format("tree_%1%_%2%_%3%_%4%_%5%") % layerNumber % ladderNumber % sensorNumber % uBin % vBin);
        getObjectPtr<TTree>(treename)->Fill();
      }
 
      // Fill cluster charge ratio histogram if enabled
      if (m_fillChargeRatioHistogram) {
        double ratio = m_signal / m_estimated;
        auto axis = getObjectPtr<TH2F>("PXDClusterChargeRatio")->GetYaxis();
        double maxY  = axis->GetBinCenter(axis->GetNbins());
        // Manipulate too large ratio for better estimation on median.
        getObjectPtr<TH2F>("PXDClusterChargeRatio")->Fill(binID, TMath::Min(ratio, maxY));
      }
    }
 
    // Fill effciency
    if (m_selectedEff && selected4Eff) {
      auto x = intersection.x;
      auto y = intersection.y;
      auto phi = atan2(y, x);
      auto z = intersection.z;
 
      // Get uBin and vBin from a global point.
      VxdID sensorID = PXD::getVxdIDFromPXDModuleID(cluster.pxdID);
      const PXD::SensorInfo& Info = dynamic_cast<const PXD::SensorInfo&>(VXD::GeoCache::getInstance().getSensorInfo(sensorID));
      auto localPoint = Info.pointToLocal(ROOT::Math::XYZVector(x, y, z));
      auto uID = Info.getUCellID(localPoint.X());
      auto vID = Info.getVCellID(localPoint.Y());
      auto iSensor = gTools->getPXDSensorIndex(sensorID);
      auto uBin = PXD::PXDGainCalibrator::getInstance().getBinU(sensorID, uID, vID, m_nBinsU);
      auto vBin = PXD::PXDGainCalibrator::getInstance().getBinV(sensorID, vID, m_nBinsV);
 
      // Filling counters
      getObjectPtr<TH1I>("PXDTrackPointCounter")->Fill(iSensor * m_nBinsU * m_nBinsV + uBin * m_nBinsV + vBin);
      if (usedInTrack)
        getObjectPtr<TH1I>("PXDTrackClusterCounter")->Fill(iSensor * m_nBinsU * m_nBinsV + uBin * m_nBinsV + vBin);
 
      // Filling 2D histograms
      if (cluster.pxdID < 2000) {
        //getObjectPtr<TEfficiency>("PXDLayer1Efficiency")->Fill(usedInTrack,phi,z);
        getObjectPtr<TH2F>("hTotalHitsLayer1")->Fill(phi, z);
        if (usedInTrack)
          getObjectPtr<TH2F>("hPassedHitsLayer1")->Fill(phi, z);
      } else {
        //getObjectPtr<TEfficiency>("PXDLayer2Efficiency")->Fill(usedInTrack,phi,z);
        getObjectPtr<TH2F>("hTotalHitsLayer2")->Fill(phi, z);
        if (usedInTrack)
          getObjectPtr<TH2F>("hPassedHitsLayer2")->Fill(phi, z);
      }
    }
 
  } // end loop trackClusters
 
}

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(); }

defineHisto()

void defineHisto ( )

finalvirtualinherited

Runs due to HistoManager, allows us to discover the correct file.

Reimplemented from HistoModule.

Definition at line 127 of file CalibrationCollectorModule.cc.

{
  if (!ProcHandler::parallelProcessingUsed() || ProcHandler::isWorkerProcess()) {
    m_dir = gDirectory->mkdir(getName().c_str(), "", true);
    m_manager.setDirectory(m_dir);
    B2INFO("Saving output to TDirectory " << m_dir->GetPath());
    B2DEBUG(100, "Creating directories for individual collector objects.");
    m_manager.createDirectories();
    m_runRange = new RunRange();
    m_runRange->setGranularity(m_granularity);
    m_runRange->SetName(Calibration::RUN_RANGE_OBJ_NAME.c_str());
    m_dir->Add(m_runRange);
  }
  inDefineHisto();
}

endRun()

void endRun ( void  )

finalvirtualinherited

Write the current collector objects to a file and clear their memory.

Reimplemented from HistoModule.

Definition at line 143 of file CalibrationCollectorModule.cc.

{
  closeRun();
  // Moving between runs possibly creates new objects if getObjectPtr is called and granularity is run
  // So we should write and clear the current memory objects.
  if (m_granularity == "run") {
    ExpRun expRun = make_pair(m_emd->getExperiment(), m_emd->getRun());
    m_manager.writeCurrentObjects(expRun);
    m_manager.clearCurrentObjects(expRun);
  }
}

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  )

finalvirtualinherited

Check current experiment and run and update if needed, fill into RunRange and collect()

Reimplemented from HistoModule.

Definition at line 52 of file CalibrationCollectorModule.cc.

{
  // Should we collect data this event based on the number collected in the run?
  if (m_runCollectOnRun) {
    // If yes, does our preScale return true?
    if (getPreScaleChoice()) {
      collect();
      // Since we collected, do we care about incrementing the number of events collected?
      if (m_maxEventsPerRun > -1) {
        (*m_eventsCollectedInRun) += 1;
        // Now that we incremented, have we exceeded our maximum collected events in this run?
        if ((*m_eventsCollectedInRun) >= m_maxEventsPerRun) {
          // If we have, we should skip collection until further notice
          B2INFO("Reached maximum number of events processed by collector for this run ("
                 << (*m_eventsCollectedInRun)
                 << " >= "
                 << m_maxEventsPerRun
                 << "). Turning off collection.");
          m_runCollectOnRun = false;
        }
      }
    }
  }
}

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://xwiki.desy.de/xwiki/rest/p/f4fa4/#HModuleDevelopment
 
)");
  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)

finish()

virtual void finish ( )

inlineprotectedvirtualinherited

Replacement for terminate(). Do anything you would normally do in terminate here.

Reimplemented in MillepedeCollectorModule, CaTestModule, CDCCalibrationCollectorModule, CDCFudgeFactorCalibrationCollectorModule, CDCT0CalibrationCollectorModule, CDCCrudeT0CollectorModule, EKLMAlignmentAlongStripsCollectorModule, KLMStripEfficiencyCollectorModule, KLMTimeCollectorModule, SVDCrossTalkCalibrationsCollectorModule, and SVDOccupancyCalibrationsCollectorModule.

Definition at line 79 of file CalibrationCollectorModule.h.

{}

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>();
    }

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

getObjectPtr()

T * getObjectPtr ( std::string  name )

inlineinherited

Calls the CalibObjManager to get the requested stored collector data.

Definition at line 64 of file CalibrationCollectorModule.h.

    {
      return m_manager.getObject<T>(name, m_expRun);
    }

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

getPreScaleChoice()

bool getPreScaleChoice ( )

inlineprivateinherited

I'm a little worried about floating point precision when comparing to 0.0 and 1.0 as special values.

But since a user will have set them (or left them as default) as exactly equal to 0.0 or 1.0 rather than calculating them in almost every case, I think we can assume that the equalities hold.

Definition at line 122 of file CalibrationCollectorModule.h.

    {
      if (m_preScale == 1.) {
        return true;
      } else if (m_preScale == 0.) {
        return false;
      } else {
        const double randomNumber = gRandom->Uniform();
        return randomNumber < m_preScale;
      }
    }

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

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://xwiki.desy.de/xwiki/rest/p/a94f2 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);
}

inDefineHisto()

virtual void inDefineHisto ( )

inlineprotectedvirtualinherited

Replacement for defineHisto(). Do anything you would normally do in defineHisto here.

Reimplemented in CaTestModule, ECLBhabhaTCollectorModule, eclBhabhaTimeCalibrationValidationCollectorModule, eclHadronTimeCalibrationValidationCollectorModule, and eclTimeShiftsPlottingCollectorModule.

Definition at line 81 of file CalibrationCollectorModule.h.

{}

initialize()

void initialize ( void  )

finalvirtualinherited

Set up a default RunRange object in datastore and call prepare()

Reimplemented from HistoModule.

Definition at line 44 of file CalibrationCollectorModule.cc.

{
  m_evtMetaData.isRequired();
  REG_HISTOGRAM
  prepare();
}

prepare()

void prepare ( )

finaloverridevirtual

Prepare.

Reimplemented from CalibrationCollectorModule.

Definition at line 79 of file PXDPerformanceCollectorModule.cc.

{
  m_pxd2TrackEvents.isRequired(m_store2TrackEventsName);
 
  if (m_nBinsU == 0) {
    B2WARNING("Number of bins along u side incremented from 0->1");
    m_nBinsU = 1;
  }
 
  if (m_nBinsV == 0) {
    B2WARNING("Number of bins along v side incremented from 0->1");
    m_nBinsV = 1;
  }
 
  auto gTools = VXD::GeoCache::getInstance().getGeoTools();
  int nPXDSensors = gTools->getNumberOfPXDSensors();
 
  //-------------------------------------------------------------------------------------
  // PXDClusterCounter: Count the number of PXDClusters and store charge for each uBin/vBin pair
  //-------------------------------------------------------------------------------------
 
  auto hPXDClusterCounter = new TH1I("hPXDClusterCounter", "Number of clusters found in data sample",
                                     m_nBinsU * m_nBinsV * nPXDSensors, 0,
                                     m_nBinsU * m_nBinsV * nPXDSensors);
  hPXDClusterCounter->GetXaxis()->SetTitle("bin id");
  hPXDClusterCounter->GetYaxis()->SetTitle("Number of clusters");
  auto hPXDClusterChargeRatio = new TH2F("hPXDClusterChargeRatio", "Charge ratio of clusters found in data sample",
                                         m_nBinsU * m_nBinsV * nPXDSensors, 0,
                                         m_nBinsU * m_nBinsV * nPXDSensors,
                                         400, 0., 4.);
  hPXDClusterChargeRatio->GetXaxis()->SetTitle("bin id");
  hPXDClusterChargeRatio->GetYaxis()->SetTitle("Cluster charge ratio (relative to expected MPV)");
  //auto hPXDTrackClusterCounter = new TH1I("hPXDTrackClusterCounter", "Number of clusters found in data sample",
  //m_nBinsU * m_nBinsV * nPXDSensors, 0,
  //m_nBinsU * m_nBinsV * nPXDSensors);
  //hPXDTrackClusterCounter->GetXaxis()->SetTitle("bin id");
  //hPXDTrackClusterCounter->GetYaxis()->SetTitle("Number of clusters");
  //auto hPXDTrackPointCounter = new TH1I("hPXDTrackPointCounter", "Number of clusters found in data sample",
  //m_nBinsU * m_nBinsV * nPXDSensors, 0,
  //m_nBinsU * m_nBinsV * nPXDSensors);
  //hPXDTrackPointCounter->GetXaxis()->SetTitle("bin id");
  //hPXDTrackPointCounter->GetYaxis()->SetTitle("Number of clusters");
  for (int iSensor = 0; iSensor < nPXDSensors; iSensor++) {
    for (int uBin = 0; uBin < m_nBinsU; uBin++) {
      for (int vBin = 0; vBin < m_nBinsV; vBin++) {
        VxdID id = gTools->getSensorIDFromPXDIndex(iSensor);
        string sensorDescr = id;
        hPXDClusterCounter->GetXaxis()->SetBinLabel(iSensor * m_nBinsU * m_nBinsV + uBin * m_nBinsV + vBin + 1,
                                                    str(format("%1%_%2%_%3%") % sensorDescr % uBin % vBin).c_str());
        if (m_fillChargeRatioHistogram)
          hPXDClusterChargeRatio->GetXaxis()->SetBinLabel(iSensor * m_nBinsU * m_nBinsV + uBin * m_nBinsV + vBin + 1,
                                                          str(format("%1%_%2%_%3%") % sensorDescr % uBin % vBin).c_str());
        //hPXDTrackClusterCounter->GetXaxis()->SetBinLabel(iSensor * m_nBinsU * m_nBinsV + uBin * m_nBinsV + vBin + 1,
        //str(format("%1%_%2%_%3%") % sensorDescr % uBin % vBin).c_str());
        //hPXDTrackPointCounter->GetXaxis()->SetBinLabel(iSensor * m_nBinsU * m_nBinsV + uBin * m_nBinsV + vBin + 1,
        //str(format("%1%_%2%_%3%") % sensorDescr % uBin % vBin).c_str());
      }
    }
  }
 
  registerObject<TH1I>("PXDClusterCounter", hPXDClusterCounter);
  if (m_fillChargeRatioHistogram)
    registerObject<TH2F>("PXDClusterChargeRatio", hPXDClusterChargeRatio);
 
  //-------------------------------------------------------------------------------------
  // PXDTrackClusterCounter: Count the number of PXDClustersFrom tracks (the same track selection as for track points)
  //-------------------------------------------------------------------------------------
  auto hPXDTrackClusterCounter = (TH1I*)hPXDClusterCounter->Clone("hPXDTrackClusterCounter");
  hPXDTrackClusterCounter->SetTitle("Number of track clusters");
  hPXDTrackClusterCounter->GetYaxis()->SetTitle("Number of track clusters");
  registerObject<TH1I>("PXDTrackClusterCounter", hPXDTrackClusterCounter);
 
  //-------------------------------------------------------------------------------------
  // PXDTrackPointCounter: Count the number of PXDClustersFrom tracks (the same track selection as for track points)
  //-------------------------------------------------------------------------------------
  auto hPXDTrackPointCounter = (TH1I*)hPXDClusterCounter->Clone("hPXDTrackPointCounter");
  hPXDTrackPointCounter->SetTitle("Number of track points");
  hPXDTrackPointCounter->GetYaxis()->SetTitle("Number of track points");
  registerObject<TH1I>("PXDTrackPointCounter", hPXDTrackPointCounter);
 
  //----------------------------------------------------------------------
  // PXDTrees for gain calibration: One tree to store the calibration data for each grid bin
  //----------------------------------------------------------------------
 
  if (m_fillChargeTree) // only fill the tree when required
    for (int iSensor = 0; iSensor < nPXDSensors; iSensor++) {
      for (int uBin = 0; uBin < m_nBinsU; uBin++) {
        for (int vBin = 0; vBin < m_nBinsV; vBin++) {
          VxdID id = gTools->getSensorIDFromPXDIndex(iSensor);
          auto layerNumber = id.getLayerNumber();
          auto ladderNumber = id.getLadderNumber();
          auto sensorNumber = id.getSensorNumber();
          string treename = str(format("tree_%1%_%2%_%3%_%4%_%5%") % layerNumber % ladderNumber % sensorNumber % uBin % vBin);
          auto tree = new TTree(treename.c_str(), treename.c_str());
          tree->Branch<int>("signal", &m_signal);
          tree->Branch<float>("estimated", &m_estimated);
          registerObject<TTree>(treename, tree);
        }
      }
    }
 
  // TEfficiency for validation, no Reset() and may be questionable for merging
  //auto effPXDLayer1 = new TEfficiency("PXDLayer1Efficiency", "Efficiency of PXD innner layer;#phi;#z [cm];#epsilon", 730, -M_PI, M_PI, 400, -3.2, 6.2);
  //auto effPXDLayer2 = new TEfficiency("PXDLayer2Efficiency", "Efficiency of PXD outer layer;#phi;#z [cm];#epsilon", 128, 1.4, 2.5, 400, -4.2, 8.2);
  //registerObject<TEfficiency>("PXDLayer1Efficiency", effPXDLayer1);
  //registerObject<TEfficiency>("PXDLayer2Efficiency", effPXDLayer2);
  auto hTotalHitsLayer1  = new TH2F("hTotalHitsLayer1",  "Total number of hits from layer 1;#phi;z [cm]",  730, -M_PI, M_PI, 400,
                                    -3.2, 6.2);
  auto hPassedHitsLayer1 = new TH2F("hPassedHitsLayer1", "Passed number of hits from layer 1;#phi;z [cm]", 730, -M_PI, M_PI, 400,
                                    -3.2, 6.2);
  auto hTotalHitsLayer2  = new TH2F("hTotalHitsLayer2",  "Total number of hits from layer 2;#phi;z [cm]",  128,   1.4,  2.5, 400,
                                    -4.2, 8.2);
  auto hPassedHitsLayer2 = new TH2F("hPassedHitsLayer2", "Passed number of hits from layer 2;#phi;z [cm]", 128,   1.4,  2.5, 400,
                                    -4.2, 8.2);
  registerObject<TH2F>("hTotalHitsLayer1", hTotalHitsLayer1);
  registerObject<TH2F>("hPassedHitsLayer1", hPassedHitsLayer1);
  registerObject<TH2F>("hTotalHitsLayer2", hTotalHitsLayer2);
  registerObject<TH2F>("hPassedHitsLayer2", hPassedHitsLayer2);
 
  // trees for correctd d0 and z0 to the IP
  auto treeD0Z0 = new TTree("tree_d0z0", "TTree of corrected d0 and z0");
  treeD0Z0->Branch<float>("d0", &m_deltaD0oSqrt2);
  treeD0Z0->Branch<float>("z0", &m_deltaZ0oSqrt2);
  registerObject<TTree>("tree_d0z0", treeD0Z0);
 
  // dbtree
  auto dbtree = new TTree("dbtree", "dbtree");
  dbtree->Branch<int>("run", &m_run);
  dbtree->Branch<int>("exp", &m_exp);
  dbtree->Branch<PXDGainMapPar>("gainMap", &m_gainMap);
  registerObject<TTree>("dbtree", dbtree);
 
  if (m_fillEventTree) {
    auto tree = new TTree("pxd", "PXD 2-track events");
    tree->Branch<PXD2TrackEvent>("PXD2TrackEvent", &m_pxd2TrackEvent, 8000, 1);
    registerObject<TTree>("pxd", tree);
  }
}

registerObject()

void registerObject ( std::string  name, T *  obj  )

inlineinherited

Register object with a name, takes ownership, do not access the pointer beyond prepare()

Definition at line 55 of file CalibrationCollectorModule.h.

    {
      std::shared_ptr<T> calObj(obj);
      calObj->SetName(name.c_str());
      m_manager.addObject(name, calObj);
    }

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

startRun()

void startRun ( )

finaloverridevirtual

Start run.

Reimplemented from CalibrationCollectorModule.

Definition at line 218 of file PXDPerformanceCollectorModule.cc.

{
  m_run = m_evtMetaData->getRun();
  m_exp = m_evtMetaData->getExperiment();
  if (m_gainName.length()) {
    DBObjPtr<PXDGainMapPar> gainMap(m_gainName);
    m_gainMap = *gainMap;
  } else {
    m_gainMap = PXDGainMapPar();
  }
  getObjectPtr<TTree>("dbtree")->Fill();
}

terminate()

void terminate ( void  )

finalvirtualinherited

Write the final objects to the file.

Reimplemented from HistoModule.

Definition at line 155 of file CalibrationCollectorModule.cc.

{
  finish();
  // actually this should be done by the write() called by HistoManager....
 
  // Haven't written objects yet if collecting with granularity == all
  // Write them now that everything is done.
//  if (m_granularity == "all") {
//    m_manager.writeCurrentObjects(m_expRun);
//    m_manager.clearCurrentObjects(m_expRun);
//  }
  m_manager.deleteHeldObjects();
}

Member Data Documentation

m_conditions

std::vector<ModuleCondition> m_conditions

privateinherited

Module condition, only non-null if set.

Definition at line 521 of file Module.h.

m_deltaD0oSqrt2

float m_deltaD0oSqrt2

private

(d0_p + d0_m)/sqrt(2)

Definition at line 135 of file PXDPerformanceCollectorModule.h.

m_deltaZ0oSqrt2

float m_deltaZ0oSqrt2

private

(z0_p - z0_m)/sqrt(2)

Definition at line 137 of file PXDPerformanceCollectorModule.h.

m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.h.

m_dir

TDirectory* m_dir

protectedinherited

The top TDirectory that collector objects for this collector will be stored beneath.

Definition at line 84 of file CalibrationCollectorModule.h.

m_emd

StoreObjPtr<EventMetaData> m_emd

protectedinherited

Current EventMetaData.

Definition at line 96 of file CalibrationCollectorModule.h.

m_estimated

float m_estimated

private

Estimated cluster charge in ADU.

Definition at line 141 of file PXDPerformanceCollectorModule.h.

m_eventsCollectedInRun

int* m_eventsCollectedInRun

privateinherited

Will point at correct value in m_expRunEvents.

Definition at line 117 of file CalibrationCollectorModule.h.

m_evtMetaData

StoreObjPtr<EventMetaData> m_evtMetaData

private

Required input EventMetaData.

Definition at line 76 of file PXDPerformanceCollectorModule.h.

m_exp

int m_exp

private

Experiment number to be stored in dbtree.

Definition at line 145 of file PXDPerformanceCollectorModule.h.

m_expRun

Calibration::ExpRun m_expRun

protectedinherited

Current ExpRun for object retrieval (becomes -1,-1 for granularity=all)

Definition at line 93 of file CalibrationCollectorModule.h.

m_expRunEvents

std::map<Calibration::ExpRun, int> m_expRunEvents

privateinherited

How many events processed for each ExpRun so far, stops counting up once max is hit Only used/incremented if m_maxEventsPerRun > -1.

Definition at line 115 of file CalibrationCollectorModule.h.

m_fillChargeRatioHistogram

bool m_fillChargeRatioHistogram

private

Flag to fill cluster charge ratio (relative to expected MPV) histograms.

Definition at line 121 of file PXDPerformanceCollectorModule.h.

m_fillChargeTree

bool m_fillChargeTree

private

Flag to fill cluster charge and its estimated MPV in TTree.

Definition at line 123 of file PXDPerformanceCollectorModule.h.

m_fillEventTree

bool m_fillEventTree

private

Flag to fill event tree for validation.

Definition at line 126 of file PXDPerformanceCollectorModule.h.

m_gainMap

PXDGainMapPar m_gainMap

private

GainMap to be stored in dbtree.

Definition at line 147 of file PXDPerformanceCollectorModule.h.

m_gainName

std::string m_gainName

private

Payload name for Gain to be read from DB.

Definition at line 119 of file PXDPerformanceCollectorModule.h.

m_granularity

std::string m_granularity

privateinherited

Granularity of data collection = run|all(= no granularity, exp,run=-1,-1)

Definition at line 101 of file CalibrationCollectorModule.h.

m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

m_manager

CalibObjManager m_manager

protectedinherited

Controls the creation, collection and access to calibration objects.

Definition at line 87 of file CalibrationCollectorModule.h.

m_maxAbsD0

float m_maxAbsD0

private

Maximum abs(d0)

Definition at line 103 of file PXDPerformanceCollectorModule.h.

m_maxAbsLambda

float m_maxAbsLambda

private

Maximum absolute dip angle (lambda)

Definition at line 97 of file PXDPerformanceCollectorModule.h.

m_maxAbsVx

float m_maxAbsVx

private

Maximum absolute value for x coordinate of vertex.

Definition at line 84 of file PXDPerformanceCollectorModule.h.

m_maxAbsVy

float m_maxAbsVy

private

Maximum absolute value for y coordinate of vertex.

Definition at line 86 of file PXDPerformanceCollectorModule.h.

m_maxAbsVz

float m_maxAbsVz

private

Maximum absolute value for z coordinate of vertex.

Definition at line 88 of file PXDPerformanceCollectorModule.h.

m_maxAbsZ0

float m_maxAbsZ0

private

Maximum abs(z0)

Definition at line 101 of file PXDPerformanceCollectorModule.h.

m_maxClusterSize

int m_maxClusterSize

private

Maximum cluster size cut.

Definition at line 112 of file PXDPerformanceCollectorModule.h.

m_maxEventsPerRun

int m_maxEventsPerRun

privateinherited

Maximum number of events to be collected at the start of each run (-1 = no maximum)

Definition at line 103 of file CalibrationCollectorModule.h.

m_minCDCHits

int m_minCDCHits

private

Minimum number of CDC hits for resolution.

Definition at line 95 of file PXDPerformanceCollectorModule.h.

m_minClusterCharge

int m_minClusterCharge

private

Minimum cluster charge cut

Definition at line 108 of file PXDPerformanceCollectorModule.h.

m_minClusterSize

int m_minClusterSize

private

Minimum cluster size cut.

Definition at line 110 of file PXDPerformanceCollectorModule.h.

m_minPBetaSinTheta3o2

float m_minPBetaSinTheta3o2

private

Minimum p*Beta*sin(theta_0)^{3/2}.

Definition at line 99 of file PXDPerformanceCollectorModule.h.

m_minPt

float m_minPt

private

Minimum pt cut.

Definition at line 106 of file PXDPerformanceCollectorModule.h.

m_minPt4Eff

float m_minPt4Eff

private

Minimum pt cut for efficiency monitoring.

Definition at line 82 of file PXDPerformanceCollectorModule.h.

m_minPt4Res

float m_minPt4Res

private

Minimum pt cut for resolution monitoring.

Definition at line 91 of file PXDPerformanceCollectorModule.h.

m_minSVDHits

int m_minSVDHits

private

Minimum number of SVD hits for resolution.

Definition at line 93 of file PXDPerformanceCollectorModule.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_nBinsU

int m_nBinsU

private

Number of corrections per sensor along u side.

Definition at line 115 of file PXDPerformanceCollectorModule.h.

m_nBinsV

int m_nBinsV

private

Number of corrections per sensor along v side.

Definition at line 117 of file PXDPerformanceCollectorModule.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_preScale

float m_preScale

privateinherited

Prescale module parameter, this fraction of events will have collect() run on them [0.0 -> 1.0].

Definition at line 105 of file CalibrationCollectorModule.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_pxd2TrackEvent

PXD2TrackEvent m_pxd2TrackEvent

private

Event holder.

Definition at line 133 of file PXDPerformanceCollectorModule.h.

m_pxd2TrackEvents

StoreArray<PXD2TrackEvent> m_pxd2TrackEvents

private

Required input PXD2TrackEvent

Definition at line 74 of file PXDPerformanceCollectorModule.h.

m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 519 of file Module.h.

m_run

int m_run

private

Run number to be stored in dbtree.

Definition at line 143 of file PXDPerformanceCollectorModule.h.

m_runCollectOnRun

bool m_runCollectOnRun = true

privateinherited

Whether or not we will run the collect() at all this run, basically skips the event() function if false.

Definition at line 111 of file CalibrationCollectorModule.h.

m_runRange

RunRange* m_runRange

protectedinherited

Overall list of runs processed.

Definition at line 90 of file CalibrationCollectorModule.h.

m_selectedEff

bool m_selectedEff

private

Flag of selection for efficiency validation.

Definition at line 128 of file PXDPerformanceCollectorModule.h.

m_selectedRes

bool m_selectedRes

private

Flag of selection for resolution validation.

Definition at line 130 of file PXDPerformanceCollectorModule.h.

m_signal

int m_signal

private

Cluster charge in ADU.

Definition at line 139 of file PXDPerformanceCollectorModule.h.

m_store2TrackEventsName

std::string m_store2TrackEventsName

private

Name of the collection to use for PXD2TrackEvents.

Definition at line 79 of file PXDPerformanceCollectorModule.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/pxdPerformanceCollector/include/PXDPerformanceCollectorModule.h
• pxd/modules/pxdPerformanceCollector/src/PXDPerformanceCollectorModule.cc