Advancer Class Reference

Helper findlet for performing an extrapolation of a mSoP of one plane to another plane using the representation stored in the mSoP. More...

#include <Advancer.h>

Inheritance diagram for Advancer:

Public Member Functions
double	extrapolateToPlane (genfit::MeasuredStateOnPlane &measuredStateOnPlane, const genfit::SharedPlanePtr &plane) const
	Extrapolate the mSoP of one plane to another plane and return the traveled distance or NAN, if travelling into the wrong direction.
void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix)
	Expose the parameters.
void	setMaterialEffectsToParameterValue () const
	Call this to set the material effects handling accorinf to the given parameters.
void	resetMaterialEffects () const
	Call this to reset the material effects back to their default value (turned on).
void	initialize () final
	Convert the string parameter to a valid forward backward information.
virtual void	beginRun ()
	Receive signal for the beginning of a new run.
virtual void	beginEvent ()
	Receive signal for the start of a new event.
virtual void	endRun ()
	Receive signal for the end of the run.
virtual void	terminate ()
	Receive Signal for termination of the event processing.

Private Attributes
bool	m_param_useMaterialEffects = false
	Use material effects during extrapolation or not.
std::string	m_param_directionAsString = "both"
	Parameter for the distance given to the framework (can not handle EForwardBackward directly)
TrackFindingCDC::EForwardBackward	m_param_direction = TrackFindingCDC::EForwardBackward::c_Unknown
	Direction parameter converted from the string parameters.
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

Helper findlet for performing an extrapolation of a mSoP of one plane to another plane using the representation stored in the mSoP.

Will return the travelled distance or NAN, if

• the extrapolation failed or
• the extrapolation was into another direction as the direction parameter. See below.

Definition at line 37 of file Advancer.h.

Member Function Documentation

beginEvent()

void beginEvent ( )

virtualinherited

Receive signal for the start of a new event.

Reimplemented in BaseEventTimeExtractor< AIOTypes >, BaseEventTimeExtractor< RecoTrack * >, BaseEventTimeExtractor< RecoTrack * >, BaseEventTimeExtractor< TrackFindingCDC::CDCWireHit & >, BaseEventTimeExtractor< TrackFindingCDC::CDCWireHit & >, CDCCKFStateCreator, CKFToCDCFindlet, CKFToCDCFromEclFindlet, CKFToPXDFindlet, CKFToSVDFindlet, CKFToSVDSeedFindlet, DATCONFPGAFindlet, SpacePointTagger< AResult, ACluster >, SpacePointTagger< Belle2::CKFToPXDResult, Belle2::PXDCluster >, SpacePointTagger< Belle2::CKFToSVDResult, Belle2::SVDCluster >, AxialTrackCreatorMCTruth, BestMatchedTruthVarSet, BkgTruthClusterVarSet, CDCMCCloneLookUpFiller, CompositeProcessingSignalListener, FindletStoreArrayInput< TWrappedFindlet >, MCSymmetric< BaseAxialSegmentPairFilter >, MCSymmetric< BaseAxialSegmentPairFilter >, MCSymmetric< BaseFacetFilter >, MCSymmetric< BaseFacetFilter >, MCSymmetric< BaseFacetRelationFilter >, MCSymmetric< BaseFacetRelationFilter >, MCSymmetric< BaseSegmentPairFilter >, MCSymmetric< BaseSegmentPairFilter >, MCSymmetric< BaseSegmentPairRelationFilter >, MCSymmetric< BaseSegmentPairRelationFilter >, MCSymmetric< BaseSegmentRelationFilter >, MCSymmetric< BaseSegmentRelationFilter >, MCSymmetric< BaseSegmentTripleFilter >, MCSymmetric< BaseSegmentTripleFilter >, MCSymmetric< BaseSegmentTripleRelationFilter >, MCSymmetric< BaseSegmentTripleRelationFilter >, MCSymmetric< BaseTrackRelationFilter >, MCSymmetric< BaseTrackRelationFilter >, MonopoleStereoHitFinder, MonopoleStereoHitFinderQuadratic, SegmentCreatorMCTruth, SegmentFinderFacetAutomaton, SegmentTrackCombiner, SegmentTrackTruthVarSet, SharingHitsMatcher< ACollectorItem, ACollectionItem >, SharingHitsMatcher< Belle2::TrackFindingCDC::CDCTrack, Belle2::TrackFindingCDC::CDCSegment2D >, StereoHitFinder, StereoHitTruthVarSet, StoreVectorSwapper< IOType, a_alwaysWrite >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCFacet >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCSegment2D >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCSegmentPair >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCSegmentTriple >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCTrack >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCWireHit, true >, TrackFinderAutomaton, TrackFinderSegmentPairAutomaton, TrackFinderSegmentTripleAutomaton, TruthAxialSegmentPairVarSet, TruthSegmentVarSet, TruthTrackVarSet, WireHitMCMultiLoopBlocker, RecoTrackStorer, ROIFinder, and SVDHoughTracking.

Definition at line 45 of file ProcessingSignalListener.cc.

{
  if (not m_initialized) {
    B2DEBUG(20, typeid(*this).name() << " was not initialized");
  }
}

beginRun()

void beginRun ( )

virtualinherited

Receive signal for the beginning of a new run.

Reimplemented in DATCONSVDClusterizer, LayerPXDRelationFilter< AFilter, APrefilter >, LayerPXDRelationFilter< TrackFindingCDC::ChooseableFilter< PXDPairFilterFactory > >, LayerPXDRelationFilter< TrackFindingCDC::ChooseableFilter< PXDPairFilterFactory > >, LayerSVDRelationFilter< AFilter, APrefilter >, LayerSVDRelationFilter< TrackFindingCDC::ChooseableFilter< SVDPairFilterFactory > >, LayerSVDRelationFilter< TrackFindingCDC::ChooseableFilter< SVDPairFilterFactory > >, SectorMapBasedSVDPairFilter, SimplePXDStateFilter, SimpleSVDStateFilter, AsicBackgroundDetector, AsicBackgroundLibraryCreator, CompositeProcessingSignalListener, CutsFromDBWireHitFilter, MVA< Filter< AVarSet::Object > >, MVA< Filter< typename AVarSet::Object > >, MVA< Filter< typename AVarSet::Object > >, WireHitCreator, FourHitFilter, LayerRelationFilter< AFilter >, LayerRelationFilter< TrackFindingCDC::ChooseableFilter< RelationFilterFactory > >, LayerRelationFilter< TrackFindingCDC::ChooseableFilter< RelationFilterFactory > >, QualityIndicatorFilter, RecoTrackStorer, ROIFinder, SpacePointLoaderAndPreparer, ThreeHitFilter, TrackCandidateResultRefiner, TwoHitVirtualIPFilter, and TwoHitVirtualIPQIFilter.

Definition at line 38 of file ProcessingSignalListener.cc.

{
  if (not m_initialized) {
    B2DEBUG(20, typeid(*this).name() << " was not initialized");
  }
}

endRun()

void endRun ( )

virtualinherited

Receive signal for the end of the run.

Reimplemented in CompositeProcessingSignalListener.

Definition at line 52 of file ProcessingSignalListener.cc.

{
  if (not m_initialized) {
    B2DEBUG(20, typeid(*this).name() << " was not initialized");
  }
}

exposeParameters()

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

Expose the parameters.

Definition at line 52 of file Advancer.cc.

{
  moduleParamList->addParameter(prefixed(prefix, "useMaterialEffects"),
                                m_param_useMaterialEffects,
                                "Use the material effects during extrapolation.",
                                m_param_useMaterialEffects);
 
  moduleParamList->addParameter(prefixed(prefix, "direction"), m_param_directionAsString,
                                "The direction where the extrapolation will happen.");
}

extrapolateToPlane()

double extrapolateToPlane	(	genfit::MeasuredStateOnPlane &	measuredStateOnPlane,
		const genfit::SharedPlanePtr &	plane ) const

Extrapolate the mSoP of one plane to another plane and return the traveled distance or NAN, if travelling into the wrong direction.

Definition at line 22 of file Advancer.cc.

{
  setMaterialEffectsToParameterValue();
 
  double returnValue = NAN;
  try {
    const double extrapolatedS = measuredStateOnPlane.extrapolateToPlane(plane);
 
    if (arcLengthInRightDirection(extrapolatedS, m_param_direction)) {
      returnValue = static_cast<double>(m_param_direction) * extrapolatedS;
    }
  } catch (const genfit::Exception& e) {
    B2DEBUG(29, "Extrapolation failed: " << e.what());
  }
 
  resetMaterialEffects();
  return returnValue;
}

initialize()

void initialize ( )

finalvirtual

Convert the string parameter to a valid forward backward information.

Reimplemented from ProcessingSignalListener.

Definition at line 63 of file Advancer.cc.

{
  ProcessingSignalListener::initialize();
 
  m_param_direction = fromString(m_param_directionAsString);
}

resetMaterialEffects()

void resetMaterialEffects

(

)

const

Call this to reset the material effects back to their default value (turned on).

Definition at line 47 of file Advancer.cc.

{
  genfit::MaterialEffects::getInstance()->setNoEffects(false);
}

setMaterialEffectsToParameterValue()

void setMaterialEffectsToParameterValue

(

)

const

Call this to set the material effects handling accorinf to the given parameters.

Definition at line 42 of file Advancer.cc.

{
  genfit::MaterialEffects::getInstance()->setNoEffects(not m_param_useMaterialEffects);
}

terminate()

void terminate ( )

virtualinherited

Receive Signal for termination of the event processing.

Reimplemented in AsicBackgroundLibraryCreator, AxialTrackCreatorHitHough, AxialTrackCreatorSegmentHough, CompositeProcessingSignalListener, Recording< Filter< AVarSet::Object > >, Recording< Filter< typename AVarSet::Object > >, Recording< Filter< typename AVarSet::Object > >, StereoHitTrackQuadTreeMatcher< AQuadTree >, StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::HyperHough< std::pair< CDCRecoHit3D, const CDCRLWireHit * >, FirstOfPairInBox< HitInHyperBox >, 4, 3, 2 > >, StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::QuadraticLegendre< std::pair< CDCRecoHit3D, const CDCRLWireHit * >, FirstOfPairInBox< HitInQuadraticBox >, 2, 2 > >, and StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::Z0TanLambdaLegendre< std::pair< CDCRecoHit3D, const CDCRLWireHit * >, FirstOfPairInBox< HitInZ0TanLambdaBox >, 2, 2 > >.

Definition at line 59 of file ProcessingSignalListener.cc.

{
  if (m_terminated) {
    B2DEBUG(20, typeid(*this).name() << " has been terminated before");
    printBacktrace(LogConfig::c_Debug, 10);
  }
  m_terminated = true;
 
  if (not m_initialized) {
    B2DEBUG(20, typeid(*this).name() << " was not initialized before termination");
    printBacktrace(LogConfig::c_Debug, 10);
  }
  m_initialized = false;
}

Member Data Documentation

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_param_direction

TrackFindingCDC::EForwardBackward m_param_direction = TrackFindingCDC::EForwardBackward::c_Unknown

private

Direction parameter converted from the string parameters.

Definition at line 62 of file Advancer.h.

m_param_directionAsString

std::string m_param_directionAsString = "both"

private

Parameter for the distance given to the framework (can not handle EForwardBackward directly)

Definition at line 60 of file Advancer.h.

m_param_useMaterialEffects

bool m_param_useMaterialEffects = false

private

Use material effects during extrapolation or not.

Definition at line 57 of file Advancer.h.

m_terminated

bool m_terminated = false

privateinherited

Flag to keep track whether termination happened before.

Definition at line 55 of file ProcessingSignalListener.h.

---

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

• tracking/ckf/general/utilities/include/Advancer.h
• tracking/ckf/general/utilities/src/Advancer.cc