Add custom information to the display. More...

#include <DisplayData.h>

Inheritance diagram for DisplayData:

Collaboration diagram for DisplayData:

[legend]

Classes
struct	Arrow
	Stores data associated with an arrow. More...

Public Member Functions
	DisplayData ()
	Constructor.

	~DisplayData ()
	Destructor.

void	addArrow (const std::string &name, const ROOT::Math::XYZVector &start, const ROOT::Math::XYZVector &end, int color=-1)
	Add an arrow in the display (for axes, to point out some specific location). More...

void	addHistogram (const std::string &name, const TH1 *hist)
	Add histogram with the given name. More...

void	addLabel (const std::string &text, const ROOT::Math::XYZVector &pos)
	Add a text label at the given position.

void	addPoint (const std::string &name, const ROOT::Math::XYZVector &pos)
	Add a point at the given position, as part of a collection specified by name. More...

void	select (const TObject *object)
	Select the given object in the display. More...

Private Member Functions
	ClassDef (DisplayData, 5)
	Add custom information to the display.

Private Attributes
std::map< std::string, std::vector< ROOT::Math::XYZVector > >	m_pointSets
	name -> points map

std::vector< std::pair< std::string, ROOT::Math::XYZVector > >	m_labels
	text labels (to be shown at a given position).

std::vector< TH1 * >	m_histograms
	Histograms to be shown in Eve.

std::vector< std::pair< std::string, unsigned int > >	m_selectedObjects
	List of selected objects (array name, index).

std::vector< Arrow >	m_arrows
	List of arrows.

Friends
class	DisplayUI

class	EVEVisualization

Detailed Description

Add custom information to the display.

To use it, simply create a DisplayData object using StoreObjPtr and call the functions to add custom data. For example:

StoreObjPtr<DisplayData> displayData;
displayData.create();
 
//let's label the interaction point
displayData.addLabel("IP", ROOT::Math::XYZVector(0, 0, 0));
 
//add some dots along the x axis
for (int i = 0; i < 20; i++) {
  displayData.addPoint("pointset", ROOT::Math::XYZVector(i*10.0, 0, 0));
}
 
//add an arrow to point to (0, 0, -2m)
displayData.addArrow("z=-2m", ROOT::Math::XYZVector(100, 100, -200),
        ROOT::Math::XYZVector(0, 0, -200), kGray);

You can then save the output of your module to a file and view it with 'b2display', or look at it directly after execution by adding the Display module in your steering file.

See also: Check display/examples/displaydata.py to see how to use most features from a python steering file.; See display/examples/histogram_monitor.py for an example that generates and adds histograms in Python.

Definition at line 55 of file DisplayData.h.

Member Function Documentation

◆ addArrow()

void addArrow	(	const std::string &	name,
		const ROOT::Math::XYZVector &	start,
		const ROOT::Math::XYZVector &	end,
		int	color = `-1`
	)

Add an arrow in the display (for axes, to point out some specific location).

Parameters

name	Text to be shown beside arrow.
start	The arrow will start here.
end	The pointy end ends up here.
color	Color_t to use for this object, default: random color.

Definition at line 24 of file DisplayData.cc.

 {
   m_arrows.push_back(Arrow {name, start, end, color});
 }

◆ addHistogram()

void addHistogram	(	const std::string &	name,
		const TH1 *	hist
	)

Add histogram with the given name.

The histogram will show up in the 'Histograms' tab and can be drawn on the active canvas by double-clicking it.

Definition at line 39 of file DisplayData.cc.

◆ addPoint()

void addPoint	(	const std::string &	name,
		const ROOT::Math::XYZVector &	pos
	)

Add a point at the given position, as part of a collection specified by name.

All points with the same name will be highlighted when clicked etc.

Definition at line 29 of file DisplayData.cc.

◆ select()

void select ( const TObject * object )

Select the given object in the display.

Only has an effect if the object actually has a visualisation. Can be called multiple times to select more than one object.

Parameters

object object to select, must be inside a StoreArray

Definition at line 46 of file DisplayData.cc.

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

framework/dataobjects/include/DisplayData.h
framework/dataobjects/src/DisplayData.cc

Classes

Public Member Functions

Private Member Functions