AxialTrackCreatorMCTruth Class Reference

Findlet that generates tracks from wire hits using the mc truth information. More...

#include <AxialTrackCreatorMCTruth.h>

Inheritance diagram for AxialTrackCreatorMCTruth:

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

Public Member Functions
void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) final
	Expose the parameters to a module.
std::string	getDescription () final
	Short description of the findlet.
void	initialize () final
	Initialize the Module before event processing.
void	beginEvent () final
	Start processing the current event.
void	apply (const std::vector< CDCWireHit > &inputWireHits, std::vector< CDCTrack > &outputAxialTracks) final
	Main function of the track finding by the cellular automaton.
virtual void	apply (ToVector< AIOTypes > &... ioVectors)=0
	Main function executing the algorithm.
void	beginRun () override
	Receive and dispatch signal for the beginning of a new run.
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
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 = Findlet< const CDCWireHit, CDCTrack >
	Type of the base class.

Private Attributes
bool	m_param_reconstructedDriftLength = true
	Parameter : Setup the drift length as it can be estimated from two dimensional information.
bool	m_param_reconstructedPositions = false
	Parameter : Switch to reconstruct the positions in the tracks immitating the legendre finder.
bool	m_param_fit = false
	Parameter : Fit the track instead of forwarding the mc truth information.
bool	m_param_useOnlyBeforeTOP = false
	Parameter : Cut tracks after the last layer of the CDC has been reached, assuming the tracks left the CDC.
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 happend before.
bool	m_terminated = false
	Flag to keep track whether termination happend before.
std::string	m_initializedAs
	Name of the type during initialisation.

Detailed Description

Findlet that generates tracks from wire hits using the mc truth information.

Definition at line 27 of file AxialTrackCreatorMCTruth.h.

Member Typedef Documentation

IOTypes

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

inherited

Types that should be served to apply on invokation.

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 invokation.

Definition at line 53 of file Findlet.h.

Super

using Super = Findlet<const CDCWireHit, CDCTrack>

private

Type of the base class.

Definition at line 31 of file AxialTrackCreatorMCTruth.h.

ToVector

using ToVector = typename ToVectorImpl<T>::Type

protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

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 ( const std::vector< CDCWireHit > &  inputWireHits, std::vector< CDCTrack > &  outputAxialTracks  )

final

Main function of the track finding by the cellular automaton.

Definition at line 86 of file AxialTrackCreatorMCTruth.cc.

{
  const CDCMCTrackStore& mcTrackStore = CDCMCTrackStore::getInstance();
  const CDCSimHitLookUp& simHitLookUp = CDCSimHitLookUp::getInstance();
 
  using CDCHitVector = CDCMCTrackStore::CDCHitVector;
 
  const std::map<ITrackType, CDCHitVector>& mcTracksByMCParticleIdx =
    mcTrackStore.getMCTracksByMCParticleIdx();
 
  std::size_t nAxialTracks = mcTracksByMCParticleIdx.size();
  outputAxialTracks.reserve(outputAxialTracks.size() + nAxialTracks);
 
  for (const std::pair<ITrackType, CDCHitVector> mcTracksAndMCParticleIdx : mcTracksByMCParticleIdx) {
 
    const CDCHitVector& mcTrack = mcTracksAndMCParticleIdx.second;
 
    outputAxialTracks.push_back(CDCTrack());
    CDCTrack& axialTrack = outputAxialTracks.back();
    bool reachedOuterMostLayer = false;
    for (const CDCHit* ptrHit : mcTrack) {
 
      if (m_param_useOnlyBeforeTOP) {
        // Cut tracks after the outermost layer has been reached and
        // the track starts to go inwards again.
        // But let all hits in the outermost layer survive.
        if (ptrHit->getISuperLayer() == 8 and ptrHit->getILayer() == 5) {
          reachedOuterMostLayer = true;
        }
        if (reachedOuterMostLayer and ptrHit->getILayer() != 5) {
          break;
        }
      }
 
      const CDCWireHit* wireHit = simHitLookUp.getWireHit(ptrHit, inputWireHits);
      if (not wireHit) continue;
 
      CDCRecoHit2D recoHit2D = simHitLookUp.getClosestPrimaryRecoHit2D(ptrHit, inputWireHits);
      if (not recoHit2D.isAxial()) continue;
 
      CDCRecoHit3D recoHit3D(recoHit2D.getRLWireHit(), {recoHit2D.getRecoPos2D(), 0}, NAN);
      axialTrack.push_back(recoHit3D);
    }
 
    // Discard short tracks
    if (axialTrack.size() < 5) outputAxialTracks.pop_back();
  }
 
  CDC::RealisticTDCCountTranslator tdcCountTranslator;
  for (CDCTrack& track : outputAxialTracks) {
    for (CDCRecoHit3D& recoHit3D : track) {
      Vector2D recoPos2D = recoHit3D.getRecoPos2D();
      Vector2D flightDirection = recoHit3D.getFlightDirection2D();
      double alpha = recoPos2D.angleWith(flightDirection);
 
      const CDCWire& wire = recoHit3D.getWire();
      const bool rl = recoHit3D.getRLInfo() == ERightLeft::c_Right;
 
      double driftLength = std::fabs(recoHit3D.getSignedRecoDriftLength());
      if (m_param_reconstructedDriftLength) {
        // Setup the drift length such that only information
        // that would be present in two dimensional reconstruction is used
        const double beta = 1;
        FlightTimeEstimator::instance().getFlightTime2D(recoPos2D, alpha, beta);
 
        //TODO: for now this seems to be unused, (see following comment)
        /*
        double flightTimeEstimate = 0;
        const CDCHit* hit = recoHit3D.getWireHit().getHit();
        driftLength =
          tdcCountTranslator.getDriftLength(hit->getTDCCount(),
                                            wire.getWireID(),
                                            flightTimeEstimate,
                                            rl,
                                            wire.getRefZ(),
                                            alpha);
        */
 
        // As the legendre finder does not reestimate the drift length
        // We simply set it to the reference drift length for now.
        // Use version above once the reestimation comes along.
        driftLength = recoHit3D.getWireHit().getRefDriftLength();
 
      } else {
        // In case the true drift length should be kept at least smear it with its variance.
        double driftLengthVariance = tdcCountTranslator.getDriftLengthResolution(driftLength,
                                     wire.getWireID(),
                                     rl,
                                     wire.getRefZ(),
                                     alpha);
 
        driftLength += gRandom->Gaus(0, std::sqrt(driftLengthVariance));
      }
      bool snapRecoPos = true;
      recoHit3D.setRecoDriftLength(driftLength, snapRecoPos);
    }
  }
 
  if (m_param_fit) {
    CDCKarimakiFitter fitter;
    for (CDCTrack& track : outputAxialTracks) {
      CDCTrajectory2D trajectory2D = fitter.fit(track);
      trajectory2D.setLocalOrigin(Vector2D(0.0, 0.0));
      track.setStartTrajectory3D({trajectory2D, CDCTrajectorySZ::basicAssumption()});
    }
  } else {
    const CDCMCTrackLookUp& mcTrackLookUp = CDCMCTrackLookUp::getInstance();
    for (CDCTrack& track : outputAxialTracks) {
      CDCTrajectory3D trajectory3D = mcTrackLookUp.getTrajectory3D(&track);
      CDCTrajectory2D trajectory2D = trajectory3D.getTrajectory2D();
      track.setStartTrajectory3D({trajectory2D, CDCTrajectorySZ::basicAssumption()});
    }
  }
 
  if (m_param_reconstructedPositions) {
    for (CDCTrack& track : outputAxialTracks) {
      AxialTrackUtil::normalizeTrack(track);
    }
  }
}

beginEvent()

void beginEvent ( )

finalvirtual

Start processing the current event.

Reimplemented from ProcessingSignalListener.

Definition at line 80 of file AxialTrackCreatorMCTruth.cc.

{
  CDCMCManager::getInstance().fill();
  Super::beginEvent();
}

beginRun()

void beginRun ( )

overridevirtualinherited

Receive and dispatch signal for the beginning of a new run.

Reimplemented from ProcessingSignalListener.

Reimplemented in LayerRelationFilter< AFilter >, FourHitFilter, QualityIndicatorFilter, ThreeHitFilter, TwoHitVirtualIPFilter, TwoHitVirtualIPQIFilter, RecoTrackStorer, ROIFinder, SpacePointLoaderAndPreparer, and TrackCandidateResultRefiner.

Definition at line 23 of file CompositeProcessingSignalListener.cc.

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

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  )

finalvirtual

Expose the parameters to a module.

Reimplemented from Findlet< const CDCWireHit, CDCTrack >.

Definition at line 41 of file AxialTrackCreatorMCTruth.cc.

{
  moduleParamList->addParameter(prefixed(prefix, "reconstructedDriftLength"),
                                m_param_reconstructedDriftLength,
                                "Switch to assign the reconstructed drift length to each hit, "
                                "as it can be estimated from two dimensional information only.",
                                m_param_reconstructedDriftLength);
 
  moduleParamList->addParameter(prefixed(prefix, "reconstructedPositions"),
                                m_param_reconstructedPositions,
                                "Switch to reconstruct the positions in the tracks "
                                "immitating the legendre finder.",
                                m_param_reconstructedPositions);
 
  moduleParamList->addParameter(prefixed(prefix, "fit"),
                                m_param_fit,
                                "Fit the track instead of forwarding the mc truth fit information",
                                m_param_fit);
 
  moduleParamList->addParameter(prefixed(prefix, "useOnlyBeforeTOP"),
                                m_param_useOnlyBeforeTOP,
                                "Cut tracks after the last layer of the CDC has been reached, "
                                "assuming the tracks left the CDC.",
                                m_param_useOnlyBeforeTOP);
}

getDescription()

std::string getDescription ( )

finalvirtual

Short description of the findlet.

Reimplemented from Findlet< const CDCWireHit, CDCTrack >.

Definition at line 67 of file AxialTrackCreatorMCTruth.cc.

{
  return "Constructs tracks from wire hits using the mc truth information.";
}

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

finalvirtual

Initialize the Module before event processing.

Reimplemented from ProcessingSignalListener.

Definition at line 73 of file AxialTrackCreatorMCTruth.cc.

{
  CDCMCManager::getInstance().requireTruthInformation();
  Super::initialize();
}

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_initialized

bool m_initialized = false

privateinherited

Flag to keep track whether initialization happend 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_param_fit

bool m_param_fit = false

private

Parameter : Fit the track instead of forwarding the mc truth information.

Definition at line 58 of file AxialTrackCreatorMCTruth.h.

m_param_reconstructedDriftLength

bool m_param_reconstructedDriftLength = true

private

Parameter : Setup the drift length as it can be estimated from two dimensional information.

Definition at line 52 of file AxialTrackCreatorMCTruth.h.

m_param_reconstructedPositions

bool m_param_reconstructedPositions = false

private

Parameter : Switch to reconstruct the positions in the tracks immitating the legendre finder.

Definition at line 55 of file AxialTrackCreatorMCTruth.h.

m_param_useOnlyBeforeTOP

bool m_param_useOnlyBeforeTOP = false

private

Parameter : Cut tracks after the last layer of the CDC has been reached, assuming the tracks left the CDC.

Definition at line 61 of file AxialTrackCreatorMCTruth.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_terminated

bool m_terminated = false

privateinherited

Flag to keep track whether termination happend before.

Definition at line 55 of file ProcessingSignalListener.h.

---

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

• tracking/trackFindingCDC/findlets/minimal/include/AxialTrackCreatorMCTruth.h
• tracking/trackFindingCDC/findlets/minimal/src/AxialTrackCreatorMCTruth.cc