AlignDQMModule Class Reference

DQM of Alignment for off line residuals per sensor, layer, keep also On-Line DQM from tracking: their momentum, Number of hits in tracks, Number of tracks. More...

#include <AlignDQMModule.h>

Inheritance diagram for AlignDQMModule:

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
	AlignDQMModule ()
	Constructor.
virtual void	event () override
	Module function event.
virtual void	endRun () override
	Module function endRun.
virtual void	defineHisto () override
	Histogram definitions such as TH1(), TH2(), TNtuple(), TTree()....
virtual TH1F *	Create (std::string name, std::string title, int nbinsx, double xlow, double xup, std::string xTitle, std::string yTitle) override
	Function to create TH1F and add it to the vector of histograms (m_histograms).
virtual TH2F *	Create (std::string name, std::string title, int nbinsx, double xlow, double xup, int nbinsy, double ylow, double yup, std::string xTitle, std::string yTitle, std::string zTitle) override
	Same as above but for TH2F.
virtual void	initialize () override
	Initializer.
virtual void	beginRun () override
	Called when entering a new run.
void	runningOnHLT ()
	function called when the module is run on HLT
virtual TH1F **	CreateLayers (boost::format nameTemplate, boost::format titleTemplate, int nbinsx, double xlow, double xup, std::string xTitle, std::string yTitle)
	Function to create array of TH1F histograms, one for each layer.
virtual TH2F **	CreateLayers (boost::format nameTemplate, boost::format titleTemplate, int nbinsx, double xlow, double xup, int nbinsy, double ylow, double yup, std::string xTitle, std::string yTitle, std::string zTitle)
	Same as above but for TH2F.
virtual TH1F **	CreateSensors (boost::format nameTemplate, boost::format titleTemplate, int nbinsx, double xlow, double xup, std::string xTitle, std::string yTitle)
	Function to create array of TH1F histograms, one for each sensor.
virtual TH2F **	CreateSensors (boost::format nameTemplate, boost::format titleTemplate, int nbinsx, double xlow, double xup, int nbinsy, double ylow, double yup, std::string xTitle, std::string yTitle, std::string zTitle)
	Same as above but for TH2F.
virtual void	terminate () override
	Function to terminate module.
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.
Fill- functions
All the following Fill- functions are used by DQMEventProcessorBase or derived classes to fill histograms. They are supposed not to contain any computations need for more than one of them. All computations should be moved to the DQMEventProcessorBase or derived classes.
virtual void	FillHelixParametersAndCorrelations (const TrackFitResult *tfr) override
	Fill histograms with helix parameters and their correlations.
virtual void	FillPositionSensors (ROOT::Math::XYZVector residual_um, ROOT::Math::XYZVector position, int sensorIndex)
	Fill histograms which depend on position for individual sensors.
virtual void	FillLayers (ROOT::Math::XYZVector residual_um, float phi_deg, float theta_deg, int layerIndex)
	Fill histograms which depend on layerIndex.
Fill- functions
All the following Fill- functions are used by DQMEventProcessorBase or derived classes to fill histograms. They are supposed not to contain any computations need for more than one of them. All computations should be moved to the DQMEventProcessorBase or derived classes.
virtual void	FillTrackIndexes (int iTrack, int iTrackVXD, int iTrackCDC, int iTrackVXDCDC)
	Fill histograms with track indexes.
virtual void	FillHitNumbers (int nPXD, int nSVD, int nCDC)
	Fill histograms with numbers of hits.
virtual void	FillMomentumAngles (const TrackFitResult *tfr)
	Fill histograms with track momentum Pt.
virtual void	FillMomentumCoordinates (const TrackFitResult *tfr)
	Fill histograms with track momentum Pt.
virtual void	FillTrackFitStatus (const genfit::FitStatus *tfs)
	Fill histograms which require FitStatus.
virtual void	FillTRClusterCorrelations (float phi_deg, float phiPrev_deg, float theta_deg, float thetaPrev_deg, int correlationIndex)
	Fill histograms with correlations between neighbor layers.
virtual void	FillTRClusterHitmap (float phi_deg, float theta_deg, int layerIndex)
	Fill cluster hitmap in IP angle range.
virtual void	FillUBResidualsPXD (const B2Vector3D &residual_um)
	Fill histograms with unbiased residuals in PXD sensors.
virtual void	FillUBResidualsSVD (const B2Vector3D &residual_um)
	Fill histograms with unbiased residuals in SVD sensors.
virtual void	FillHalfShellsPXD (const B2Vector3D &globalResidual_um, bool isNotYang)
	Fill histograms with unbiased residuals for half-shells for PXD sensors.
virtual void	FillHalfShellsSVD (const B2Vector3D &globalResidual_um, bool isNotMat)
	Fill histograms with unbiased residuals for half-shells for SVD sensors.
virtual void	FillUB1DResidualsSensor (const B2Vector3D &residual_um, int sensorIndex)
	Fill 1D histograms with unbiased residuals for individual sensors.
virtual void	FillUB2DResidualsSensor (const B2Vector3D &residual_um, int sensorIndex)
	Fill 2D histograms with unbiased residuals for individual sensors.

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

Protected Member Functions
void	ProcessHistogramParameterChange (const std::string &name, const std::string &parameter, const std::string &value)
	Process one change in histogram parameters.
void	EditHistogramParameter (TH1 *histogram, const std::string &parameter, std::string value)
	On given histogram sets given parameter to given value.
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.
virtual void	DefineHelixParametersAndCorrelations () override
	All the following Define- functions should be used in the defineHisto() function to define histograms.
void	DefineSensors ()
	Define histograms which depend on position for individual sensors.
virtual void	DefineLayers ()
	Define histograms which depend on layerIndex.
virtual void	DefineTracks ()
	All the following Define- functions should be used in the defineHisto() function to define histograms.
virtual void	DefineHits ()
	Define histograms with numbers of hits.
virtual void	DefineMomentumAngles ()
	Define histograms with track momentum Pt.
virtual void	DefineMomentumCoordinates ()
	Define histograms with track momentum Pt.
virtual void	DefineTrackFitStatus ()
	Define histograms which require FitStatus.
virtual void	DefineTRClusters ()
	Define histograms with correlations between neighbor layers and cluster hitmap in IP angle range.
virtual void	DefineUBResidualsVXD ()
	Define histograms with unbiased residuals in PXD and SVD sensors.
virtual void	DefineHalfShellsVXD ()
	Define histograms with unbiased residuals for half-shells for PXD and SVD sensors.
virtual void	Define1DSensors ()
	Define 1D histograms with unbiased residuals for individual sensors.
virtual void	Define2DSensors ()
	Define 2D histograms with unbiased residuals for individual sensors.

Static Protected Member Functions
static std::string	SensorNameDescription (VxdID sensorID)
	Creates string description of the sensor from given sensor ID to be used in a histogram name.
static std::string	SensorTitleDescription (VxdID sensorID)
	Creates string description of the sensor from given sensor ID to be used in a histogram title.
static void	ComputeMean (TH1F *output, TH2F *input, bool onX=true)
	Creates a graph of means by given axis from given TH2F histogram.

Protected Attributes
TH2F **	m_ResMeanPosUVSensCounts = nullptr
	Special Alignment related: Sensor level.
TH2F **	m_ResMeanUPosUVSens = nullptr
	ResidaulMeanU vs U vs V for sensor.
TH2F **	m_ResMeanVPosUVSens = nullptr
	ResidaulMeanU vs U vs V for sensor.
TH2F **	m_ResUPosUSens = nullptr
	ResidaulU vs U for sensor.
TH2F **	m_ResUPosVSens = nullptr
	ResidaulU vs V for sensor.
TH2F **	m_ResVPosUSens = nullptr
	ResidaulV vs U for sensor.
TH2F **	m_ResVPosVSens = nullptr
	ResidaulV vs V for sensor.
TH1F **	m_ResMeanUPosUSens = nullptr
	ResidaulMeanU vs U for sensor.
TH1F **	m_ResMeanUPosVSens = nullptr
	ResidaulMeanU vs V for sensor.
TH1F **	m_ResMeanVPosUSens = nullptr
	ResidaulMeanV vs U for sensor.
TH1F **	m_ResMeanVPosVSens = nullptr
	ResidaulMeanV vs V for sensor.
TH2F **	m_ResMeanPhiThetaLayerCounts = nullptr
	Special Alignment related: Layer level.
TH2F **	m_ResMeanUPhiThetaLayer = nullptr
	ResidaulMeanU vs Phi vs Theta for Layer.
TH2F **	m_ResMeanVPhiThetaLayer = nullptr
	ResidaulMeanU vs Phi vs Theta for Layer.
TH2F **	m_ResUPhiLayer = nullptr
	ResidaulU vs Phi for Layer.
TH2F **	m_ResUThetaLayer = nullptr
	ResidaulU vs Theta for Layer.
TH2F **	m_ResVPhiLayer = nullptr
	ResidaulV vs Phi for Layer.
TH2F **	m_ResVThetaLayer = nullptr
	ResidaulV vs Theta for Layer.
TH1F **	m_ResMeanUPhiLayer = nullptr
	ResidaulMeanU vs Phi for Layer.
TH1F **	m_ResMeanUThetaLayer = nullptr
	ResidaulMeanU vs Theta for Layer.
TH1F **	m_ResMeanVPhiLayer = nullptr
	ResidaulMeanV vs Phi for Layer.
TH1F **	m_ResMeanVThetaLayer = nullptr
	ResidaulMeanV vs Theta for Layer.
TH2F *	m_PhiZ0 = nullptr
	helix parameters and their corellations
TH2F *	m_PhiMomPt = nullptr
	Phi - the angle of the transverse momentum in the r-phi plane vs.
TH2F *	m_PhiOmega = nullptr
	Phi - the angle of the transverse momentum in the r-phi plane vs.
TH2F *	m_PhiTanLambda = nullptr
	Phi - the angle of the transverse momentum in the r-phi plane vs.
TH2F *	m_D0MomPt = nullptr
	d0 - signed distance to the IP in r-phi vs.
TH2F *	m_D0Omega = nullptr
	d0 - signed distance to the IP in r-phi vs.
TH2F *	m_D0TanLambda = nullptr
	d0 - signed distance to the IP in r-phi vs.
TH2F *	m_Z0MomPt = nullptr
	z0 - the z0 coordinate of the perigee vs.
TH2F *	m_Z0Omega = nullptr
	z0 - the z0 coordinate of the perigee vs.
TH2F *	m_Z0TanLambda = nullptr
	z0 - the z0 coordinate of the perigee vs.
TH2F *	m_MomPtOmega = nullptr
	Track momentum Pt vs.
TH2F *	m_MomPtTanLambda = nullptr
	Track momentum Pt vs.
TH2F *	m_OmegaTanLambda = nullptr
	Omega - the curvature of the track vs.
std::vector< TH1 * >	m_histograms
	All histograms created via the Create- functions are automatically added to this set.
bool	histogramsDefined = false
	True if the defineHisto() was called.
bool	m_hltDQM = false
	True if the DQM module is run on HLT.
std::vector< std::tuple< std::string, std::string, std::string > >	m_histogramParameterChanges
	Used for changing parameters of histograms via the ProcessHistogramParameterChange function.
std::string	m_tracksStoreArrayName
	StoreArray name where Tracks are written.
std::string	m_recoTracksStoreArrayName
	StoreArray name where RecoTracks are written.
TH1F *	m_PValue = nullptr
	p Value
TH1F *	m_Chi2 = nullptr
	Chi2.
TH1F *	m_NDF = nullptr
	NDF.
TH1F *	m_Chi2NDF = nullptr
	Chi2 / NDF.
TH2F *	m_UBResidualsPXD = nullptr
	Unbiased residuals for PXD u vs v.
TH2F *	m_UBResidualsSVD = nullptr
	Unbiased residuals for SVD u vs v.
TH2F **	m_UBResidualsSensor = nullptr
	Unbiased residuals for PXD and SVD u vs v per sensor.
TH1F *	m_UBResidualsPXDU = nullptr
	Unbiased residuals for PXD u.
TH1F *	m_UBResidualsSVDU = nullptr
	Unbiased residuals for SVD u.
TH1F **	m_UBResidualsSensorU = nullptr
	Unbiased residuals for PXD and SVD u per sensor.
TH1F *	m_UBResidualsPXDV = nullptr
	Unbiased residuals for PXD v.
TH1F *	m_UBResidualsSVDV = nullptr
	Unbiased residuals for SVD v.
TH1F *	m_UBResidualsPXDX_Yin = nullptr
	half-shells
TH1F *	m_UBResidualsPXDX_Yang = nullptr
	Unbiased residuals in X for PXD for Yang.
TH1F *	m_UBResidualsSVDX_Pat = nullptr
	Unbiased residuals in X for PXD for Pat.
TH1F *	m_UBResidualsSVDX_Mat = nullptr
	Unbiased residuals in X for PXD for Mat.
TH1F *	m_UBResidualsPXDY_Yin = nullptr
	Unbiased residuals in Y for PXD for Yin.
TH1F *	m_UBResidualsPXDY_Yang = nullptr
	Unbiased residuals in Y for PXD for Yang.
TH1F *	m_UBResidualsSVDY_Pat = nullptr
	Unbiased residuals in Y for PXD for Pat.
TH1F *	m_UBResidualsSVDY_Mat = nullptr
	Unbiased residuals in Y for PXD for Mat.
TH1F *	m_UBResidualsPXDZ_Yin = nullptr
	Unbiased residuals in Z for PXD for Yin.
TH1F *	m_UBResidualsPXDZ_Yang = nullptr
	Unbiased residuals in Z for PXD for Yang.
TH1F *	m_UBResidualsSVDZ_Pat = nullptr
	Unbiased residuals in Z for PXD for Pat.
TH1F *	m_UBResidualsSVDZ_Mat = nullptr
	Unbiased residuals in Z for PXD for Mat.
TH1F **	m_UBResidualsSensorV = nullptr
	Unbiased residuals for PXD and SVD v per sensor.
TH2F **	m_TRClusterHitmap = nullptr
	Track related clusters - hitmap in IP angle range.
TH2F **	m_TRClusterCorrelationsPhi = nullptr
	Track related clusters - neighbor correlations in Phi.
TH2F **	m_TRClusterCorrelationsTheta = nullptr
	Track related clusters - neighbor corelations in Theta.
TH1F *	m_MomPhi = nullptr
	Track momentum Pt.Phi.
TH1F *	m_MomTheta = nullptr
	Track momentum Pt.Theta.
TH1F *	m_MomCosTheta = nullptr
	Track momentum Pt.CosTheta.
TH1F *	m_MomX = nullptr
	Track momentum Pt.X.
TH1F *	m_MomY = nullptr
	Track momentum Pt.Y.
TH1F *	m_MomZ = nullptr
	Track momentum Pt.Z.
TH1F *	m_MomPt = nullptr
	Track momentum Pt.
TH1F *	m_Mom = nullptr
	Track momentum Magnitude.
TH1F *	m_D0 = nullptr
	d0 - the signed distance to the IP in the r-phi plane
TH2F *	m_PhiD0 = nullptr
	d0 vs Phi - the signed distance to the IP in the r-phi plane
TH1F *	m_Z0 = nullptr
	z0 - the z0 coordinate of the perigee (beam spot position)
TH2F *	m_D0Z0 = nullptr
	z0 vs d0 - signed distance to the IP in r-phi vs.
TH1F *	m_Phi = nullptr
	Phi - the angle of the transverse momentum in the r-phi plane, with CDF naming convention.
TH1F *	m_TanLambda = nullptr
	TanLambda - the slope of the track in the r-z plane.
TH1F *	m_Omega = nullptr
	Omega - the curvature of the track.
TH1F *	m_HitsPXD = nullptr
	Number of hits on PXD.
TH1F *	m_HitsSVD = nullptr
	Number of hits on SVD.
TH1F *	m_HitsCDC = nullptr
	Number of hits on CDC.
TH1F *	m_Hits = nullptr
	Number of all hits in tracks.
TH1F *	m_TracksVXD = nullptr
	Number of tracks only with VXD.
TH1F *	m_TracksCDC = nullptr
	Number of tracks only with CDC.
TH1F *	m_TracksVXDCDC = nullptr
	Number of full tracks with VXD+CDC.
TH1F *	m_Tracks = nullptr
	Number of all finding tracks.

Private Member Functions
bool	checkVariableForNANOrINF (const double var)
	Check a variable for whether or not it is NAN or INF.
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
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

DQM of Alignment for off line residuals per sensor, layer, keep also On-Line DQM from tracking: their momentum, Number of hits in tracks, Number of tracks.

Definition at line 26 of file AlignDQMModule.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

AlignDQMModule()

AlignDQMModule

(

)

Constructor.

Definition at line 30 of file AlignDQMModule.cc.

                               : DQMHistoModuleBase()
{
  setDescription("DQM of Alignment for off line "
                 "residuals per sensor, layer, "
                 "keep also On-Line DQM from tracking: "
                 "their momentum, "
                 "Number of hits in tracks, "
                 "Number of tracks. "
                );
}

~AlignDQMModule()

~AlignDQMModule ( )

inline

Definition at line 32 of file AlignDQMModule.h.

{ }

Member Function Documentation

beginRun()

void beginRun ( void  )

overridevirtualinherited

Called when entering a new run.

Reimplemented from HistoModule.

Definition at line 70 of file DQMHistoModuleBase.cc.

{
  StoreArray<RecoTrack> recoTracks(m_recoTracksStoreArrayName);
  if (!recoTracks.isOptional()) {
    B2DEBUG(22, "Missing recoTracks array in beginRun() for " + getName());
    return;
  }
  StoreArray<Track> tracks(m_tracksStoreArrayName);
  if (!tracks.isOptional()) {
    B2DEBUG(22, "Missing recoTracks array in beginRun() for " + getName());
    return;
  }
 
  for (TH1* histogram : m_histograms)
    histogram->Reset();
}

checkVariableForNANOrINF()

bool checkVariableForNANOrINF ( const double  var )

inlineprivateinherited

Check a variable for whether or not it is NAN or INF.

Definition at line 314 of file DQMHistoModuleBase.h.

    {
      return std::isnan(var) or std::isinf(var);
    }

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

ComputeMean()

void ComputeMean ( TH1F *  output, TH2F *  input, bool  onX = true  )

staticprotectedinherited

Creates a graph of means by given axis from given TH2F histogram.

Parameters

output	- value of every bin of this histogram is set to be the mean of all bins from input with the same x (or y) coordinate.
input	- any TH2F histogram which NBinsX (or NBinsY) has the same value as the NBinsX of the input.
onX	- if true, use "x" and "NBinsX" options in the statements above. If false, use "y" and "NBinsY" instead.

Definition at line 618 of file DQMHistoModuleBase.cc.

{
  output->Reset();
  int nbinsi = onX ? input->GetNbinsX() : input->GetNbinsY();
  int nbinsy = onX ? input->GetNbinsY() : input->GetNbinsX();
  TAxis* axis = onX ? input->GetYaxis() : input->GetXaxis();
 
  for (int i = 1; i <= nbinsi; i++) {
    float sum = 0;
    float count = 0;
 
    for (int j = 1; j <= nbinsy; j++) {
      float value = onX ? input->GetBinContent(i, j) : input->GetBinContent(j, i);
      sum += value * axis->GetBinCenter(j);
      count += value;
    }
 
    output->SetBinContent(i, count != 0 ? sum / count : 0);
  }
}

Create() [1/2]

TH2F * Create ( std::string  name, std::string  title, int  nbinsx, double  xlow, double  xup, int  nbinsy, double  ylow, double  yup, std::string  xTitle, std::string  yTitle, std::string  zTitle  )

overridevirtual

Same as above but for TH2F.

Reimplemented from DQMHistoModuleBase.

Definition at line 411 of file AlignDQMModule.cc.

{
  return DQMHistoModuleBase::Create("Alig_" + name, title, nbinsx, xlow, xup,  nbinsy, ylow, yup, xTitle, yTitle, zTitle);
}

Create() [2/2]

TH1F * Create ( std::string  name, std::string  title, int  nbinsx, double  xlow, double  xup, std::string  xTitle, std::string  yTitle  )

overridevirtual

Function to create TH1F and add it to the vector of histograms (m_histograms).

All histograms in the module should be created via this function (or following Create- functions). This function calls base function but wirh "Alig_" prefix to the name parameter

Reimplemented from DQMHistoModuleBase.

Definition at line 406 of file AlignDQMModule.cc.

{
  return DQMHistoModuleBase::Create("Alig_" + name, title, nbinsx, xlow, xup, xTitle, yTitle);
}

CreateLayers() [1/2]

TH2F ** CreateLayers ( boost::format  nameTemplate, boost::format  titleTemplate, int  nbinsx, double  xlow, double  xup, int  nbinsy, double  ylow, double  yup, std::string  xTitle, std::string  yTitle, std::string  zTitle  )

virtualinherited

Same as above but for TH2F.

Definition at line 151 of file DQMHistoModuleBase.cc.

{
  VXD::GeoCache& geo = VXD::GeoCache::getInstance();
  auto gTools = geo.getGeoTools();
 
  TH2F** output = new TH2F*[gTools->getNumberOfLayers()];
 
  for (VxdID layer : geo.getLayers()) {
    int layerNumber = layer.getLayerNumber();
    int layerIndex = gTools->getLayerIndex(layerNumber);
    std::string name = str(nameTemplate % layerNumber);
    std::string title = str(titleTemplate % layerNumber);
    output[layerIndex] = Create(name, title, nbinsx, xlow, xup, nbinsy, ylow, yup, xTitle, yTitle, zTitle);
  }
 
  return output;
}

CreateLayers() [2/2]

TH1F ** CreateLayers ( boost::format  nameTemplate, boost::format  titleTemplate, int  nbinsx, double  xlow, double  xup, std::string  xTitle, std::string  yTitle  )

virtualinherited

Function to create array of TH1F histograms, one for each layer.

Parameters

nameTemplate	- format() of string with exactly one %1% which is then replaced by the layer number and then used as a name for the histogram.
titleTemplate	- same as nameTemplate but for title.
nbinsx	- number of bins.
xlow	- range x-axis (low boundary).
xup	- range x-axis (high boundary).
xTitle	- title x-axis.
yTitle	- title y-axis

Definition at line 132 of file DQMHistoModuleBase.cc.

{
  VXD::GeoCache& geo = VXD::GeoCache::getInstance();
  auto gTools = geo.getGeoTools();
 
  TH1F** output = new TH1F*[gTools->getNumberOfLayers()];
 
  for (VxdID layer : geo.getLayers()) {
    int layerNumber = layer.getLayerNumber();
    int layerIndex = gTools->getLayerIndex(layerNumber);
    std::string name = str(nameTemplate % layerNumber);
    std::string title = str(titleTemplate % layerNumber);
    output[layerIndex] = Create(name, title, nbinsx, xlow, xup, xTitle, yTitle);
  }
 
  return output;
}

CreateSensors() [1/2]

TH2F ** CreateSensors ( boost::format  nameTemplate, boost::format  titleTemplate, int  nbinsx, double  xlow, double  xup, int  nbinsy, double  ylow, double  yup, std::string  xTitle, std::string  yTitle, std::string  zTitle  )

virtualinherited

Same as above but for TH2F.

Definition at line 189 of file DQMHistoModuleBase.cc.

{
  VXD::GeoCache& geo = VXD::GeoCache::getInstance();
  auto gTools = geo.getGeoTools();
  int nVXDSensors = gTools->getNumberOfSensors();
 
  TH2F** output = new TH2F*[nVXDSensors];
 
  for (int sensorIndex = 0; sensorIndex < nVXDSensors; sensorIndex++) {
    VxdID sensorID = gTools->getSensorIDFromIndex(sensorIndex);
    std::string name = str(nameTemplate % SensorNameDescription(sensorID));
    std::string title = str(titleTemplate % SensorTitleDescription(sensorID));
    output[sensorIndex] = Create(name, title, nbinsx, xlow, xup, nbinsy, ylow, yup, xTitle, yTitle, zTitle);
  }
 
  return output;
}

CreateSensors() [2/2]

TH1F ** CreateSensors ( boost::format  nameTemplate, boost::format  titleTemplate, int  nbinsx, double  xlow, double  xup, std::string  xTitle, std::string  yTitle  )

virtualinherited

Function to create array of TH1F histograms, one for each sensor.

Parameters

nameTemplate	- format() of string with exactly one %1% which is then replaced by the output of the SensorNameDescription function and then used as a name for the histogram.
titleTemplate	- same as nameTemplate but for title and with the SensorTitleDescription function.
nbinsx	- number of bins.
xlow	- range x-axis (low boundary).
xup	- range x-axis (high boundary).
xTitle	- title x-axis.
yTitle	- title y-axis

Definition at line 170 of file DQMHistoModuleBase.cc.

{
  VXD::GeoCache& geo = VXD::GeoCache::getInstance();
  auto gTools = geo.getGeoTools();
  int nVXDSensors = gTools->getNumberOfSensors();
 
  TH1F** output = new TH1F*[nVXDSensors];
 
  for (int sensorIndex = 0; sensorIndex < nVXDSensors; sensorIndex++) {
    VxdID sensorID = gTools->getSensorIDFromIndex(sensorIndex);
    std::string name = str(nameTemplate % SensorNameDescription(sensorID));
    std::string title = str(titleTemplate % SensorTitleDescription(sensorID));
    output[sensorIndex] = Create(name, title, nbinsx, xlow, xup, xTitle, yTitle);
  }
 
  return output;
}

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

Define1DSensors()

void Define1DSensors ( )

protectedvirtualinherited

Define 1D histograms with unbiased residuals for individual sensors.

Definition at line 410 of file DQMHistoModuleBase.cc.

{
 
  double residualRange = 400;  // in um
 
  auto residualU = Axis(200, -residualRange, residualRange, "residual U [#mum]");
  auto residualV = Axis(residualU).title("residual V [#mum]");
 
  auto factory = Factory(this);
 
  factory.yTitleDefault("counts");
 
  m_UBResidualsSensorU = factory.xAxis(residualU).CreateSensorsTH1F(format("UBResidualsU_%1%"),
                         format("VXD Unbiased U Residuals for sensor %1%"));
  m_UBResidualsSensorV = factory.xAxis(residualV).CreateSensorsTH1F(format("UBResidualsV_%1%"),
                         format("VXD Unbiased V Residuals for sensor %1%"));
 
}

Define2DSensors()

void Define2DSensors ( )

protectedvirtualinherited

Define 2D histograms with unbiased residuals for individual sensors.

Definition at line 429 of file DQMHistoModuleBase.cc.

{
 
  double residualRange = 400;  // in um
 
  auto residualU = Axis(200, -residualRange, residualRange, "residual U [#mum]");
  auto residualV = Axis(residualU).title("residual V [#mum]");
 
  auto factory = Factory(this);
 
  m_UBResidualsSensor = factory.xAxis(residualU).yAxis(residualV).zTitle("counts").CreateSensorsTH2F(format("UBResiduals_%1%"),
                        format("VXD Unbiased Residuals for sensor %1%"));
}

DefineHalfShellsVXD()

void DefineHalfShellsVXD ( )

protectedvirtualinherited

Define histograms with unbiased residuals for half-shells for PXD and SVD sensors.

Definition at line 340 of file DQMHistoModuleBase.cc.

{
 
  double residualRange = 400;  // in um
  auto residual = Axis(200, -residualRange, residualRange, "residual [#mum]");
  auto factory = Factory(this).xAxisDefault(residual).yTitleDefault("counts");
 
  if (! m_hltDQM) {
    m_UBResidualsPXDX_Yin = factory.CreateTH1F("UBResidualsPXDX_Yin", "PXD-Yin Unbiased Residuals in X");
    m_UBResidualsPXDX_Yang = factory.CreateTH1F("UBResidualsPXDX_Yang", "PXD-Yang Unbiased Residuals in X");
  }
  m_UBResidualsSVDX_Pat = factory.CreateTH1F("UBResidualsSVDX_Pat", "SVD-Pat Unbiased Residuals in X");
  m_UBResidualsSVDX_Mat = factory.CreateTH1F("UBResidualsSVDX_Mat", "SVD-Mat Unbiased Residuals in X");
 
  if (! m_hltDQM) {
    m_UBResidualsPXDY_Yin = factory.CreateTH1F("UBResidualsPXDY_Yin", "PXD-Yin Unbiased Residuals in Y");
    m_UBResidualsPXDY_Yang = factory.CreateTH1F("UBResidualsPXDY_Yang", "PXD-Yang Unbiased Residuals in Y");
  }
  m_UBResidualsSVDY_Pat = factory.CreateTH1F("UBResidualsSVDY_Pat", "SVD-Pat Unbiased Residuals in Y");
  m_UBResidualsSVDY_Mat = factory.CreateTH1F("UBResidualsSVDY_Mat", "SVD-Mat Unbiased Residuals in Y");
 
  if (! m_hltDQM) {
    m_UBResidualsPXDZ_Yin = factory.CreateTH1F("UBResidualsPXDZ_Yin", "PXD-Yin Unbiased Residuals in Z");
    m_UBResidualsPXDZ_Yang = factory.CreateTH1F("UBResidualsPXDZ_Yang", "PXD-Yang Unbiased Residuals in Z");
  }
  m_UBResidualsSVDZ_Pat = factory.CreateTH1F("UBResidualsSVDZ_Pat", "SVD-Pat Unbiased Residuals in Z");
  m_UBResidualsSVDZ_Mat = factory.CreateTH1F("UBResidualsSVDZ_Mat", "SVD-Mat Unbiased Residuals in Z");
 
}

DefineHelixParametersAndCorrelations()

void DefineHelixParametersAndCorrelations ( )

overrideprotectedvirtual

All the following Define- functions should be used in the defineHisto() function to define histograms.

The convention is that every Define- function is responsible for creating its own TDirectory (if it's needed). In any case the function must then return to the original gDirectory. For the creation of histograms the THFFactory or the Create- functions should be used. Define histograms with helix parameters and their correlations.

Reimplemented from DQMHistoModuleBase.

Definition at line 120 of file AlignDQMModule.cc.

{
  TDirectory* originalDirectory = gDirectory;
 
  TDirectory* helixParameters = originalDirectory->mkdir("HelixPars", "", true);
  TDirectory* helixCorrelations = originalDirectory->mkdir("HelixCorrelations", "", true);
 
  int iZ0Range = 100;
  double fZ0Range = 10.0;     // Half range in cm
  int iD0Range = 100;
  double fD0Range = 1.0;      // Half range in cm
  int iMomRangeBig = 600;
  int iMomRangeSmall = 60;
  double fMomRange = 6.0;
  int iPhiRange = 180;
  double fPhiRange = 180.0;   // Half range in deg
  int iLambdaRange = 100;
  double fLambdaRange = 4.0;
  int iOmegaRange = 100;
  double fOmegaRange = 0.1;
 
  auto phi = Axis(iPhiRange, -fPhiRange, fPhiRange, "#phi [deg]");
  auto D0 = Axis(iD0Range, -fD0Range, fD0Range, "d0 [cm]");
  auto Z0 = Axis(iZ0Range, -fZ0Range, fZ0Range, "z0 [cm]");
  auto tanLambda = Axis(iLambdaRange, -fLambdaRange, fLambdaRange, "Tan Lambda");
  auto omega = Axis(iOmegaRange, -fOmegaRange, fOmegaRange, "Omega");
  auto momentumBig = Axis(2 * iMomRangeBig, 0.0, fMomRange, "Momentum");
  auto momentumSmall = Axis(2 * iMomRangeSmall, 0.0, fMomRange, "Momentum");
 
  auto factory = Factory(this);
 
  helixParameters->cd();
 
  factory.yTitleDefault("Arb. Units");
 
  m_Z0 =        factory.xAxis(Z0).CreateTH1F("Z0", "z0 - the z coordinate of the perigee (beam spot position)");
  m_D0 =        factory.xAxis(D0).CreateTH1F("D0", "d0 - the signed distance to the IP in the r-phi plane");
  m_Phi =       factory.xAxis(phi).CreateTH1F("Phi",
                                              "Phi - angle of the transverse momentum in the r-phi plane, with CDF naming convention");
  m_Omega =     factory.xAxis(omega).CreateTH1F("Omega",
                                                "Omega - the curvature of the track. It's sign is defined by the charge of the particle");
  m_TanLambda = factory.xAxis(tanLambda).CreateTH1F("TanLambda", "TanLambda - the slope of the track in the r-z plane");
  m_MomPt =     factory.xAxis(momentumBig).yTitle("counts").CreateTH1F("TrackMomentumPt", "Track Momentum pT");
 
  helixCorrelations->cd();
 
  factory.zTitleDefault("Arb. Units");
 
  m_PhiD0 =           factory.xAxis(phi).yAxis(D0).CreateTH2F("PhiD0",
                                                              "Phi - angle of the transverse momentum in the r-phi plane vs. d0 - signed distance to the IP in r-phi");
  m_PhiZ0 =           factory.xAxis(phi).yAxis(Z0).CreateTH2F("PhiZ0",
                                                              "Phi - angle of the transverse momentum in the r-phi plane vs. z0 of the perigee (to see primary vertex shifts along R or z)");
  m_PhiMomPt =        factory.xAxis(phi).yAxis(momentumSmall).CreateTH2F("PhiMomPt",
                      "Phi - angle of the transverse momentum in the r-phi plane vs. Track momentum Pt");
  m_PhiOmega =        factory.xAxis(phi).yAxis(omega).CreateTH2F("PhiOmega",
                      "Phi - angle of the transverse momentum in the r-phi plane vs. Omega - the curvature of the track");
  m_PhiTanLambda =    factory.xAxis(phi).yAxis(tanLambda).CreateTH2F("PhiTanLambda",
                      "dPhi - angle of the transverse momentum in the r-phi plane vs. TanLambda - the slope of the track in the r-z plane");
  m_D0Z0 =            factory.xAxis(D0).yAxis(Z0).CreateTH2F("D0Z0",
                                                             "d0 - signed distance to the IP in r-phi vs. z0 of the perigee (to see primary vertex shifts along R or z)");
  m_D0MomPt =         factory.xAxis(D0).yAxis(momentumSmall).CreateTH2F("D0MomPt",
                      "d0 - signed distance to the IP in r-phi vs. Track momentum Pt");
  m_D0Omega =         factory.xAxis(D0).yAxis(omega).CreateTH2F("D0Omega",
                      "d0 - signed distance to the IP in r-phi vs. Omega - the curvature of the track");
  m_D0TanLambda =     factory.xAxis(D0).yAxis(tanLambda).CreateTH2F("D0TanLambda",
                      "d0 - signed distance to the IP in r-phi vs. TanLambda - the slope of the track in the r-z plane");
  m_Z0MomPt =         factory.xAxis(Z0).yAxis(momentumSmall).CreateTH2F("Z0MomPt",
                      "z0 - the z0 coordinate of the perigee vs. Track momentum Pt");
  m_Z0Omega =         factory.xAxis(Z0).yAxis(omega).CreateTH2F("Z0Omega",
                      "z0 - the z0 coordinate of the perigee vs. Omega - the curvature of the track");
  m_Z0TanLambda =     factory.xAxis(Z0).yAxis(tanLambda).CreateTH2F("Z0TanLambda",
                      "z0 - the z0 coordinate of the perigee vs. TanLambda - the slope of the track in the r-z plane");
  m_MomPtOmega =      factory.xAxis(momentumSmall).yAxis(omega).CreateTH2F("MomPtOmega",
                      "Track momentum Pt vs. Omega - the curvature of the track");
  m_MomPtTanLambda =  factory.xAxis(momentumSmall).yAxis(tanLambda).CreateTH2F("MomPtTanLambda",
                      "Track momentum Pt vs. TanLambda - the slope of the track in the r-z plane");
  m_OmegaTanLambda =  factory.xAxis(omega).yAxis(tanLambda).CreateTH2F("OmegaTanLambda",
                      "Omega - the curvature of the track vs. TanLambda - the slope of the track in the r-z plane");
 
  originalDirectory->cd();
}

defineHisto()

void defineHisto ( )

overridevirtual

Histogram definitions such as TH1(), TH2(), TNtuple(), TTree()....

are supposed to be placed in this function. Also at the end function all m_histogramParameterChanges should be processed via the ProcessHistogramParameterChange function.

Reimplemented from DQMHistoModuleBase.

Definition at line 45 of file AlignDQMModule.cc.

{
  DQMHistoModuleBase::defineHisto();
 
  if (VXD::GeoCache::getInstance().getGeoTools()->getNumberOfLayers() == 0)
    B2WARNING("Missing geometry for VXD.");
 
  TDirectory* originalDirectory = gDirectory;
  TDirectory* alignmentDirectory = originalDirectory->mkdir("AlignmentDQM", "", true);
  TDirectory* sensorsDirectory = originalDirectory->mkdir("AlignmentDQMSensors", "", true);
  TDirectory* layersDirectory = originalDirectory->mkdir("AlignmentDQMLayers", "", true);
 
  alignmentDirectory->cd();
  DefineTracks();
  DefineHits();
  DefineMomentumAngles();
  DefineMomentumCoordinates();
  DefineHelixParametersAndCorrelations();
  DefineTrackFitStatus();
  DefineTRClusters();
  DefineUBResidualsVXD();
  DefineHalfShellsVXD();
 
  sensorsDirectory->cd();
  DefineSensors();
 
  layersDirectory->cd();
  DefineLayers();
 
  originalDirectory->cd();
 
  for (auto change : m_histogramParameterChanges)
    ProcessHistogramParameterChange(get<0>(change), get<1>(change), get<2>(change));
}

DefineHits()

void DefineHits ( )

protectedvirtualinherited

Define histograms with numbers of hits.

Definition at line 310 of file DQMHistoModuleBase.cc.

{
  int iHitsInSVD = 20;
  int iHitsInCDC = 200;
  int iHits = 200;
 
  auto factory = Factory(this).xlowDefault(0).xTitleDefault("# hits").yTitleDefault("counts");
 
  if (! m_hltDQM) {
    int iHitsInPXD = 10;
    m_HitsPXD = factory.nbinsx(iHitsInPXD).xup(iHitsInPXD).CreateTH1F("NoOfHitsInTrack_PXD", "Number of PXD Hits per Track");
  }
  m_HitsSVD = factory.nbinsx(iHitsInSVD).xup(iHitsInSVD).CreateTH1F("NoOfHitsInTrack_SVD", "Number of SVD Hits per Track");
  m_HitsCDC = factory.nbinsx(iHitsInCDC).xup(iHitsInCDC).CreateTH1F("NoOfHitsInTrack_CDC", "Number of CDC Hits per Track");
  m_Hits = factory.nbinsx(iHits).xup(iHits).CreateTH1F("NoOfHitsInTrack", "Number of Hits per Track");
}

DefineLayers()

void DefineLayers ( )

protectedvirtual

Define histograms which depend on layerIndex.

Definition at line 292 of file AlignDQMModule.cc.

{
  TDirectory* originalDirectory = gDirectory;
 
  TDirectory* resMeanUPosUV = originalDirectory->mkdir("ResidLayerMeanUPositPhiTheta", "", true);
  TDirectory* resMeanVPosUV = originalDirectory->mkdir("ResidLayerMeanVPositPhiTheta", "", true);
  TDirectory* resMeanPosUVCounts = originalDirectory->mkdir("ResidLayerMeanPositPhiThetaCounts", "", true);
  TDirectory* resMeanUPosU = originalDirectory->mkdir("ResidLayerMeanUPositPhi", "", true);
  TDirectory* resMeanVPosU = originalDirectory->mkdir("ResidLayerMeanVPositPhi", "", true);
  TDirectory* resMeanUPosV = originalDirectory->mkdir("ResidLayerMeanUPositTheta", "", true);
  TDirectory* resMeanVPosV = originalDirectory->mkdir("ResidLayerMeanVPositTheta", "", true);
  TDirectory* resUPosU = originalDirectory->mkdir("ResidLayerUPositPhi", "", true);
  TDirectory* resVPosU = originalDirectory->mkdir("ResidLayerVPositPhi", "", true);
  TDirectory* resUPosV = originalDirectory->mkdir("ResidLayerUPositTheta", "", true);
  TDirectory* resVPosV = originalDirectory->mkdir("ResidLayerVPositTheta", "", true);
 
  int iPhiGran = 90;
  int iThetGran = iPhiGran / 2;
  int iYResGran = 200;
  double residualRange = 400;  // in um
 
  auto phi = Axis(iPhiGran, -180, 180, "Phi [deg]");
  auto theta = Axis(iThetGran, 0, 180, "Theta [deg]");
  auto residual = Axis(iYResGran, -residualRange, residualRange, "residual [#mum]");
 
  auto factory = Factory(this);
  factory.xAxisDefault(phi).yAxisDefault(theta).zTitleDefault("counts");
 
  resMeanUPosUV->cd();
  m_ResMeanUPhiThetaLayer =       factory.zTitle("residual [#mum]").CreateLayersTH2F(format("ResMeanUPhiThetaLayer_%1%"),
                                  format("Residuals Mean U in Phi Theta, Layer %1%"));
  resMeanVPosUV->cd();
  m_ResMeanVPhiThetaLayer =       factory.zTitle("residual [#mum]").CreateLayersTH2F(format("ResMeanVPhiThetaLayer_%1%"),
                                  format("Residuals Mean V in Phi Theta, Layer %1%"));
  resMeanPosUVCounts->cd();
  m_ResMeanPhiThetaLayerCounts =  factory.CreateLayersTH2F(format("ResCounterPhiThetaLayer_%1%"),
                                                           format("Residuals counter in Phi Theta, Layer %1%"));
 
  factory.yAxisDefault(residual);
 
  resUPosU->cd();
  m_ResUPhiLayer =                factory.CreateLayersTH2F(format("ResUPhiLayer_%1%"), format("Residuals U in Phi, Layer %1%"));
  resVPosU->cd();
  m_ResVPhiLayer =                factory.CreateLayersTH2F(format("ResVPhiLayer_%1%"), format("Residuals V in Phi, Layer %1%"));
 
  factory.xAxisDefault(theta);
 
  resUPosV->cd();
  m_ResUThetaLayer =              factory.CreateLayersTH2F(format("ResUThetaLayer_%1%"), format("Residuals U in Theta, Layer %1%"));
  resVPosV->cd();
  m_ResVThetaLayer =              factory.CreateLayersTH2F(format("ResVThetaLayer_%1%"), format("Residuals V in Theta, Layer %1%"));
  resMeanUPosV->cd();
  m_ResMeanUThetaLayer =          factory.CreateLayersTH1F(format("ResMeanUThetaLayer_%1%"),
                                                           format("Residuals Mean U in Theta, Layer %1%"));
  resMeanVPosV->cd();
  m_ResMeanVThetaLayer =          factory.CreateLayersTH1F(format("ResMeanVThetaLayer_%1%"),
                                                           format("Residuals Mean V in Theta, Layer %1%"));
 
  factory.xAxisDefault(phi).yTitleDefault("residual [#mum]");
 
  resMeanUPosU->cd();
  m_ResMeanUPhiLayer =            factory.CreateLayersTH1F(format("ResMeanUPhiLayer_%1%"),
                                                           format("Residuals Mean U in Phi, Layer %1%"));
  resMeanVPosU->cd();
  m_ResMeanVPhiLayer =            factory.CreateLayersTH1F(format("ResMeanVPhiLayer_%1%"),
                                                           format("Residuals Mean V in Phi, Layer %1%"));
 
  originalDirectory->cd();
}

DefineMomentumAngles()

void DefineMomentumAngles ( )

protectedvirtualinherited

Define histograms with track momentum Pt.

angles.

Definition at line 208 of file DQMHistoModuleBase.cc.

{
  m_MomPhi = Create("MomPhi", "Track Azimuthal Angle", 180, -180, 180, "Mom Phi", "counts");
  m_MomTheta = Create("MomTheta", "Track Polar Angle", 90, 0, 180, "Mom Theta", "counts");
  m_MomCosTheta = Create("MomCosTheta", "Cosine of the Track Polar Angle", 100, -1, 1, "Mom CosTheta", "counts");
}

DefineMomentumCoordinates()

void DefineMomentumCoordinates ( )

protectedvirtualinherited

Define histograms with track momentum Pt.

coordinates.

Definition at line 294 of file DQMHistoModuleBase.cc.

{
  int iMomRange = 100;
  double fMomRange = 6.0;
 
  auto momentum = Axis(2 * iMomRange, -fMomRange, fMomRange, "Momentum [GeV/c]");
  auto pt_momentum = Axis(iMomRange, 0, fMomRange, "Momentum [GeV/c]");
  auto factory = Factory(this).xAxisDefault(momentum).yTitleDefault("counts");
 
  m_MomX = factory.CreateTH1F("TrackMomentumX", "Track Momentum X");
  m_MomY = factory.CreateTH1F("TrackMomentumY", "Track Momentum Y");
  m_MomZ = factory.CreateTH1F("TrackMomentumZ", "Track Momentum Z");
  m_MomPt = factory.xAxis(pt_momentum).yTitle("counts").CreateTH1F("TrackMomentumPt", "Track Momentum pT");
  m_Mom = factory.xlow(.0).CreateTH1F("TrackMomentumMag", "Track Momentum Magnitude");
}

DefineSensors()

void DefineSensors ( )

protected

Define histograms which depend on position for individual sensors.

Definition at line 202 of file AlignDQMModule.cc.

{
  TDirectory* originalDirectory = gDirectory;
 
  TDirectory* resMeanUPosUV = originalDirectory->mkdir("ResidMeanUPositUV", "", true);
  TDirectory* resMeanVPosUV = originalDirectory->mkdir("ResidMeanVPositUV", "", true);
  TDirectory* resMeanPosUVCounts = originalDirectory->mkdir("ResidMeanPositUVCounts", "", true);
  TDirectory* resMeanUPosU = originalDirectory->mkdir("ResidMeanUPositU", "", true);
  TDirectory* resMeanVPosU = originalDirectory->mkdir("ResidMeanVPositU", "", true);
  TDirectory* resMeanUPosV = originalDirectory->mkdir("ResidMeanUPositV", "", true);
  TDirectory* resMeanVPosV = originalDirectory->mkdir("ResidMeanVPositV", "", true);
  TDirectory* resUPosU = originalDirectory->mkdir("ResidUPositU", "", true);
  TDirectory* resVPosU = originalDirectory->mkdir("ResidVPositU", "", true);
  TDirectory* resUPosV = originalDirectory->mkdir("ResidUPositV", "", true);
  TDirectory* resVPosV = originalDirectory->mkdir("ResidVPositV", "", true);
  TDirectory* resids2D = originalDirectory->mkdir("Residuals2D", "", true);
  TDirectory* resids1D = originalDirectory->mkdir("Residuals1D", "", true);
 
  int iSizeBins = 20;
  double fSizeMin = -50;  // in mm
  double fSizeMax = -fSizeMin;
  double residualRange = 400;  // in um
 
  auto positionU = Axis(iSizeBins, fSizeMin, fSizeMax, "position U [mm]");
  auto positionV = Axis(positionU).title("position V [mm]");
  auto residualU = Axis(200, -residualRange, residualRange, "residual U [#mum]");
  auto residualV = Axis(residualU).title("residual V [#mum]");
 
  auto factory = Factory(this);
 
  factory.xAxisDefault(positionU).yAxisDefault(positionV);
 
  resMeanUPosUV->cd();
  m_ResMeanUPosUVSens =       factory.zTitle("residual U [#mum]").CreateSensorsTH2F(format("ResMeanUPosUVSens_%1%"),
                              format("Residual Mean U in Position UV, %1%"));
  resMeanVPosUV->cd();
  m_ResMeanVPosUVSens =       factory.zTitle("residual V [#mum]").CreateSensorsTH2F(format("ResMeanVPosUVSens_%1%"),
                              format("Residual Mean V in Position UV, %1%"));
  resMeanPosUVCounts->cd();
  m_ResMeanPosUVSensCounts =  factory.zTitle("counts").CreateSensorsTH2F(format("ResMeanPosUVCountsSens_%1%"),
                              format("Residual Mean Counts in Position UV, %1%"));
  resMeanUPosU->cd();
  m_ResMeanUPosUSens =        factory.yTitle("residual mean U [#mum]").CreateSensorsTH1F(format("ResMeanUPosUSens_%1%"),
                              format("Residual Mean U in Position U, %1%"));
  resMeanVPosU->cd();
  m_ResMeanVPosUSens =        factory.yTitle("residual mean V [#mum]").CreateSensorsTH1F(format("ResMeanVPosUSens_%1%"),
                              format("Residual Mean V in Position U, %1%"));
 
  factory.xAxisDefault(positionV);
 
  resMeanUPosV->cd();
  m_ResMeanUPosVSens =        factory.yTitle("residual mean U [#mum]").CreateSensorsTH1F(format("ResMeanUPosVSens_%1%"),
                              format("Residual Mean U in Position V, %1%"));
  resMeanVPosV->cd();
  m_ResMeanVPosVSens =        factory.yTitle("residual mean V [#mum]").CreateSensorsTH1F(format("ResMeanVPosVSens_%1%"),
                              format("Residual Mean V in Position V, %1%"));
 
  factory.xAxisDefault(positionU).zTitleDefault("counts");
 
  resUPosU->cd();
  m_ResUPosUSens =            factory.yAxis(residualU).CreateSensorsTH2F(format("ResUPosUSensor_%1%"),
                              format("Residual U in Position U, %1%"));
  resVPosU->cd();
  m_ResVPosUSens =            factory.yAxis(residualV).CreateSensorsTH2F(format("ResVPosUSensor_%1%"),
                              format("Residual V in Position U, %1%"));
 
  factory.xAxisDefault(positionV);
 
  resUPosV->cd();
  m_ResUPosVSens =            factory.yAxis(residualU).CreateSensorsTH2F(format("ResUPosVSensor_%1%"),
                              format("Residual U in Position V, %1%"));
  resVPosV->cd();
  m_ResVPosVSens =            factory.yAxis(residualV).CreateSensorsTH2F(format("ResVPosVSensor_%1%"),
                              format("Residual V in Position V, %1%"));
 
  resids2D->cd();
  m_UBResidualsSensor =       factory.xAxis(residualU).yAxis(residualV).CreateSensorsTH2F(format("UBResiduals_%1%"),
                              format("PXD Unbiased residuals for sensor %1%"));
 
  factory.yTitleDefault("counts");
 
  resids1D->cd();
  m_UBResidualsSensorU =      factory.xAxis(residualU).CreateSensorsTH1F(format("UBResidualsU_%1%"),
                              format("PXD Unbiased U residuals for sensor %1%"));
  m_UBResidualsSensorV =      factory.xAxis(residualV).CreateSensorsTH1F(format("UBResidualsV_%1%"),
                              format("PXD Unbiased V residuals for sensor %1%"));
 
  originalDirectory->cd();
}

DefineTrackFitStatus()

void DefineTrackFitStatus ( )

protectedvirtualinherited

Define histograms which require FitStatus.

Definition at line 215 of file DQMHistoModuleBase.cc.

{
  m_PValue = Create("PValue", "Track Fit P value", 100, 0, 1, "p-value", "counts");
  m_Chi2 = Create("Chi2", "Track Fit Chi2", 200, 0, 150, "Chi2", "counts");
  m_NDF = Create("NDF", "Track Fit NDF", 200, 0, 200, "NDF", "counts");
  m_Chi2NDF = Create("Chi2NDF", "Track Fit Chi2/NDF", 200, 0, 10, "Chi2/NDF", "counts");
}

DefineTracks()

void DefineTracks ( )

protectedvirtualinherited

All the following Define- functions should be used in the defineHisto() function to define histograms.

The convention is that every Define- function is responsible for creating its own TDirectory (if it's needed). In any case the function must then return to the original gDirectory. For the creation of histograms the THFFactory or the Create- functions should be used. Define histograms with track indexes.

Definition at line 327 of file DQMHistoModuleBase.cc.

{
  int iTracks = 30;
 
  auto tracks = Axis(iTracks, 0, iTracks, "# tracks");
  auto factory = Factory(this).xAxisDefault(tracks).yTitleDefault("counts");
 
  m_TracksVXD = factory.CreateTH1F("NoOfTracksInVXDOnly", "Number of VXD-Only Tracks per Event");
  m_TracksCDC = factory.CreateTH1F("NoOfTracksInCDCOnly", "Number of CDC-Only Tracks per Event");
  m_TracksVXDCDC = factory.CreateTH1F("NoOfTracksInVXDCDC", "Number of VXD+CDC Tracks per Event");
  m_Tracks = factory.CreateTH1F("NoOfTracks", "Number of Tracks per Event");
}

DefineTRClusters()

void DefineTRClusters ( )

protectedvirtualinherited

Define histograms with correlations between neighbor layers and cluster hitmap in IP angle range.

Track related clusters - hitmap in IP angle range

Track related clusters - neighbor corelations in Phi

Track related clusters - neighbor corelations in Theta

Definition at line 370 of file DQMHistoModuleBase.cc.

{
  double range = 180; // in um
  int nbins = 360;
 
  auto gTools = VXD::GeoCache::getInstance().getGeoTools();
 
  int nVXDLayers = gTools->getNumberOfLayers();
  VXD::GeoCache& geo = VXD::GeoCache::getInstance();
 
  m_TRClusterCorrelationsPhi = new TH2F*[nVXDLayers - 1];
  m_TRClusterCorrelationsTheta = new TH2F*[nVXDLayers - 1];
 
  m_TRClusterHitmap = CreateLayers(format("TRClusterHitmapLayer%1%"), format("Cluster Hitmap for layer %1%"), nbins, -range, range,
                                   nbins / 2, .0, range, "Phi angle [deg]", "Theta angle [deg]", "counts");
 
  for (VxdID layer : geo.getLayers()) {
    int layerNumber = layer.getLayerNumber();
    if (layerNumber == gTools->getLastLayer())
      continue;
 
    int layerIndex = gTools->getLayerIndex(layerNumber);
 
    std::string name = str(format("CorrelationsPhiLayers_%1%_%2%") % layerNumber % (layerNumber + 1));
    std::string title = str(format("Correlations in Phi for Layers %1% %2%") % layerNumber % (layerNumber + 1));
    std::string xTitle = str(format("angle layer %1% [deg]") % layerNumber);
    std::string yTitle = str(format("angle layer %1% [deg]") % (layerNumber + 1));
    m_TRClusterCorrelationsPhi[layerIndex] = Create(name, title, nbins, -range, range, nbins, -range, range,
                                                    xTitle, yTitle, "counts");
 
    name = str(format("CorrelationsThetaLayers_%1%_%2%") % layerNumber % (layerNumber + 1));
    title = str(format("Correlations in Theta for Layers %1% %2%") % layerNumber % (layerNumber + 1));
    m_TRClusterCorrelationsTheta[layerIndex] = Create(name, title, nbins / 2, .0, range, nbins / 2, .0, range,
                                                      xTitle, yTitle, "counts");
  }
}

DefineUBResidualsVXD()

void DefineUBResidualsVXD ( )

protectedvirtualinherited

Define histograms with unbiased residuals in PXD and SVD sensors.

Definition at line 223 of file DQMHistoModuleBase.cc.

{
  double residualRange = 400;  // in um
 
  auto residualU = Axis(200, -residualRange, residualRange, "residual U [#mum]");
  auto residualV = Axis(residualU).title("residual V [#mum]");
 
  auto factory = Factory(this);
  factory.xAxisDefault(residualU).yAxisDefault(residualV).zTitleDefault("counts");
 
  if (! m_hltDQM)
    m_UBResidualsPXD = factory.CreateTH2F("UBResidualsPXD", "PXD Unbiased Residuals");
  m_UBResidualsSVD = factory.CreateTH2F("UBResidualsSVD", "SVD Unbiased Residuals");
 
  factory.xAxisDefault(residualU).yTitleDefault("counts");
 
  if (! m_hltDQM)
    m_UBResidualsPXDU = factory.CreateTH1F("UBResidualsPXDU", "PXD Unbiased residuals in U");
  m_UBResidualsSVDU = factory.CreateTH1F("UBResidualsSVDU", "SVD Unbiased residuals in U");
 
  factory.xAxisDefault(residualV);
 
  if (! m_hltDQM)
    m_UBResidualsPXDV = factory.CreateTH1F("UBResidualsPXDV", "PXD Unbiased residuals in V");
  m_UBResidualsSVDV = factory.CreateTH1F("UBResidualsSVDV", "SVD Unbiased residuals in V");
}

EditHistogramParameter()

void EditHistogramParameter ( TH1 *  histogram, const std::string &  parameter, std::string  value  )

protectedinherited

On given histogram sets given parameter to given value.

Used in the function above.

Definition at line 665 of file DQMHistoModuleBase.cc.

{
  if (parameter == "title") {
    histogram->SetTitle(value.c_str());
    return;
  }
  if (parameter == "nbinsx") {
    auto axis = histogram->GetXaxis();
    axis->Set(stoi(value), axis->GetXmin(), axis->GetXmax());
    return;
  }
  if (parameter == "xlow") {
    auto axis = histogram->GetXaxis();
    axis->Set(axis->GetNbins(), stod(value), axis->GetXmax());
    return;
  }
  if (parameter == "xup") {
    auto axis = histogram->GetXaxis();
    axis->Set(axis->GetNbins(), axis->GetXmin(), stod(value));
    return;
  }
  if (parameter == "xTitle") {
    histogram->GetXaxis()->SetTitle(value.c_str());
    return;
  }
  if (parameter == "yTitle") {
    histogram->GetYaxis()->SetTitle(value.c_str());
    return;
  }
 
  if (dynamic_cast<TH2F*>(histogram) == nullptr) {
    B2WARNING("Parameter " + parameter + " not found in histogram " + histogram->GetName() + ", parameter change is skipped in " +
              getName() + ".");
    return;
  }
 
  if (parameter == "nbinsy") {
    auto axis = histogram->GetYaxis();
    axis->Set(stoi(value), axis->GetXmin(), axis->GetXmax());
    return;
  }
  if (parameter == "ylow") {
    auto axis = histogram->GetYaxis();
    axis->Set(axis->GetNbins(), stod(value), axis->GetXmax());
    return;
  }
  if (parameter == "yup") {
    auto axis = histogram->GetYaxis();
    axis->Set(axis->GetNbins(), axis->GetXmin(), stod(value));
    return;
  }
  if (parameter == "zTitle") {
    histogram->GetZaxis()->SetTitle(value.c_str());
    return;
  }
 
  B2WARNING("Parameter " + parameter + " not found in histogram " + histogram->GetName() + ", parameter change is skipped in " +
            getName() + ".");
}

endRun()

void endRun ( void  )

overridevirtual

Module function endRun.

Reimplemented from HistoModule.

Definition at line 91 of file AlignDQMModule.cc.

{
  VXD::GeoCache& geo = VXD::GeoCache::getInstance();
  auto gTools = geo.getGeoTools();
 
  for (VxdID layer : geo.getLayers()) {
    int layerIndex = gTools->getLayerIndex(layer.getLayerNumber());
    m_ResMeanUPhiThetaLayer[layerIndex]->Divide(m_ResMeanPhiThetaLayerCounts[layerIndex]);
    m_ResMeanVPhiThetaLayer[layerIndex]->Divide(m_ResMeanPhiThetaLayerCounts[layerIndex]);
 
    ComputeMean(m_ResMeanUPhiLayer[layerIndex], m_ResUPhiLayer[layerIndex]);
    ComputeMean(m_ResMeanVPhiLayer[layerIndex], m_ResVPhiLayer[layerIndex]);
 
    ComputeMean(m_ResMeanUThetaLayer[layerIndex], m_ResUThetaLayer[layerIndex]);
    ComputeMean(m_ResMeanVThetaLayer[layerIndex], m_ResVThetaLayer[layerIndex]);
  }
 
  for (int sensorIndex = 0; sensorIndex < gTools->getNumberOfSensors(); sensorIndex++) {
    m_ResMeanUPosUVSens[sensorIndex]->Divide(m_ResMeanPosUVSensCounts[sensorIndex]);
    m_ResMeanVPosUVSens[sensorIndex]->Divide(m_ResMeanPosUVSensCounts[sensorIndex]);
 
    ComputeMean(m_ResMeanUPosUSens[sensorIndex], m_ResUPosUSens[sensorIndex]);
    ComputeMean(m_ResMeanVPosUSens[sensorIndex], m_ResVPosUSens[sensorIndex]);
 
    ComputeMean(m_ResMeanUPosVSens[sensorIndex], m_ResUPosVSens[sensorIndex]);
    ComputeMean(m_ResMeanVPosVSens[sensorIndex], m_ResVPosVSens[sensorIndex]);
  }
}

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

Module function event.

Reimplemented from DQMHistoModuleBase.

Definition at line 80 of file AlignDQMModule.cc.

{
  DQMHistoModuleBase::event();
  if (!histogramsDefined)
    return;
 
  AlignDQMEventProcessor eventProcessor = AlignDQMEventProcessor(this, m_recoTracksStoreArrayName, m_tracksStoreArrayName);
 
  eventProcessor.Run();
}

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)

FillHalfShellsPXD()

void FillHalfShellsPXD ( const B2Vector3D &  globalResidual_um, bool  isNotYang  )

virtualinherited

Fill histograms with unbiased residuals for half-shells for PXD sensors.

Definition at line 560 of file DQMHistoModuleBase.cc.

{
  if (checkVariableForNANOrINF(globalResidual_um.X()) or
      checkVariableForNANOrINF(globalResidual_um.Y()) or
      checkVariableForNANOrINF(globalResidual_um.Z())) {
    return;
  }
  if (isNotYang) {
    m_UBResidualsPXDX_Yin->Fill(globalResidual_um.x());
    m_UBResidualsPXDY_Yin->Fill(globalResidual_um.y());
    m_UBResidualsPXDZ_Yin->Fill(globalResidual_um.z());
  } else {
    m_UBResidualsPXDX_Yang->Fill(globalResidual_um.x());
    m_UBResidualsPXDY_Yang->Fill(globalResidual_um.y());
    m_UBResidualsPXDZ_Yang->Fill(globalResidual_um.z());
  }
}

FillHalfShellsSVD()

void FillHalfShellsSVD ( const B2Vector3D &  globalResidual_um, bool  isNotMat  )

virtualinherited

Fill histograms with unbiased residuals for half-shells for SVD sensors.

Definition at line 578 of file DQMHistoModuleBase.cc.

{
  if (checkVariableForNANOrINF(globalResidual_um.X()) or
      checkVariableForNANOrINF(globalResidual_um.Y()) or
      checkVariableForNANOrINF(globalResidual_um.Z())) {
    return;
  }
  if (isNotMat) {
    m_UBResidualsSVDX_Pat->Fill(globalResidual_um.x());
    m_UBResidualsSVDY_Pat->Fill(globalResidual_um.y());
    m_UBResidualsSVDZ_Pat->Fill(globalResidual_um.z());
  } else {
    m_UBResidualsSVDX_Mat->Fill(globalResidual_um.x());
    m_UBResidualsSVDY_Mat->Fill(globalResidual_um.y());
    m_UBResidualsSVDZ_Mat->Fill(globalResidual_um.z());
  }
}

FillHelixParametersAndCorrelations()

void FillHelixParametersAndCorrelations ( const TrackFitResult *  tfr )

overridevirtual

Fill histograms with helix parameters and their correlations.

Reimplemented from DQMHistoModuleBase.

Definition at line 362 of file AlignDQMModule.cc.

{
  DQMHistoModuleBase::FillHelixParametersAndCorrelations(tfr);
 
  m_PhiZ0->Fill(tfr->getPhi0() / Unit::deg, tfr->getZ0());
  m_PhiMomPt->Fill(tfr->getPhi0() / Unit::deg, tfr->getMomentum().Rho());
  m_PhiOmega->Fill(tfr->getPhi0() / Unit::deg, tfr->getOmega());
  m_PhiTanLambda->Fill(tfr->getPhi0() / Unit::deg, tfr->getTanLambda());
  m_D0MomPt->Fill(tfr->getD0(), tfr->getMomentum().Rho());
  m_D0Omega->Fill(tfr->getD0(), tfr->getOmega());
  m_D0TanLambda->Fill(tfr->getD0(), tfr->getTanLambda());
  m_Z0MomPt->Fill(tfr->getZ0(), tfr->getMomentum().Rho());
  m_Z0Omega->Fill(tfr->getZ0(), tfr->getOmega());
  m_Z0TanLambda->Fill(tfr->getZ0(), tfr->getTanLambda());
  m_MomPtOmega->Fill(tfr->getMomentum().Rho(), tfr->getOmega());
  m_MomPtTanLambda->Fill(tfr->getMomentum().Rho(), tfr->getTanLambda());
  m_OmegaTanLambda->Fill(tfr->getOmega(), tfr->getTanLambda());
}

FillHitNumbers()

void FillHitNumbers ( int  nPXD, int  nSVD, int  nCDC  )

virtualinherited

Fill histograms with numbers of hits.

Definition at line 451 of file DQMHistoModuleBase.cc.

{
  if (! m_hltDQM)
    m_HitsPXD->Fill(nPXD);
  else nPXD = 0;
  m_HitsSVD->Fill(nSVD);
  m_HitsCDC->Fill(nCDC);
  m_Hits->Fill(nPXD + nSVD + nCDC);
}

FillLayers()

void FillLayers ( ROOT::Math::XYZVector  residual_um, float  phi_deg, float  theta_deg, int  layerIndex  )

virtual

Fill histograms which depend on layerIndex.

Definition at line 395 of file AlignDQMModule.cc.

{
  m_ResMeanPhiThetaLayerCounts[layerIndex]->Fill(phi_deg, theta_deg);
  m_ResMeanUPhiThetaLayer[layerIndex]->Fill(phi_deg, theta_deg, residual_um.X());
  m_ResMeanVPhiThetaLayer[layerIndex]->Fill(phi_deg, theta_deg, residual_um.Y());
  m_ResUPhiLayer[layerIndex]->Fill(phi_deg, residual_um.X());
  m_ResVPhiLayer[layerIndex]->Fill(phi_deg, residual_um.Y());
  m_ResUThetaLayer[layerIndex]->Fill(theta_deg, residual_um.X());
  m_ResVThetaLayer[layerIndex]->Fill(theta_deg, residual_um.Y());
}

FillMomentumAngles()

void FillMomentumAngles ( const TrackFitResult *  tfr )

virtualinherited

Fill histograms with track momentum Pt.

angles.

Definition at line 461 of file DQMHistoModuleBase.cc.

{
  const ROOT::Math::XYZVector mom = tfr->getMomentum();
 
  // don't fill NAN or INF
  if (checkVariableForNANOrINF(mom.X()) or checkVariableForNANOrINF(mom.Y()) or checkVariableForNANOrINF(mom.Z()) or
      checkVariableForNANOrINF(mom.Phi()) or checkVariableForNANOrINF(mom.Theta())) {
    return;
  }
 
  float Phi = mom.Phi();
  float Theta = mom.Theta();
 
  m_MomPhi->Fill(Phi / Unit::deg);
  m_MomTheta->Fill(Theta / Unit::deg);
  m_MomCosTheta->Fill(cos(Theta));
}

FillMomentumCoordinates()

void FillMomentumCoordinates ( const TrackFitResult *  tfr )

virtualinherited

Fill histograms with track momentum Pt.

coordinates.

Definition at line 479 of file DQMHistoModuleBase.cc.

{
  const ROOT::Math::XYZVector& mom = tfr->getMomentum();
 
  // don't fill NAN or INF, Mag is NAN/INF if any component is, no need to check
  if (checkVariableForNANOrINF(mom.X()) or checkVariableForNANOrINF(mom.Y()) or
      checkVariableForNANOrINF(mom.Z()) or checkVariableForNANOrINF(mom.Rho())) {
    return;
  }
 
  m_MomX->Fill(mom.X());
  m_MomY->Fill(mom.Y());
  m_MomZ->Fill(mom.Z());
  m_Mom->Fill(mom.R());
  m_MomPt->Fill(mom.Rho());
}

FillPositionSensors()

void FillPositionSensors ( ROOT::Math::XYZVector  residual_um, ROOT::Math::XYZVector  position, int  sensorIndex  )

virtual

Fill histograms which depend on position for individual sensors.

Definition at line 381 of file AlignDQMModule.cc.

{
  float positionU_mm = position.X() / Unit::mm;
  float positionV_mm = position.Y() / Unit::mm;
 
  m_ResMeanPosUVSensCounts[sensorIndex]->Fill(positionU_mm, positionV_mm);
  m_ResMeanUPosUVSens[sensorIndex]->Fill(positionU_mm, positionV_mm, residual_um.X());
  m_ResMeanVPosUVSens[sensorIndex]->Fill(positionU_mm, positionV_mm, residual_um.Y());
  m_ResUPosUSens[sensorIndex]->Fill(positionU_mm, residual_um.X());
  m_ResUPosVSens[sensorIndex]->Fill(positionV_mm, residual_um.X());
  m_ResVPosUSens[sensorIndex]->Fill(positionU_mm, residual_um.Y());
  m_ResVPosVSens[sensorIndex]->Fill(positionV_mm, residual_um.Y());
}

FillTrackFitStatus()

void FillTrackFitStatus ( const genfit::FitStatus *  tfs )

virtualinherited

Fill histograms which require FitStatus.

Definition at line 514 of file DQMHistoModuleBase.cc.

{
  // don't fill NAN or INF
  if (checkVariableForNANOrINF(tfs->getChi2()) or checkVariableForNANOrINF(tfs->getNdf())) {
    return;
  }
 
  float NDF = tfs->getNdf();
  m_NDF->Fill(NDF);
  float chi2 = tfs->getChi2();
  m_Chi2->Fill(chi2);
  if (NDF > 0) {
    float Chi2NDF = chi2 / NDF;
    m_Chi2NDF->Fill(Chi2NDF);
  }
 
  m_PValue->Fill(tfs->getPVal());
}

FillTrackIndexes()

void FillTrackIndexes ( int  iTrack, int  iTrackVXD, int  iTrackCDC, int  iTrackVXDCDC  )

virtualinherited

Fill histograms with track indexes.

Definition at line 443 of file DQMHistoModuleBase.cc.

{
  m_Tracks->Fill(iTrack);
  m_TracksVXD->Fill(iTrackVXD);
  m_TracksCDC->Fill(iTrackCDC);
  m_TracksVXDCDC->Fill(iTrackVXDCDC);
}

FillTRClusterCorrelations()

void FillTRClusterCorrelations ( float  phi_deg, float  phiPrev_deg, float  theta_deg, float  thetaPrev_deg, int  correlationIndex  )

virtualinherited

Fill histograms with correlations between neighbor layers.

Definition at line 533 of file DQMHistoModuleBase.cc.

{
  m_TRClusterCorrelationsPhi[correlationIndex]->Fill(phiPrev_deg, phi_deg);
  m_TRClusterCorrelationsTheta[correlationIndex]->Fill(thetaPrev_deg, theta_deg);
}

FillTRClusterHitmap()

void FillTRClusterHitmap ( float  phi_deg, float  theta_deg, int  layerIndex  )

virtualinherited

Fill cluster hitmap in IP angle range.

Definition at line 613 of file DQMHistoModuleBase.cc.

{
  m_TRClusterHitmap[layerIndex]->Fill(phi_deg, theta_deg);
}

FillUB1DResidualsSensor()

void FillUB1DResidualsSensor ( const B2Vector3D &  residual_um, int  sensorIndex  )

virtualinherited

Fill 1D histograms with unbiased residuals for individual sensors.

Definition at line 596 of file DQMHistoModuleBase.cc.

{
  if (checkVariableForNANOrINF(residual_um.X()) or checkVariableForNANOrINF(residual_um.Y())) {
    return;
  }
  m_UBResidualsSensorU[sensorIndex]->Fill(residual_um.x());
  m_UBResidualsSensorV[sensorIndex]->Fill(residual_um.y());
}

FillUB2DResidualsSensor()

void FillUB2DResidualsSensor ( const B2Vector3D &  residual_um, int  sensorIndex  )

virtualinherited

Fill 2D histograms with unbiased residuals for individual sensors.

Definition at line 605 of file DQMHistoModuleBase.cc.

{
  if (checkVariableForNANOrINF(residual_um.X()) or checkVariableForNANOrINF(residual_um.Y())) {
    return;
  }
  m_UBResidualsSensor[sensorIndex]->Fill(residual_um.x(), residual_um.y());
}

FillUBResidualsPXD()

void FillUBResidualsPXD ( const B2Vector3D &  residual_um )

virtualinherited

Fill histograms with unbiased residuals in PXD sensors.

Definition at line 540 of file DQMHistoModuleBase.cc.

{
  if (checkVariableForNANOrINF(residual_um.X()) or checkVariableForNANOrINF(residual_um.Y())) {
    return;
  }
  m_UBResidualsPXD->Fill(residual_um.x(), residual_um.y());
  m_UBResidualsPXDU->Fill(residual_um.x());
  m_UBResidualsPXDV->Fill(residual_um.y());
}

FillUBResidualsSVD()

void FillUBResidualsSVD ( const B2Vector3D &  residual_um )

virtualinherited

Fill histograms with unbiased residuals in SVD sensors.

Definition at line 550 of file DQMHistoModuleBase.cc.

{
  if (checkVariableForNANOrINF(residual_um.X()) or checkVariableForNANOrINF(residual_um.Y())) {
    return;
  }
  m_UBResidualsSVD->Fill(residual_um.x(), residual_um.y());
  m_UBResidualsSVDU->Fill(residual_um.x());
  m_UBResidualsSVDV->Fill(residual_um.y());
}

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

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

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  )

overridevirtualinherited

Initializer.

Reimplemented from HistoModule.

Reimplemented in TrackDQMModule, TrackingExpressRecoDQMModule, and TrackingHLTDQMModule.

Definition at line 43 of file DQMHistoModuleBase.cc.

{
  StoreArray<RecoTrack> recoTracks(m_recoTracksStoreArrayName);
  if (!recoTracks.isOptional()) {
    B2WARNING("Missing recoTracks array, " + getName() + " is skipped.");
    return;
  }
 
  StoreArray<Track> Tracks(m_tracksStoreArrayName);
  if (!Tracks.isOptional()) {
    B2WARNING("Missing Tracks array, " + getName() + " is skipped.");
    return;
  }
 
  // Register histograms (calls back defineHisto)
  REG_HISTOGRAM
}

ProcessHistogramParameterChange()

void ProcessHistogramParameterChange ( const std::string &  name, const std::string &  parameter, const std::string &  value  )

protectedinherited

Process one change in histogram parameters.

Should be applied to all items from m_histogramParameterChanges at the end of the defineHisto() function.

Parameters

name	- name of the histogram whose parameter we want to change.
parameter	- name of the parameter we want to change. Possible values are: name, title, nbinsx, xlow, xup, xTitle, yTitle (for both TH1F and TH2F) and nbinsy, ylow, yup, zTitle (only for TH2F).
value	- new value we wish the parameter of the histogram to have. Int and double values are parsed from string so they must be given correctly.

Definition at line 639 of file DQMHistoModuleBase.cc.

{
  TH1* histogram = nullptr;
 
  for (auto adept : m_histograms)
    if (adept->GetName() == name) {
      histogram = adept;
      break;
    }
 
  if (!histogram) {
    B2WARNING("Histogram " + name + " not found, parameter change is skipped in " + getName() + ".");
  } else {
    try {
      EditHistogramParameter(histogram, parameter, value);
    } catch (const std::invalid_argument& e) {
      B2WARNING("Value " + value + " of parameter " + parameter + " for histogram " + histogram->GetName() +
                " could not be parsed, parameter change is skipped in " + getName() + ".");
    } catch (const std::out_of_range& e) {
      B2WARNING("Value " + value + " of parameter " + parameter + " for histogram " + histogram->GetName() +
                " is out of range, parameter change is skipped in " + getName() + ".");
    }
  }
}

runningOnHLT()

void runningOnHLT ( )

inlineinherited

function called when the module is run on HLT

Definition at line 63 of file DQMHistoModuleBase.h.

{m_hltDQM = true;};

SensorNameDescription()

std::string SensorNameDescription ( VxdID  sensorID )

staticprotectedinherited

Creates string description of the sensor from given sensor ID to be used in a histogram name.

Its used in the CreateSensors functions.

Definition at line 121 of file DQMHistoModuleBase.cc.

{
  return str(format("%1%_%2%_%3%") % sensorID.getLayerNumber() % sensorID.getLadderNumber() % sensorID.getSensorNumber());
}

SensorTitleDescription()

std::string SensorTitleDescription ( VxdID  sensorID )

staticprotectedinherited

Creates string description of the sensor from given sensor ID to be used in a histogram title.

Its used in the CreateSensors functions.

Definition at line 126 of file DQMHistoModuleBase.cc.

{
  return str(format("Layer %1% Ladder %2% Sensor %3%") % sensorID.getLayerNumber() % sensorID.getLadderNumber() %
             sensorID.getSensorNumber());
}

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

virtual void terminate ( void  )

inlineoverridevirtualinherited

Function to terminate module.

Reimplemented from Module.

Reimplemented in CalibrationCollectorModule, B2BIIMCParticlesMonitorModule, AnalysisPhase1StudyModule, BeamabortStudyModule, BgoStudyModule, ClawStudyModule, ClawsStudyModule, CsiStudy_v2Module, CsIStudyModule, DosiStudyModule, FANGSStudyModule, He3tubeStudyModule, MicrotpcStudyModule, PindiodeStudyModule, QcsmonitorStudyModule, CDCCRTestModule, cdcDQM7Module, CDCDQMModule, MonitorDataModule, TrackAnaModule, PhysicsObjectsDQMModule, PhysicsObjectsMiraBelleBhabhaModule, PhysicsObjectsMiraBelleDst2Module, PhysicsObjectsMiraBelleDstModule, PhysicsObjectsMiraBelleHadronModule, PhysicsObjectsMiraBelleModule, ECLBackgroundModule, ECLDQMModule, ECLDQMEXTENDEDModule, ECLDQMOutOfTimeDigitsModule, KLMDQMModule, KLMDQM2Module, CDCDedxDQMModule, CDCDedxValidationModule, TOPGainEfficiencyCalculatorModule, TOPLaserHitSelectorModule, TOPInterimFENtupleModule, TOPPDFCheckerModule, TOPTBCComparatorModule, CDCTriggerNeuroDQMModule, CDCTriggerNeuroDQMOnlineModule, TRGCDCT2DDQMModule, TRGCDCT3DDQMModule, TRGCDCTSFDQMModule, TRGECLDQMModule, TRGGDLModule, TRGGDLDQMModule, TRGGRLDQMModule, TRGTOPDQMModule, TRGRAWDATAModule, SVDDQMClustersOnTrackModule, SVDDQMExpressRecoModule, and ROIDQMModule.

Definition at line 46 of file HistoModule.h.

{};

Member Data Documentation

histogramsDefined

bool histogramsDefined = false

protectedinherited

True if the defineHisto() was called.

If false, the event() function does nothing.

Definition at line 191 of file DQMHistoModuleBase.h.

m_Chi2

TH1F* m_Chi2 = nullptr

protectedinherited

Chi2.

Definition at line 205 of file DQMHistoModuleBase.h.

m_Chi2NDF

TH1F* m_Chi2NDF = nullptr

protectedinherited

Chi2 / NDF.

Definition at line 209 of file DQMHistoModuleBase.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_D0

TH1F* m_D0 = nullptr

protectedinherited

d0 - the signed distance to the IP in the r-phi plane

Definition at line 281 of file DQMHistoModuleBase.h.

m_D0MomPt

TH2F* m_D0MomPt = nullptr

protected

d0 - signed distance to the IP in r-phi vs.

Track momentum Pt

Definition at line 135 of file AlignDQMModule.h.

m_D0Omega

TH2F* m_D0Omega = nullptr

protected

d0 - signed distance to the IP in r-phi vs.

Omega - the curvature of the track

Definition at line 137 of file AlignDQMModule.h.

m_D0TanLambda

TH2F* m_D0TanLambda = nullptr

protected

d0 - signed distance to the IP in r-phi vs.

TanLambda - the slope of the track in the r-z plane

Definition at line 139 of file AlignDQMModule.h.

m_D0Z0

TH2F* m_D0Z0 = nullptr

protectedinherited

z0 vs d0 - signed distance to the IP in r-phi vs.

z0 of the perigee (to see primary vertex shifts along R or z)

Definition at line 287 of file DQMHistoModuleBase.h.

m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.h.

m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

m_histogramParameterChanges

std::vector<std::tuple<std::string, std::string, std::string> > m_histogramParameterChanges

protectedinherited

Used for changing parameters of histograms via the ProcessHistogramParameterChange function.

Definition at line 196 of file DQMHistoModuleBase.h.

m_histograms

std::vector<TH1*> m_histograms

protectedinherited

All histograms created via the Create- functions are automatically added to this set.

Its used to easy call Reset() on all histograms in beginRun() and also for changing parameters of histograms via the ProcessHistogramParameterChange function.

Definition at line 189 of file DQMHistoModuleBase.h.

m_Hits

TH1F* m_Hits = nullptr

protectedinherited

Number of all hits in tracks.

Definition at line 302 of file DQMHistoModuleBase.h.

m_HitsCDC

TH1F* m_HitsCDC = nullptr

protectedinherited

Number of hits on CDC.

Definition at line 300 of file DQMHistoModuleBase.h.

m_HitsPXD

TH1F* m_HitsPXD = nullptr

protectedinherited

Number of hits on PXD.

Definition at line 296 of file DQMHistoModuleBase.h.

m_HitsSVD

TH1F* m_HitsSVD = nullptr

protectedinherited

Number of hits on SVD.

Definition at line 298 of file DQMHistoModuleBase.h.

m_hltDQM

bool m_hltDQM = false

protectedinherited

True if the DQM module is run on HLT.

Definition at line 193 of file DQMHistoModuleBase.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_Mom

TH1F* m_Mom = nullptr

protectedinherited

Track momentum Magnitude.

Definition at line 279 of file DQMHistoModuleBase.h.

m_MomCosTheta

TH1F* m_MomCosTheta = nullptr

protectedinherited

Track momentum Pt.CosTheta.

Definition at line 269 of file DQMHistoModuleBase.h.

m_MomPhi

TH1F* m_MomPhi = nullptr

protectedinherited

Track momentum Pt.Phi.

Definition at line 265 of file DQMHistoModuleBase.h.

m_MomPt

TH1F* m_MomPt = nullptr

protectedinherited

Track momentum Pt.

Definition at line 277 of file DQMHistoModuleBase.h.

m_MomPtOmega

TH2F* m_MomPtOmega = nullptr

protected

Track momentum Pt vs.

Omega - the curvature of the track

Definition at line 147 of file AlignDQMModule.h.

m_MomPtTanLambda

TH2F* m_MomPtTanLambda = nullptr

protected

Track momentum Pt vs.

TanLambda - the slope of the track in the r-z plane

Definition at line 149 of file AlignDQMModule.h.

m_MomTheta

TH1F* m_MomTheta = nullptr

protectedinherited

Track momentum Pt.Theta.

Definition at line 267 of file DQMHistoModuleBase.h.

m_MomX

TH1F* m_MomX = nullptr

protectedinherited

Track momentum Pt.X.

Definition at line 271 of file DQMHistoModuleBase.h.

m_MomY

TH1F* m_MomY = nullptr

protectedinherited

Track momentum Pt.Y.

Definition at line 273 of file DQMHistoModuleBase.h.

m_MomZ

TH1F* m_MomZ = nullptr

protectedinherited

Track momentum Pt.Z.

Definition at line 275 of file DQMHistoModuleBase.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_NDF

TH1F* m_NDF = nullptr

protectedinherited

NDF.

Definition at line 207 of file DQMHistoModuleBase.h.

m_Omega

TH1F* m_Omega = nullptr

protectedinherited

Omega - the curvature of the track.

It's sign is defined by the charge of the particle

Definition at line 293 of file DQMHistoModuleBase.h.

m_OmegaTanLambda

TH2F* m_OmegaTanLambda = nullptr

protected

Omega - the curvature of the track vs.

TanLambda - the slope of the track in the r-z plane

Definition at line 151 of file AlignDQMModule.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_Phi

TH1F* m_Phi = nullptr

protectedinherited

Phi - the angle of the transverse momentum in the r-phi plane, with CDF naming convention.

Definition at line 289 of file DQMHistoModuleBase.h.

m_PhiD0

TH2F* m_PhiD0 = nullptr

protectedinherited

d0 vs Phi - the signed distance to the IP in the r-phi plane

Definition at line 283 of file DQMHistoModuleBase.h.

m_PhiMomPt

TH2F* m_PhiMomPt = nullptr

protected

Phi - the angle of the transverse momentum in the r-phi plane vs.

Track momentum Pt

Definition at line 129 of file AlignDQMModule.h.

m_PhiOmega

TH2F* m_PhiOmega = nullptr

protected

Phi - the angle of the transverse momentum in the r-phi plane vs.

Omega - the curvature of the track

Definition at line 131 of file AlignDQMModule.h.

m_PhiTanLambda

TH2F* m_PhiTanLambda = nullptr

protected

Phi - the angle of the transverse momentum in the r-phi plane vs.

TanLambda - the slope of the track in the r-z plane

Definition at line 133 of file AlignDQMModule.h.

m_PhiZ0

TH2F* m_PhiZ0 = nullptr

protected

helix parameters and their corellations

Phi - the angle of the transverse momentum in the r-phi plane vs. z0 of the perigee (to see primary vertex shifts along R or z)

Definition at line 127 of file AlignDQMModule.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_PValue

TH1F* m_PValue = nullptr

protectedinherited

p Value

Definition at line 203 of file DQMHistoModuleBase.h.

m_recoTracksStoreArrayName

std::string m_recoTracksStoreArrayName

protectedinherited

StoreArray name where RecoTracks are written.

Definition at line 200 of file DQMHistoModuleBase.h.

m_ResMeanPhiThetaLayerCounts

TH2F** m_ResMeanPhiThetaLayerCounts = nullptr

protected

Special Alignment related: Layer level.

ResidaulMean vs Phi vs Theta counter for Layer

Definition at line 103 of file AlignDQMModule.h.

m_ResMeanPosUVSensCounts

TH2F** m_ResMeanPosUVSensCounts = nullptr

protected

Special Alignment related: Sensor level.

ResidaulMean vs U vs V counter for sensor

Definition at line 79 of file AlignDQMModule.h.

m_ResMeanUPhiLayer

TH1F** m_ResMeanUPhiLayer = nullptr

protected

ResidaulMeanU vs Phi for Layer.

Definition at line 117 of file AlignDQMModule.h.

m_ResMeanUPhiThetaLayer

TH2F** m_ResMeanUPhiThetaLayer = nullptr

protected

ResidaulMeanU vs Phi vs Theta for Layer.

Definition at line 105 of file AlignDQMModule.h.

m_ResMeanUPosUSens

TH1F** m_ResMeanUPosUSens = nullptr

protected

ResidaulMeanU vs U for sensor.

Definition at line 93 of file AlignDQMModule.h.

m_ResMeanUPosUVSens

TH2F** m_ResMeanUPosUVSens = nullptr

protected

ResidaulMeanU vs U vs V for sensor.

Definition at line 81 of file AlignDQMModule.h.

m_ResMeanUPosVSens

TH1F** m_ResMeanUPosVSens = nullptr

protected

ResidaulMeanU vs V for sensor.

Definition at line 95 of file AlignDQMModule.h.

m_ResMeanUThetaLayer

TH1F** m_ResMeanUThetaLayer = nullptr

protected

ResidaulMeanU vs Theta for Layer.

Definition at line 119 of file AlignDQMModule.h.

m_ResMeanVPhiLayer

TH1F** m_ResMeanVPhiLayer = nullptr

protected

ResidaulMeanV vs Phi for Layer.

Definition at line 121 of file AlignDQMModule.h.

m_ResMeanVPhiThetaLayer

TH2F** m_ResMeanVPhiThetaLayer = nullptr

protected

ResidaulMeanU vs Phi vs Theta for Layer.

Definition at line 107 of file AlignDQMModule.h.

m_ResMeanVPosUSens

TH1F** m_ResMeanVPosUSens = nullptr

protected

ResidaulMeanV vs U for sensor.

Definition at line 97 of file AlignDQMModule.h.

m_ResMeanVPosUVSens

TH2F** m_ResMeanVPosUVSens = nullptr

protected

ResidaulMeanU vs U vs V for sensor.

Definition at line 83 of file AlignDQMModule.h.

m_ResMeanVPosVSens

TH1F** m_ResMeanVPosVSens = nullptr

protected

ResidaulMeanV vs V for sensor.

Definition at line 99 of file AlignDQMModule.h.

m_ResMeanVThetaLayer

TH1F** m_ResMeanVThetaLayer = nullptr

protected

ResidaulMeanV vs Theta for Layer.

Definition at line 123 of file AlignDQMModule.h.

m_ResUPhiLayer

TH2F** m_ResUPhiLayer = nullptr

protected

ResidaulU vs Phi for Layer.

Definition at line 109 of file AlignDQMModule.h.

m_ResUPosUSens

TH2F** m_ResUPosUSens = nullptr

protected

ResidaulU vs U for sensor.

Definition at line 85 of file AlignDQMModule.h.

m_ResUPosVSens

TH2F** m_ResUPosVSens = nullptr

protected

ResidaulU vs V for sensor.

Definition at line 87 of file AlignDQMModule.h.

m_ResUThetaLayer

TH2F** m_ResUThetaLayer = nullptr

protected

ResidaulU vs Theta for Layer.

Definition at line 111 of file AlignDQMModule.h.

m_ResVPhiLayer

TH2F** m_ResVPhiLayer = nullptr

protected

ResidaulV vs Phi for Layer.

Definition at line 113 of file AlignDQMModule.h.

m_ResVPosUSens

TH2F** m_ResVPosUSens = nullptr

protected

ResidaulV vs U for sensor.

Definition at line 89 of file AlignDQMModule.h.

m_ResVPosVSens

TH2F** m_ResVPosVSens = nullptr

protected

ResidaulV vs V for sensor.

Definition at line 91 of file AlignDQMModule.h.

m_ResVThetaLayer

TH2F** m_ResVThetaLayer = nullptr

protected

ResidaulV vs Theta for Layer.

Definition at line 115 of file AlignDQMModule.h.

m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 519 of file Module.h.

m_TanLambda

TH1F* m_TanLambda = nullptr

protectedinherited

TanLambda - the slope of the track in the r-z plane.

Definition at line 291 of file DQMHistoModuleBase.h.

m_Tracks

TH1F* m_Tracks = nullptr

protectedinherited

Number of all finding tracks.

Definition at line 310 of file DQMHistoModuleBase.h.

m_TracksCDC

TH1F* m_TracksCDC = nullptr

protectedinherited

Number of tracks only with CDC.

Definition at line 306 of file DQMHistoModuleBase.h.

m_tracksStoreArrayName

std::string m_tracksStoreArrayName

protectedinherited

StoreArray name where Tracks are written.

Definition at line 198 of file DQMHistoModuleBase.h.

m_TracksVXD

TH1F* m_TracksVXD = nullptr

protectedinherited

Number of tracks only with VXD.

Definition at line 304 of file DQMHistoModuleBase.h.

m_TracksVXDCDC

TH1F* m_TracksVXDCDC = nullptr

protectedinherited

Number of full tracks with VXD+CDC.

Definition at line 308 of file DQMHistoModuleBase.h.

m_TRClusterCorrelationsPhi

TH2F** m_TRClusterCorrelationsPhi = nullptr

protectedinherited

Track related clusters - neighbor correlations in Phi.

Definition at line 260 of file DQMHistoModuleBase.h.

m_TRClusterCorrelationsTheta

TH2F** m_TRClusterCorrelationsTheta = nullptr

protectedinherited

Track related clusters - neighbor corelations in Theta.

Definition at line 262 of file DQMHistoModuleBase.h.

m_TRClusterHitmap

TH2F** m_TRClusterHitmap = nullptr

protectedinherited

Track related clusters - hitmap in IP angle range.

Definition at line 258 of file DQMHistoModuleBase.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.

m_UBResidualsPXD

TH2F* m_UBResidualsPXD = nullptr

protectedinherited

Unbiased residuals for PXD u vs v.

Definition at line 211 of file DQMHistoModuleBase.h.

m_UBResidualsPXDU

TH1F* m_UBResidualsPXDU = nullptr

protectedinherited

Unbiased residuals for PXD u.

Definition at line 217 of file DQMHistoModuleBase.h.

m_UBResidualsPXDV

TH1F* m_UBResidualsPXDV = nullptr

protectedinherited

Unbiased residuals for PXD v.

Definition at line 223 of file DQMHistoModuleBase.h.

m_UBResidualsPXDX_Yang

TH1F* m_UBResidualsPXDX_Yang = nullptr

protectedinherited

Unbiased residuals in X for PXD for Yang.

Definition at line 231 of file DQMHistoModuleBase.h.

m_UBResidualsPXDX_Yin

TH1F* m_UBResidualsPXDX_Yin = nullptr

protectedinherited

half-shells

Unbiased residuals in X for PXD for Yin

Definition at line 229 of file DQMHistoModuleBase.h.

m_UBResidualsPXDY_Yang

TH1F* m_UBResidualsPXDY_Yang = nullptr

protectedinherited

Unbiased residuals in Y for PXD for Yang.

Definition at line 240 of file DQMHistoModuleBase.h.

m_UBResidualsPXDY_Yin

TH1F* m_UBResidualsPXDY_Yin = nullptr

protectedinherited

Unbiased residuals in Y for PXD for Yin.

Definition at line 238 of file DQMHistoModuleBase.h.

m_UBResidualsPXDZ_Yang

TH1F* m_UBResidualsPXDZ_Yang = nullptr

protectedinherited

Unbiased residuals in Z for PXD for Yang.

Definition at line 249 of file DQMHistoModuleBase.h.

m_UBResidualsPXDZ_Yin

TH1F* m_UBResidualsPXDZ_Yin = nullptr

protectedinherited

Unbiased residuals in Z for PXD for Yin.

Definition at line 247 of file DQMHistoModuleBase.h.

m_UBResidualsSensor

TH2F** m_UBResidualsSensor = nullptr

protectedinherited

Unbiased residuals for PXD and SVD u vs v per sensor.

Definition at line 215 of file DQMHistoModuleBase.h.

m_UBResidualsSensorU

TH1F** m_UBResidualsSensorU = nullptr

protectedinherited

Unbiased residuals for PXD and SVD u per sensor.

Definition at line 221 of file DQMHistoModuleBase.h.

m_UBResidualsSensorV

TH1F** m_UBResidualsSensorV = nullptr

protectedinherited

Unbiased residuals for PXD and SVD v per sensor.

Definition at line 256 of file DQMHistoModuleBase.h.

m_UBResidualsSVD

TH2F* m_UBResidualsSVD = nullptr

protectedinherited

Unbiased residuals for SVD u vs v.

Definition at line 213 of file DQMHistoModuleBase.h.

m_UBResidualsSVDU

TH1F* m_UBResidualsSVDU = nullptr

protectedinherited

Unbiased residuals for SVD u.

Definition at line 219 of file DQMHistoModuleBase.h.

m_UBResidualsSVDV

TH1F* m_UBResidualsSVDV = nullptr

protectedinherited

Unbiased residuals for SVD v.

Definition at line 225 of file DQMHistoModuleBase.h.

m_UBResidualsSVDX_Mat

TH1F* m_UBResidualsSVDX_Mat = nullptr

protectedinherited

Unbiased residuals in X for PXD for Mat.

Definition at line 235 of file DQMHistoModuleBase.h.

m_UBResidualsSVDX_Pat

TH1F* m_UBResidualsSVDX_Pat = nullptr

protectedinherited

Unbiased residuals in X for PXD for Pat.

Definition at line 233 of file DQMHistoModuleBase.h.

m_UBResidualsSVDY_Mat

TH1F* m_UBResidualsSVDY_Mat = nullptr

protectedinherited

Unbiased residuals in Y for PXD for Mat.

Definition at line 244 of file DQMHistoModuleBase.h.

m_UBResidualsSVDY_Pat

TH1F* m_UBResidualsSVDY_Pat = nullptr

protectedinherited

Unbiased residuals in Y for PXD for Pat.

Definition at line 242 of file DQMHistoModuleBase.h.

m_UBResidualsSVDZ_Mat

TH1F* m_UBResidualsSVDZ_Mat = nullptr

protectedinherited

Unbiased residuals in Z for PXD for Mat.

Definition at line 253 of file DQMHistoModuleBase.h.

m_UBResidualsSVDZ_Pat

TH1F* m_UBResidualsSVDZ_Pat = nullptr

protectedinherited

Unbiased residuals in Z for PXD for Pat.

Definition at line 251 of file DQMHistoModuleBase.h.

m_Z0

TH1F* m_Z0 = nullptr

protectedinherited

z0 - the z0 coordinate of the perigee (beam spot position)

Definition at line 285 of file DQMHistoModuleBase.h.

m_Z0MomPt

TH2F* m_Z0MomPt = nullptr

protected

z0 - the z0 coordinate of the perigee vs.

Track momentum Pt

Definition at line 141 of file AlignDQMModule.h.

m_Z0Omega

TH2F* m_Z0Omega = nullptr

protected

z0 - the z0 coordinate of the perigee vs.

Omega - the curvature of the track

Definition at line 143 of file AlignDQMModule.h.

m_Z0TanLambda

TH2F* m_Z0TanLambda = nullptr

protected

z0 - the z0 coordinate of the perigee vs.

TanLambda - the slope of the track in the r-z plane

Definition at line 145 of file AlignDQMModule.h.

---

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

• alignment/modules/AlignmentDQM/include/AlignDQMModule.h
• alignment/modules/AlignmentDQM/src/AlignDQMModule.cc