Belle II Software  release-05-01-25
RelatedTracksCombinerModule.cc
1 /**************************************************************************
2  * BASF2 (Belle Analysis Framework 2) *
3  * Copyright(C) 2017 - Belle II Collaboration *
4  * *
5  * Author: The Belle II Collaboration *
6  * Contributors: Nils Braun *
7  * *
8  * This software is provided "as is" without any warranty. *
9  **************************************************************************/
10 
11 #include <tracking/modules/relatedTracksCombiner/RelatedTracksCombinerModule.h>
12 #include <tracking/trackFitting/fitter/base/TrackFitter.h>
13 
14 using namespace Belle2;
15 
16 REG_MODULE(RelatedTracksCombiner);
17 
19  Module()
20 {
21  setDescription("Combine related tracks from CDC and VXD into a single track by copying the hit "
22  "information and combining the seed information. The sign of the weight defines, "
23  "if the hits go before (-1) or after (+1) the CDC track.");
25 
26  addParam("CDCRecoTracksStoreArrayName", m_cdcRecoTracksStoreArrayName , "Name of the input CDC StoreArray.",
28  addParam("VXDRecoTracksStoreArrayName", m_vxdRecoTracksStoreArrayName , "Name of the input VXD StoreArray.",
30  addParam("recoTracksStoreArrayName", m_recoTracksStoreArrayName, "Name of the output StoreArray.", m_recoTracksStoreArrayName);
31 }
32 
34 {
37 
40 
41  m_recoTracks.registerRelationTo(m_vxdRecoTracks);
42  m_recoTracks.registerRelationTo(m_cdcRecoTracks);
43 }
44 
46 {
47  TrackFitter trackFitter;
48 
49  // Loop over all CDC reco tracks and add them to the store array of they do not have a match or combined them with
50  // their VXD partner if they do.
51  // For this, the fitted or seed state of the tracks is used - if they are already fitted or not.
52  for (RecoTrack& cdcRecoTrack : m_cdcRecoTracks) {
53  const RelationVector<RecoTrack>& relatedVXDRecoTracks = cdcRecoTrack.getRelationsWith<RecoTrack>(m_vxdRecoTracksStoreArrayName);
54 
55  B2ASSERT("Can not handle more than 2 relations!", relatedVXDRecoTracks.size() <= 2);
56 
57  RecoTrack* vxdTrackBefore = nullptr;
58  RecoTrack* vxdTrackAfter = nullptr;
59 
60  for (unsigned int index = 0; index < relatedVXDRecoTracks.size(); ++index) {
61  const double weight = relatedVXDRecoTracks.weight(index);
62  if (weight < 0) {
63  vxdTrackBefore = relatedVXDRecoTracks[index];
64  } else if (weight > 0) {
65  vxdTrackAfter = relatedVXDRecoTracks[index];
66  }
67  }
68 
69  // Do not output non-fittable tracks
70  if (not vxdTrackAfter and not vxdTrackBefore and not trackFitter.fit(cdcRecoTrack)) {
71  continue;
72  }
73 
74  RecoTrack* newMergedTrack = nullptr;
75 
76  if (vxdTrackBefore) {
77  newMergedTrack = vxdTrackBefore->copyToStoreArray(m_recoTracks);
78  newMergedTrack->addHitsFromRecoTrack(vxdTrackBefore, newMergedTrack->getNumberOfTotalHits());
79  newMergedTrack->addRelationTo(vxdTrackBefore);
80  } else {
81  newMergedTrack = cdcRecoTrack.copyToStoreArray(m_recoTracks);
82  }
83 
84  newMergedTrack->addHitsFromRecoTrack(&cdcRecoTrack, newMergedTrack->getNumberOfTotalHits());
85  newMergedTrack->addRelationTo(&cdcRecoTrack);
86 
87  if (vxdTrackAfter) {
88  newMergedTrack->addHitsFromRecoTrack(vxdTrackAfter, newMergedTrack->getNumberOfTotalHits(), true);
89  newMergedTrack->addRelationTo(vxdTrackAfter);
90  }
91  }
92 
93  // Now we only have to add the VXD tracks without a match
94  for (RecoTrack& vxdRecoTrack : m_vxdRecoTracks) {
95  const RecoTrack* cdcRecoTrack = vxdRecoTrack.getRelated<RecoTrack>(m_cdcRecoTracksStoreArrayName);
96  if (not cdcRecoTrack and trackFitter.fit(vxdRecoTrack)) {
97  RecoTrack* newTrack = vxdRecoTrack.copyToStoreArray(m_recoTracks);
98  newTrack->addHitsFromRecoTrack(&vxdRecoTrack);
99  newTrack->addRelationTo(&vxdRecoTrack);
100  }
101  }
102 }
103 
Belle2::RelationVector::size
size_t size() const
Get number of relations.
Definition: RelationVector.h:98
Belle2::RecoTrack::registerRequiredRelations
static void registerRequiredRelations(StoreArray< RecoTrack > &recoTracks, std::string const &pxdHitsStoreArrayName="", std::string const &svdHitsStoreArrayName="", std::string const &cdcHitsStoreArrayName="", std::string const &bklmHitsStoreArrayName="", std::string const &eklmHitsStoreArrayName="", std::string const &recoHitInformationStoreArrayName="")
Convenience method which registers all relations required to fully use a RecoTrack.
Definition: RecoTrack.cc:42
Belle2::RecoTrack::addHitsFromRecoTrack
size_t addHitsFromRecoTrack(const RecoTrack *recoTrack, unsigned int sortingParameterOffset=0, bool reversed=false, boost::optional< double > optionalMinimalWeight=boost::none)
Add all hits from another RecoTrack to this RecoTrack.
Definition: RecoTrack.cc:230
Belle2::Module::setDescription
void setDescription(const std::string &description)
Sets the description of the module.
Definition: Module.cc:216
Belle2::TrackFitter::fit
bool fit(RecoTrack &recoTrack, genfit::AbsTrackRep *trackRepresentation) const
Fit a reco track with a given non-default track representation.
Definition: TrackFitter.cc:109
REG_MODULE
#define REG_MODULE(moduleName)
Register the given module (without 'Module' suffix) with the framework.
Definition: Module.h:652
Belle2::Module::c_ParallelProcessingCertified
@ c_ParallelProcessingCertified
This module can be run in parallel processing mode safely (All I/O must be done through the data stor...
Definition: Module.h:82
Belle2::RelatedTracksCombinerModule::m_vxdRecoTracksStoreArrayName
std::string m_vxdRecoTracksStoreArrayName
Name of the input VXD StoreArray.
Definition: RelatedTracksCombinerModule.h:55
Belle2::RelatedTracksCombinerModule::initialize
void initialize() override
Declare required StoreArray.
Definition: RelatedTracksCombinerModule.cc:33
Belle2::RelationsInterface::addRelationTo
void addRelationTo(const RelationsInterface< BASE > *object, float weight=1.0, const std::string &namedRelation="") const
Add a relation from this object to another object (with caching).
Definition: RelationsObject.h:144
Belle2::RelationsInterface::getRelated
T * getRelated(const std::string &name="", const std::string &namedRelation="") const
Get the object to or from which this object has a relation.
Definition: RelationsObject.h:280
Belle2::RecoTrack::copyToStoreArray
RecoTrack * copyToStoreArray(StoreArray< RecoTrack > &storeArray) const
Append a new RecoTrack to the given store array and copy its general properties, but not the hits the...
Definition: RecoTrack.cc:506
Belle2::RelatedTracksCombinerModule::RelatedTracksCombinerModule
RelatedTracksCombinerModule()
Constructor of the module. Setting up parameters and description.
Definition: RelatedTracksCombinerModule.cc:18
Belle2::Module
Base class for Modules.
Definition: Module.h:74
Belle2::Module::setPropertyFlags
void setPropertyFlags(unsigned int propertyFlags)
Sets the flags for the module properties.
Definition: Module.cc:210
Belle2::TrackFitter
Algorithm class to handle the fitting of RecoTrack objects.
Definition: TrackFitter.h:116
Belle2::RecoTrack
This is the Reconstruction Event-Data Model Track.
Definition: RecoTrack.h:78
Belle2::RelationVector
Class for type safe access to objects that are referred to in relations.
Definition: DataStore.h:38
Belle2::RelatedTracksCombinerModule::m_cdcRecoTracks
StoreArray< RecoTrack > m_cdcRecoTracks
Store Array of the input tracks.
Definition: RelatedTracksCombinerModule.h:60
Belle2
Abstract base class for different kinds of events.
Definition: MillepedeAlgorithm.h:19
Belle2::RelatedTracksCombinerModule::m_vxdRecoTracks
StoreArray< RecoTrack > m_vxdRecoTracks
Store Array of the input tracks.
Definition: RelatedTracksCombinerModule.h:62
Belle2::RelatedTracksCombinerModule::m_recoTracks
StoreArray< RecoTrack > m_recoTracks
Store Array of the output tracks.
Definition: RelatedTracksCombinerModule.h:64
Belle2::RelatedTracksCombinerModule::event
void event() override
Event processing, combine store array.
Definition: RelatedTracksCombinerModule.cc:45
Belle2::DataStore::c_ErrorIfAlreadyRegistered
@ c_ErrorIfAlreadyRegistered
If the object/array was already registered, produce an error (aborting initialisation).
Definition: DataStore.h:74
Belle2::Module::addParam
void addParam(const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
Adds a new parameter to the module.
Definition: Module.h:562
Belle2::RelationVector::weight
float weight(int index) const
Get weight with index.
Definition: RelationVector.h:120
Belle2::RecoTrack::getNumberOfTotalHits
unsigned int getNumberOfTotalHits() const
Return the number of cdc + svd + pxd + bklm + eklm hits.
Definition: RecoTrack.h:432
Belle2::RelatedTracksCombinerModule::m_recoTracksStoreArrayName
std::string m_recoTracksStoreArrayName
Name of the output StoreArray.
Definition: RelatedTracksCombinerModule.h:57
Belle2::RelatedTracksCombinerModule::m_cdcRecoTracksStoreArrayName
std::string m_cdcRecoTracksStoreArrayName
Name of the input CDC StoreArray.
Definition: RelatedTracksCombinerModule.h:53