Belle II Software  release-08-01-10
CDCCKFTracksCombinerModule.cc
1 /**************************************************************************
2  * basf2 (Belle II Analysis Software Framework) *
3  * Author: The Belle II Collaboration *
4  * *
5  * See git log for contributors and copyright holders. *
6  * This file is licensed under LGPL-3.0, see LICENSE.md. *
7  **************************************************************************/
8 
9 #include <tracking/modules/relatedTracksCombiner/CDCCKFTracksCombinerModule.h>
10 
11 using namespace Belle2;
12 
13 REG_MODULE(CDCCKFTracksCombiner);
14 
16  Module()
17 {
18  setDescription("Combine related tracks from CDC, determined in SVD->CDC CKF, and VXD (and VXD+CDC) into a single track by copying the hit "
19  "information and combining the seed information. The sign of the weight defines, "
20  "if the hits go before (-1) or after (+1) the CDC track.");
22 
23  addParam("CDCRecoTracksStoreArrayName", m_cdcRecoTracksStoreArrayName, "Name of the input CDC StoreArray.",
25  addParam("VXDRecoTracksStoreArrayName", m_vxdRecoTracksStoreArrayName, "Name of the input VXD (and+CDC) StoreArray.",
27  addParam("recoTracksStoreArrayName", m_recoTracksStoreArrayName, "Name of the output StoreArray.", m_recoTracksStoreArrayName);
28 }
29 
31 {
34 
37 
40 }
41 
43 {
44  std::set <RecoTrack*> mergedTracks;
45  // Loop over all CDC reco tracks and add them to the store array if they do not have a match or combined them with
46  // their VXD partner if they do.
47  // For this, the fitted or seed state of the tracks is used - if they are already fitted or not.
48  for (const RecoTrack& cdcRecoTrack : m_cdcRecoTracks) {
49  const RelationVector<RecoTrack>& relatedVXDRecoTracks = cdcRecoTrack.getRelationsWith<RecoTrack>(m_vxdRecoTracksStoreArrayName);
50 
51  B2ASSERT("Can not handle more than 2 relations!", relatedVXDRecoTracks.size() <= 2);
52 
53  RecoTrack* vxdTrackBefore = nullptr;
54  RecoTrack* vxdTrackAfter = nullptr;
55 
56  for (unsigned int index = 0; index < relatedVXDRecoTracks.size(); ++index) {
57  const double weight = relatedVXDRecoTracks.weight(index);
58  if (weight < 0) {
59  vxdTrackBefore = relatedVXDRecoTracks[index];
60  } else if (weight > 0) {
61  vxdTrackAfter = relatedVXDRecoTracks[index];
62  }
63  }
64 
65  // Do not output non-fittable tracks
66  if (not vxdTrackAfter and not vxdTrackBefore) {
67  continue;
68  }
69 
70  RecoTrack* newMergedTrack = nullptr;
71 
72  if (vxdTrackBefore) {
73  mergedTracks.insert(vxdTrackBefore);
74  newMergedTrack = vxdTrackBefore->copyToStoreArray(m_recoTracks);
75  newMergedTrack->addHitsFromRecoTrack(vxdTrackBefore, newMergedTrack->getNumberOfTotalHits());
76  newMergedTrack->addRelationTo(vxdTrackBefore);
77  } else {
78  newMergedTrack = cdcRecoTrack.copyToStoreArray(m_recoTracks);
79  }
80 
81  newMergedTrack->addHitsFromRecoTrack(&cdcRecoTrack, newMergedTrack->getNumberOfTotalHits());
82  newMergedTrack->addRelationTo(&cdcRecoTrack);
83 
84  if (vxdTrackAfter) {
85  mergedTracks.insert(vxdTrackAfter);
86  newMergedTrack->addHitsFromRecoTrack(vxdTrackAfter, newMergedTrack->getNumberOfTotalHits(), true);
87  newMergedTrack->addRelationTo(vxdTrackAfter);
88  }
89  }
90 
91  // Now we have to add remaining tracks
92  for (RecoTrack& vxdRecoTrack : m_vxdRecoTracks) {
93  auto alreadyIncluded = mergedTracks.count(&vxdRecoTrack) ;
94 
95  if (not alreadyIncluded) {
96  RecoTrack* newTrack = vxdRecoTrack.copyToStoreArray(m_recoTracks);
97  newTrack->addHitsFromRecoTrack(&vxdRecoTrack);
98  newTrack->addRelationTo(&vxdRecoTrack);
99  }
100  }
101 }
102 
CDCCKFTracksCombinerModule()
Constructor of the module. Setting up parameters and description.
void initialize() override
Declare required StoreArray.
void event() override
Event processing, combine store array.
StoreArray< RecoTrack > m_vxdRecoTracks
Store Array of the input tracks.
std::string m_cdcRecoTracksStoreArrayName
Name of the input CDC StoreArray.
StoreArray< RecoTrack > m_recoTracks
Store Array of the output tracks.
StoreArray< RecoTrack > m_cdcRecoTracks
Store Array of the input tracks.
std::string m_recoTracksStoreArrayName
Name of the output StoreArray.
std::string m_vxdRecoTracksStoreArrayName
Name of the input VXD StoreArray.
@ c_ErrorIfAlreadyRegistered
If the object/array was already registered, produce an error (aborting initialisation).
Definition: DataStore.h:72
Base class for Modules.
Definition: Module.h:72
void setDescription(const std::string &description)
Sets the description of the module.
Definition: Module.cc:214
void setPropertyFlags(unsigned int propertyFlags)
Sets the flags for the module properties.
Definition: Module.cc:208
@ 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:80
This is the Reconstruction Event-Data Model Track.
Definition: RecoTrack.h:79
size_t addHitsFromRecoTrack(const RecoTrack *recoTrack, unsigned int sortingParameterOffset=0, bool reversed=false, std::optional< double > optionalMinimalWeight=std::nullopt)
Add all hits from another RecoTrack to this RecoTrack.
Definition: RecoTrack.cc:240
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:529
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:53
unsigned int getNumberOfTotalHits() const
Return the number of cdc + svd + pxd + bklm + eklm hits.
Definition: RecoTrack.h:436
Class for type safe access to objects that are referred to in relations.
size_t size() const
Get number of relations.
float weight(int index) const
Get weight with index.
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).
bool isRequired(const std::string &name="")
Ensure this array/object has been registered previously.
bool registerInDataStore(DataStore::EStoreFlags storeFlags=DataStore::c_WriteOut)
Register the object/array in the DataStore.
bool registerRelationTo(const StoreArray< TO > &toArray, DataStore::EDurability durability=DataStore::c_Event, DataStore::EStoreFlags storeFlags=DataStore::c_WriteOut, const std::string &namedRelation="") const
Register a relation to the given StoreArray.
Definition: StoreArray.h:140
REG_MODULE(arichBtest)
Register the Module.
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:560
Abstract base class for different kinds of events.