RecoTrackStorer Class Reference

Store RecoTracks into StoreArray. More...

#include <RecoTrackStorer.h>

Inheritance diagram for RecoTrackStorer:

Public Types
using	IOTypes = std::tuple< AIOTypes... >
	Types that should be served to apply on invocation.
using	IOVectors = std::tuple< std::vector< AIOTypes >... >
	Vector types that should be served to apply on invocation.

Public Member Functions
	RecoTrackStorer ()
	Constructor.
	~RecoTrackStorer ()
	Default destructor.
void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) override
	Expose the parameters of the sub findlets.
void	initialize () override
	Create the store arrays.
void	beginRun () override
	Begin run.
void	beginEvent () override
	Reset internal vectors.
void	apply (std::vector< SpacePointTrackCand > &finishedResults, const std::vector< const SpacePoint * > &spacePoints) override
	Store the finishey SpacePointTrackCands into RecoTracks and tag the SpacePoints.
virtual std::string	getDescription ()
	Brief description of the purpose of the concrete findlet.
virtual void	apply (ToVector< AIOTypes > &... ioVectors)=0
	Main function executing the algorithm.
void	endRun () override
	Receive and dispatch signal for the end of the run.
void	terminate () override
	Receive and dispatch Signal for termination of the event processing.

Protected Types
template<class T >
using	ToVector = typename ToVectorImpl< T >::Type
	Short hand for ToRangeImpl.

Protected Member Functions
void	addProcessingSignalListener (ProcessingSignalListener *psl)
	Register a processing signal listener to be notified.
int	getNProcessingSignalListener ()
	Get the number of currently registered listeners.

Private Types
using	Super = TrackFindingCDC::Findlet< SpacePointTrackCand, const SpacePoint *const >
	Parent class.

Private Attributes
std::string	m_RecoTracksStoreArrayName = "SVDHoughRecoTracks"
	StoreArray name of the output Track StoreArray.
std::string	m_SVDClustersStoreArrayName = "SVDClusters"
	StoreArray name of the SVDCluster StoreArray.
std::string	m_SVDSpacePointTrackCandsStoreArrayName = "SVDHoughSpacePointTrackCands"
	StoreArray name of the SpacePointTrackCandidate StoreArray.
StoreArray< RecoTrack >	m_storeRecoTracks
	Output RecoTracks Store Array.
StoreArray< SpacePointTrackCand >	m_storeSpacePointTrackCands
	Output SpacePointTrackCand Store Array.
std::set< const SVDCluster * >	m_usedClusters
	Store the used clusters in the results.
std::set< const SpacePoint * >	m_usedSpacePoints
	Store the used space points in the results.
std::unique_ptr< QualityEstimatorBase >	m_estimator
	pointer to the selected QualityEstimator
std::string	m_MCRecoTracksStoreArrayName = "MCRecoTracks"
	sets the name of the expected StoreArray containing MCRecoTracks. Only required for MCInfo method
bool	m_MCStrictQualityEstimator = true
	Only required for MCInfo method.
std::string	m_EstimationMethod = "helixFit"
	Identifier which estimation method to use.
std::vector< ProcessingSignalListener * >	m_subordinaryProcessingSignalListeners
	References to subordinary signal processing listener contained in this findlet.
bool	m_initialized = false
	Flag to keep track whether initialization happened before.
bool	m_terminated = false
	Flag to keep track whether termination happened before.
std::string	m_initializedAs
	Name of the type during initialisation.

Detailed Description

Store RecoTracks into StoreArray.

Definition at line 32 of file RecoTrackStorer.h.

Member Typedef Documentation

IOTypes

using IOTypes = std::tuple<AIOTypes...>

inherited

Types that should be served to apply on invocation.

Definition at line 30 of file Findlet.h.

IOVectors

using IOVectors = std::tuple< std::vector<AIOTypes>... >

inherited

Vector types that should be served to apply on invocation.

Definition at line 53 of file Findlet.h.

Super

using Super = TrackFindingCDC::Findlet<SpacePointTrackCand, const SpacePoint* const>

private

Parent class.

Definition at line 34 of file RecoTrackStorer.h.

ToVector

using ToVector = typename ToVectorImpl<T>::Type

protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

Constructor & Destructor Documentation

RecoTrackStorer()

RecoTrackStorer

(

)

Constructor.

Definition at line 30 of file RecoTrackStorer.cc.

                                 : Super()
{
}

Member Function Documentation

addProcessingSignalListener()

void addProcessingSignalListener ( ProcessingSignalListener *  psl )

protectedinherited

Register a processing signal listener to be notified.

Definition at line 55 of file CompositeProcessingSignalListener.cc.

{
  m_subordinaryProcessingSignalListeners.push_back(psl);
}

apply()

void apply ( std::vector< SpacePointTrackCand > &  finishedResults, const std::vector< const SpacePoint * > &  spacePoints  )

override

Store the finishey SpacePointTrackCands into RecoTracks and tag the SpacePoints.

Definition at line 110 of file RecoTrackStorer.cc.

{
  for (auto& thisSPTC : finishedResults) {
    // do nothing if the SpacePointTrackCand is not active
    if (!thisSPTC.hasRefereeStatus(SpacePointTrackCand::c_isActive)) {
      continue;
    }
 
    auto sortedHits = thisSPTC.getSortedHits();
    const auto& estimatorResult = m_estimator->estimateQualityAndProperties(sortedHits);
 
    const ROOT::Math::XYZVector trackPosition(sortedHits.front()->X(), sortedHits.front()->Y(), sortedHits.front()->Z());
    const ROOT::Math::XYZVector& trackMomentum = *estimatorResult.p;
    const short& trackChargeSeed = estimatorResult.curvatureSign ? -1 * (*(estimatorResult.curvatureSign)) : 0;
    const double qi = estimatorResult.qualityIndicator;
 
    RecoTrack* newRecoTrack = m_storeRecoTracks.appendNew(trackPosition, trackMomentum, trackChargeSeed, "",
                                                          m_SVDClustersStoreArrayName);
 
    // TODO: find out where these numbers come from!
    // This is copied from the VXDTF2 counterpart tracking/modules/spacePointCreator/SPTCmomentumSeedRetrieverModule !
    TVectorD stateSeed(6); //(x,y,z,px,py,pz)
    TMatrixDSym covSeed(6);
    covSeed(0, 0) = 0.01 ; covSeed(1, 1) = 0.01 ; covSeed(2, 2) = 0.04 ; // 0.01 = 0.1^2 = dx*dx =dy*dy. 0.04 = 0.2^2 = dz*dz
    covSeed(3, 3) = 0.01 ; covSeed(4, 4) = 0.01 ; covSeed(5, 5) = 0.04 ;
 
    stateSeed(0) = (sortedHits.front()->X());
    stateSeed(1) = (sortedHits.front()->Y());
    stateSeed(2) = (sortedHits.front()->Z());
    if (estimatorResult.p) {
      auto momentumSeed = *(estimatorResult.p);
      stateSeed(3) = momentumSeed.X();
      stateSeed(4) = momentumSeed.Y();
      stateSeed(5) = momentumSeed.Z();
    } else {
      stateSeed(3) = 0;
      stateSeed(4) = 0;
      stateSeed(5) = 0;
    }
 
    thisSPTC.set6DSeed(stateSeed);
    thisSPTC.setCovSeed(covSeed);
    thisSPTC.setChargeSeed(trackChargeSeed);
    // until here
 
    // Set information not required by constructor
    newRecoTrack->setSeedCovariance(covSeed);
 
    // Transfer quality indicator from SPTC to RecoTrack
    newRecoTrack->setQualityIndicator(qi);
 
    SpacePointTrackCand* newSPTC = m_storeSpacePointTrackCands.appendNew(thisSPTC);
    // Add relation to SpacePointTrackCandidate
    newRecoTrack->addRelationTo(newSPTC);
 
 
    unsigned int sortingParameter = 0;
    for (const SpacePoint* spacePoint : sortedHits) {
      m_usedSpacePoints.insert(spacePoint);
 
      RelationVector<SVDCluster> relatedClusters = spacePoint->getRelationsTo<SVDCluster>(m_SVDClustersStoreArrayName);
      for (const SVDCluster& relatedCluster : relatedClusters) {
        m_usedClusters.insert(&relatedCluster);
        newRecoTrack->addSVDHit(&relatedCluster, sortingParameter, Belle2::RecoHitInformation::c_SVDHough);
        sortingParameter++;
      }
    }
  }
 
  for (const SpacePoint* spacePoint : spacePoints) {
    if (TrackFindingCDC::is_in(spacePoint, m_usedSpacePoints)) {
      spacePoint->setAssignmentState(true);
      continue;
    }
 
    const auto& relatedClusters = spacePoint->getRelationsTo<SVDCluster>(m_SVDClustersStoreArrayName);
    for (const SVDCluster& relatedCluster : relatedClusters) {
      if (TrackFindingCDC::is_in(&relatedCluster, m_usedClusters)) {
        spacePoint->setAssignmentState(true);
        break;
      }
    }
  }
 
}

beginEvent()

void beginEvent ( )

overridevirtual

Reset internal vectors.

Reimplemented from CompositeProcessingSignalListener.

Definition at line 102 of file RecoTrackStorer.cc.

{
  Super::beginEvent();
 
  m_usedClusters.clear();
  m_usedSpacePoints.clear();
}

beginRun()

void beginRun ( )

overridevirtual

Begin run.

Reimplemented from CompositeProcessingSignalListener.

Definition at line 88 of file RecoTrackStorer.cc.

{
  Super::beginRun();
 
  // BField is required by all QualityEstimators
  double bFieldZ = BFieldManager::getField(0, 0, 0).Z() / Unit::T;
  m_estimator->setMagneticFieldStrength(bFieldZ);
 
  if (m_EstimationMethod == "mcInfo") {
    QualityEstimatorMC* MCestimator = static_cast<QualityEstimatorMC*>(m_estimator.get());
    MCestimator->forceUpdateClusterNames();
  }
}

endRun()

void endRun ( )

overridevirtualinherited

Receive and dispatch signal for the end of the run.

Reimplemented from ProcessingSignalListener.

Definition at line 39 of file CompositeProcessingSignalListener.cc.

{
  for (ProcessingSignalListener* psl : reversedRange(m_subordinaryProcessingSignalListeners)) {
    psl->endRun();
  }
  Super::endRun();
}

exposeParameters()

void exposeParameters ( ModuleParamList *  moduleParamList, const std::string &  prefix  )

overridevirtual

Expose the parameters of the sub findlets.

Reimplemented from Findlet< AIOTypes >.

Definition at line 34 of file RecoTrackStorer.cc.

{
  Super::exposeParameters(moduleParamList, prefix);
 
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "SVDClustersStoreArrayName"), m_SVDClustersStoreArrayName,
                                "Name of the SVDClusters Store Array.", m_SVDClustersStoreArrayName);
 
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "RecoTracksStoreArrayName"), m_RecoTracksStoreArrayName,
                                "Name of the RecoTracks Store Array.", m_RecoTracksStoreArrayName);
 
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "SVDSpacePointTrackCandsStoreArrayName"),
                                m_SVDSpacePointTrackCandsStoreArrayName,
                                "Name of the SpacePointTrackCand Store Array.", m_SVDSpacePointTrackCandsStoreArrayName);
 
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "ResultStorerQualityEstimationMethod"), m_EstimationMethod,
                                "Identifier which estimation method to use. Valid identifiers are: [mcInfo, circleFit, tripletFit, helixFit].",
                                m_EstimationMethod);
 
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "ResultStorerMCRecoTracksStoreArrayName"),
                                m_MCRecoTracksStoreArrayName,
                                "Only required for MCInfo method. Name of StoreArray containing MCRecoTracks.",
                                m_MCRecoTracksStoreArrayName);
 
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "ResultStorerMCStrictQualityEstimator"),
                                m_MCStrictQualityEstimator,
                                "Only required for MCInfo method. If false combining several MCTracks is allowed.",
                                m_MCStrictQualityEstimator);
}

getDescription()

virtual std::string getDescription ( )

inlinevirtualinherited

Brief description of the purpose of the concrete findlet.

Reimplemented in CosmicsTrackMergerFindlet, CDCTrackingEventLevelMdstInfoFillerFromHitsFindlet, CDCTrackingEventLevelMdstInfoFillerFromSegmentsFindlet, AxialStraightTrackFinder, AxialTrackFinderHough, AxialTrackFinderLegendre, ClusterPreparer, MonopoleAxialTrackFinderLegendre, MonopoleStereoHitFinder, MonopoleStereoHitFinderQuadratic, SegmentFinderFacetAutomaton, SegmentTrackCombiner, StereoHitFinder, TrackFinderSegmentPairAutomaton, TrackFinderSegmentTripleAutomaton, TrackQualityEstimator, WireHitPreparer, AsicBackgroundLibraryCreator, TrackFinderCosmics, AsicBackgroundDetector, AxialSegmentPairCreator, AxialStraightTrackCreator, AxialTrackCreatorHitHough, AxialTrackCreatorHitLegendre, AxialTrackCreatorMCTruth, AxialTrackCreatorSegmentHough, AxialTrackHitMigrator, AxialTrackMerger, CDCMCCloneLookUpFiller, ClusterBackgroundDetector, ClusterCreator< AWireHitRelationFilter >, ClusterRefiner< AWireHitRelationFilter >, ClusterRefiner< BridgingWireHitRelationFilter >, ClusterRefiner< Belle2::TrackFindingCDC::BridgingWireHitRelationFilter >, FacetCreator, HitReclaimer, RLTaggedWireHitCreator, SegmentAliasResolver, SegmentCreatorFacetAutomaton, SegmentCreatorMCTruth, SegmentLinker, SegmentOrienter, SegmentPairCreator, SegmentRejecter, SegmentTripleCreator, SuperClusterCreator, TrackCombiner, TrackCreatorSegmentPairAutomaton, TrackCreatorSegmentTripleAutomaton, TrackCreatorSingleSegments, TrackExporter, TrackFlightTimeAdjuster, TrackInspector, TrackLinker, TrackNormalizer, TrackOrienter, TrackRejecter, TrackSZFitter, WeightedRelationCreator< AObject, ARelationFilter >, WeightedRelationCreator< const Belle2::TrackFindingCDC::WithAutomatonCell, Belle2::PhiRecoTrackRelationFilter >, WeightedRelationCreator< const Belle2::TrackFindingCDC::CDCFacet, Belle2::TrackFindingCDC::ChooseableFilter >, WeightedRelationCreator< const Belle2::TrackFindingCDC::CDCSegment2D, Belle2::TrackFindingCDC::ChooseableFilter >, WeightedRelationCreator< const Belle2::TrackFindingCDC::CDCSegmentPair, Belle2::TrackFindingCDC::ChooseableFilter >, WeightedRelationCreator< const Belle2::TrackFindingCDC::CDCSegmentTriple, Belle2::TrackFindingCDC::ChooseableFilter >, WeightedRelationCreator< const Belle2::TrackFindingCDC::CDCTrack, Belle2::TrackFindingCDC::ChooseableFilter >, WireHitBackgroundBlocker, WireHitBackgroundDetector, WireHitCreator, WireHitMCMultiLoopBlocker, StoreArrayLoader< IOType >, StoreArrayLoader< const Belle2::SpacePoint >, StoreArrayLoader< DataStoreInputTypeRefType >, StoreVectorSwapper< IOType, a_alwaysWrite >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCFacet >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCWireHit, true >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCSegment2D >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCTrack >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCSegmentPair >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCSegmentTriple >, TrackFinder, TrackFinderAutomaton, SegmentFitter, SegmentTrackAdderWithNormalization, TrackQualityAsserter, HitBasedT0Extractor, and FindletStoreArrayInput< TWrappedFindlet >.

Definition at line 60 of file Findlet.h.

      {
        return "(no description)";
      }

getNProcessingSignalListener()

int getNProcessingSignalListener ( )

protectedinherited

Get the number of currently registered listeners.

Definition at line 60 of file CompositeProcessingSignalListener.cc.

{
  return m_subordinaryProcessingSignalListeners.size();
}

initialize()

void initialize ( )

overridevirtual

Create the store arrays.

Reimplemented from CompositeProcessingSignalListener.

Definition at line 63 of file RecoTrackStorer.cc.

{
  Super::initialize();
 
  m_storeRecoTracks.registerInDataStore(m_RecoTracksStoreArrayName);
  RecoTrack::registerRequiredRelations(m_storeRecoTracks, "", m_SVDClustersStoreArrayName, "", "", "", "");
  m_storeSpacePointTrackCands.registerInDataStore(m_SVDSpacePointTrackCandsStoreArrayName,
                                                  DataStore::c_DontWriteOut | DataStore::c_ErrorIfAlreadyRegistered);
  m_storeRecoTracks.registerRelationTo(m_storeSpacePointTrackCands);
 
  // create pointer to chosen estimator
  if (m_EstimationMethod == "mcInfo") {
    StoreArray<RecoTrack> mcRecoTracks;
    mcRecoTracks.isRequired(m_MCRecoTracksStoreArrayName);
    m_estimator = std::make_unique<QualityEstimatorMC>(m_MCRecoTracksStoreArrayName, m_MCStrictQualityEstimator);
  } else if (m_EstimationMethod == "tripletFit") {
    m_estimator = std::make_unique<QualityEstimatorTripletFit>();
  } else if (m_EstimationMethod == "circleFit") {
    m_estimator = std::make_unique<QualityEstimatorCircleFit>();
  } else if (m_EstimationMethod == "helixFit") {
    m_estimator = std::make_unique<QualityEstimatorRiemannHelixFit>();
  }
  B2ASSERT("QualityEstimator could not be initialized with method: " << m_EstimationMethod, m_estimator);
}

terminate()

void terminate ( )

overridevirtualinherited

Receive and dispatch Signal for termination of the event processing.

Reimplemented from ProcessingSignalListener.

Reimplemented in StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::HyperHough >, StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::QuadraticLegendre >, and StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::Z0TanLambdaLegendre >.

Definition at line 47 of file CompositeProcessingSignalListener.cc.

{
  for (ProcessingSignalListener* psl : reversedRange(m_subordinaryProcessingSignalListeners)) {
    psl->terminate();
  }
  Super::terminate();
}

Member Data Documentation

m_EstimationMethod

std::string m_EstimationMethod = "helixFit"

private

Identifier which estimation method to use.

Valid identifiers are: mcInfo, circleFit, tripletFit, helixFit

Definition at line 86 of file RecoTrackStorer.h.

m_estimator

std::unique_ptr<QualityEstimatorBase> m_estimator

private

pointer to the selected QualityEstimator

Definition at line 79 of file RecoTrackStorer.h.

m_initialized

bool m_initialized = false

privateinherited

Flag to keep track whether initialization happened before.

Definition at line 52 of file ProcessingSignalListener.h.

m_initializedAs

std::string m_initializedAs

privateinherited

Name of the type during initialisation.

Definition at line 58 of file ProcessingSignalListener.h.

m_MCRecoTracksStoreArrayName

std::string m_MCRecoTracksStoreArrayName = "MCRecoTracks"

private

sets the name of the expected StoreArray containing MCRecoTracks. Only required for MCInfo method

Definition at line 81 of file RecoTrackStorer.h.

m_MCStrictQualityEstimator

bool m_MCStrictQualityEstimator = true

private

Only required for MCInfo method.

Definition at line 83 of file RecoTrackStorer.h.

m_RecoTracksStoreArrayName

std::string m_RecoTracksStoreArrayName = "SVDHoughRecoTracks"

private

StoreArray name of the output Track StoreArray.

Definition at line 61 of file RecoTrackStorer.h.

m_storeRecoTracks

StoreArray<RecoTrack> m_storeRecoTracks

private

Output RecoTracks Store Array.

Definition at line 68 of file RecoTrackStorer.h.

m_storeSpacePointTrackCands

StoreArray<SpacePointTrackCand> m_storeSpacePointTrackCands

private

Output SpacePointTrackCand Store Array.

Definition at line 71 of file RecoTrackStorer.h.

m_subordinaryProcessingSignalListeners

std::vector<ProcessingSignalListener*> m_subordinaryProcessingSignalListeners

privateinherited

References to subordinary signal processing listener contained in this findlet.

Definition at line 52 of file CompositeProcessingSignalListener.h.

m_SVDClustersStoreArrayName

std::string m_SVDClustersStoreArrayName = "SVDClusters"

private

StoreArray name of the SVDCluster StoreArray.

Definition at line 63 of file RecoTrackStorer.h.

m_SVDSpacePointTrackCandsStoreArrayName

std::string m_SVDSpacePointTrackCandsStoreArrayName = "SVDHoughSpacePointTrackCands"

private

StoreArray name of the SpacePointTrackCandidate StoreArray.

Definition at line 65 of file RecoTrackStorer.h.

m_terminated

bool m_terminated = false

privateinherited

Flag to keep track whether termination happened before.

Definition at line 55 of file ProcessingSignalListener.h.

m_usedClusters

std::set<const SVDCluster*> m_usedClusters

private

Store the used clusters in the results.

Definition at line 74 of file RecoTrackStorer.h.

m_usedSpacePoints

std::set<const SpacePoint*> m_usedSpacePoints

private

Store the used space points in the results.

Definition at line 76 of file RecoTrackStorer.h.

---

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

• tracking/vxdHoughTracking/findlets/include/RecoTrackStorer.h
• tracking/vxdHoughTracking/findlets/src/RecoTrackStorer.cc