Findlet for clustering DATCONSVDDigits and creating SVDClusters that are used for tracking in DATCON. More...

#include <DATCONSVDClusterizer.h>

Inheritance diagram for DATCONSVDClusterizer:

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
	DATCONSVDClusterizer ()
	Cluster SVD strips.

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	apply (const std::vector< DATCONSVDDigit > &digits, std::vector< SVDCluster > &clusters) override
	Load in the DATCONSVDDigits and create SVDClusters from them.

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	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	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 = TrackFindingCDC::Findlet< const DATCONSVDDigit, SVDCluster >
	Parent class.

typedef std::map< int, float >	SimpleSVDNoiseMap
	Simple representation of a SVD Noise Map.

Private Member Functions
void	fillDATCONSVDNoiseMap ()
	fill the noise map to be used for SNR cuts

float	calculateSNR (DATCONSVDDigit digit)
	calculate the SNR of a DATCONSVDDigit (= one strip) in a simplified way

void	saveCluster (DATCONSVDClusterCandidate &clusterCand, std::vector< SVDCluster > &clusters)
	save the current cluster candidate as a SVDCluster

Private Attributes
SVDNoiseCalibrations	m_NoiseCal
	SVD Noise payload.

SimpleSVDNoiseMap	m_svdNoiseMap
	Simple noise map for u-strips*‍/.

std::string	m_param_noiseMapfileName = "noiseMap.txt"
	File name for a file containing the noise of the strips for export to FPGA.

bool	m_param_writeNoiseMapsToFile = false
	Write the noise map to file m_param_noiseMapfileName for export to FPGA?

bool	m_param_isU = true
	Is this the finldlet for u-side or for v-side?

bool	m_param_saveClusterToDataStore = false
	Save SVDCluster to DataStore for analysis?

std::string	m_param_storeSVDClustersName = "DATCONSVDClusters"
	SVDClusters StoreArray name.

StoreArray< SVDCluster >	m_storeSVDClusters
	StoreArray to save the clusters to.

unsigned short	m_param_maxiClusterSize = 20
	maximum cluster size

float	m_param_noiseCut = 4
	Value above which u-strips are considered noisy, all other u-strips will get assigned a standard noise value of m_noiseCut.

float	m_param_requiredSNRstrip = 5
	Require a SNR for a u-strip signal to be valid.

float	m_param_requiredSNRcluster = 5
	Require a SNR for at least one strip in the u-cluster to make the cluster valid.

const VXD::GeoCache &	m_geoCache = VXD::GeoCache::getInstance()
	instance of GeoCache to avoid creating it again for every cluster

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

Findlet for clustering DATCONSVDDigits and creating SVDClusters that are used for tracking in DATCON.

This finldet only clusters strips on one side. The created SVDClusters can be stored in the DataStore by setting m_param_saveClusterToDataStore to true.

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

◆ SimpleSVDNoiseMap

typedef std::map<int, float> SimpleSVDNoiseMap

private

Simple representation of a SVD Noise Map.

Definition at line 40 of file DATCONSVDClusterizer.h.

◆ Super

using Super = TrackFindingCDC::Findlet<const DATCONSVDDigit, SVDCluster>

private

Parent class.

Definition at line 37 of file DATCONSVDClusterizer.h.

◆ ToVector

using ToVector = typename ToVectorImpl<T>::Type

protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

Constructor & Destructor Documentation

◆ DATCONSVDClusterizer()

DATCONSVDClusterizer ( )

Cluster SVD strips.

Definition at line 22 of file DATCONSVDClusterizer.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	(	const std::vector< DATCONSVDDigit > &	digits,
		std::vector< SVDCluster > &	clusters
	)

override

Load in the DATCONSVDDigits and create SVDClusters from them.

Definition at line 75 of file DATCONSVDClusterizer.cc.

{
  if (digits.size() == 0) return;
 
  DATCONSVDClusterCandidate clusterCand;
 
  // create a dummy cluster just to start
  clusterCand.vxdID = digits.at(0).getSensorID();
 
  for (auto& digit : digits) {
 
    float stripSNR = calculateSNR(digit);
    if (stripSNR < m_param_requiredSNRstrip) {
      continue;
    }
 
    //retrieve the VxdID, sensor and cellID of the current DATCONSVDDigit
    VxdID thisSensorID = digit.getSensorID();
    unsigned short thisCellID = digit.getCellID();
    unsigned short thisCharge = digit.getMaxSampleCharge();
 
    //try to add the strip to the existing cluster
    if (! clusterCand.add(thisSensorID, thisCharge, thisCellID, stripSNR, m_param_maxiClusterSize)) {
      //if the strip is not added, write the cluster, if present and good:
      if (clusterCand.strips.size() > 0) {
        saveCluster(clusterCand, clusters);
      }
 
      // start the next cluster
      clusterCand.strips.clear();
      clusterCand.charges.clear();
      clusterCand.vxdID = thisSensorID;
      clusterCand.strips.emplace_back(thisCellID);
      clusterCand.charges.emplace_back(thisCharge);
      clusterCand.maxSNRinClusterCandidate = stripSNR;
    }
  }
 
  //write the last cluster, if good
  if (clusterCand.strips.size() > 0) {
    saveCluster(clusterCand, clusters);
  }
 
  if (m_param_saveClusterToDataStore) {
    for (const auto& cluster : clusters) {
      m_storeSVDClusters.appendNew(cluster);
    }
  }
 
}

◆ beginEvent()

void beginEvent ( )

overridevirtualinherited

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

Reimplemented from ProcessingSignalListener.

Definition at line 31 of file CompositeProcessingSignalListener.cc.

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

◆ beginRun()

void beginRun ( )

overridevirtual

Begin Run.

Reimplemented from ProcessingSignalListener.

Definition at line 60 of file DATCONSVDClusterizer.cc.

{
  m_svdNoiseMap.clear();
  fillDATCONSVDNoiseMap();
}

◆ calculateSNR()

float calculateSNR ( DATCONSVDDigit digit )

private

calculate the SNR of a DATCONSVDDigit (= one strip) in a simplified way

Parameters

digit DATCONSVDDigit for which the SNR is calculated

Returns: SNR of the digit

Definition at line 149 of file DATCONSVDClusterizer.cc.

{
  unsigned short maxSampleIndex = digit.getMaxSampleIndex();
  const DATCONSVDDigit::APVRawSamples& sample = digit.getRawSamples();
  unsigned short stripID = digit.getCellID();
  VxdID sensorID = digit.getSensorID();
  int simpleVXDID = 131072 * (sensorID.getLayerNumber() - 3) + 8192 * (sensorID.getLadderNumber() - 1)
                    + 1024 * (sensorID.getSensorNumber() - 1) + stripID;
 
  // set noise value to default value and only use actual noise if it is too large (> m_param_noiseCut)
  float stripNoise = m_param_noiseCut;
  if (m_svdNoiseMap.find(simpleVXDID) != m_svdNoiseMap.end()) {
    stripNoise = m_svdNoiseMap.at(simpleVXDID);
  }
 
  float currentSNR = (float)sample[maxSampleIndex] / stripNoise;
  return currentSNR;
}

◆ 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< const DATCONSVDDigit, SVDCluster >.

Definition at line 26 of file DATCONSVDClusterizer.cc.

{
  Super::exposeParameters(moduleParamList, prefix);
 
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "noiseMap"), m_param_noiseMapfileName,
                                "Name of the text file containing strip noise information.", m_param_noiseMapfileName);
 
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "writeNoiseMapsToFile"), m_param_writeNoiseMapsToFile,
                                "Write noise information to text file?", m_param_writeNoiseMapsToFile);
 
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "maximumClusterSize"), m_param_maxiClusterSize,
                                "Maximum SVD cluster size for this side. Data type: unsigned short", m_param_maxiClusterSize);
 
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "noiseCut"), m_param_noiseCut,
                                "Cut for using default noise (noise < this value), or actual noise (noise > this value).",
                                m_param_noiseCut);
 
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "requiredSNRstrip"),
                                m_param_requiredSNRstrip, "Required SNR per strip.", m_param_requiredSNRstrip);
 
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "requiredSNRcluster"),
                                m_param_requiredSNRcluster, "Required SNR for the cluster.", m_param_requiredSNRcluster);
 
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "isUClusterizer"),
                                m_param_isU, "Is this u or v side?", m_param_isU);
 
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "saveClusterToDataStore"),
                                m_param_saveClusterToDataStore, "Save SVDClusters for analysis?", m_param_saveClusterToDataStore);
 
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "storeSVDClustersName"),
                                m_param_storeSVDClustersName, "Name of the SVDClusters StoreArray", m_param_storeSVDClustersName);
 
}

◆ fillDATCONSVDNoiseMap()

void fillDATCONSVDNoiseMap ( )

private

fill the noise map to be used for SNR cuts

Definition at line 169 of file DATCONSVDClusterizer.cc.

{
  //call for a geometry instance
  VXD::GeoCache& aGeometry = VXD::GeoCache::getInstance();
  std::set<Belle2::VxdID> svdLayers = aGeometry.getLayers(VXD::SensorInfoBase::SVD);
  std::set<Belle2::VxdID>::iterator itSvdLayers = svdLayers.begin();
 
  std::ofstream noiseMap;
  if (m_param_writeNoiseMapsToFile) {
    noiseMap.open(m_param_noiseMapfileName, std::ios::trunc);
  }
 
  while (itSvdLayers != svdLayers.end()) { //loop on Layers
 
    std::set<Belle2::VxdID> svdLadders = aGeometry.getLadders(*itSvdLayers);
    std::set<Belle2::VxdID>::iterator itSvdLadders = svdLadders.begin();
 
    while (itSvdLadders != svdLadders.end()) { //loop on Ladders
 
      std::set<Belle2::VxdID> svdSensors = aGeometry.getSensors(*itSvdLadders);
      std::set<Belle2::VxdID>::iterator itSvdSensors = svdSensors.begin();
      B2DEBUG(29, "    svd sensor info " << * (svdSensors.begin()));
 
      while (itSvdSensors != svdSensors.end()) { //loop on sensors
        B2DEBUG(29, "    svd sensor info " << *itSvdSensors);
 
        int layer = itSvdSensors->getLayerNumber();
        int ladder =  itSvdSensors->getLadderNumber();
        int sensor = itSvdSensors->getSensorNumber();
        Belle2::VxdID theVxdID(layer, ladder, sensor);
        const SVD::SensorInfo* currentSensorInfo = dynamic_cast<const SVD::SensorInfo*>(&VXD::GeoCache::getInstance().getSensorInfo(
                                                     theVxdID));
 
        int simpleVXDID = 131072 * (layer - 3) + 8192 * (ladder - 1) + 1024 * (sensor - 1);
 
        int Ncells = m_param_isU ? currentSensorInfo->getUCells() : currentSensorInfo->getVCells();
 
        for (int strip = 0; strip < Ncells; strip++) {
 
          float noise = -1;
          if (m_NoiseCal.isValid()) {
            noise = m_NoiseCal.getNoise(theVxdID, m_param_isU, strip);
          }
 
          if (noise > m_param_noiseCut) {
            m_svdNoiseMap.insert(std::make_pair(simpleVXDID + strip, noise));
            if (m_param_writeNoiseMapsToFile) {
              noiseMap << 4096 * (layer - 3) + 16 * (ladder - 1) + (sensor - 1) << " " << strip << " " << noise << std::endl;
            }
          }
        }
        ++itSvdSensors;
      }
      ++itSvdLadders;
    }
    ++itSvdLayers;
  }
  if (m_param_writeNoiseMapsToFile) {
    noiseMap.close();
  }
 
}

◆ getDescription()

virtual std::string getDescription ( )

inlinevirtualinherited

Brief description of the purpose of the concrete findlet.

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

Definition at line 66 of file DATCONSVDClusterizer.cc.

{
  Super::initialize();
 
  if (m_param_saveClusterToDataStore) {
    m_storeSVDClusters.registerInDataStore(m_param_storeSVDClustersName);
  }
}

◆ saveCluster()

void saveCluster	(	DATCONSVDClusterCandidate &	clusterCand,
		std::vector< SVDCluster > &	clusters
	)

private

save the current cluster candidate as a SVDCluster

Parameters

clusterCand	cluster candidate to be stored
clusters	vector containing all the finalized clusters

Definition at line 127 of file DATCONSVDClusterizer.cc.

{
  const VXD::SensorInfoBase& info = m_geoCache.getSensorInfo(clusterCand.vxdID);
  double pitch = m_param_isU ? info.getUPitch() : info.getVPitch();
  unsigned short numberofStrips = m_param_isU ? info.getUCells() : info.getVCells();
 
  clusterCand.finalizeCluster(pitch, numberofStrips);
  if (clusterCand.maxSNRinClusterCandidate >= m_param_requiredSNRcluster) {
 
    double clusterPositionError = pitch;
    if (clusterCand.strips.size() == 1) {
      clusterPositionError = pitch / sqrt(12.);
    } else if (clusterCand.strips.size() == 2) {
      clusterPositionError = pitch / 2.;
    }
 
    clusters.emplace_back(SVDCluster(clusterCand.vxdID, m_param_isU, clusterCand.clusterPosition, clusterPositionError,
                                     0.0, 0.0, clusterCand.charge, clusterCand.seedCharge, clusterCand.strips.size(), 0.0, 0.0));
  }
}

◆ 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_geoCache

const VXD::GeoCache& m_geoCache = VXD::GeoCache::getInstance()

private

instance of GeoCache to avoid creating it again for every cluster

Definition at line 103 of file DATCONSVDClusterizer.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_NoiseCal

SVDNoiseCalibrations m_NoiseCal

private

SVD Noise payload.

Definition at line 73 of file DATCONSVDClusterizer.h.

◆ m_param_isU

bool m_param_isU = true

private

Is this the finldlet for u-side or for v-side?

Definition at line 84 of file DATCONSVDClusterizer.h.

◆ m_param_maxiClusterSize

unsigned short m_param_maxiClusterSize = 20

private

maximum cluster size

Definition at line 94 of file DATCONSVDClusterizer.h.

◆ m_param_noiseCut

float m_param_noiseCut = 4

private

Value above which u-strips are considered noisy, all other u-strips will get assigned a standard noise value of m_noiseCut.

Definition at line 96 of file DATCONSVDClusterizer.h.

◆ m_param_noiseMapfileName

std::string m_param_noiseMapfileName = "noiseMap.txt"

private

File name for a file containing the noise of the strips for export to FPGA.

Definition at line 80 of file DATCONSVDClusterizer.h.

◆ m_param_requiredSNRcluster

float m_param_requiredSNRcluster = 5

private

Require a SNR for at least one strip in the u-cluster to make the cluster valid.

Definition at line 100 of file DATCONSVDClusterizer.h.

◆ m_param_requiredSNRstrip

float m_param_requiredSNRstrip = 5

private

Require a SNR for a u-strip signal to be valid.

Definition at line 98 of file DATCONSVDClusterizer.h.

◆ m_param_saveClusterToDataStore

bool m_param_saveClusterToDataStore = false

private

Save SVDCluster to DataStore for analysis?

Definition at line 87 of file DATCONSVDClusterizer.h.

◆ m_param_storeSVDClustersName

std::string m_param_storeSVDClustersName = "DATCONSVDClusters"

private

SVDClusters StoreArray name.

Definition at line 89 of file DATCONSVDClusterizer.h.

◆ m_param_writeNoiseMapsToFile

bool m_param_writeNoiseMapsToFile = false

private

Write the noise map to file m_param_noiseMapfileName for export to FPGA?

Definition at line 82 of file DATCONSVDClusterizer.h.

◆ m_storeSVDClusters

StoreArray<SVDCluster> m_storeSVDClusters

private

StoreArray to save the clusters to.

Definition at line 91 of file DATCONSVDClusterizer.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_svdNoiseMap

SimpleSVDNoiseMap m_svdNoiseMap

private

Simple noise map for u-strips*‍/.

Definition at line 77 of file DATCONSVDClusterizer.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/datcon/findlets/include/DATCONSVDClusterizer.h
tracking/datcon/findlets/src/DATCONSVDClusterizer.cc

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ IOTypes

◆ IOVectors

◆ SimpleSVDNoiseMap

◆ Super

◆ ToVector

Constructor & Destructor Documentation

◆ DATCONSVDClusterizer()

Member Function Documentation

◆ addProcessingSignalListener()

◆ apply()

◆ beginEvent()

◆ beginRun()

◆ calculateSNR()

◆ endRun()

◆ exposeParameters()

◆ fillDATCONSVDNoiseMap()

◆ getDescription()

◆ getNProcessingSignalListener()

◆ initialize()

◆ saveCluster()

◆ terminate()

Member Data Documentation

◆ m_geoCache

◆ m_initialized

◆ m_initializedAs

◆ m_NoiseCal

◆ m_param_isU

◆ m_param_maxiClusterSize

◆ m_param_noiseCut

◆ m_param_noiseMapfileName

◆ m_param_requiredSNRcluster

◆ m_param_requiredSNRstrip

◆ m_param_saveClusterToDataStore

◆ m_param_storeSVDClustersName

◆ m_param_writeNoiseMapsToFile

◆ m_storeSVDClusters

◆ m_subordinaryProcessingSignalListeners

◆ m_svdNoiseMap

◆ m_terminated