BadBoardADCDetector Class Reference

Marks hits as background based on the result of a filter. More...

#include <BadBoardADCDetector.h>

Inheritance diagram for BadBoardADCDetector:

Collaboration diagram for BadBoardADCDetector:

Public Types
using	IOTypes
	Types that should be served to apply on invocation.
using	IOTypes
	Types that should be served to apply on invocation.
using	IOVectors
	Vector types that should be served to apply on invocation.
using	IOVectors
	Vector types that should be served to apply on invocation.

Public Member Functions
	BadBoardADCDetector ()
	Default constructor.
std::string	getDescription () final
	Short description of the findlet.
void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) final
	Expose the parameters to a module.
void	initialize () final
	Initialization.
void	beginRun () final
	begin run
void	apply (std::vector< TrackingUtilities::CDCWireHit > &wireHits) final
	Main algorithm marking hit as background.
virtual void	apply (ToVector< AIOTypes > &... ioVectors)=0
	Main function executing the algorithm.
void	beginEvent () override
	Receive and dispatch signal for the start of a new event.
void	beginEvent () override
	Receive and dispatch signal for the start of a new event.
void	endRun () override
	Receive and dispatch signal for the end of the 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.
void	terminate () override
	Receive and dispatch Signal for termination of the event processing.

Protected Types
using	ToVector
	Short hand for ToRangeImpl.
using	ToVector
	Short hand for ToRangeImpl.

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

Private Types
using	Super = Findlet<TrackingUtilities::CDCWireHit&>
	Type of the base class.

Private Attributes
int	m_badADCaverageMin = 1000
	Min ADC value for the average.
int	m_badADCaverageMax = 0
	Max ADC value for the average.
int	m_badTOTaverageMin = 15
	Min TOT value for the average.
DBObjPtr< CDCBadBoards >	m_badBoardsFromDB
	Pointer to the CDCBadBoards payload.
std::vector< ProcessingSignalListener * >	m_subordinaryProcessingSignalListeners
	References to subordinary signal processing listener contained in this findlet.
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_initialized
	Flag to keep track whether initialization happened before.
bool	m_terminated = false
	Flag to keep track whether termination happened before.
bool	m_terminated
	Flag to keep track whether termination happened before.
std::string	m_initializedAs
	Name of the type during initialisation.
std::string	m_initializedAs
	Name of the type during initialisation.

Detailed Description

Marks hits as background based on the result of a filter.

Definition at line 28 of file BadBoardADCDetector.h.

Member Typedef Documentation

IOTypes [1/2]

using IOTypes

inherited

Types that should be served to apply on invocation.

Definition at line 30 of file Findlet.h.

IOTypes [2/2]

using IOTypes

inherited

Types that should be served to apply on invocation.

Definition at line 30 of file Findlet.h.

IOVectors [1/2]

using IOVectors

inherited

Vector types that should be served to apply on invocation.

Definition at line 53 of file Findlet.h.

IOVectors [2/2]

using IOVectors

inherited

Vector types that should be served to apply on invocation.

Definition at line 53 of file Findlet.h.

Super

using Super = Findlet<TrackingUtilities::CDCWireHit&>

private

Type of the base class.

Definition at line 32 of file BadBoardADCDetector.h.

ToVector [1/2]

using ToVector

protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

ToVector [2/2]

using ToVector

protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

Constructor & Destructor Documentation

BadBoardADCDetector()

BadBoardADCDetector

(

)

Default constructor.

Definition at line 22 of file BadBoardADCDetector.cc.

{
}

Member Function Documentation

addProcessingSignalListener() [1/2]

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);
}

addProcessingSignalListener() [2/2]

void addProcessingSignalListener ( ProcessingSignalListener * psl )

protectedinherited

Register a processing signal listener to be notified.

Definition at line 53 of file CompositeProcessingSignalListener.cc.

{
  m_subordinaryProcessingSignalListeners.push_back(psl);
}

apply()

void apply ( std::vector< TrackingUtilities::CDCWireHit > & wireHits )

final

Main algorithm marking hit as background.

Definition at line 60 of file BadBoardADCDetector.cc.

{
  CDC::CDCGeometryPar& geometryPar = CDC::CDCGeometryPar::Instance();
  // first loop: average ADC per board
  std::map <int, double> BoardADC;
  std::map <int, double> BoardTOT;
  std::map <int, int> BoardCount;
  for (auto& wireHit : wireHits) {
    auto board = geometryPar.getBoardID(wireHit.getWireID());
    BoardCount[board] += 1;
    BoardADC[board] += (*wireHit.getHit()).getADCCount();
    BoardTOT[board] += (*wireHit.getHit()).getTOT();
  };
  // now compute the averages:
  for (auto& pair  : BoardADC) {
    int board = pair.first;
    BoardADC[board] /= BoardCount[board];
    BoardTOT[board] /= BoardCount[board];
  }
 
  // second loop, set flag if board is problematic:
  for (auto& wireHit : wireHits) {
    auto board = geometryPar.getBoardID(wireHit.getWireID());
    if ((BoardADC[board] > m_badADCaverageMin) || (BoardADC[board] <= m_badADCaverageMax))
      wireHit->setBoardWithBadADCFlag();
    if (BoardTOT[board] > m_badTOTaverageMin)
      wireHit->setBoardWithBadTOTFlag();
  }
 
  // 3rd loop, over all boards, update list of them. Include boards with no hits at all
  Belle2::TrackingUtilities::StoreWrappedObjPtr< std::vector<unsigned int> > storeVector("CDCDeadBoardsVector");
 
  storeVector.create();
 
  // TODO: decide if need the dead boards from the payload. Should be not possible that this method fails to detect those!?
  double dummyEff = 0; // needed by isDeadBoard function else unused
  // Note that board 0 is absent, the loop starts from 1.
  for (unsigned int iBoard = 1; iBoard < c_nBoards; iBoard += 1) {
    if (BoardCount.find(iBoard) == BoardCount.end() || m_badBoardsFromDB->isDeadBoard(iBoard, dummyEff)) {
      storeVector->push_back(iBoard);
    }
  }
}

beginEvent() [1/2]

void beginEvent ( )

overridevirtualinherited

Receive and dispatch signal for the start of a new event.

Reimplemented from ProcessingSignalListener.

Reimplemented in DATCONFPGAFindlet, SpacePointTagger< AResult, ACluster >, SpacePointTagger< Belle2::CKFToPXDResult, Belle2::PXDCluster >, SpacePointTagger< Belle2::CKFToSVDResult, Belle2::SVDCluster >, 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, StereoHitFinder, StereoHitTruthVarSet, TrackFinderAutomaton, TrackFinderSegmentPairAutomaton, TrackFinderSegmentTripleAutomaton, TruthAxialSegmentPairVarSet, TruthSegmentVarSet, TruthTrackVarSet, WireHitMCMultiLoopBlocker, FindletStoreArrayInput< TWrappedFindlet >, SharingHitsMatcher< ACollectorItem, ACollectionItem >, SharingHitsMatcher< Belle2::TrackingUtilities::CDCTrack, Belle2::TrackingUtilities::CDCSegment2D >, StoreVectorSwapper< IOType, a_alwaysWrite >, StoreVectorSwapper< Belle2::TrackingUtilities::CDCFacet >, StoreVectorSwapper< Belle2::TrackingUtilities::CDCSegment2D >, StoreVectorSwapper< Belle2::TrackingUtilities::CDCSegmentPair >, StoreVectorSwapper< Belle2::TrackingUtilities::CDCSegmentTriple >, StoreVectorSwapper< Belle2::TrackingUtilities::CDCTrack >, StoreVectorSwapper< Belle2::TrackingUtilities::CDCWireHit, true >, RecoTrackStorer, ROIFinder, and SVDHoughTracking.

Definition at line 31 of file CompositeProcessingSignalListener.cc.

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

beginEvent() [2/2]

void beginEvent ( )

overrideinherited

Receive and dispatch signal for the start of a new event.

Definition at line 36 of file CompositeProcessingSignalListener.cc.

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

beginRun()

void beginRun ( )

finalvirtual

begin run

Reimplemented from ProcessingSignalListener.

Definition at line 32 of file BadBoardADCDetector.cc.

{
  // checking validity once per run should be sufficient
  if (not m_badBoardsFromDB.isValid()) B2FATAL("CDCBadBoards payload not found!");
}

endRun() [1/2]

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

endRun() [2/2]

void endRun ( )

overrideinherited

Receive and dispatch signal for the end of the run.

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

Definition at line 43 of file BadBoardADCDetector.cc.

{
  moduleParamList->addParameter(TrackingUtilities::prefixed(prefix, "badADCaverageMin"),
                                m_badADCaverageMin,
                                "Minimal value of average ADC to consider board bad",
                                m_badADCaverageMin);
  moduleParamList->addParameter(TrackingUtilities::prefixed(prefix, "badADCaverageMax"),
                                m_badADCaverageMax,
                                "Maximal value of average ADC to consider a board as bad",
                                m_badADCaverageMax);
  moduleParamList->addParameter(TrackingUtilities::prefixed(prefix, "badTOTaverageMin"),
                                m_badTOTaverageMin,
                                "Minimal value of average TOT to consider board bad",
                                m_badTOTaverageMin);
}

getDescription()

std::string getDescription ( )

finalvirtual

Short description of the findlet.

Reimplemented from Findlet< TrackingUtilities::CDCWireHit & >.

Definition at line 38 of file BadBoardADCDetector.cc.

{
  return "Detect boards with bad ADC values and mark hits accordingly";
}

getNProcessingSignalListener() [1/2]

int getNProcessingSignalListener ( )

protectedinherited

Get the number of currently registered listeners.

Definition at line 60 of file CompositeProcessingSignalListener.cc.

{
  return m_subordinaryProcessingSignalListeners.size();
}

getNProcessingSignalListener() [2/2]

int getNProcessingSignalListener ( )

protectedinherited

Get the number of currently registered listeners.

Definition at line 56 of file CompositeProcessingSignalListener.cc.

{
  return m_subordinaryProcessingSignalListeners.size();
}

initialize()

void initialize ( )

finalvirtual

Initialization.

Reimplemented from ProcessingSignalListener.

Definition at line 26 of file BadBoardADCDetector.cc.

{
  Belle2::TrackingUtilities::StoreWrappedObjPtr< std::vector<unsigned int> > storeVector("CDCDeadBoardsVector");
  storeVector.registerInDataStore();
}

terminate() [1/2]

void terminate ( )

overridevirtualinherited

Receive and dispatch Signal for termination of the event processing.

Reimplemented from ProcessingSignalListener.

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

Definition at line 47 of file CompositeProcessingSignalListener.cc.

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

terminate() [2/2]

void terminate ( )

overrideinherited

Receive and dispatch Signal for termination of the event processing.

Definition at line 42 of file CompositeProcessingSignalListener.cc.

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

Member Data Documentation

m_badADCaverageMax

int m_badADCaverageMax = 0

private

Max ADC value for the average.

Definition at line 60 of file BadBoardADCDetector.h.

m_badADCaverageMin

int m_badADCaverageMin = 1000

private

Min ADC value for the average.

Definition at line 57 of file BadBoardADCDetector.h.

m_badBoardsFromDB

DBObjPtr<CDCBadBoards> m_badBoardsFromDB

private

Pointer to the CDCBadBoards payload.

Definition at line 66 of file BadBoardADCDetector.h.

m_badTOTaverageMin

int m_badTOTaverageMin = 15

private

Min TOT value for the average.

Definition at line 63 of file BadBoardADCDetector.h.

m_initialized [1/2]

bool m_initialized

privateinherited

Flag to keep track whether initialization happened before.

Definition at line 52 of file ProcessingSignalListener.h.

m_initialized [2/2]

bool m_initialized = false

privateinherited

Flag to keep track whether initialization happened before.

Definition at line 52 of file ProcessingSignalListener.h.

m_initializedAs [1/2]

std::string m_initializedAs

privateinherited

Name of the type during initialisation.

Definition at line 58 of file ProcessingSignalListener.h.

m_initializedAs [2/2]

std::string m_initializedAs

privateinherited

Name of the type during initialisation.

Definition at line 58 of file ProcessingSignalListener.h.

m_subordinaryProcessingSignalListeners [1/2]

std::vector<ProcessingSignalListener*> m_subordinaryProcessingSignalListeners

privateinherited

References to subordinary signal processing listener contained in this findlet.

Definition at line 60 of file CompositeProcessingSignalListener.h.

m_subordinaryProcessingSignalListeners [2/2]

std::vector<ProcessingSignalListener*> m_subordinaryProcessingSignalListeners

privateinherited

References to subordinary signal processing listener contained in this findlet.

Definition at line 60 of file CompositeProcessingSignalListener.h.

m_terminated [1/2]

bool m_terminated

privateinherited

Flag to keep track whether termination happened before.

Definition at line 55 of file ProcessingSignalListener.h.

m_terminated [2/2]

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/trackFindingCDC/findlets/minimal/include/BadBoardADCDetector.h
• tracking/trackFindingCDC/findlets/minimal/src/BadBoardADCDetector.cc