AsicBackgroundLibraryCreator Class Reference

Finds ASICs with single signal hit, records info to the library. More...

#include <AsicBackgroundLibraryCreator.h>

Inheritance diagram for AsicBackgroundLibraryCreator:

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
	AsicBackgroundLibraryCreator ()=default
	Default constructor.
void	initialize () final
	Access database here, open library for writing:
void	beginRun () final
	Reload channel map if needed.
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	apply (const std::vector< TrackingUtilities::CDCWireHit > &wireHits, const std::vector< TrackingUtilities::CDCTrack > &tracks) final
	Main algorithm marking hit as background.
void	terminate () final
	write out the library
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	endRun () override
	Receive and dispatch signal for the end of the run.

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.
int	getNProcessingSignalListener ()
	Get the number of currently registered listeners.

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

Private Member Functions
void	selectAsic (const std::vector< const TrackingUtilities::CDCWireHit * > &wireHits, const std::vector< TrackingUtilities::CDCTrack > &tracks)
	Algorithm to select suitable ASIC for library creation.

Private Attributes
std::unique_ptr< DBArray< CDCChannelMap > >	m_channelMapFromDB
	Channel map retrieved from DB.
std::map< int, std::pair< int, int > >	m_map
	map from ewire to board/channel ID
std::string	m_library_name {"CDCAsicLibrary.root"}
	output library name
size_t	m_minimal_hit_number {1}
	min. number of hits in ASIC for background check
double	m_distance_signal_max {0.25}
	maximal distance from track to signal hit
double	m_distance_background_min {0.5}
	minimal distance from track to background hit
bool	m_use_axial_hits_only {false}
	use axial layers only
bool	m_write_extra_vars {false}
	extra vars to the library
size_t	m_minimal_hits_on_track {40}
	min. number of hits on the track
std::unique_ptr< TrackingUtilities::Recorder >	m_recorder
	Recorder for the root output.
asicChannel	m_asic_info [8]
	all 8 channels
UChar_t	m_board {0}
	signal boardID
UChar_t	m_channel {0}
	signal channelID
UChar_t	m_n_hit {0}
	For debugging, store also number of channels with hits.
float	m_dist_signal {0}
	Distance to signal hit.
float	m_dist_bg {0}
	min. distance to non-linked hits
Short_t	m_adc_sig {0}
	ADC of the signal.
Short_t	m_adc_max_bg {0}
	Max. ADC background.
UShort_t	m_n_hit_track {0}
	Number of hits on the track.
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

Finds ASICs with single signal hit, records info to the library.

Definition at line 31 of file AsicBackgroundLibraryCreator.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 = TrackingUtilities::Findlet<const TrackingUtilities::CDCWireHit, const TrackingUtilities::CDCTrack >

private

Type of the base class.

Definition at line 35 of file AsicBackgroundLibraryCreator.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.

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< TrackingUtilities::CDCWireHit > & wireHits, const std::vector< TrackingUtilities::CDCTrack > & tracks )

final

Main algorithm marking hit as background.

Definition at line 111 of file AsicBackgroundLibraryCreator.cc.

{
 
  std::map< std::pair<int, int>, std::vector<const CDCWireHit*>> groupedByAsic;
  for (const CDCWireHit& wireHit : wireHits) {
    auto eWire = wireHit.getWireID().getEWire();
    B2ASSERT("Channel map NOT found for the channel", m_map.count(eWire) > 0);
    auto board = m_map[eWire].first;
    auto channel = m_map[eWire].second;
    auto asicID = std::pair<int, int>(board, channel / 8);  // ASIC are groups of 8 channels
    groupedByAsic[asicID].push_back(&wireHit);
  };
  for (auto& asicList :  groupedByAsic) {
    selectAsic(asicList.second, tracks);
  };
 
  return;
}

beginEvent()

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

beginRun()

void beginRun ( )

finalvirtual

Reload channel map if needed.

Reimplemented from ProcessingSignalListener.

Definition at line 91 of file AsicBackgroundLibraryCreator.cc.

{
  Super::beginRun();
  // Load map from DB:
  for (const auto& cm : (*m_channelMapFromDB)) {
    const int isl = cm.getISuperLayer();
    const int il = cm.getILayer();
    const int iw = cm.getIWire();
    const int iBoard = cm.getBoardID();
    const int iCh = cm.getBoardChannel();
    const WireID wireId(isl, il, iw);
    m_map[wireId.getEWire()] = std::pair<int, int>(iBoard, iCh);
  }
}

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

Definition at line 130 of file AsicBackgroundLibraryCreator.cc.

{
  Super::exposeParameters(moduleParamList, prefix);
  moduleParamList->addParameter(prefixed(prefix, "minimalHitNumberASIC"),
                                m_minimal_hit_number,
                                "Required number of hits per ASIC for library creation",
                                m_minimal_hit_number);
 
  moduleParamList->addParameter(prefixed(prefix, "AsicLibraryFileName"),
                                m_library_name,
                                "ASIC library file name",
                                m_library_name);
 
  moduleParamList->addParameter(prefixed(prefix, "maximalDistanceSignal"),
                                m_distance_signal_max,
                                "maximal distance in cm from track to signal hit",
                                m_distance_signal_max);
 
  moduleParamList->addParameter(prefixed(prefix, "minimalDistanceBackground"),
                                m_distance_background_min,
                                "minimal distance in cm from track to background hit",
                                m_distance_background_min);
 
  moduleParamList->addParameter(prefixed(prefix, "useAxialHitsOnly"),
                                m_use_axial_hits_only,
                                "use axial layers only",
                                m_use_axial_hits_only);
 
  moduleParamList->addParameter(prefixed(prefix, "writeExtraVars"),
                                m_write_extra_vars,
                                "Write extra variables to the library",
                                m_write_extra_vars);
 
  moduleParamList->addParameter(prefixed(prefix, "minimalHitsOnTrack"),
                                m_minimal_hits_on_track,
                                "Required number of hits on track for library creation",
                                m_minimal_hits_on_track);
 
  // set some defaults:
  moduleParamList->getParameter<std::string>("inputTracks").setDefaultValue("CDCTrackVector");
  moduleParamList->getParameter<std::string>("inputWireHits").setDefaultValue("CDCWireHitVector");
}

getDescription()

std::string getDescription ( )

finalvirtual

Short description of the findlet.

Reimplemented from Findlet< const TrackingUtilities::CDCWireHit, const TrackingUtilities::CDCTrack >.

Definition at line 106 of file AsicBackgroundLibraryCreator.cc.

{
  return "Finds suitable ASICs with a single hit attached to a track and uses them to create the library";
}

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

Access database here, open library for writing:

Reimplemented from ProcessingSignalListener.

Definition at line 57 of file AsicBackgroundLibraryCreator.cc.

{
  Super::initialize();
  // database:
  m_channelMapFromDB = std::make_unique<DBArray<CDCChannelMap>> ();
 
  if ((*m_channelMapFromDB).isValid()) {
    B2DEBUG(29, "CDC Channel map is  valid");
  } else {
    B2FATAL("CDC Channel map is not valid");
  }
 
  // Library for writing
 
  auto leavesCreator = [this](TTree & tree) {
    if (m_write_extra_vars) {
      tree.Branch("Dist", &m_dist_signal, "DistSig/f:DistBg/f");
      tree.Branch("ADC", &m_adc_sig, "ADC_Sig/S:ADC_bg/S");
      tree.Branch("Track", &m_n_hit_track, "tr_nhit/S");
    }
    tree.Branch("Board", &m_board, "board/b");
    tree.Branch("Channel", &m_channel, "channel/b");
    tree.Branch("Nhit", &m_n_hit, "nhit/b");
    tree.Branch("Asic", &m_asic_info[0],
                "TDC0/S:ADC0/S:TOT0/S:TDC1/S:ADC1/S:TOT1/S:TDC2/S:ADC2/S:TOT2/S:TDC3/S:ADC3/S:TOT3/S:TDC4/S:ADC4/S:TOT4/S:TDC5/S:ADC5/S:TOT5/S:TDC6/S:ADC6/S:TOT6/S:TDC7/S:ADC7/S:TOT7/S");
    return;
  };
 
  m_recorder.reset(new Recorder(
                     leavesCreator
                     , m_library_name
                     , "ASIC"));
}

selectAsic()

void selectAsic ( const std::vector< const TrackingUtilities::CDCWireHit * > & wireHits, const std::vector< TrackingUtilities::CDCTrack > & tracks )

private

Algorithm to select suitable ASIC for library creation.

This is abnormal situation, detected for few runs, related to CDC unpacker. Hits are to be marked as background.

Definition at line 179 of file AsicBackgroundLibraryCreator.cc.

{
 
  if (wireHits.size() < m_minimal_hit_number) {
    return;
  };
 
  if (wireHits.size() > 8) {
    B2ERROR("Number of hits per asic should not exceed 8, observe too many hits." << LogVar("nHits", wireHits.size()));
    return;
  }
 
 
  // count taken non-background hits:
  int count = 0;
  const CDCWireHit* signal = nullptr;
  for (auto& hit : wireHits) {
    if (!(*hit)->hasBackgroundFlag() && (*hit)->hasTakenFlag()) {
      count += 1;
      signal = hit;
    }
  }
 
  // require one and only one taken hit
  if (count != 1) {
    return;
  }
 
 
  // check if only axial hits are used:
 
  if ((!signal->isAxial()) && m_use_axial_hits_only) {
    return;
  }
 
  // find the track to which this hit belongs
  const CDCTrack* signalTrack = nullptr;
  for (auto& track : tracks) {
    for (auto& hit : track) {
      if (&hit.getWireHit() == signal) {
        signalTrack = &track;
        break;
      }
    }
    if (signalTrack != nullptr) {
      break;
    }
  }
 
  if (signalTrack == nullptr) {
    B2DEBUG(29, "AsicBackgroundLibraryCreator::No track found for the signal hit");
    return;
  }
 
  m_n_hit_track = signalTrack->size();
 
  if (m_n_hit_track < m_minimal_hits_on_track) return;
 
  // check the distance from the track to each signal hit
  const auto& trajectory = signalTrack->getStartTrajectory3D();
 
  m_dist_bg = 1000.;
 
  for (auto& hit : wireHits) {
 
    const float dist = getDist2D(trajectory, hit);
 
 
    if (hit == signal) {
      m_dist_signal = dist;
      if (dist > m_distance_signal_max) return;
    } else {
      m_dist_bg = std::min(m_dist_bg, dist);
      if (dist < m_distance_background_min) return;
    }
  }
 
 
  // Ok, passes all cuts !
 
  // reset the library entries
  for (auto& channel : m_asic_info) {
    channel.TDC = -1;
    channel.ADC = -1;
    channel.TOT = -1;
  }
 
  // add to the library
 
  m_n_hit = wireHits.size();
 
  m_adc_max_bg = 0;
  for (auto& hit : wireHits) {
    auto eWire = hit->getWireID().getEWire();
    auto channel = m_map[eWire].second;
    auto asicCH = channel % 8;
    m_asic_info[asicCH].ADC = hit->getHit()->getADCCount();
    m_asic_info[asicCH].TDC = hit->getHit()->getTDCCount();
    m_asic_info[asicCH].TOT = hit->getHit()->getTOT();
 
    if (hit != signal) {
      m_adc_max_bg = std::max(m_adc_max_bg, m_asic_info[asicCH].ADC);
    }
  }
  // also signal hit info
  auto eWire = signal->getWireID().getEWire();
  m_channel = m_map[eWire].second;
  m_board   = m_map[eWire].first;
  m_adc_sig = signal->getHit()->getADCCount();
 
  // make sure that ADC of the signal is >= than ADC of the background:
  if (m_adc_sig < m_adc_max_bg) return;
 
  // write out
  m_recorder->capture();
}

terminate()

void terminate ( )

finalvirtual

write out the library

Reimplemented from ProcessingSignalListener.

Definition at line 173 of file AsicBackgroundLibraryCreator.cc.

{
  m_recorder->write();
  Super::terminate();
}

Member Data Documentation

m_adc_max_bg

Short_t m_adc_max_bg {0}

private

Max. ADC background.

Definition at line 123 of file AsicBackgroundLibraryCreator.h.

{0};

m_adc_sig

Short_t m_adc_sig {0}

private

ADC of the signal.

Definition at line 120 of file AsicBackgroundLibraryCreator.h.

{0};

m_asic_info

asicChannel m_asic_info[8]

private

all 8 channels

Definition at line 100 of file AsicBackgroundLibraryCreator.h.

m_board

UChar_t m_board {0}

private

signal boardID

Definition at line 103 of file AsicBackgroundLibraryCreator.h.

{0};

m_channel

UChar_t m_channel {0}

private

signal channelID

Definition at line 106 of file AsicBackgroundLibraryCreator.h.

{0};

m_channelMapFromDB

std::unique_ptr<DBArray<CDCChannelMap> > m_channelMapFromDB

private

Channel map retrieved from DB.

Definition at line 67 of file AsicBackgroundLibraryCreator.h.

m_dist_bg

float m_dist_bg {0}

private

min. distance to non-linked hits

Definition at line 117 of file AsicBackgroundLibraryCreator.h.

{0};

m_dist_signal

float m_dist_signal {0}

private

Distance to signal hit.

Definition at line 114 of file AsicBackgroundLibraryCreator.h.

{0};

m_distance_background_min

double m_distance_background_min {0.5}

private

minimal distance from track to background hit

Definition at line 82 of file AsicBackgroundLibraryCreator.h.

{0.5};

m_distance_signal_max

double m_distance_signal_max {0.25}

private

maximal distance from track to signal hit

Definition at line 79 of file AsicBackgroundLibraryCreator.h.

{0.25};

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_library_name

std::string m_library_name {"CDCAsicLibrary.root"}

private

output library name

Definition at line 73 of file AsicBackgroundLibraryCreator.h.

{"CDCAsicLibrary.root"};

m_map

std::map<int, std::pair<int, int> > m_map

private

map from ewire to board/channel ID

Definition at line 70 of file AsicBackgroundLibraryCreator.h.

m_minimal_hit_number

size_t m_minimal_hit_number {1}

private

min. number of hits in ASIC for background check

Definition at line 76 of file AsicBackgroundLibraryCreator.h.

{1};

m_minimal_hits_on_track

size_t m_minimal_hits_on_track {40}

private

min. number of hits on the track

Definition at line 92 of file AsicBackgroundLibraryCreator.h.

{40};

m_n_hit

UChar_t m_n_hit {0}

private

For debugging, store also number of channels with hits.

Definition at line 109 of file AsicBackgroundLibraryCreator.h.

{0};

m_n_hit_track

UShort_t m_n_hit_track {0}

private

Number of hits on the track.

Definition at line 126 of file AsicBackgroundLibraryCreator.h.

{0};

m_recorder

std::unique_ptr<TrackingUtilities::Recorder> m_recorder

private

Recorder for the root output.

Definition at line 95 of file AsicBackgroundLibraryCreator.h.

m_subordinaryProcessingSignalListeners

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

bool m_terminated = false

privateinherited

Flag to keep track whether termination happened before.

Definition at line 55 of file ProcessingSignalListener.h.

m_use_axial_hits_only

bool m_use_axial_hits_only {false}

private

use axial layers only

Definition at line 85 of file AsicBackgroundLibraryCreator.h.

{false};

m_write_extra_vars

bool m_write_extra_vars {false}

private

extra vars to the library

Definition at line 88 of file AsicBackgroundLibraryCreator.h.

{false};

---

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

• tracking/trackFindingCDC/findlets/complete/include/AsicBackgroundLibraryCreator.h
• tracking/trackFindingCDC/findlets/complete/src/AsicBackgroundLibraryCreator.cc