MillepedeCollectorModule Class Reference

Calibration data collector for Millepede Algorithm. More...

#include <MillepedeCollectorModule.h>

Inheritance diagram for MillepedeCollectorModule:

Collaboration diagram for MillepedeCollectorModule:

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
	MillepedeCollectorModule ()
	Constructor: Sets the description, the properties and the parameters of the module.
virtual void	prepare () override
	Prepration.
virtual void	collect () override
	Data collection.
virtual void	closeRun () override
	Only for closing mille binaries after each run.
virtual void	finish () override
	Register mille binaries in file catalog.
std::string	getUniqueMilleName ()
	Make a name for mille binary (encodes module name + starting exp, run and event + process id)
std::vector< genfit::Track * >	getParticlesTracks (std::vector< Particle * > particles, bool addVertexPoint=true)
	Get all useable tracks for particles. More...
bool	fitRecoTrack (RecoTrack &recoTrack, Particle *particle=nullptr)
	Fit given RecoTrack with GBL. More...
TMatrixD	getGlobalToLocalTransform (const genfit::MeasuredStateOnPlane &msop)
	Compute the transformation matrix d(q/p,u',v',u,v)/d(x,y,z,px,py,pz) from state at first track point (vertex) More...
TMatrixD	getLocalToGlobalTransform (const genfit::MeasuredStateOnPlane &msop)
	Compute the transformation matrix d(x,y,z,px,py,pz)/d(q/p,u',v',u,v) from state at first track point (vertex) More...
std::pair< TMatrixD, TMatrixD >	getTwoBodyToLocalTransform (Particle &mother, double motherMass)
	Compute the transformation matrices d(q/p,u'v',u,v)/d(vx,vy,vz,px,py,pz,theta,phi,M) = dq/d(v,z) for both particles in pair. More...
void	storeTrajectory (gbl::GblTrajectory &trajectory)
	Write down a GBL trajectory (to TTree or binary file)
std::tuple< B2Vector3D, TMatrixDSym >	getPrimaryVertexAndCov () const
	Get the primary vertex position estimation and its size from BeamSpot. More...
void	initialize () final
	Set up a default RunRange object in datastore and call prepare()
void	event () final
	Check current experiment and run and update if needed, fill into RunRange and collect()
void	beginRun () final
	Reset the m_runCollectOnRun flag, if necessary, to begin collection again. More...
void	endRun () final
	Write the current collector objects to a file and clear their memory.
void	terminate () final
	Write the final objects to the file.
void	defineHisto () final
	Runs due to HistoManager, allows us to discover the correct file.
template<class T >
void	registerObject (std::string name, T *obj)
	Register object with a name, takes ownership, do not access the pointer beyond prepare()
template<class T >
T *	getObjectPtr (std::string name)
	Calls the CalibObjManager to get the requested stored collector data.
virtual std::vector< std::string >	getFileNames (bool outputFiles)
	Return a list of output filenames for this modules. More...
const std::string &	getName () const
	Returns the name of the module. More...
const std::string &	getType () const
	Returns the type of the module (i.e. More...
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. More...
void	setPropertyFlags (unsigned int propertyFlags)
	Sets the flags for the module properties. More...
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. More...
void	if_value (const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	Add a condition to the module. More...
void	if_false (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to add a condition to the module. More...
void	if_true (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to set the condition of the module. More...
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. More...
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). More...
Module::EAfterConditionPath	getAfterConditionPath () const
	What to do after the conditional path is finished. More...
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. More...
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. More...
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. More...
std::shared_ptr< PathElement >	clone () const override
	Create an independent copy of this module. More...
std::shared_ptr< boost::python::list >	getParamInfoListPython () const
	Returns a python list of all parameters. More...

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

Protected Member Functions
virtual void	startRun ()
	Replacement for beginRun(). Do anything you would normally do in beginRun here.
virtual void	inDefineHisto ()
	Replacement for defineHisto(). Do anything you would normally do in defineHisto here.
virtual void	def_initialize ()
	Wrappers to make the methods without "def_" prefix callable from Python. More...
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. More...
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. More...
void	setType (const std::string &type)
	Set the module type. More...
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. More...
template<typename T >
void	addParam (const std::string &name, T &paramVariable, const std::string &description)
	Adds a new enforced parameter to the module. More...
void	setReturnValue (int value)
	Sets the return value for this module as integer. More...
void	setReturnValue (bool value)
	Sets the return value for this module as bool. More...
void	setParamList (const ModuleParamList &params)
	Replace existing parameter list.

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

Private Member Functions
void	updateMassWidthIfSet (std::string listName, double &mass, double &width)
	Update mass and width of the particle (mother in list) with user custom-defined values.
bool	getPreScaleChoice ()
	I'm a little worried about floating point precision when comparing to 0.0 and 1.0 as special values. More...
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. More...
void	setParamPythonDict (const boost::python::dict &dictionary)
	Implements a method for reading the parameter values from a boost::python dictionary. More...

Private Attributes
std::vector< std::string >	m_tracks
	Names of arrays with single RecoTracks fitted by GBL.
std::vector< std::string >	m_particles
	Names of particle list with single particles.
std::vector< std::string >	m_vertices
	Name of particle list with mothers of daughters to be used with vertex constraint in calibration.
std::vector< std::string >	m_primaryVertices
	Name of particle list with mothers of daughters to be used with vertex + IP profile (+ optional calibration) constraint in calibration.
std::vector< std::string >	m_twoBodyDecays
	Name of particle list with mothers of daughters to be used with vertex + mass constraint in calibration.
std::vector< std::string >	m_primaryTwoBodyDecays
	Name of particle list with mothers of daughters to be used with vertex + IP profile (+ optional calibration) + IP kinematics (+ optional calibration) constraint in calibration.
std::vector< std::string >	m_primaryMassTwoBodyDecays
	Name of particle list with mothers of daughters to be used with vertex + IP profile + mass constraint in calibration.
std::vector< std::string >	m_primaryMassVertexTwoBodyDecays
	Name of particle list with mothers of daughters to be used with vertex + IP profile + mass constraint in calibration.
double	m_stableParticleWidth
	Width (in GeV/c/c) to use for invariant mass constraint for 'stable' particles (like K short). More...
bool	m_doublePrecision
	Use double (instead of single/float) precision for binary files.
bool	m_calibrateVertex
	Add derivatives for beam spot vertex calibration for primary vertices.
bool	m_calibrateKinematics = true
	Add derivatives for beam spot kinematics calibration for primary vertices.
double	m_minPValue
	Minimum p.value for output.
bool	m_useGblTree
	Whether to use TTree to accumulate GBL data instead of binary files.
bool	m_absFilePaths
	Use absolute path to locate binary files in MilleData.
std::vector< std::string >	m_components {}
	Whether to use VXD alignment hierarchy.
int	m_externalIterations
	Number of external iterations of GBL fitter.
std::string	m_internalIterations
	String defining internal GBL iterations for outlier down-weighting.
int	m_recalcJacobians
	Up to which external iteration propagation Jacobians should be re-calculated.
bool	m_fitTrackT0
	Add local parameter for track T0 fit in GBL (local derivative)
bool	m_updateCDCWeights
	Update L/R weights from previous DAF fit result?
double	m_minCDCHitWeight
	Minimum CDC hit weight.
double	m_minUsedCDCHitFraction
	Minimum CDC used hit fraction.
int	m_hierarchyType
	Type of alignment hierarchy (for VXD only for now): 0 = None, 1 = Flat (only constraints, no new global parameters/derivatives), 2 = Half-Shells + sensors (no ladders), 3 = Full.
bool	m_enablePXDHierarchy
	enable PXD hierarchy
bool	m_enableSVDHierarchy
	enable SVD hierarchy
bool	m_enableWireByWireAlignment
	Enable global derivatives for wire-by-wire alignment.
bool	m_enableWireSagging
	Enable global derivatives for wire sagging.
std::vector< std::tuple< int, int, int > >	m_eventNumbers {}
	List of event meta data entries at which payloads can change for timedep calibration.
std::vector< std::tuple< std::vector< int >, std::vector< std::tuple< int, int, int > > > >	m_timedepConfig
	Config for time dependence: list( tuple( list( param1, param2, ... More...
std::map< std::string, std::tuple< double, double > >	m_customMassConfig
	Map of list_name -> (mass, width) for custom mass and width setting.
std::vector< gbl::GblData >	m_currentGblData {}
	Current vector of GBL data from trajectory to be stored in a tree.
StoreObjPtr< EventT0 >	m_eventT0
	Optional input for EventT0.
StoreObjPtr< EventMetaData >	m_evtMetaData
	Required object pointer to EventMetaData.
std::string	m_granularity
	Granularity of data collection = run|all(= no granularity, exp,run=-1,-1)
int	m_maxEventsPerRun
	Maximum number of events to be collected at the start of each run (-1 = no maximum)
float	m_preScale
	Prescale module parameter, this fraction of events will have collect() run on them [0.0 -> 1.0].
bool	m_runCollectOnRun = true
	Whether or not we will run the collect() at all this run, basically skips the event() function if false.
std::map< Calibration::ExpRun, int >	m_expRunEvents
	How many events processed for each ExpRun so far, stops counting up once max is hit Only used/incremented if m_maxEventsPerRun > -1.
int *	m_eventsCollectedInRun
	Will point at correct value in m_expRunEvents.
std::string	m_name
	The name of the module, saved as a string (user-modifiable)
std::string	m_type
	The type of the module, saved as a string.
std::string	m_package
	Package this module is found in (may be empty).
std::string	m_description
	The description of the module.
unsigned int	m_propertyFlags
	The properties of the module as bitwise or (with |) of EModulePropFlags.
LogConfig	m_logConfig
	The log system configuration of the module.
ModuleParamList	m_moduleParamList
	List storing and managing all parameter of the module.
bool	m_hasReturnValue
	True, if the return value is set.
int	m_returnValue
	The return value.
std::vector< ModuleCondition >	m_conditions
	Module condition, only non-null if set.

Detailed Description

Calibration data collector for Millepede Algorithm.

Collects data from GBL-fitted tracks and produces binary files for Millepede

Definition at line 34 of file MillepedeCollectorModule.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.

Member Function Documentation

beginRun()

void beginRun ( void  )

finalvirtualinherited

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

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

Reimplemented from HistoModule.

Definition at line 77 of file CalibrationCollectorModule.cc.

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

clone()

std::shared_ptr< PathElement > clone ( ) const

overridevirtualinherited

Create an independent copy of this module.

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

Implements PathElement.

Definition at line 179 of file Module.cc.

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.

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.

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.

fitRecoTrack()

bool fitRecoTrack	(	RecoTrack &	recoTrack,
		Particle *	particle = nullptr
	)

Fit given RecoTrack with GBL.

Parameters

recoTrack	A RecoTrack object to be fitted
particle	Pointer to reconstructed daughter particle updated by vertex fit OR nullptr for single track

Returns

true for success, false when some problems occured (or track too much down-weighted by previous DAF fit)

Definition at line 1036 of file MillepedeCollectorModule.cc.

{
  try {
    // For already fitted tracks, try to get fitted (DAF) weights for CDC
    if (m_updateCDCWeights && recoTrack.getNumberOfCDCHits() && recoTrack.getTrackFitStatus()
        && recoTrack.getTrackFitStatus()->isFitted()) {
      double sumCDCWeights = recoTrack.getNumberOfCDCHits(); // start with full weights
      // Do the hits synchronisation
      auto relatedRecoHitInformation =
        recoTrack.getRelationsTo<RecoHitInformation>(recoTrack.getStoreArrayNameOfRecoHitInformation());
 
      for (RecoHitInformation& recoHitInformation : relatedRecoHitInformation) {
 
        if (recoHitInformation.getFlag() == RecoHitInformation::c_pruned) {
          B2FATAL("Found pruned point in RecoTrack. Pruned tracks cannot be used in MillepedeCollector.");
        }
 
        if (recoHitInformation.getTrackingDetector() != RecoHitInformation::c_CDC) continue;
 
        const genfit::TrackPoint* trackPoint = recoTrack.getCreatedTrackPoint(&recoHitInformation);
        if (trackPoint) {
          if (not trackPoint->hasFitterInfo(recoTrack.getCardinalRepresentation()))
            continue;
          auto kalmanFitterInfo = dynamic_cast<genfit::KalmanFitterInfo*>(trackPoint->getFitterInfo());
          if (not kalmanFitterInfo) {
            continue;
          } else {
            std::vector<double> weights = kalmanFitterInfo->getWeights();
            if (weights.size() == 2) {
              if (weights.at(0) > weights.at(1))
                recoHitInformation.setRightLeftInformation(RecoHitInformation::c_left);
              else if (weights.at(0) < weights.at(1))
                recoHitInformation.setRightLeftInformation(RecoHitInformation::c_right);
 
              double weightLR = weights.at(0) + weights.at(1);
              if (weightLR < m_minCDCHitWeight)  recoHitInformation.setUseInFit(false);
              sumCDCWeights += weightLR - 1.; // reduce weight sum if weightLR<1
            }
          }
        }
      }
 
      double usedCDCHitFraction = sumCDCWeights / double(recoTrack.getNumberOfCDCHits());
      getObjectPtr<TH1F>("cdc_hit_fraction")->Fill(usedCDCHitFraction);
      if (usedCDCHitFraction < m_minUsedCDCHitFraction)
        return false;
    }
  } catch (...) {
    B2ERROR("Error in checking DAF weights from previous fit to resolve hit ambiguity. Why? Failed fit points in DAF? Skip track to be sure.");
    return false;
  }
 
  std::shared_ptr<genfit::GblFitter> gbl(new genfit::GblFitter());
  gbl->setOptions(m_internalIterations, true, true, m_externalIterations, m_recalcJacobians);
  gbl->setTrackSegmentController(new GblMultipleScatteringController);
 
  MeasurementAdder factory("", "", "", "", "");
 
  // We need the store arrays
  StoreArray<RecoHitInformation::UsedCDCHit> cdcHits("");
  StoreArray<RecoHitInformation::UsedPXDHit> pxdHits("");
  StoreArray<RecoHitInformation::UsedSVDHit> svdHits("");
  StoreArray<RecoHitInformation::UsedBKLMHit> bklmHits("");
  StoreArray<RecoHitInformation::UsedEKLMHit> eklmHits("");
 
  // Create the genfit::MeasurementFactory
  genfit::MeasurementFactory<genfit::AbsMeasurement> genfitMeasurementFactory;
 
  // Add producer for alignable RecoHits to factory
  if (pxdHits.isOptional()) {
    genfit::MeasurementProducer <RecoHitInformation::UsedPXDHit, AlignablePXDRecoHit>* PXDProducer =  new genfit::MeasurementProducer
    <RecoHitInformation::UsedPXDHit, AlignablePXDRecoHit> (pxdHits.getPtr());
    genfitMeasurementFactory.addProducer(Const::PXD, PXDProducer);
  }
 
  if (svdHits.isOptional())  {
    genfit::MeasurementProducer <RecoHitInformation::UsedSVDHit, AlignableSVDRecoHit>* SVDProducer =  new genfit::MeasurementProducer
    <RecoHitInformation::UsedSVDHit, AlignableSVDRecoHit> (svdHits.getPtr());
    genfitMeasurementFactory.addProducer(Const::SVD, SVDProducer);
  }
 
  if (cdcHits.isOptional()) {
    genfit::MeasurementProducer <RecoHitInformation::UsedCDCHit, AlignableCDCRecoHit>* CDCProducer =  new genfit::MeasurementProducer
    <RecoHitInformation::UsedCDCHit, AlignableCDCRecoHit> (cdcHits.getPtr());
    genfitMeasurementFactory.addProducer(Const::CDC, CDCProducer);
  }
 
  if (bklmHits.isOptional()) {
    genfit::MeasurementProducer <RecoHitInformation::UsedBKLMHit, AlignableBKLMRecoHit>* BKLMProducer =  new genfit::MeasurementProducer
    <RecoHitInformation::UsedBKLMHit, AlignableBKLMRecoHit> (bklmHits.getPtr());
    genfitMeasurementFactory.addProducer(Const::BKLM, BKLMProducer);
  }
 
  if (eklmHits.isOptional()) {
    genfit::MeasurementProducer <RecoHitInformation::UsedEKLMHit, AlignableEKLMRecoHit>* EKLMProducer =  new genfit::MeasurementProducer
    <RecoHitInformation::UsedEKLMHit, AlignableEKLMRecoHit> (eklmHits.getPtr());
    genfitMeasurementFactory.addProducer(Const::EKLM, EKLMProducer);
  }
 
 
  // Create the measurement creators
  std::vector<std::shared_ptr<PXDBaseMeasurementCreator>> pxdMeasurementCreators = { std::shared_ptr<PXDBaseMeasurementCreator>(new PXDCoordinateMeasurementCreator(genfitMeasurementFactory)) };
  std::vector<std::shared_ptr<SVDBaseMeasurementCreator>> svdMeasurementCreators = { std::shared_ptr<SVDBaseMeasurementCreator>(new SVDCoordinateMeasurementCreator(genfitMeasurementFactory)) };
  // TODO: Create a new MeasurementCreator based on SVDBaseMeasurementCreator (or on SVDCoordinateMeasurementCreator), which does the combination on the fly.
 
  std::vector<std::shared_ptr<CDCBaseMeasurementCreator>> cdcMeasurementCreators = { std::shared_ptr<CDCBaseMeasurementCreator>(new CDCCoordinateMeasurementCreator(genfitMeasurementFactory)) };
  std::vector<std::shared_ptr<BKLMBaseMeasurementCreator>> bklmMeasurementCreators = { std::shared_ptr<BKLMBaseMeasurementCreator>(new BKLMCoordinateMeasurementCreator(genfitMeasurementFactory)) };
  std::vector<std::shared_ptr<EKLMBaseMeasurementCreator>> eklmMeasurementCreators = { std::shared_ptr<EKLMBaseMeasurementCreator>(new EKLMCoordinateMeasurementCreator(genfitMeasurementFactory)) };
 
  // TODO: Or put it in here and leave the svdMeasurementCreators empty.
  std::vector<std::shared_ptr<BaseMeasurementCreator>> additionalMeasurementCreators = {};
  factory.resetMeasurementCreators(pxdMeasurementCreators, svdMeasurementCreators, cdcMeasurementCreators, bklmMeasurementCreators,
                                   eklmMeasurementCreators, additionalMeasurementCreators);
  factory.addMeasurements(recoTrack);
 
  auto& gfTrack = RecoTrackGenfitAccess::getGenfitTrack(recoTrack);
 
  int currentPdgCode = TrackFitter::createCorrectPDGCodeForChargedStable(Const::muon, recoTrack);
  if (particle)
    currentPdgCode = particle->getPDGCode();
 
  genfit::AbsTrackRep* trackRep = RecoTrackGenfitAccess::createOrReturnRKTrackRep(recoTrack, currentPdgCode);
  gfTrack.setCardinalRep(gfTrack.getIdForRep(trackRep));
 
  if (particle) {
    B2Vector3D vertexPos = particle->getVertex();
    B2Vector3D vertexMom = particle->getMomentum();
    gfTrack.setStateSeed(vertexPos, vertexMom);
 
    genfit::StateOnPlane vertexSOP(gfTrack.getCardinalRep());
    B2Vector3D vertexRPhiDir(vertexPos[0], vertexPos[1], 0);
    B2Vector3D vertexZDir(0, 0, vertexPos[2]);
    //FIXME: This causes problem to current GBL version in genfit -> needs update of GBL to re-enable
    // genfit::SharedPlanePtr vertexPlane(new genfit::DetPlane(vertexPos, vertexRPhiDir, vertexZDir));
    //This works instead fine:
    genfit::SharedPlanePtr vertexPlane(new genfit::DetPlane(vertexPos, vertexMom));
 
    vertexSOP.setPlane(vertexPlane);
    vertexSOP.setPosMom(vertexPos, vertexMom);
    TMatrixDSym vertexCov(5);
    vertexCov.UnitMatrix();
    // By using negative covariance no measurement is added to GBL. But this first point
    // is then used as additional point in trajectory at the assumed point of its fitted vertex
    vertexCov *= -1.;
    genfit::MeasuredStateOnPlane mop(vertexSOP, vertexCov);
    genfit::FullMeasurement* vertex = new genfit::FullMeasurement(mop, Const::IR);
    gfTrack.insertMeasurement(vertex, 0);
  }
 
  try {
    for (unsigned int i = 0; i < gfTrack.getNumPoints() - 1; ++i) {
      //if (gfTrack.getPointWithMeasurement(i)->getNumRawMeasurements() != 1)
      //  continue;
      genfit::PlanarMeasurement* planarMeas1 = dynamic_cast<genfit::PlanarMeasurement*>(gfTrack.getPointWithMeasurement(
                                                 i)->getRawMeasurement(0));
      genfit::PlanarMeasurement* planarMeas2 = dynamic_cast<genfit::PlanarMeasurement*>(gfTrack.getPointWithMeasurement(
                                                 i + 1)->getRawMeasurement(0));
 
      if (planarMeas1 != NULL && planarMeas2 != NULL &&
          planarMeas1->getDetId() == planarMeas2->getDetId() &&
          planarMeas1->getPlaneId() != -1 &&   // -1 is default plane id
          planarMeas1->getPlaneId() == planarMeas2->getPlaneId()) {
        Belle2::AlignableSVDRecoHit* hit1 = dynamic_cast<Belle2::AlignableSVDRecoHit*>(planarMeas1);
        Belle2::AlignableSVDRecoHit* hit2 = dynamic_cast<Belle2::AlignableSVDRecoHit*>(planarMeas2);
        if (hit1 && hit2) {
          Belle2::AlignableSVDRecoHit* hitU(NULL);
          Belle2::AlignableSVDRecoHit* hitV(NULL);
          // We have to decide U/V now (else AlignableSVDRecoHit2D could throw FATAL)
          if (hit1->isU() && !hit2->isU()) {
            hitU = hit1;
            hitV = hit2;
          } else if (!hit1->isU() && hit2->isU()) {
            hitU = hit2;
            hitV = hit1;
          } else {
            continue;
          }
          Belle2::AlignableSVDRecoHit2D* hit = new Belle2::AlignableSVDRecoHit2D(*hitU, *hitV);
          // insert measurement before point i (increases number of currect point to i+1)
          gfTrack.insertMeasurement(hit, i);
          // now delete current point (at its original place, we have the new 2D recohit)
          gfTrack.deletePoint(i + 1);
          gfTrack.deletePoint(i + 1);
        }
      }
    }
  } catch (std::exception& e) {
    B2ERROR(e.what());
    B2ERROR("SVD Cluster combination failed. This is symptomatic of pruned tracks. MillepedeCollector cannot process pruned tracks.");
    return false;
  }
 
  try {
    gbl->processTrackWithRep(&gfTrack, gfTrack.getCardinalRep(), true);
  } catch (genfit::Exception& e) {
    B2ERROR(e.what());
    return false;
  } catch (...) {
    B2ERROR("GBL fit failed.");
    return false;
  }
 
  return true;
}

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.

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.

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 RootOutputModule, StorageRootOutputModule, and RootInputModule.

Definition at line 134 of file Module.h.

getGlobalToLocalTransform()

TMatrixD getGlobalToLocalTransform

(

const genfit::MeasuredStateOnPlane &

msop

)

Compute the transformation matrix d(q/p,u',v',u,v)/d(x,y,z,px,py,pz) from state at first track point (vertex)

Parameters

msop	MeasuredStateOnPlane - linearization point (track state @ plane) at which the transformation should be computed

Definition at line 1435 of file MillepedeCollectorModule.cc.

getLocalToGlobalTransform()

TMatrixD getLocalToGlobalTransform

(

const genfit::MeasuredStateOnPlane &

msop

)

Compute the transformation matrix d(x,y,z,px,py,pz)/d(q/p,u',v',u,v) from state at first track point (vertex)

Parameters

msop	MeasuredStateOnPlane - linearization point (track state @ plane) at which the transformation should be computed

Definition at line 1507 of file MillepedeCollectorModule.cc.

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.

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.

getParticlesTracks()

std::vector< genfit::Track * > getParticlesTracks	(	std::vector< Particle * >	particles,
		bool	addVertexPoint = true
	)

Get all useable tracks for particles.

Parameters

particles	vector of Belle2::Particles to be changed in vector of genfit::Tracks
addVertexPoint	flag for adding the vertex point

Definition at line 1241 of file MillepedeCollectorModule.cc.

getPreScaleChoice()

bool getPreScaleChoice ( )

inlineprivateinherited

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

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

Definition at line 122 of file CalibrationCollectorModule.h.

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

getPrimaryVertexAndCov()

tuple< B2Vector3D, TMatrixDSym > getPrimaryVertexAndCov

(

)

const

Get the primary vertex position estimation and its size from BeamSpot.

Returns

tuple<B2Vector3D, TMatrixDSym> tuple with position and size as covariance matrix

Definition at line 1569 of file MillepedeCollectorModule.cc.

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.

getTwoBodyToLocalTransform()

std::pair< TMatrixD, TMatrixD > getTwoBodyToLocalTransform	(	Particle &	mother,
		double	motherMass
	)

Compute the transformation matrices d(q/p,u'v',u,v)/d(vx,vy,vz,px,py,pz,theta,phi,M) = dq/d(v,z) for both particles in pair.

Only for decays of type V0(*)->f+f- (same mass for f)

Parameters

mother	The mother Belle2::Particle with two daughters, its 4-momenta should already be updated by a previous vertex fit done by modularAnalysis.
motherMass	This function expect the assumed invariant mass of the pair. This is to allow to set artifical values (e.g. for e+e- -> mu+mu-)

Returns

a pair of 5x9 matrices {dq+/d(v,z), dq-/d(v,z)}. One for each particle in list (in list order). NOTE: The signs DO NOT refer to charges of the particles! If you want to know: (+) particle is that one which goes along the mother momentum in CM system

The transformation is from local measurement system at 1st (GBL) point of each track in pair (virtual measurement (see fitRecoTrack(..., particle) and addVertexPoint parameter of getParticlesTracks(...)) to the common parameters which staticaly and kinematicaly describe the two-body decay:

• Position of the common vertex (vy,vy,vz)
• Total momentum of the pair (particles are back-to-back in their CM) (px,py,pz) and the invariant mass (M) of the decay
• 2 angles describing the orientation of the decay particles in the system of the mother (CM)

Reference: Widl, Edmund ; Frühwirth R; "Representation and Estimation of Trajectories from Two-body Decays", CMS-NOTE-2007-032, http://cds.cern.ch/record/1073690

Definition at line 1289 of file MillepedeCollectorModule.cc.

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.

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.

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Member Data Documentation

m_stableParticleWidth

double m_stableParticleWidth

private

Width (in GeV/c/c) to use for invariant mass constraint for 'stable' particles (like K short).

Temporary until proper solution is found

Definition at line 136 of file MillepedeCollectorModule.h.

m_timedepConfig

std::vector< std::tuple< std::vector< int >, std::vector< std::tuple< int, int, int > > > > m_timedepConfig

private

Config for time dependence: list( tuple( list( param1, param2, ...

), list( (ev, run, exp), ... )), ...

Definition at line 181 of file MillepedeCollectorModule.h.

---

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

• alignment/modules/MillepedeCollector/include/MillepedeCollectorModule.h
• alignment/modules/MillepedeCollector/src/MillepedeCollectorModule.cc