AxialHitQuadTreeProcessor Class Reference

A QuadTreeProcessor for TrackHits. More...

#include <AxialHitQuadTreeProcessor.h>

Inheritance diagram for AxialHitQuadTreeProcessor:

Public Types
using	Item = QuadTreeItem< const CDCWireHit >
	The QuadTree will only see items of this type.
using	QuadTree = QuadTreeNode< long, float, Item >
	The used QuadTree.
using	XSpan = typename QuadTree::XSpan
	This pair describes the span in X for a node.
using	YSpan = typename QuadTree::YSpan
	This pair describes the span in Y for a node.
using	XYSpans = std::pair< XSpan, YSpan >
	This pair of spans describes the span of a node.
using	QuadTreeChildren = typename QuadTree::Children
	Alias for the QuadTree Children.
using	CandidateReceiver = std::function< void(const std::vector< const CDCWireHit * > &, QuadTree *)>
	This lambda function can be used for postprocessing.

Public Member Functions
	AxialHitQuadTreeProcessor (int lastLevel, int seedLevel, const XYSpans &ranges, PrecisionUtil::PrecisionFunction precisionFunction)
	Constructor.
	AxialHitQuadTreeProcessor (const Vector2D &localOrigin, const YSpan &curvSpan, const LookupTable< Vector2D > *cosSinLookupTable)
	Constructor for the quad tree processor used in the off-origin extension.
void	drawHits (std::vector< const CDCWireHit * > hits, unsigned int color=46) const
	Draw QuadTree node.
void	drawNode (QuadTree *node) const
	Draw QuadTree node.
void	clear ()
	Delete all the QuadTreeItems in the tree and clear the tree.
void	seed (const std::vector< const CDCWireHit * > &datas)
	Fill in the items in the given vector.
std::vector< const CDCWireHit * >	getAssignedItems ()
	Get items that have been assigned to the seed level The returned elements are unique even if items are assigned multiple times.
void	fill (const CandidateReceiver &candidateReceiver, int nHitsThreshold)
	Start filling the already created tree.
void	fill (const CandidateReceiver &candidateReceiver, int nHitsThreshold, float yLimit)
	Fill vector of QuadTree instances with hits.
virtual void	afterFillDebugHook (QuadTreeChildren &children)
	Override that function if you want to receive debug output whenever the children of a node are filled the first time Maybe you want to make some nice plots or statistics.
const std::map< std::pair< long, float >, std::vector< Item * > > &	getDebugInformation () const
	Return the debug information if collected.

Static Public Member Functions
static const LookupTable< Vector2D > &	getCosSinLookupTable ()
	Get the standard lookup table containing equally spaces unit vectors (cos, sin)
static std::vector< float >	createCurvBound (YSpan curvSpan, int lastLevel)
	Constructs an array with the curvature bounds as generated by the default bin divisions.

Protected Member Functions
bool	isLeaf (QuadTree *node) const final
	lastLevel depends on curvature of the track candidate
XYSpans	createChild (QuadTree *node, int i, int j) const final
	Return the new ranges.
bool	isInNode (QuadTree *node, const CDCWireHit *wireHit) const final
	Check whether hit belongs to the quadtree node:
bool	checkDerivative (QuadTree *node, const CDCWireHit *wireHit) const
	Check derivative of the sinogram.
bool	checkExtremum (QuadTree *node, const CDCWireHit *wireHit) const
	Checks whether extremum point is located whithin QuadTree node's ranges.
virtual XYSpans	createChild (QuadTree *node, int iX, int iY) const
	Implement that function if you want to provide a new processor.
virtual bool	isInNode (QuadTree *node, const CDCWireHit *item) const=0
	Implement that function if you want to provide a new processor.
virtual bool	isLeaf (QuadTree *node) const
	Function which checks if given node is leaf Implemented as virtual to keep possibility of changing lastLevel values depending on region is phase-space (i.e.
int	getLastLevel () const
	Return the parameter last level.

Protected Attributes
std::unique_ptr< QuadTree >	m_quadTree
	The quad tree we work with.
std::deque< Item >	m_items
	Storage space for the items that are referenced by the quad tree nodes.
std::vector< QuadTree * >	m_seededTrees
	Vector of QuadTrees QuadTree instances (which are filled in the vector) cover the whole Legendre phase-space; each instance is processes independently.

Private Member Functions
void	fillGivenTree (QuadTree *node, const CandidateReceiver &candidateReceiver, int nItemsThreshold, float yLimit)
	Internal function to do the real quad tree search: fill the nodes, check which of the n*m bins we need to process further and go one level deeper.
void	createChildren (QuadTree *node, QuadTreeChildren &m_children) const
	Creates the sub node of a given node.
void	fillChildren (QuadTree *node, const std::vector< Item * > &items)
	This function is called by fillGivenTree and fills the items into the corresponding children.
void	callResultFunction (QuadTree *node, const CandidateReceiver &candidateReceiver) const
	When a node is accepted as a result, we extract a vector with the items (back transformed to AData*) and pass it together with the result node to the candidate receiver function.

Private Attributes
const LookupTable< Vector2D > *	m_cosSinLookupTable
	Pinned lookup table for precompute cosine and sine values.
Vector2D	m_localOrigin
	Local origin on which the phase space coordinates are centered.
bool	m_twoSidedPhaseSpace
	Indicator whether the two sided phases space insertion check should be used This option should automatically split back to back tracks in the low curvature regions.
const double	c_curlCurv = 0.02
	The curvature above which the trajectory is considered a curler.
PrecisionUtil::PrecisionFunction	m_precisionFunction
	Lambda which holds resolution function for the quadtree.
int	m_lastLevel
	The last level to be filled.
int	m_seedLevel
	The first level to be filled, effectively skip forward to this higher granularity level.
bool	m_debugOutput
	A flag to control the creation of the debug output.
std::map< std::pair< long, float >, std::vector< Item * > >	m_debugOutputMap
	The calculated debug map.

Detailed Description

A QuadTreeProcessor for TrackHits.

Definition at line 26 of file AxialHitQuadTreeProcessor.h.

Member Typedef Documentation

CandidateReceiver

using CandidateReceiver = std::function<void(const std::vector<const CDCWireHit *>&, QuadTree*)>

inherited

This lambda function can be used for postprocessing.

Definition at line 59 of file QuadTreeProcessor.h.

Item

using Item = QuadTreeItem<const CDCWireHit >

inherited

The QuadTree will only see items of this type.

Definition at line 41 of file QuadTreeProcessor.h.

QuadTree

using QuadTree = QuadTreeNode<long , float , Item>

inherited

The used QuadTree.

Definition at line 44 of file QuadTreeProcessor.h.

QuadTreeChildren

using QuadTreeChildren = typename QuadTree::Children

inherited

Alias for the QuadTree Children.

Definition at line 56 of file QuadTreeProcessor.h.

XSpan

using XSpan = typename QuadTree::XSpan

inherited

This pair describes the span in X for a node.

Definition at line 47 of file QuadTreeProcessor.h.

XYSpans

using XYSpans = std::pair<XSpan, YSpan>

inherited

This pair of spans describes the span of a node.

Definition at line 53 of file QuadTreeProcessor.h.

YSpan

using YSpan = typename QuadTree::YSpan

inherited

This pair describes the span in Y for a node.

Definition at line 50 of file QuadTreeProcessor.h.

Constructor & Destructor Documentation

AxialHitQuadTreeProcessor() [1/2]

AxialHitQuadTreeProcessor	(	int	lastLevel,
		int	seedLevel,
		const XYSpans &	ranges,
		PrecisionUtil::PrecisionFunction	precisionFunction
	)

Constructor.

Definition at line 96 of file AxialHitQuadTreeProcessor.cc.

  : QuadTreeProcessor(lastLevel, seedLevel, ranges)
  , m_cosSinLookupTable(&getCosSinLookupTable())
  , m_localOrigin(0.0, 0.0)
  , m_precisionFunction(precisionFunction)
{
  m_twoSidedPhaseSpace = m_quadTree->getYMin() * m_quadTree->getYMax() < 0;
}

AxialHitQuadTreeProcessor() [2/2]

AxialHitQuadTreeProcessor	(	const Vector2D &	localOrigin,
		const YSpan &	curvSpan,
		const LookupTable< Vector2D > *	cosSinLookupTable
	)

Constructor for the quad tree processor used in the off-origin extension.

Currently only used in zero level mode to collect hits that are in a phase space part with respect to the given point.

Definition at line 108 of file AxialHitQuadTreeProcessor.cc.

  : QuadTreeProcessor(0, 0, { {0, cosSinLookupTable->getNPoints() - 1}, curvSpan})
, m_cosSinLookupTable(cosSinLookupTable)
, m_localOrigin(localOrigin)
{
  // Never use two sided mode in off origin extension
  m_twoSidedPhaseSpace = false;
}

Member Function Documentation

afterFillDebugHook()

virtual void afterFillDebugHook ( QuadTreeChildren &  children )

inlinevirtualinherited

Override that function if you want to receive debug output whenever the children of a node are filled the first time Maybe you want to make some nice plots or statistics.

Definition at line 356 of file QuadTreeProcessor.h.

      {
        if (not m_debugOutput) return;
        for (QuadTree& childNode : children) {
          if (childNode.getLevel() != getLastLevel()) continue; // Only write the lowest level
          //m_debugOutputMap[ {childNode.getXMean(), childNode.getYMean()}] = childNode.getItems();
        }
      }

callResultFunction()

void callResultFunction ( QuadTree *  node, const CandidateReceiver &  candidateReceiver  ) const

inlineprivateinherited

When a node is accepted as a result, we extract a vector with the items (back transformed to AData*) and pass it together with the result node to the candidate receiver function.

Definition at line 288 of file QuadTreeProcessor.h.

      {
        const std::vector<Item*>& foundItems = node->getItems();
        std::vector<AData*> candidate;
        candidate.reserve(foundItems.size());
 
        for (Item* item : foundItems) {
          item->setUsedFlag();
          candidate.push_back(item->getPointer());
        }
 
        candidateReceiver(candidate, node);
      }

checkDerivative()

bool checkDerivative ( QuadTree *  node, const CDCWireHit *  wireHit  ) const

protected

Check derivative of the sinogram.

Parameters

node	QuadTree node
wireHit	pointer to the hit to check

Returns

returns true in cases:

- positive derivative and no extremum in the node's ranges or

- extremum located in the node's ranges

returns false in other cases (namely negative derivative

Definition at line 261 of file AxialHitQuadTreeProcessor.cc.

{
  const Vector2D& pos2D = wireHit->getRefPos2D() - m_localOrigin;
 
  long thetaMin = node->getXMin();
  long thetaMax = node->getXMax();
 
  const Vector2D& thetaVecMin = m_cosSinLookupTable->at(thetaMin);
  const Vector2D& thetaVecMax = m_cosSinLookupTable->at(thetaMax);
 
  float rMinD = thetaVecMin.cross(pos2D);
  float rMaxD = thetaVecMax.cross(pos2D);
 
  // Does not really make sense...
  if ((rMinD > 0) && (rMaxD * rMinD >= 0)) return true;
  if ((rMaxD * rMinD < 0)) return true;
  return false;
}

checkExtremum()

bool checkExtremum ( QuadTree *  node, const CDCWireHit *  wireHit  ) const

protected

Checks whether extremum point is located whithin QuadTree node's ranges.

Parameters

node	QuadTree node
wireHit	hit to check

Returns

true or false

Definition at line 280 of file AxialHitQuadTreeProcessor.cc.

{
  const double& l = wireHit->getRefDriftLength();
  const Vector2D& pos2D = wireHit->getRefPos2D() - m_localOrigin;
  double r2 = pos2D.normSquared() - l * l;
 
  // get left and right borders of the node
  long thetaMin = node->getXMin();
  long thetaMax = node->getXMax();
 
  const Vector2D& thetaVecMin = m_cosSinLookupTable->at(thetaMin);
  const Vector2D& thetaVecMax = m_cosSinLookupTable->at(thetaMax);
 
  if (not pos2D.isBetween(thetaVecMin, thetaVecMax)) return false;
 
  // compute sinograms at the position
  double r = pos2D.norm();
  float rRight = r - l;
  float rLeft = r + l;
 
  // get top and bottom borders of the node
  float rMin = node->getYMin() * r2 / 2;
  float rMax = node->getYMax() * r2 / 2;
 
  bool crossesRight = (rMin - rRight) * (rMax - rRight) < 0;
  bool crossesLeft = (rMin - rLeft) * (rMax - rLeft) < 0;
  return crossesRight or crossesLeft;
}

clear()

void clear ( )

inlineinherited

Delete all the QuadTreeItems in the tree and clear the tree.

Definition at line 92 of file QuadTreeProcessor.h.

      {
        m_seededTrees.clear();
        m_quadTree->clearChildren();
        m_quadTree->clearItems();
        m_items.clear();
      }

createChild() [1/2]

AxialHitQuadTreeProcessor::XYSpans createChild ( QuadTree *  node, int  i, int  j  ) const

finalprotected

Return the new ranges.

We do not use the standard ranges for the lower levels.

Parameters

node	quadtree node
i	theta index of the child
j	rho index of the child

Returns

returns ranges of the (i;j) child

Definition at line 135 of file AxialHitQuadTreeProcessor.cc.

{
  const int nodeLevel = node->getLevel();
  const int lastLevel = getLastLevel();
  const float meanCurv = std::fabs(node->getYMax() + node->getYMin()) / 2;
 
  // Expand bins for all nodes 7 levels before the last level (for lastLevel = 12 starting at 6)
  // but only in a curvature region higher than 0.005. Lower than that use always standard.
  bool standardBinning = (nodeLevel <= lastLevel - 7) or (meanCurv <= 0.005);
 
  if (standardBinning) {
    float r1 = node->getYLowerBound(j);
    float r2 = node->getYUpperBound(j);
    long theta1 = node->getXLowerBound(i);
    long theta2 = node->getXUpperBound(i);
 
    // Standard bin division
    return XYSpans({theta1, theta2}, {r1, r2});
  }
 
  // Non-standard binning
  // For level 6 to 7 only expand 1 / 4, for higher levels expand  1 / 8.
  // (assuming last level == 12)
  if (nodeLevel < lastLevel - 5) {
    float r1 = node->getYLowerBound(j) - node->getYBinWidth(j) / 4.;
    float r2 = node->getYUpperBound(j) + node->getYBinWidth(j) / 4.;
 
    // long extension = pow(2, lastLevel - nodeLevel) / 4; is same as:
    long extension = pow(2, lastLevel - nodeLevel - 2);
 
    long theta1 = node->getXLowerBound(i) - extension;
    if (theta1 < 0) theta1 = 0;
 
    long theta2 = node->getXUpperBound(i) + extension;
    if (theta2 >= m_cosSinLookupTable->getNPoints()) {
      theta2 = m_cosSinLookupTable->getNPoints() - 1;
    }
 
    return XYSpans({theta1, theta2}, {r1, r2});
  } else {
    float r1 = node->getYLowerBound(j) - node->getYBinWidth(j) / 8.;
    float r2 = node->getYUpperBound(j) + node->getYBinWidth(j) / 8.;
 
    // long extension = pow(2, lastLevel - nodeLevel) / 8; is same as
    long extension = pow(2, lastLevel - nodeLevel - 3);
 
    long theta1 = node->getXLowerBound(i) - extension;
    if (theta1 < 0) theta1 = 0;
 
    long theta2 = node->getXUpperBound(i) + extension;
    if (theta2 >= m_cosSinLookupTable->getNPoints()) {
      theta2 = m_cosSinLookupTable->getNPoints() - 1;
    }
 
    return XYSpans({theta1, theta2}, {r1, r2});
  }
}

createChild() [2/2]

virtual XYSpans createChild ( QuadTree *  node, int  iX, int  iY  ) const

inlineprotectedvirtualinherited

Implement that function if you want to provide a new processor.

It decides which node-spans the n * m children of the node should have. It is called when creating the nodes. The two indices iX and iY tell you where the new node will be created (as node.children[iX][iY]). You can check some information on the level or the x- or y-values by using the methods implemented for node.

Returns

a XYSpan pair of a x- and a y-span that the new child should have. If you don nt want to provide custom spans, just return XYSpans(XSpan(node->getXBinBound(iX), node->getXBinBound(iX + 1)), YSpan(node->getYBinBound(iY), node->getYBinBound(iY + 1)));

Definition at line 311 of file QuadTreeProcessor.h.

      {
        AX xMin = node->getXLowerBound(iX);
        AX xMax = node->getXUpperBound(iX);
        AY yMin = node->getYLowerBound(iY);
        AY yMax = node->getYUpperBound(iY);
        return XYSpans({xMin, xMax}, {yMin, yMax});
      }

createChildren()

void createChildren ( QuadTree *  node, QuadTreeChildren &  m_children  ) const

inlineprivateinherited

Creates the sub node of a given node.

This function is called by fillGivenTree. To calculate the spans of the children nodes the user-defined function createChiildWithParent is used.

Definition at line 249 of file QuadTreeProcessor.h.

      {
        for (int i = 0; i < node->getXNbins(); ++i) {
          for (int j = 0; j < node->getYNbins(); ++j) {
            const XYSpans& xySpans = createChild(node, i, j);
            const XSpan& xSpan = xySpans.first;
            const YSpan& ySpan = xySpans.second;
            m_children.push_back(QuadTree(xSpan, ySpan, node->getLevel() + 1, node));
          }
        }
      }

createCurvBound()

std::vector< float > createCurvBound ( YSpan  curvSpan, int  lastLevel  )

static

Constructs an array with the curvature bounds as generated by the default bin divisions.

Definition at line 64 of file AxialHitQuadTreeProcessor.cc.

{
  std::vector<YSpan> spans{{curvSpan}};
 
  std::vector<YSpan> nextSpans;
  for (int level = 1; level <= lastLevel; ++level) {
    nextSpans.clear();
    for (const YSpan& span : spans) {
      nextSpans.push_back(splitCurvSpan(span, level, lastLevel, 0));
      nextSpans.push_back(splitCurvSpan(span, level, lastLevel, 1));
    }
    spans.swap(nextSpans);
  }
 
  std::vector<float> bounds;
  for (const YSpan& span : spans) {
    bounds.push_back(span[0]);
    bounds.push_back(span[1]);
  }
 
  assert(bounds.size() == std::pow(2, lastLevel));
  return bounds;
}

drawHits()

void drawHits	(	std::vector< const CDCWireHit * >	hits,
		unsigned int	color = 46
	)		const

Draw QuadTree node.

Definition at line 309 of file AxialHitQuadTreeProcessor.cc.

{
  static int nevent(0);
 
  TCanvas* canv = new TCanvas("canv", "legendre transform", 0, 0, 1200, 600);
  canv->cd(1);
  TGraph* dummyGraph = new TGraph();
  dummyGraph->SetPoint(1, -3.1415, 0);
  dummyGraph->SetPoint(2, 3.1415, 0);
  dummyGraph->Draw("AP");
  dummyGraph->GetXaxis()->SetTitle("#theta");
  dummyGraph->GetYaxis()->SetTitle("#rho");
  dummyGraph->GetXaxis()->SetRangeUser(-3.1415, 3.1415);
  dummyGraph->GetYaxis()->SetRangeUser(-0.02, 0.15);
 
  for (const CDCWireHit* wireHit : hits) {
    const double& l = wireHit->getRefDriftLength();
    const Vector2D& pos2D = wireHit->getRefPos2D() - m_localOrigin;
    double x = pos2D.x();
    double y = pos2D.y();
    double r2 = pos2D.normSquared() - l * l;
 
    TF1* concaveHitLegendre = new TF1("concaveHitLegendre", "2*([0]/[3])*cos(x) + 2*([1]/[3])*sin(x) + 2*([2]/[3])", -3.1415, 3.1415);
    TF1* convexHitLegendre = new TF1("convexHitLegendre", "2*([0]/[3])*cos(x) + 2*([1]/[3])*sin(x) - 2*([2]/[3])", -3.1415, 3.1415);
    concaveHitLegendre->SetLineWidth(1);
    convexHitLegendre->SetLineWidth(1);
    concaveHitLegendre->SetLineColor(color);
    convexHitLegendre->SetLineColor(color);
 
    concaveHitLegendre->SetParameters(x, y, l, r2);
    convexHitLegendre->SetParameters(x, y, l, r2);
    concaveHitLegendre->Draw("CSAME");
    convexHitLegendre->Draw("CSAME");
  }
//   canv->Print(Form("legendreHits_%i.root", nevent));
//   canv->Print(Form("legendreHits_%i.eps", nevent));
  canv->Print(Form("legendreHits_%i.png", nevent));
  delete canv;
 
  nevent++;
}

drawNode()

void drawNode

(

QuadTree *

node

)

const

Draw QuadTree node.

Definition at line 351 of file AxialHitQuadTreeProcessor.cc.

{
  std::vector<const CDCWireHit*> hits;
  for (Item* item : node->getItems()) {
    const CDCWireHit* wireHit = item->getPointer();
    hits.push_back(wireHit);
  }
  drawHits(hits);
}

fill() [1/2]

void fill ( const CandidateReceiver &  candidateReceiver, int  nHitsThreshold  )

inlineinherited

Start filling the already created tree.

Parameters

candidateReceiver	the lambda function to call after a node was selected
nHitsThreshold	the threshold on the number of items

Definition at line 168 of file QuadTreeProcessor.h.

      {
        fill(candidateReceiver, nHitsThreshold, std::numeric_limits<AY>::max());
      }

fill() [2/2]

void fill ( const CandidateReceiver &  candidateReceiver, int  nHitsThreshold, float  yLimit  )

inlineinherited

Fill vector of QuadTree instances with hits.

Parameters

candidateReceiver	the lambda function to call after a node was selected
nHitsThreshold	the threshold on the number of items
yLimit	the threshold in the rho (curvature) variable

Definition at line 179 of file QuadTreeProcessor.h.

      {
        std::vector<QuadTree*> quadTrees = m_seededTrees;
        std::sort(quadTrees.begin(), quadTrees.end(), [](QuadTree * quadTree1, QuadTree * quadTree2) {
          return quadTree1->getNItems() > quadTree2->getNItems();
        });
 
        for (QuadTree* tree : quadTrees) {
          erase_remove_if(tree->getItems(), [](Item * hit) { return hit->isUsed(); });
          fillGivenTree(tree, candidateReceiver, nHitsThreshold, yLimit);
        }
      }

fillChildren()

void fillChildren ( QuadTree *  node, const std::vector< Item * > &  items  )

inlineprivateinherited

This function is called by fillGivenTree and fills the items into the corresponding children.

For this the user-defined method isInNode is called.

Definition at line 265 of file QuadTreeProcessor.h.

      {
        const size_t neededSize = 2 * items.size();
        for (QuadTree& child : node->getChildren()) {
          child.reserveItems(neededSize);
        }
 
        for (Item* item : items) {
          if (item->isUsed()) continue;
 
          for (QuadTree& child : node->getChildren()) {
            if (isInNode(&child, item->getPointer())) {
              child.insertItem(item);
            }
          }
        }
        afterFillDebugHook(node->getChildren());
      }

fillGivenTree()

void fillGivenTree ( QuadTree *  node, const CandidateReceiver &  candidateReceiver, int  nItemsThreshold, float  yLimit  )

inlineprivateinherited

Internal function to do the real quad tree search: fill the nodes, check which of the n*m bins we need to process further and go one level deeper.

Definition at line 197 of file QuadTreeProcessor.h.

      {
        if (node->getNItems() < nItemsThreshold) {
          return;
        }
 
        if ((node->getYMin() > yLimit) or (-node->getYMax() > yLimit)) {
          return;
        }
 
        if (isLeaf(node)) {
          callResultFunction(node, candidateReceiver);
          return;
        }
 
        if (node->getChildren().empty()) {
          this->createChildren(node, node->getChildren());
        }
 
        if (!node->checkFilled()) {
          fillChildren(node, node->getItems());
          node->setFilled();
        }
 
        std::vector<QuadTree*> children;
        for (QuadTree& child : node->getChildren()) {
          children.push_back(&child);
        }
        const auto compareNItems = [](const QuadTree * lhs, const QuadTree * rhs) {
          return lhs->getNItems() < rhs->getNItems();
        };
 
        // Explicitly count down the children
        const int nChildren = children.size();
        for (int iChild = 0; iChild < nChildren; ++iChild) {
          auto itHeaviestChild = std::max_element(children.begin(), children.end(), compareNItems);
          QuadTree* heaviestChild = *itHeaviestChild;
          children.erase(itHeaviestChild);
          // After we have processed some children we need to get rid of the already used hits in all the children,
          // because this can change the number of items drastically
          erase_remove_if(heaviestChild->getItems(), [&](Item * hit) { return hit->isUsed(); });
          this->fillGivenTree(heaviestChild, candidateReceiver, nItemsThreshold, yLimit);
        }
      }

getAssignedItems()

std::vector< const CDCWireHit * > getAssignedItems ( )

inlineinherited

Get items that have been assigned to the seed level The returned elements are unique even if items are assigned multiple times.

Definition at line 149 of file QuadTreeProcessor.h.

      {
        std::vector<const CDCWireHit*> result;
        for (QuadTree* seededTree : m_seededTrees) {
          for (Item* item : seededTree->getItems()) {
            result.push_back(item->getPointer());
          }
        }
        std::sort(result.begin(), result.end());
        result.erase(std::unique(result.begin(), result.end()), result.end());
        return result;
      }

getCosSinLookupTable()

const LookupTable< Vector2D > & getCosSinLookupTable ( )

static

Get the standard lookup table containing equally spaces unit vectors (cos, sin)

It contains 2**16 + 1 sampling points between -pi and pi.

Definition at line 88 of file AxialHitQuadTreeProcessor.cc.

{
  static const int maxLevel = PrecisionUtil::getLookupGridLevel();
  static const int nBins = std::pow(2, maxLevel);
  static LookupTable<Vector2D> trigonometricLookUpTable(&Vector2D::Phi, nBins, -M_PI, M_PI);
  return trigonometricLookUpTable;
}

getDebugInformation()

const std::map< std::pair< long , float >, std::vector< Item * > > & getDebugInformation ( ) const

inlineinherited

Return the debug information if collected.

Definition at line 368 of file QuadTreeProcessor.h.

      {
        return m_debugOutputMap;
      }

getLastLevel()

int getLastLevel ( ) const

inlineprotectedinherited

Return the parameter last level.

Definition at line 346 of file QuadTreeProcessor.h.

      {
        return m_lastLevel;
      }

isInNode() [1/2]

virtual bool isInNode ( QuadTree *  node, const CDCWireHit *  item  ) const

protectedpure virtualinherited

Implement that function if you want to provide a new processor.

It is called when filling the quad tree after creation. For every item in a node and every child node this function gets called and should decide, if the item should go into this child node or not.

Parameters

node	child node
item	item to be filled into the child node or not

Returns

true if this item belongs into this node.

isInNode() [2/2]

bool isInNode ( QuadTree *  node, const CDCWireHit *  wireHit  ) const

finalprotected

Check whether hit belongs to the quadtree node:

Parameters

node	quadtree node
wireHit	hit being checked

Returns

returns true if sinogram of the hit crosses (geometrically) borders of the node

Definition at line 193 of file AxialHitQuadTreeProcessor.cc.

{
  // Check whether the hit lies in the forward direction
  if (node->getLevel() <= 4 and m_twoSidedPhaseSpace and node->getYMin() > -c_curlCurv and
      node->getYMax() < c_curlCurv) {
    if (not checkDerivative(node, wireHit)) return false;
  }
 
  const double& l = wireHit->getRefDriftLength();
  const Vector2D& pos2D = wireHit->getRefPos2D() - m_localOrigin;
  double r2 = pos2D.normSquared() - l * l;
 
  using Quadlet = std::array<std::array<float, 2>, 2>;
  Quadlet distRight{};
  Quadlet distLeft{};
 
  // get top and bottom borders of the node
  float rMin = node->getYMin() * r2 / 2;
  float rMax = node->getYMax() * r2 / 2;
 
  // get left and right borders of the node
  long thetaMin = node->getXMin();
  long thetaMax = node->getXMax();
 
  const Vector2D& thetaVecMin = m_cosSinLookupTable->at(thetaMin);
  const Vector2D& thetaVecMax = m_cosSinLookupTable->at(thetaMax);
 
  float rHitMin = thetaVecMin.dot(pos2D);
  float rHitMax = thetaVecMax.dot(pos2D);
 
  // compute sinograms at the left and right borders of the node
  float rHitMinRight = rHitMin - l;
  float rHitMaxRight = rHitMax - l;
 
  float rHitMinLeft = rHitMin + l;
  float rHitMaxLeft = rHitMax + l;
 
  // Compute distance from the sinograms to bottom and top borders of the node
  distRight[0][0] = rMin - rHitMinRight;
  distRight[0][1] = rMin - rHitMaxRight;
  distRight[1][0] = rMax - rHitMinRight;
  distRight[1][1] = rMax - rHitMaxRight;
 
  distLeft[0][0] = rMin - rHitMinLeft;
  distLeft[0][1] = rMin - rHitMaxLeft;
  distLeft[1][0] = rMax - rHitMinLeft;
  distLeft[1][1] = rMax - rHitMaxLeft;
 
  // Compare distance signes from sinograms to the node
  // Check right
  if (not sameSign(distRight[0][0], distRight[0][1], distRight[1][0], distRight[1][1])) {
    return true;
  }
 
  // Check left
  if (not sameSign(distLeft[0][0], distLeft[0][1], distLeft[1][0], distLeft[1][1])) {
    return true;
  }
 
  // Check the extremum
  float rHitMinExtr = thetaVecMin.cross(pos2D);
  float rHitMaxExtr = thetaVecMax.cross(pos2D);
  if (rHitMinExtr * rHitMaxExtr < 0.) return checkExtremum(node, wireHit);
 
  // Not contained
  return false;
}

isLeaf() [1/2]

virtual bool isLeaf ( QuadTree *  node ) const

inlineprotectedvirtualinherited

Function which checks if given node is leaf Implemented as virtual to keep possibility of changing lastLevel values depending on region is phase-space (i.e.

setting lastLevel as a function of Y-variable)

Definition at line 334 of file QuadTreeProcessor.h.

      {
        if (node->getLevel() >= m_lastLevel) {
          return true;
        } else {
          return false;
        }
      }

isLeaf() [2/2]

bool isLeaf ( QuadTree *  node ) const

finalprotected

lastLevel depends on curvature of the track candidate

Definition at line 120 of file AxialHitQuadTreeProcessor.cc.

{
  if (node->getLevel() <= 6) return false;
  if (node->getLevel() >= getLastLevel()) return true;
 
  const double nodeResolution = fabs(node->getYMin() - node->getYMax());
  const double meanCurv = (node->getYMax() + node->getYMin()) / 2;
 
  const double resolution = m_precisionFunction(meanCurv);
  if (resolution >= nodeResolution) return true;
 
  return false;
}

seed()

void seed ( const std::vector< const CDCWireHit * > &  datas )

inlineinherited

Fill in the items in the given vector.

They are transformed to QuadTreeItems internally.

Definition at line 103 of file QuadTreeProcessor.h.

      {
        // Create the items
        for (AData* data : datas) {
          m_items.emplace_back(data);
        }
 
        // Creating the seed level
        long nSeedBins = pow(2, m_seedLevel);
        m_seededTrees.reserve(nSeedBins * nSeedBins);
 
        // Expand the first levels to the seed sectors
        m_seededTrees.push_back(m_quadTree.get());
        std::vector<QuadTree*> nextSeededTrees;
 
        for (int level = 0; level < m_seedLevel; ++level) {
          for (QuadTree* node : m_seededTrees) {
            if (node->getChildren().empty()) {
              this->createChildren(node, node->getChildren());
            }
            for (QuadTree& child :  node->getChildren()) {
              nextSeededTrees.push_back(&child);
            }
          }
          std::swap(nextSeededTrees, m_seededTrees);
          nextSeededTrees.clear();
        }
 
        // Fill the seed level with the items
        for (QuadTree* seededTree : m_seededTrees) {
          seededTree->reserveItems(m_items.size());
 
          for (Item& item : m_items) {
            if (item.isUsed()) continue;
            if (isInNode(seededTree, item.getPointer())) {
              seededTree->insertItem(&item);
            }
          }
        }
      }

Member Data Documentation

c_curlCurv

const double c_curlCurv = 0.02

private

The curvature above which the trajectory is considered a curler.

Definition at line 120 of file AxialHitQuadTreeProcessor.h.

m_cosSinLookupTable

const LookupTable<Vector2D>* m_cosSinLookupTable

private

Pinned lookup table for precompute cosine and sine values.

Definition at line 108 of file AxialHitQuadTreeProcessor.h.

m_debugOutput

bool m_debugOutput

privateinherited

A flag to control the creation of the debug output.

Definition at line 395 of file QuadTreeProcessor.h.

m_debugOutputMap

std::map<std::pair<long , float >, std::vector<Item*> > m_debugOutputMap

privateinherited

The calculated debug map.

Definition at line 398 of file QuadTreeProcessor.h.

m_items

std::deque<Item> m_items

protectedinherited

Storage space for the items that are referenced by the quad tree nodes.

Definition at line 378 of file QuadTreeProcessor.h.

m_lastLevel

int m_lastLevel

privateinherited

The last level to be filled.

Definition at line 389 of file QuadTreeProcessor.h.

m_localOrigin

Vector2D m_localOrigin

private

Local origin on which the phase space coordinates are centered.

Definition at line 111 of file AxialHitQuadTreeProcessor.h.

m_precisionFunction

PrecisionUtil::PrecisionFunction m_precisionFunction

private

Lambda which holds resolution function for the quadtree.

Definition at line 123 of file AxialHitQuadTreeProcessor.h.

m_quadTree

std::unique_ptr<QuadTree> m_quadTree

protectedinherited

The quad tree we work with.

Definition at line 375 of file QuadTreeProcessor.h.

m_seededTrees

std::vector<QuadTree*> m_seededTrees

protectedinherited

Vector of QuadTrees QuadTree instances (which are filled in the vector) cover the whole Legendre phase-space; each instance is processes independently.

Definition at line 385 of file QuadTreeProcessor.h.

m_seedLevel

int m_seedLevel

privateinherited

The first level to be filled, effectively skip forward to this higher granularity level.

Definition at line 392 of file QuadTreeProcessor.h.

m_twoSidedPhaseSpace

bool m_twoSidedPhaseSpace

private

Indicator whether the two sided phases space insertion check should be used This option should automatically split back to back tracks in the low curvature regions.

Definition at line 117 of file AxialHitQuadTreeProcessor.h.

---

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

• tracking/trackFindingCDC/legendre/quadtree/include/AxialHitQuadTreeProcessor.h
• tracking/trackFindingCDC/legendre/quadtree/src/AxialHitQuadTreeProcessor.cc