EventDataPlotter Class Reference

A class that can plot event related data types. More...

#include <EventDataPlotter.h>

Public Types
using	AttributeMap = PrimitivePlotter::AttributeMap
	Forward the Attribute map from the primitive plotter.

Public Member Functions
	EventDataPlotter (bool animate=false, bool forwardFade=false)
	Default constructor for ROOT compatibility. Uses an SVGPrimitivePlotter as backend.
	EventDataPlotter (std::unique_ptr< PrimitivePlotter > ptrPrimitivePlotter, bool animate=false, bool forwardFade=false)
	Constructor taking the specific PrimitivePlotter instance as backend.
	EventDataPlotter (const EventDataPlotter &eventDataPlotter)
	Copy constructor.
const std::string	save (const std::string &fileName)
	Saves the current plot stead to a file.
void	clear ()
	Clears all drawn elements from the plotter.
BoundingBox	getBoundingBox () const
	Getter for the current bounding box.
void	setBoundingBox (const BoundingBox &boundingBox)
	Setter for the bounding box of all drawn objects.
float	getCanvasWidth () const
	Getter for the canvas width in pixels.
float	getCanvasHeight () const
	Getter for the canvas height in pixels.
void	setCanvasWidth (float width)
	Setter for the canvas width in pixels.
void	setCanvasHeight (float height)
	Setter for the canvas height in pixels The canvas height denotes the size of the image being produced.
void	startGroup (const AttributeMap &attributeMap=AttributeMap())
	Indicates the start of a group of drawn elements.
void	endGroup ()
	Indicates the end of a group of drawn elements.
std::string	getAnimationTimeFromNanoSeconds (float nanoseconds)
	Converts a time given in nanoseconds to a time string of the from "%fs".
void	drawInteractionPoint ()
	Marks the position of the interaction point with a filled circle.
void	drawInnerCDCWall (const AttributeMap &attributeMap=AttributeMap())
	Draw the inner wall of the CDC.
void	drawOuterCDCWall (const AttributeMap &attributeMap=AttributeMap())
	Draw the outer wall of the CDC.
void	drawSuperLayerBoundaries (const AttributeMap &attributeMap=AttributeMap())
	Draw the super layer bounds of the CDC.
void	drawLine (float startX, float startY, float endX, float endY, const AttributeMap &attributeMap=AttributeMap())
	Draws a straight Line.
void	draw (const TrackingUtilities::Circle2D &circle, AttributeMap attributeMap=AttributeMap())
	Draws a filled circle.
void	draw (const CDC::CDCWire &wire, const AttributeMap &attributeMap=AttributeMap())
	Draws the CDCWire as a small circle at the reference position.
void	draw (const CDC::CDCWireSuperLayer &wireSuperLayer, const AttributeMap &attributeMap=AttributeMap())
	Draws the inner and the outer bound of the super layer.
void	draw (const CDC::CDCWireTopology &wireTopology, AttributeMap attributeMap=AttributeMap())
	Draws the all wires in the CDC.
void	draw (const CDCSimHit &simHit, const AttributeMap &attributeMap=AttributeMap())
	Draws the CDCSimHit as a momentum arrow starting at the track position with a length proportional to its momentum.
void	draw (const CDCHit &hit, const AttributeMap &attributeMap=AttributeMap())
	Draws the CDCHit as the wire position and its drift circle at the wire reference position.
void	draw (const TrackingUtilities::CDCWireHit &wireHit, const AttributeMap &attributeMap=AttributeMap())
	Draws the CDCWireHit as the wire position and its drift circle at the wire reference position.
void	draw (const TrackingUtilities::CDCRecoHit2D &recoHit2D, const AttributeMap &attributeMap=AttributeMap())
	Draws the TrackingUtilities::CDCRecoHit2D as a drift circle at the two dimensional reference wire position and a point at the reconstructed position""".
void	draw (const TrackingUtilities::CDCRecoHit3D &recoHit3D, const AttributeMap &attributeMap=AttributeMap())
	Draws the CDCRecoHit3D as a drift circle at the two dimensional reference wire position and a point at the reconstructed position""".
void	draw (const TrackingUtilities::CDCTangent &tangent, const AttributeMap &attributeMap=AttributeMap())
	Draws the CDCRecoHit3D as a drift circle at the two dimensional reference wire position and a point at the reconstructed position""".
void	draw (const TrackingUtilities::CDCTrajectory2D &trajectory2D, AttributeMap attributeMap=AttributeMap())
	Draws the CDCTrajectory from the start point until it first exits the CDC.
void	draw (const TrackingUtilities::CDCWireHitCluster &wireHitCluster, const AttributeMap &attributeMap=AttributeMap())
	Draws all CDCWireHits of the cluster.
void	draw (const TrackingUtilities::CDCSegment2D &segment2D, const AttributeMap &attributeMap=AttributeMap())
	Draws all CDCRecoHits2D of the segment.
void	draw (const TrackingUtilities::CDCSegment3D &segment3D, const AttributeMap &attributeMap=AttributeMap())
	Draws all CDCRecoHits3D of the segment.
void	draw (const TrackingUtilities::CDCAxialSegmentPair &axialSegmentPair, const AttributeMap &attributeMap=AttributeMap())
	Draws the pair of segments as an arrow connecting the centers of them.
void	draw (const TrackingUtilities::CDCSegmentPair &segmentPair, const AttributeMap &attributeMap=AttributeMap())
	Draws the pair of segments as an arrow connecting the centers of them.
void	draw (const TrackingUtilities::CDCSegmentTriple &segmentTriple, const AttributeMap &attributeMap=AttributeMap())
	Draws the triple of segments as two arrows connecting the centers from start to the middle segment and from the middle to the end segment.
void	draw (const TrackingUtilities::CDCTrack &track, const AttributeMap &attributeMap=AttributeMap())
	Draws all CDCRecoHits3D of the segment.
void	draw (const RecoTrack &recoTrack, const AttributeMap &attributeMap=AttributeMap())
	Draws the hit content of the RecoTrack.
void	drawTrajectory (const MCParticle &mcParticle, const AttributeMap &attributeMap=AttributeMap())
	Draws the trajectory that is represented by the MC particle.
void	drawTrajectory (const TrackingUtilities::CDCSegment2D &segment, const AttributeMap &attributeMap=AttributeMap())
	Draws trajectory of the CDCSegment2D.
void	drawTrajectory (const TrackingUtilities::CDCSegmentTriple &segmentTriple, const AttributeMap &attributeMap=AttributeMap())
	Draws trajectory of the CDCSegmentTriple.
void	drawTrajectory (const TrackingUtilities::CDCTrack &track, const AttributeMap &attributeMap=AttributeMap())
	Draws trajectory of the CDCTrack.
void	drawTrajectory (const RecoTrack &recoTrack, const AttributeMap &attributeMap=AttributeMap())
	Draws curve along the fitted points of the RecoTrack.
template<class T>
void	draw (const T *ptr, const AttributeMap &attributeMap=AttributeMap())
	Allow the drawing of pointers checking if the pointer is nonzero.
template<class T>
void	draw (const StoreArray< T > &storeArray, const AttributeMap &attributeMap=AttributeMap())
	Draw store array.
template<class ARange>
void	drawRange (const ARange &range, const AttributeMap &attributeMap=AttributeMap())
	Draws a range iterable collection of drawable elements.
template<class ARange>
void	drawRangeWithFade (const ARange &range, const AttributeMap &attributeMap=AttributeMap())
	Draws a range iterable collection of drawable elements.

Private Member Functions
void	startAnimationGroup (const Belle2::CDCSimHit &simHit)
	Start a group in the underlying plotter with an animation uncovering the elements at the time of flight of the CDCSimHit.
void	startAnimationGroup (const Belle2::CDCHit *ptrHit)
	Start a group in the underlying plotter with an animation uncovering the elements at the time of flight of the related CDCSimHit.

Private Attributes
std::unique_ptr< PrimitivePlotter >	m_ptrPrimitivePlotter
	Reference to the primitivePlotter instance used as backend for the draw commands.
bool	m_animate = false
	Memory for the flag if the event data should be animated. If animation is supported is backend dependent.
bool	m_forwardFade = false
	Memory for the flag whether the orientation of tracks segments etc should be shown as dimming opacity.

Detailed Description

A class that can plot event related data types.

Definition at line 53 of file EventDataPlotter.h.

Member Typedef Documentation

AttributeMap

using AttributeMap = PrimitivePlotter::AttributeMap

Forward the Attribute map from the primitive plotter.

Definition at line 58 of file EventDataPlotter.h.

Constructor & Destructor Documentation

EventDataPlotter() [1/3]

EventDataPlotter ( bool animate = false, bool forwardFade = false )

explicit

Default constructor for ROOT compatibility. Uses an SVGPrimitivePlotter as backend.

Definition at line 48 of file EventDataPlotter.cc.

  : m_ptrPrimitivePlotter(new SVGPrimitivePlotter(
                            AttributeMap{{"stroke", "orange"}, {"stroke-width", "0.55"}, {"fill", "none"}}))
, m_animate(animate)
, m_forwardFade(forwardFade)
{
}

EventDataPlotter() [2/3]

EventDataPlotter ( std::unique_ptr< PrimitivePlotter > ptrPrimitivePlotter, bool animate = false, bool forwardFade = false )

explicit

Constructor taking the specific PrimitivePlotter instance as backend.

Note that the EventDataPlotter takes ownership of the PrimitivePlotter and destroys it on its on own deconstruction.

Definition at line 56 of file EventDataPlotter.cc.

  : m_ptrPrimitivePlotter(std::move(ptrPrimitivePlotter))
  , m_animate(animate)
  , m_forwardFade(forwardFade)
{
  B2ASSERT("EventDataPlotter initialized with nullptr. Using default backend SVGPrimitivePlotter.",
           m_ptrPrimitivePlotter);
}

EventDataPlotter() [3/3]

EventDataPlotter

(

const EventDataPlotter &

eventDataPlotter

)

Copy constructor.

Definition at line 67 of file EventDataPlotter.cc.

  : m_ptrPrimitivePlotter(eventDataPlotter.m_ptrPrimitivePlotter->clone())
  , m_animate(eventDataPlotter.m_animate)
  , m_forwardFade(eventDataPlotter.m_forwardFade)
{
}

Member Function Documentation

clear()

void clear

(

)

Clears all drawn elements from the plotter.

Definition at line 84 of file EventDataPlotter.cc.

{
  if (m_ptrPrimitivePlotter) {
    PrimitivePlotter& primitivePlotter = *m_ptrPrimitivePlotter;
    return primitivePlotter.clear();
  }
}

draw() [1/21]

void draw	(	const CDC::CDCWire &	wire,
		const AttributeMap &	attributeMap = AttributeMap() )

Draws the CDCWire as a small circle at the reference position.

------------------— Draw CDCWire ---------------------—

Definition at line 294 of file EventDataPlotter.cc.

{
  const float wireRadius = 0.25;
  const Vector2D& refPos = wire.getRefPos2D();
 
  draw(Circle2D(refPos, wireRadius), attributeMap);
}

draw() [2/21]

void draw	(	const CDC::CDCWireSuperLayer &	wireSuperLayer,
		const AttributeMap &	attributeMap = AttributeMap() )

Draws the inner and the outer bound of the super layer.

------------------— Draw CDCWireSuperLayer ---------------------—

Definition at line 303 of file EventDataPlotter.cc.

{
  if (not m_ptrPrimitivePlotter) return;
  PrimitivePlotter& primitivePlotter = *m_ptrPrimitivePlotter;
 
  primitivePlotter.startGroup(attributeMap);
  for (const CDCWireLayer& wireLayer : wireSuperLayer) {
    for (const CDCWire& wire : wireLayer) {
      draw(wire);
    }
  }
  primitivePlotter.endGroup();
}

draw() [3/21]

void draw	(	const CDC::CDCWireTopology &	wireTopology,
		AttributeMap	attributeMap = AttributeMap() )

Draws the all wires in the CDC.

------------------— Draw CDCWireTopology---------------------—

Definition at line 319 of file EventDataPlotter.cc.

{
  for (const CDCWireSuperLayer& wireSuperLayer : wireTopology.getWireSuperLayers()) {
    AttributeMap defaultSuperLayerAttributeMap{{"fill",
        wireSuperLayer.isAxial() ? "black" : "gray"
      },
      {"stroke", "none"}};
 
    AttributeMap superLayerAttributeMap(attributeMap);
 
    // Insert the values as defaults. Does not overwrite attributes with the same name.
    superLayerAttributeMap.insert(defaultSuperLayerAttributeMap.begin(),
                                  defaultSuperLayerAttributeMap.end());
    draw(wireSuperLayer, superLayerAttributeMap);
  }
}

draw() [4/21]

void draw	(	const CDCHit &	hit,
		const AttributeMap &	attributeMap = AttributeMap() )

Draws the CDCHit as the wire position and its drift circle at the wire reference position.

------------------— Draw CDCHit ---------------------—

Definition at line 365 of file EventDataPlotter.cc.

{
  CDCWireHit wireHit(&hit);
  draw(wireHit, attributeMap);
}

draw() [5/21]

void draw	(	const CDCSimHit &	simHit,
		const AttributeMap &	attributeMap = AttributeMap() )

Draws the CDCSimHit as a momentum arrow starting at the track position with a length proportional to its momentum.

------------------— Draw CDCSimHit ---------------------—

Definition at line 337 of file EventDataPlotter.cc.

{
  if (not m_ptrPrimitivePlotter) return;
  PrimitivePlotter& primitivePlotter = *m_ptrPrimitivePlotter;
 
  startAnimationGroup(simHit);
 
  // Draw hit position as a small circle
  ROOT::Math::XYZVector position = simHit.getPosTrack();
  float x = position.X();
  float y = position.Y();
  float radius = 0.2;
 
  primitivePlotter.drawCircle(x, y, radius, attributeMap);
 
  // Draw momentum as an arrow proportional to the transverse component of the momentum
  const float momentumToArrowLength = 1.5;
 
  ROOT::Math::XYZVector momentum = simHit.getMomentum();
  float endX = x + momentum.X() * momentumToArrowLength;
  float endY = y + momentum.Y() * momentumToArrowLength;
 
  primitivePlotter.drawArrow(x, y, endX, endY, attributeMap);
 
  primitivePlotter.endGroup();
}

draw() [6/21]

void draw	(	const RecoTrack &	recoTrack,
		const AttributeMap &	attributeMap = AttributeMap() )

Draws the hit content of the RecoTrack.

Definition at line 689 of file EventDataPlotter.cc.

{
  if (not m_ptrPrimitivePlotter) return;
  PrimitivePlotter& primitivePlotter = *m_ptrPrimitivePlotter;
 
  primitivePlotter.startGroup(attributeMap);
  for (const CDCHit* ptrHit : recoTrack.getCDCHitList()) {
    if (ptrHit) {
      const CDCHit& hit = *ptrHit;
      draw(hit);
    }
  }
  primitivePlotter.endGroup();
}

draw() [7/21]

template<class T>

void draw ( const StoreArray< T > & storeArray, const AttributeMap & attributeMap = AttributeMap() )

inline

Draw store array.

Definition at line 259 of file EventDataPlotter.h.

      {
        if (not storeArray) return;
        drawRange(storeArray, attributeMap);
      }

draw() [8/21]

template<class T>

void draw ( const T * ptr, const AttributeMap & attributeMap = AttributeMap() )

inline

Allow the drawing of pointers checking if the pointer is nonzero.

Definition at line 252 of file EventDataPlotter.h.

      {
        if (ptr) draw(*ptr, attributeMap);
      }

draw() [9/21]

void draw	(	const TrackingUtilities::CDCAxialSegmentPair &	axialSegmentPair,
		const AttributeMap &	attributeMap = AttributeMap() )

Draws the pair of segments as an arrow connecting the centers of them.

Definition at line 552 of file EventDataPlotter.cc.

{
  if (not m_ptrPrimitivePlotter) return;
  PrimitivePlotter& primitivePlotter = *m_ptrPrimitivePlotter;
 
  const CDCSegment2D* ptrFromSegment = axialSegmentPair.getStartSegment();
  const CDCSegment2D* ptrToSegment = axialSegmentPair.getEndSegment();
 
  if (not ptrFromSegment or not ptrToSegment) return;
 
  const CDCSegment2D& fromSegment = *ptrFromSegment;
  const CDCSegment2D& toSegment = *ptrToSegment;
 
  const Vector2D& fromPos = fromSegment.back().getWire().getRefPos2D();
  const Vector2D& toPos = toSegment.front().getWire().getRefPos2D();
 
  if (fromPos.hasNAN()) {
    B2WARNING("Center of mass of first segment in a pair contains NAN values.");
    return;
  }
 
  if (toPos.hasNAN()) {
    B2WARNING("Center of mass of second segment in a pair contains NAN values.");
    return;
  }
 
  const float fromX = fromPos.x();
  const float fromY = fromPos.y();
 
  const float toX = toPos.x();
  const float toY = toPos.y();
 
  primitivePlotter.drawArrow(fromX, fromY, toX, toY, attributeMap);
}

draw() [10/21]

void draw	(	const TrackingUtilities::CDCRecoHit2D &	recoHit2D,
		const AttributeMap &	attributeMap = AttributeMap() )

Draws the TrackingUtilities::CDCRecoHit2D as a drift circle at the two dimensional reference wire position and a point at the reconstructed position""".

------------------— Draw CDCRecoHit2D ---------------------—

Definition at line 393 of file EventDataPlotter.cc.

{
  if (not m_ptrPrimitivePlotter) return;
  PrimitivePlotter& primitivePlotter = *m_ptrPrimitivePlotter;
 
  const CDCWireHit& wireHit = recoHit2D.getWireHit();
 
  startAnimationGroup(wireHit.getHit());
 
  const Vector2D& refPos2D = wireHit.getRefPos2D();
  const Vector2D& recoPos2D = recoHit2D.getRecoPos2D();
 
  float x = refPos2D.x();
  float y = refPos2D.y();
  float radius = wireHit.getRefDriftLength();
  primitivePlotter.drawCircle(x, y, radius, attributeMap);
 
  if (not recoPos2D.hasNAN()) {
    float supportPointRadius = 0.2;
    Circle2D supportPoint(recoPos2D, supportPointRadius);
    draw(supportPoint, attributeMap);
  }
 
  primitivePlotter.endGroup();
}

draw() [11/21]

void draw	(	const TrackingUtilities::CDCRecoHit3D &	recoHit3D,
		const AttributeMap &	attributeMap = AttributeMap() )

Draws the CDCRecoHit3D as a drift circle at the two dimensional reference wire position and a point at the reconstructed position""".

Definition at line 443 of file EventDataPlotter.cc.

{
  draw(recoHit3D.getRecoHit2D(), attributeMap);
}

draw() [12/21]

void draw	(	const TrackingUtilities::CDCSegment2D &	segment2D,
		const AttributeMap &	attributeMap = AttributeMap() )

Draws all CDCRecoHits2D of the segment.

Definition at line 534 of file EventDataPlotter.cc.

{
  if (m_forwardFade) {
    drawRangeWithFade(segment2D, attributeMap);
  } else {
    drawRange(segment2D, attributeMap);
  }
}

draw() [13/21]

void draw	(	const TrackingUtilities::CDCSegment3D &	segment3D,
		const AttributeMap &	attributeMap = AttributeMap() )

Draws all CDCRecoHits3D of the segment.

Definition at line 543 of file EventDataPlotter.cc.

{
  if (m_forwardFade) {
    drawRange(segment3D, attributeMap);
  } else {
    drawRange(segment3D, attributeMap);
  }
}

draw() [14/21]

void draw	(	const TrackingUtilities::CDCSegmentPair &	segmentPair,
		const AttributeMap &	attributeMap = AttributeMap() )

Draws the pair of segments as an arrow connecting the centers of them.

Definition at line 588 of file EventDataPlotter.cc.

{
  if (not m_ptrPrimitivePlotter) return;
  PrimitivePlotter& primitivePlotter = *m_ptrPrimitivePlotter;
 
  const CDCSegment2D* ptrFromSegment = segmentPair.getFromSegment();
  const CDCSegment2D* ptrToSegment = segmentPair.getToSegment();
 
  if (not ptrFromSegment or not ptrToSegment) return;
 
  const CDCSegment2D& fromSegment = *ptrFromSegment;
  const CDCSegment2D& toSegment = *ptrToSegment;
 
  const Vector2D& fromPos = fromSegment.back().getWire().getRefPos2D();
  const Vector2D& toPos = toSegment.front().getWire().getRefPos2D();
 
  if (fromPos.hasNAN()) {
    B2WARNING("Center of mass of first segment in a pair contains NAN values.");
    return;
  }
 
  if (toPos.hasNAN()) {
    B2WARNING("Center of mass of second segment in a pair contains NAN values.");
    return;
  }
 
  const float fromX = fromPos.x();
  const float fromY = fromPos.y();
 
  const float toX = toPos.x();
  const float toY = toPos.y();
 
  primitivePlotter.drawArrow(fromX, fromY, toX, toY, attributeMap);
}

draw() [15/21]

void draw	(	const TrackingUtilities::CDCSegmentTriple &	segmentTriple,
		const AttributeMap &	attributeMap = AttributeMap() )

Draws the triple of segments as two arrows connecting the centers from start to the middle segment and from the middle to the end segment.

Definition at line 623 of file EventDataPlotter.cc.

{
  if (not m_ptrPrimitivePlotter) return;
  PrimitivePlotter& primitivePlotter = *m_ptrPrimitivePlotter;
 
  const CDCSegment2D* ptrStartSegment = segmentTriple.getStartSegment();
  const CDCSegment2D* ptrMiddleSegment = segmentTriple.getMiddleSegment();
  const CDCSegment2D* ptrEndSegment = segmentTriple.getEndSegment();
 
  if (not ptrStartSegment or not ptrMiddleSegment or not ptrEndSegment) return;
 
  const CDCSegment2D& startSegment = *ptrStartSegment;
  const CDCSegment2D& middleSegment = *ptrMiddleSegment;
  const CDCSegment2D& endSegment = *ptrEndSegment;
 
  const Vector2D& startBackPos2D = startSegment.back().getRefPos2D();
  const Vector2D& middleFrontPos2D = middleSegment.front().getRefPos2D();
  const Vector2D& middleBackPos2D = middleSegment.back().getRefPos2D();
  const Vector2D& endFrontPos2D = endSegment.front().getRefPos2D();
 
  if (startBackPos2D.hasNAN()) {
    B2WARNING("Back position of start segment in a triple contains NAN values.");
    return;
  }
 
  if (middleFrontPos2D.hasNAN()) {
    B2WARNING("Front position of middle segment in a triple contains NAN values.");
    return;
  }
 
  if (middleBackPos2D.hasNAN()) {
    B2WARNING("Back position of middle segment in a triple contains NAN values.");
    return;
  }
 
  if (endFrontPos2D.hasNAN()) {
    B2WARNING("Front position of end segment in a triple contains NAN values.");
    return;
  }
 
  const float startBackX = startBackPos2D.x();
  const float startBackY = startBackPos2D.y();
 
  const float middleFrontX = middleFrontPos2D.x();
  const float middleFrontY = middleFrontPos2D.y();
 
  primitivePlotter.drawArrow(startBackX, startBackY, middleFrontX, middleFrontY, attributeMap);
 
  const float middleBackX = middleBackPos2D.x();
  const float middleBackY = middleBackPos2D.y();
 
  const float endFrontX = endFrontPos2D.x();
  const float endFrontY = endFrontPos2D.y();
 
  primitivePlotter.drawArrow(middleBackX, middleBackY, endFrontX, endFrontY, attributeMap);
}

draw() [16/21]

void draw	(	const TrackingUtilities::CDCTangent &	tangent,
		const AttributeMap &	attributeMap = AttributeMap() )

Draws the CDCRecoHit3D as a drift circle at the two dimensional reference wire position and a point at the reconstructed position""".

------------------— Draw CDCRecoHit2D ---------------------—

Definition at line 420 of file EventDataPlotter.cc.

{
  if (not m_ptrPrimitivePlotter) return;
  PrimitivePlotter& primitivePlotter = *m_ptrPrimitivePlotter;
 
  const Vector2D fromPos = tangent.getFromRecoPos2D();
  const float fromX = fromPos.x();
  const float fromY = fromPos.y();
 
  const Vector2D toPos = tangent.getToRecoPos2D();
  const float toX = toPos.x();
  const float toY = toPos.y();
 
  primitivePlotter.drawLine(fromX, fromY, toX, toY, attributeMap);
 
  float touchPointRadius = 0.015;
  const Circle2D fromTouchPoint(fromPos, touchPointRadius);
  draw(fromTouchPoint, attributeMap);
 
  const Circle2D toTouchPoint(toPos, touchPointRadius);
  draw(toTouchPoint, attributeMap);
}

draw() [17/21]

void draw	(	const TrackingUtilities::CDCTrack &	track,
		const AttributeMap &	attributeMap = AttributeMap() )

Draws all CDCRecoHits3D of the segment.

Definition at line 680 of file EventDataPlotter.cc.

{
  if (m_forwardFade) {
    drawRangeWithFade(track, attributeMap);
  } else {
    drawRange(track, attributeMap);
  }
}

draw() [18/21]

void draw	(	const TrackingUtilities::CDCTrajectory2D &	trajectory2D,
		AttributeMap	attributeMap = AttributeMap() )

Draws the CDCTrajectory from the start point until it first exits the CDC.

------------------— Draw CDCTrajectory2D ---------------------—

Definition at line 450 of file EventDataPlotter.cc.

{
  if (not m_ptrPrimitivePlotter) return;
  PrimitivePlotter& primitivePlotter = *m_ptrPrimitivePlotter;
 
  AttributeMap defaultAttributeMap{};
 
  // Make the default color charge dependent
  int charge = trajectory2D.getChargeSign();
  if (charge > 0) {
    defaultAttributeMap["stroke"] = "red";
  } else if (charge < 0) {
    defaultAttributeMap["stroke"] = "blue";
  } else {
    defaultAttributeMap["stroke"] = "green";
  }
 
  // Add attributes if not present
  attributeMap.insert(defaultAttributeMap.begin(), defaultAttributeMap.end());
 
  Vector2D trajectoryExit = trajectory2D.getOuterExit();
  if (trajectoryExit.hasNAN()) {
    // Curlers do not leave the CDC
    // Stop the trajectory at the inner wall to be able to
    // see the start point
    trajectoryExit = trajectory2D.getInnerExit();
  }
 
  if (trajectory2D.getLocalCircle()->isCircle()) {
    if (trajectoryExit.hasNAN()) {
      // No exit point out of the cdc could be detected.
      // Draw full circle
      const float radius = trajectory2D.getLocalCircle()->absRadius();
      const Vector2D center = trajectory2D.getGlobalCircle().center();
      float centerX = center.x();
      float centerY = center.y();
 
      primitivePlotter.drawCircle(centerX, centerY, radius);
 
    } else {
      const float radius = trajectory2D.getLocalCircle()->absRadius();
      const Vector2D start = trajectory2D.getSupport();
      float startX = start.x();
      float startY = start.y();
 
      float endX = trajectoryExit.x();
      float endY = trajectoryExit.y();
 
      const int curvature = -charge;
      const bool sweepFlag = curvature > 0;
 
      // check if exit point is on the close or
      // on the far side of the circle
      const bool longArc = (trajectory2D.calcArcLength2D(trajectoryExit) > 0) ? false : true;
      primitivePlotter.drawCircleArc(startX,
                                     startY,
                                     endX,
                                     endY,
                                     radius,
                                     longArc,
                                     sweepFlag,
                                     attributeMap);
    }
  } else {
    // trajectory is a straight line
    if (trajectoryExit.hasNAN()) {
      B2WARNING("Could not compute point off exit in a straight line case.");
    } else {
      const Vector2D start = trajectory2D.getSupport();
      float startX = start.x();
      float startY = start.y();
 
      float endX = trajectoryExit.x();
      float endY = trajectoryExit.y();
      primitivePlotter.drawLine(startX, startY, endX, endY, attributeMap);
    }
  }
}

draw() [19/21]

void draw	(	const TrackingUtilities::CDCWireHit &	wireHit,
		const AttributeMap &	attributeMap = AttributeMap() )

Draws the CDCWireHit as the wire position and its drift circle at the wire reference position.

------------------— Draw CDCWireHit ---------------------—

Definition at line 372 of file EventDataPlotter.cc.

{
  if (not m_ptrPrimitivePlotter) return;
  PrimitivePlotter& primitivePlotter = *m_ptrPrimitivePlotter;
 
  startAnimationGroup(wireHit.getHit());
 
  const Vector2D& refPos = wireHit.getRefPos2D();
 
  float x = refPos.x();
  float y = refPos.y();
  float radius = wireHit.getRefDriftLength();
 
  if (fabs(radius) < 100) {
    primitivePlotter.drawCircle(x, y, radius, attributeMap);
  }
 
  primitivePlotter.endGroup();
}

draw() [20/21]

void draw	(	const TrackingUtilities::CDCWireHitCluster &	wireHitCluster,
		const AttributeMap &	attributeMap = AttributeMap() )

Draws all CDCWireHits of the cluster.

Definition at line 529 of file EventDataPlotter.cc.

{
  drawRange(wireHitCluster, attributeMap);
}

draw() [21/21]

void draw	(	const TrackingUtilities::Circle2D &	circle,
		AttributeMap	attributeMap = AttributeMap() )

Draws a filled circle.

------------------— Draw Circle2D ---------------------—

Definition at line 271 of file EventDataPlotter.cc.

{
  if (not m_ptrPrimitivePlotter) return;
  PrimitivePlotter& primitivePlotter = *m_ptrPrimitivePlotter;
 
  float radius = circle.radius();
 
  if (not attributeMap.count("fill") or attributeMap["fill"] != "") {
    if (attributeMap.count("stroke")) {
      attributeMap["fill"] = attributeMap["stroke"];
      attributeMap.erase("stroke");
    }
  }
 
  const Vector2D& pos = circle.center();
 
  float x = pos.x();
  float y = pos.y();
 
  primitivePlotter.drawCircle(x, y, radius, attributeMap);
}

drawInnerCDCWall()

void drawInnerCDCWall

(

const AttributeMap &

attributeMap = AttributeMap()

)

Draw the inner wall of the CDC.

Definition at line 210 of file EventDataPlotter.cc.

{
  if (not m_ptrPrimitivePlotter) return;
  PrimitivePlotter& primitivePlotter = *m_ptrPrimitivePlotter;
 
  const CDCWireTopology& wireTopology = CDCWireTopology::getInstance();
 
  const CDCWireSuperLayer& wireSuperLayer = wireTopology.getWireSuperLayers().front();
 
  float centerX = 0.0;
  float centerY = 0.0;
  float innerR = wireSuperLayer.getInnerCylindricalR();
 
  primitivePlotter.drawCircle(centerX, centerY, innerR, attributeMap);
}

drawInteractionPoint()

void drawInteractionPoint

(

)

Marks the position of the interaction point with a filled circle.

Definition at line 198 of file EventDataPlotter.cc.

{
  Vector2D center(0.0, 0.0);
  float radius = 1.0;
 
  const Circle2D interactionPoint(center, radius);
 
  AttributeMap attributeMap{{"fill", "black"}, {"stroke-width", "0"}};
 
  draw(interactionPoint, attributeMap);
}

drawLine()

void drawLine	(	float	startX,
		float	startY,
		float	endX,
		float	endY,
		const AttributeMap &	attributeMap = AttributeMap() )

Draws a straight Line.

Definition at line 258 of file EventDataPlotter.cc.

{
  if (not m_ptrPrimitivePlotter) return;
  PrimitivePlotter& primitivePlotter = *m_ptrPrimitivePlotter;
 
  primitivePlotter.drawLine(startX, startY, endX, endY, attributeMap);
}

drawOuterCDCWall()

void drawOuterCDCWall

(

const AttributeMap &

attributeMap = AttributeMap()

)

Draw the outer wall of the CDC.

Definition at line 226 of file EventDataPlotter.cc.

{
  if (not m_ptrPrimitivePlotter) return;
  PrimitivePlotter& primitivePlotter = *m_ptrPrimitivePlotter;
 
  const CDCWireTopology& wireTopology = CDCWireTopology::getInstance();
 
  const CDCWireSuperLayer& wireSuperLayer = wireTopology.getWireSuperLayers().back();
 
  float centerX = 0.0;
  float centerY = 0.0;
  float outerR = wireSuperLayer.getOuterCylindricalR();
 
  primitivePlotter.drawCircle(centerX, centerY, outerR, attributeMap);
}

drawRange()

template<class ARange>

void drawRange ( const ARange & range, const AttributeMap & attributeMap = AttributeMap() )

inline

Draws a range iterable collection of drawable elements.

Definition at line 267 of file EventDataPlotter.h.

      {
        if (not m_ptrPrimitivePlotter) return;
        PrimitivePlotter& primitivePlotter = *m_ptrPrimitivePlotter;
        primitivePlotter.startGroup(attributeMap);
        for (const auto& element : range) {
          draw(element);
        }
        primitivePlotter.endGroup();
      }

drawRangeWithFade()

template<class ARange>

void drawRangeWithFade ( const ARange & range, const AttributeMap & attributeMap = AttributeMap() )

inline

Draws a range iterable collection of drawable elements.

Definition at line 280 of file EventDataPlotter.h.

      {
        if (not m_ptrPrimitivePlotter) return;
        PrimitivePlotter& primitivePlotter = *m_ptrPrimitivePlotter;
        primitivePlotter.startGroup(attributeMap);
        float opacity = 1;
        float endOpacity = 0.5;
        int n = std::distance(std::begin(range), std::end(range));
        if (n == 0) return;
        float opacityFactor = std::pow(endOpacity / opacity, 1.0 / (n - 1));
        for (const auto& element : range) {
          const auto opacity_str = std::to_string(opacity);
          AttributeMap elementAttributeMap{{"opacity", opacity_str}};
          draw(element, elementAttributeMap);
          opacity *= opacityFactor;
        }
        primitivePlotter.endGroup();
      }

drawSuperLayerBoundaries()

void drawSuperLayerBoundaries

(

const AttributeMap &

attributeMap = AttributeMap()

)

Draw the super layer bounds of the CDC.

Definition at line 242 of file EventDataPlotter.cc.

{
  if (not m_ptrPrimitivePlotter) return;
  PrimitivePlotter& primitivePlotter = *m_ptrPrimitivePlotter;
 
  const CDCWireTopology& wireTopology = CDCWireTopology::getInstance();
 
  for (const CDCWireSuperLayer& wireSuperLayer : wireTopology.getWireSuperLayers()) {
    float centerX = 0.0;
    float centerY = 0.0;
    float outerR = wireSuperLayer.getInnerCylindricalR();
    primitivePlotter.drawCircle(centerX, centerY, outerR, attributeMap);
  }
  drawOuterCDCWall(attributeMap);
}

drawTrajectory() [1/5]

void drawTrajectory	(	const MCParticle &	mcParticle,
		const AttributeMap &	attributeMap = AttributeMap() )

Draws the trajectory that is represented by the MC particle.

Definition at line 704 of file EventDataPlotter.cc.

{
  if (not mcParticle.isPrimaryParticle()) return;
  Vector3D pos(mcParticle.getVertex());
  Vector3D mom(mcParticle.getMomentum());
  double charge = mcParticle.getCharge();
  double time = mcParticle.getProductionTime();
  CDCTrajectory2D trajectory2D(pos.xy(), time, mom.xy(), charge);
  draw(trajectory2D, attributeMap);
}

drawTrajectory() [2/5]

void drawTrajectory	(	const RecoTrack &	recoTrack,
		const AttributeMap &	attributeMap = AttributeMap() )

Draws curve along the fitted points of the RecoTrack.

Definition at line 732 of file EventDataPlotter.cc.

{
  if (not m_ptrPrimitivePlotter) return;
  PrimitivePlotter& primitivePlotter = *m_ptrPrimitivePlotter;
 
  primitivePlotter.startGroup(attributeMap);
 
  bool fitSuccessful = not recoTrack.getRepresentations().empty() and recoTrack.wasFitSuccessful();
  if (fitSuccessful) {
    std::vector<std::array<float, 2>> points;
    std::vector<std::array<float, 2>> tangents;
 
    for (auto recoHit : recoTrack.getRecoHitInformations()) {
      // skip for reco hits which have not been used in the fit (and therefore have no fitted information on the plane
      if (!recoHit->useInFit())
        continue;
 
      TVector3 pos;
      TVector3 mom;
      TMatrixDSym cov;
 
      try {
        const auto* trackPoint = recoTrack.getCreatedTrackPoint(recoHit);
        const auto* fittedResult = trackPoint->getFitterInfo();
        if (not fittedResult) {
          B2WARNING("Skipping unfitted track point");
          continue;
        }
        const genfit::MeasuredStateOnPlane& state = fittedResult->getFittedState();
        state.getPosMomCov(pos, mom, cov);
      } catch (const genfit::Exception&) {
        B2WARNING("Skipping state with strange pos, mom or cov");
        continue;
      }
 
      float x = pos.X();
      float y = pos.Y();
      float px = mom.X();
      float py = mom.Y();
 
      points.push_back({{x, y}});
      tangents.push_back({{px, py}});
    }
    primitivePlotter.drawCurve(points, tangents, attributeMap);
  }
 
  primitivePlotter.endGroup();
}

drawTrajectory() [3/5]

void drawTrajectory	(	const TrackingUtilities::CDCSegment2D &	segment,
		const AttributeMap &	attributeMap = AttributeMap() )

Draws trajectory of the CDCSegment2D.

Definition at line 715 of file EventDataPlotter.cc.

{
  draw(segment.getTrajectory2D(), attributeMap);
}

drawTrajectory() [4/5]

void drawTrajectory	(	const TrackingUtilities::CDCSegmentTriple &	segmentTriple,
		const AttributeMap &	attributeMap = AttributeMap() )

Draws trajectory of the CDCSegmentTriple.

Definition at line 721 of file EventDataPlotter.cc.

{
  draw(segmentTriple.getTrajectory3D().getTrajectory2D(), attributeMap);
}

drawTrajectory() [5/5]

void drawTrajectory	(	const TrackingUtilities::CDCTrack &	track,
		const AttributeMap &	attributeMap = AttributeMap() )

Draws trajectory of the CDCTrack.

Definition at line 727 of file EventDataPlotter.cc.

{
  draw(track.getStartTrajectory3D().getTrajectory2D(), attributeMap);
}

endGroup()

void endGroup

(

)

Indicates the end of a group of drawn elements.

Definition at line 154 of file EventDataPlotter.cc.

{
  if (m_ptrPrimitivePlotter) {
    PrimitivePlotter& primitivePlotter = *m_ptrPrimitivePlotter;
    primitivePlotter.endGroup();
  }
}

getAnimationTimeFromNanoSeconds()

std::string getAnimationTimeFromNanoSeconds ( float nanoseconds )

inline

Converts a time given in nanoseconds to a time string of the from "%fs".

Definition at line 133 of file EventDataPlotter.h.

      {
        return std::to_string(nanoseconds) + "s";
      }

getBoundingBox()

BoundingBox getBoundingBox

(

)

const

Getter for the current bounding box.

Definition at line 92 of file EventDataPlotter.cc.

{
  if (m_ptrPrimitivePlotter) {
    PrimitivePlotter& primitivePlotter = *m_ptrPrimitivePlotter;
    return primitivePlotter.getBoundingBox();
  } else {
    return BoundingBox(0, 0, 0, 0);
  }
}

getCanvasHeight()

float getCanvasHeight

(

)

const

Getter for the canvas height in pixels.

Definition at line 120 of file EventDataPlotter.cc.

{
  if (m_ptrPrimitivePlotter) {
    PrimitivePlotter& primitivePlotter = *m_ptrPrimitivePlotter;
    return primitivePlotter.getCanvasHeight();
  } else {
    return NAN;
  }
}

getCanvasWidth()

float getCanvasWidth

(

)

const

Getter for the canvas width in pixels.

Definition at line 110 of file EventDataPlotter.cc.

{
  if (m_ptrPrimitivePlotter) {
    PrimitivePlotter& primitivePlotter = *m_ptrPrimitivePlotter;
    return primitivePlotter.getCanvasWidth();
  } else {
    return NAN;
  }
}

save()

const std::string save

(

const std::string &

fileName

)

Saves the current plot stead to a file.

Deriving instances may should implement the appropriate thing here and may return a modified string indicating the file name to which the plot as been written. It is allowed to append or change the file extension if the concrete implementation PrimitivePlotter decides to do so.

Parameters

fileName

fileName where the plot shall be saved

Returns

Potentially modified file name where the file has actually been written to.

Definition at line 74 of file EventDataPlotter.cc.

{
  if (m_ptrPrimitivePlotter) {
    PrimitivePlotter& primitivePlotter = *m_ptrPrimitivePlotter;
    return primitivePlotter.save(fileName);
  } else {
    return "";
  }
}

setBoundingBox()

void setBoundingBox

(

const BoundingBox &

boundingBox

)

Setter for the bounding box of all drawn objects.

Definition at line 102 of file EventDataPlotter.cc.

{
  if (m_ptrPrimitivePlotter) {
    PrimitivePlotter& primitivePlotter = *m_ptrPrimitivePlotter;
    return primitivePlotter.setBoundingBox(boundingBox);
  }
}

setCanvasHeight()

void setCanvasHeight

(

float

height

)

Setter for the canvas height in pixels The canvas height denotes the size of the image being produced.

The coordinates space that is visible in the picture is a separate concept which is stored in the bounding box (getBoundingBox()).

Definition at line 138 of file EventDataPlotter.cc.

{
  if (m_ptrPrimitivePlotter) {
    PrimitivePlotter& primitivePlotter = *m_ptrPrimitivePlotter;
    primitivePlotter.setCanvasHeight(height);
  }
}

setCanvasWidth()

void setCanvasWidth

(

float

width

)

Setter for the canvas width in pixels.

The canvas height denotes the size of the image being produced. The coordinates space that is visible in the picture is a separate concept which is stored in the bounding box (getBoundingBox()).

Definition at line 130 of file EventDataPlotter.cc.

{
  if (m_ptrPrimitivePlotter) {
    PrimitivePlotter& primitivePlotter = *m_ptrPrimitivePlotter;
    primitivePlotter.setCanvasWidth(width);
  }
}

startAnimationGroup() [1/2]

void startAnimationGroup ( const Belle2::CDCHit * ptrHit )

private

Start a group in the underlying plotter with an animation uncovering the elements at the time of flight of the related CDCSimHit.

Definition at line 179 of file EventDataPlotter.cc.

{
  if (not m_ptrPrimitivePlotter) return;
  PrimitivePlotter& primitivePlotter = *m_ptrPrimitivePlotter;
 
  if (m_animate) {
    if (ptrHit) {
      const CDCHit& hit = *ptrHit;
      const CDCSimHit* ptrSimHit = hit.getRelated<CDCSimHit>();
      if (ptrSimHit) {
        const CDCSimHit& simHit = *ptrSimHit;
        startAnimationGroup(simHit);
        return;
      }
    }
  }
  primitivePlotter.startGroup();
}

startAnimationGroup() [2/2]

void startAnimationGroup ( const Belle2::CDCSimHit & simHit )

private

Start a group in the underlying plotter with an animation uncovering the elements at the time of flight of the CDCSimHit.

Definition at line 162 of file EventDataPlotter.cc.

{
  // In case the event should be animated
  // uncover the group of elements at the time of flight of the CDCSimHit.
  if (not m_ptrPrimitivePlotter) return;
  PrimitivePlotter& primitivePlotter = *m_ptrPrimitivePlotter;
 
  if (m_animate) {
    float tof = simHit.getFlightTime();
    AttributeMap groupAttributeMap{{"_showAt", getAnimationTimeFromNanoSeconds(tof)}};
    primitivePlotter.startGroup(groupAttributeMap);
 
  } else {
    primitivePlotter.startGroup();
  }
}

startGroup()

void startGroup

(

const AttributeMap &

attributeMap = AttributeMap()

)

Indicates the start of a group of drawn elements.

Definition at line 146 of file EventDataPlotter.cc.

{
  if (m_ptrPrimitivePlotter) {
    PrimitivePlotter& primitivePlotter = *m_ptrPrimitivePlotter;
    primitivePlotter.startGroup(attributeMap);
  }
}

Member Data Documentation

m_animate

bool m_animate = false

private

Memory for the flag if the event data should be animated. If animation is supported is backend dependent.

Definition at line 304 of file EventDataPlotter.h.

m_forwardFade

bool m_forwardFade = false

private

Memory for the flag whether the orientation of tracks segments etc should be shown as dimming opacity.

Definition at line 307 of file EventDataPlotter.h.

m_ptrPrimitivePlotter

std::unique_ptr<PrimitivePlotter> m_ptrPrimitivePlotter

private

Reference to the primitivePlotter instance used as backend for the draw commands.

Definition at line 301 of file EventDataPlotter.h.

---

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

• tracking/trackFindingCDC/display/include/EventDataPlotter.h
• tracking/trackFindingCDC/display/src/EventDataPlotter.cc