#include <DrawCanvasObject.h>

Inheritance diagram for MuonValR4::detail::DrawCanvasObject:

Collaboration diagram for MuonValR4::detail::DrawCanvasObject:

Public Types
using	PrimitivePtr_t = IRootVisualizationService::PrimitivePtr_t

using	PrimitiveVec_t = std::vector< std::pair< PrimitivePtr_t, std::string > >

using	Range_t = std::array< double, 2 >

using	Range2D_t = std::array< Range_t, 2 >

enum	AxisRanges : std::uint8_t { AxisRanges::xLow, AxisRanges::xHigh, AxisRanges::yLow, AxisRanges::yHigh }
	Enum to select the corner coordinates shown by the plot. More...

Public Member Functions
	DrawCanvasObject (const std::string &canvasName, const std::size_t evtNumber)

virtual	~DrawCanvasObject ()=default

virtual void	expandPad (const double x, const double y) override final
	Expands the axes of the pad such that the coordinates are guaranteed to appear at least at the Canvas edges. More...

virtual void	add (PrimitivePtr_t &&drawMe, const std::string &drawOpt="") override final
	Add a TObject to the ICanvasObject for later drawing onto a TCanvas. More...

virtual void	add (std::vector< PrimitivePtr_t > &&drawMe) override final

virtual double	corner (const AxisRanges r) const override final
	Retrieves a corner coordinate of the drawn canvas. More...

virtual void	setRangeScale (const double s, bool quadCan) override final
	To ensure that the drawn objects are not cut by the axis limits, a flat scale-factor on the drawn axis intervals can be applied. More...

virtual void	trash () override final
	If no object has been drawn mark the plot as junk. More...

const PrimitiveVec_t &	primitives () const

PrimitiveVec_t &	primitives ()

virtual void	setAxisTitles (const std::string &xTitle, const std::string &yTitle, const std::string &zTitle) override final
	Define the titles of the Canvas axes. More...

const std::string &	xTitle () const
	Returns the title of the x-axis. More...

const std::string &	yTitle () const
	Returns the title of the y-axis. More...

const std::string &	zTitle () const
	Returns the title of the z-axis. More...

std::size_t	event () const
	Event number in which the canvas has been created. More...

const std::string &	name () const
	Name of the canvas. More...

bool	trashed () const
	Returns whether the canvas has been trashed. More...

virtual void	add (PrimitiveVec_t &&drawMe)=0
	Add a vector of TObjects to the ICanvasObject for later drawing onto a TCanvas. More...

Private Attributes
Range2D_t	m_axisRanges {Acts::filledArray<Range_t, 2>(Range_t{s_dblMax, -s_dblMax})}

double	m_axisScale {1.}

PrimitiveVec_t	m_primitives {}

std::string	m_name {}

std::size_t	m_evt {}

std::string	m_xTitle {}

std::string	m_yTitle {}

std::string	m_zTitle {}

bool	m_quadCan {false}

std::atomic< bool >	m_isTrashed {false}

Static Private Attributes
static constexpr double	s_dblMax = std::numeric_limits<double>::max()

Detailed Description

Definition at line 14 of file DrawCanvasObject.h.

Member Typedef Documentation

◆ PrimitivePtr_t

using MuonValR4::detail::DrawCanvasObject::PrimitivePtr_t = IRootVisualizationService::PrimitivePtr_t

Definition at line 16 of file DrawCanvasObject.h.

◆ PrimitiveVec_t

using MuonValR4::detail::DrawCanvasObject::PrimitiveVec_t = std::vector<std::pair<PrimitivePtr_t, std::string> >

Definition at line 17 of file DrawCanvasObject.h.

◆ Range2D_t

using MuonValR4::detail::DrawCanvasObject::Range2D_t = std::array<Range_t, 2>

Definition at line 19 of file DrawCanvasObject.h.

◆ Range_t

using MuonValR4::detail::DrawCanvasObject::Range_t = std::array<double, 2>

Definition at line 18 of file DrawCanvasObject.h.

Member Enumeration Documentation

◆ AxisRanges

enum MuonValR4::IRootVisualizationService::ICanvasObject::AxisRanges : std::uint8_t

stronginherited

Enum to select the corner coordinates shown by the plot.

Enumerator
xLow
xHigh
yLow
yHigh

Definition at line 66 of file IRootVisualizationService.h.

                                          : std::uint8_t{
                         xLow, xHigh, yLow, yHigh
                     };

Constructor & Destructor Documentation

◆ DrawCanvasObject()

MuonValR4::detail::DrawCanvasObject::DrawCanvasObject	(	const std::string &	canvasName,
		const std::size_t	evtNumber
	)

Definition at line 21 of file DrawCanvasObject.cxx.

                                                                  :
         m_name{canvasName},
         m_evt{evtNumber}{}

◆ ~DrawCanvasObject()

virtual MuonValR4::detail::DrawCanvasObject::~DrawCanvasObject ( )

virtualdefault

Member Function Documentation

◆ add() [1/3]

void MuonValR4::detail::DrawCanvasObject::add	(	PrimitivePtr_t &&	drawMe,
		const std::string &	drawOpt = `""`
	)

finaloverridevirtual

Add a TObject to the ICanvasObject for later drawing onto a TCanvas.

Parameters

drawMe	Unique_ptr to the object to be drawn
drawOpt	Option to be parsed to the draw command later (e.g. HIST)

Implements MuonValR4::IRootVisualizationService::ICanvasObject.

Definition at line 60 of file DrawCanvasObject.cxx.

                                                                                 {
         m_primitives.emplace_back(std::move(drawMe), drawOpt);
     }

◆ add() [2/3]

virtual void MuonValR4::IRootVisualizationService::ICanvasObject::add ( PrimitiveVec_t && drawMe )

pure virtualinherited

Add a vector of TObjects to the ICanvasObject for later drawing onto a TCanvas.

Parameters

drawMe List of unique TObject pointers

◆ add() [3/3]

void MuonValR4::detail::DrawCanvasObject::add ( std::vector< PrimitivePtr_t > && drawMe )

finaloverridevirtual

Definition at line 63 of file DrawCanvasObject.cxx.

                                                                   {
         for (PrimitivePtr_t& obj : drawMe) {
             add(std::move(obj));
         }
     }

◆ corner()

double MuonValR4::detail::DrawCanvasObject::corner ( const AxisRanges r ) const

finaloverridevirtual

Retrieves a corner coordinate of the drawn canvas.

Parameters

r	Coordinate to return

Implements MuonValR4::IRootVisualizationService::ICanvasObject.

Definition at line 26 of file DrawCanvasObject.cxx.

                                                             {
         const double deltaX = 0.5*(m_axisRanges[0][1] - m_axisRanges[0][0]) * m_axisScale;
         const double deltaY = 0.5*(m_axisRanges[1][1] - m_axisRanges[1][0]) * m_axisScale;
         switch (r) {
             using enum AxisRanges;
             case xLow:
             case xHigh: {
                 const double mid   = 0.5*(m_axisRanges[0][1] + m_axisRanges[0][0]);
                 return mid + (r == xLow ? -1. : 1.) * std::max(deltaX, deltaY * (1. -2.*m_quadCan));
             } case yLow:
               case yHigh: {
                 const double mid   = 0.5*(m_axisRanges[1][1] + m_axisRanges[1][0]);
                 return mid + (r == yLow ? -1. : 1.) * std::max(deltaY, deltaX * (1. -2.*m_quadCan));
             }
         }
         return s_dblMax;
     }

◆ event()

std::size_t MuonValR4::detail::DrawCanvasObject::event ( ) const

Event number in which the canvas has been created.

Definition at line 50 of file DrawCanvasObject.cxx.

50 { return m_evt; }

◆ expandPad()

void MuonValR4::detail::DrawCanvasObject::expandPad	(	const double	x,
		const double	y
	)

finaloverridevirtual

Expands the axes of the pad such that the coordinates are guaranteed to appear at least at the Canvas edges.

Parameters

x	Expansion in the width of the canvas
y	Expansion in the height of the canvas

Implements MuonValR4::IRootVisualizationService::ICanvasObject.

Definition at line 56 of file DrawCanvasObject.cxx.

                                                                    {
         expand(x, m_axisRanges[0]);
         expand(y, m_axisRanges[1]);
     }

◆ name()

const std::string & MuonValR4::detail::DrawCanvasObject::name ( ) const

Name of the canvas.

Definition at line 49 of file DrawCanvasObject.cxx.

49 { return m_name; }

◆ primitives() [1/2]

PrimitiveVec_t & MuonValR4::detail::DrawCanvasObject::primitives ( )

Definition at line 55 of file DrawCanvasObject.cxx.

55 { return m_primitives; }

◆ primitives() [2/2]

const PrimitiveVec_t & MuonValR4::detail::DrawCanvasObject::primitives ( ) const

Definition at line 54 of file DrawCanvasObject.cxx.

54 { return m_primitives; }

◆ setAxisTitles()

void MuonValR4::detail::DrawCanvasObject::setAxisTitles	(	const std::string &	xTitle,
		const std::string &	yTitle,
		const std::string &	zTitle
	)

finaloverridevirtual

Define the titles of the Canvas axes.

Parameters

xTitle	Title pf the x-axis
yTitle	Title pf the y-axis
zTitle	Title pf the z-axis

Implements MuonValR4::IRootVisualizationService::ICanvasObject.

Definition at line 68 of file DrawCanvasObject.cxx.

                                                                  {
         assignIfNotEmpty(xTitle, m_xTitle);
         assignIfNotEmpty(yTitle, m_yTitle);
         assignIfNotEmpty(zTitle, m_zTitle);
     }

◆ setRangeScale()

void MuonValR4::detail::DrawCanvasObject::setRangeScale	(	const double	s,
		bool	quadCan
	)

finaloverridevirtual

To ensure that the drawn objects are not cut by the axis limits, a flat scale-factor on the drawn axis intervals can be applied.

Parameters

s	scale-factor >1.
quadCan	Switch toggling whether the drawn intervals have an equal size

Implements MuonValR4::IRootVisualizationService::ICanvasObject.

Definition at line 43 of file DrawCanvasObject.cxx.

                                                                      { 
         m_axisScale = std::max(1., s); 
         m_quadCan = quadCan;
     }

◆ trash()

void MuonValR4::detail::DrawCanvasObject::trash ( )

finaloverridevirtual

If no object has been drawn mark the plot as junk.

Implements MuonValR4::IRootVisualizationService::ICanvasObject.

Definition at line 47 of file DrawCanvasObject.cxx.

47 { m_isTrashed = true; }

◆ trashed()

bool MuonValR4::detail::DrawCanvasObject::trashed ( ) const

Returns whether the canvas has been trashed.

Definition at line 48 of file DrawCanvasObject.cxx.

48 { return m_isTrashed; }

◆ xTitle()

const std::string & MuonValR4::detail::DrawCanvasObject::xTitle ( ) const

Returns the title of the x-axis.

Definition at line 51 of file DrawCanvasObject.cxx.

51 { return m_xTitle; }

◆ yTitle()

const std::string & MuonValR4::detail::DrawCanvasObject::yTitle ( ) const

Returns the title of the y-axis.

Definition at line 52 of file DrawCanvasObject.cxx.

52 { return m_yTitle; }

◆ zTitle()

const std::string & MuonValR4::detail::DrawCanvasObject::zTitle ( ) const

Returns the title of the z-axis.

Definition at line 53 of file DrawCanvasObject.cxx.

53 { return m_zTitle; }

Member Data Documentation

◆ m_axisRanges

Range2D_t MuonValR4::detail::DrawCanvasObject::m_axisRanges {Acts::filledArray<Range_t, 2>(Range_t{s_dblMax, -s_dblMax})}

private

Definition at line 57 of file DrawCanvasObject.h.

◆ m_axisScale

double MuonValR4::detail::DrawCanvasObject::m_axisScale {1.}

private

Definition at line 58 of file DrawCanvasObject.h.

◆ m_evt

std::size_t MuonValR4::detail::DrawCanvasObject::m_evt {}

private

Definition at line 62 of file DrawCanvasObject.h.

◆ m_isTrashed

std::atomic<bool> MuonValR4::detail::DrawCanvasObject::m_isTrashed {false}

private

Definition at line 69 of file DrawCanvasObject.h.

◆ m_name

std::string MuonValR4::detail::DrawCanvasObject::m_name {}

private

Definition at line 61 of file DrawCanvasObject.h.

◆ m_primitives

PrimitiveVec_t MuonValR4::detail::DrawCanvasObject::m_primitives {}

private

Definition at line 59 of file DrawCanvasObject.h.

◆ m_quadCan

bool MuonValR4::detail::DrawCanvasObject::m_quadCan {false}

private

Definition at line 68 of file DrawCanvasObject.h.

◆ m_xTitle

std::string MuonValR4::detail::DrawCanvasObject::m_xTitle {}

private

Definition at line 64 of file DrawCanvasObject.h.

◆ m_yTitle

std::string MuonValR4::detail::DrawCanvasObject::m_yTitle {}

private

Definition at line 65 of file DrawCanvasObject.h.

◆ m_zTitle

std::string MuonValR4::detail::DrawCanvasObject::m_zTitle {}

private

Definition at line 66 of file DrawCanvasObject.h.

◆ s_dblMax

constexpr double MuonValR4::detail::DrawCanvasObject::s_dblMax = std::numeric_limits<double>::max()

staticconstexprprivate

Definition at line 56 of file DrawCanvasObject.h.

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

Public Types

Public Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ PrimitivePtr_t

◆ PrimitiveVec_t

◆ Range2D_t

◆ Range_t

Member Enumeration Documentation

◆ AxisRanges

Constructor & Destructor Documentation

◆ DrawCanvasObject()

◆ ~DrawCanvasObject()

Member Function Documentation

◆ add() [1/3]

◆ add() [2/3]

◆ add() [3/3]

◆ corner()

◆ event()

◆ expandPad()

◆ name()

◆ primitives() [1/2]

◆ primitives() [2/2]

◆ setAxisTitles()

◆ setRangeScale()

◆ trash()

◆ trashed()

◆ xTitle()

◆ yTitle()

◆ zTitle()

Member Data Documentation

◆ m_axisRanges

◆ m_axisScale

◆ m_evt

◆ m_isTrashed

◆ m_name

◆ m_primitives

◆ m_quadCan

◆ m_xTitle

◆ m_yTitle

◆ m_zTitle

◆ s_dblMax