ActsPlugins::Svg Namespace Reference

Namespaces
namespace	EventDataConverter
	Utilities to convert event data to SVG objects.
namespace	GridConverter
namespace	IndexedSurfacesConverter
namespace	LayerConverter
namespace	Sheet
namespace	SurfaceArrayConverter
	Utilities to convert a surface array into proto objects for SVG output.
namespace	SurfaceConverter
namespace	TrackingGeometryConverter
namespace	TrackingGeometryProjections
namespace	View

Classes
struct	Style
	Style struct. More...

Typedefs
using	ProtoAssociations = std::vector<std::vector<std::size_t>>
using	ProtoGrid = actsvg::proto::grid
using	ProtoIndexedSurfaceGrid
using	ProtoLink = ProtoPortal::link
using	ProtoPortal = actsvg::proto::portal<std::vector<Acts::Vector3>>
using	ProtoSurface = actsvg::proto::surface<std::vector<Acts::Vector3>>
using	ProtoSurfaces = std::vector<ProtoSurface>
using	ProtoVolume = actsvg::proto::volume<std::vector<Acts::Vector3>>

Functions
static actsvg::svg::object	axesXY (double xMin, double xMax, double yMin, double yMax)
std::vector< actsvg::svg::object >	drawSurfaceArrays (const Acts::GeometryContext &gctx, const Acts::TrackingGeometry &tGeometry)
std::vector< actsvg::svg::object >	drawTrackingGeometry (const Acts::GeometryContext &gctx, const Acts::TrackingGeometry &tGeometry, std::variant< actsvg::views::x_y, actsvg::views::z_r > view, bool drawSurfaces=true, bool highlightMaterial=false)
static actsvg::svg::object	group (const std::vector< actsvg::svg::object > &objects, const std::string &name)
	Create a group.
static actsvg::svg::object	infoBox (double xPos, double yPos, const std::string &title, const Style &titleStyle, const std::vector< std::string > &info, const Style &infoStyle, const actsvg::svg::object &object, const std::vector< std::string > &highlights={"mouseover", "mouseout"})
static actsvg::svg::object	measure (double xStart, double yStart, double xEnd, double yEnd, const std::string &variable="", double value=0., const std::string &unit="")
	Helper method to a measure.
static void	toFile (const std::vector< actsvg::svg::object > &objects, const std::string &fileName)
	Helper method to write to file.

Variables
static const Style	defaultGridStyle
	Default style for grid objects.
static const Style	defaultSensitiveStyle
	Default style for sensitive objects.
static const std::array< double, 2 >	noLimitPhi
static const std::array< double, 2 >	noLimitZ

Typedef Documentation

ProtoAssociations

using ActsPlugins::Svg::ProtoAssociations = std::vector<std::vector<std::size_t>>

ProtoGrid

using ActsPlugins::Svg::ProtoGrid = actsvg::proto::grid

ProtoIndexedSurfaceGrid

using ActsPlugins::Svg::ProtoIndexedSurfaceGrid

Initial value:

 
    std::tuple<ProtoSurfaces, ProtoGrid, ProtoAssociations>

ProtoLink

using ActsPlugins::Svg::ProtoLink = ProtoPortal::link

ProtoPortal

using ActsPlugins::Svg::ProtoPortal = actsvg::proto::portal<std::vector<Acts::Vector3>>

ProtoSurface

using ActsPlugins::Svg::ProtoSurface = actsvg::proto::surface<std::vector<Acts::Vector3>>

ProtoSurfaces

using ActsPlugins::Svg::ProtoSurfaces = std::vector<ProtoSurface>

ProtoVolume

using ActsPlugins::Svg::ProtoVolume = actsvg::proto::volume<std::vector<Acts::Vector3>>

Function Documentation

axesXY()

actsvg::svg::object ActsPlugins::Svg::axesXY ( double xMin, double xMax, double yMin, double yMax )

static

Parameters

xMin	the minimum x value
xMax	the maximum x value
yMin	the minimum y value
yMax	the maximum y value

Returns

an svg object

drawSurfaceArrays()

std::vector< actsvg::svg::object > ActsPlugins::Svg::drawSurfaceArrays ( const Acts::GeometryContext & gctx, const Acts::TrackingGeometry & tGeometry )

nodiscard

drawTrackingGeometry()

std::vector< actsvg::svg::object > ActsPlugins::Svg::drawTrackingGeometry ( const Acts::GeometryContext & gctx, const Acts::TrackingGeometry & tGeometry, std::variant< actsvg::views::x_y, actsvg::views::z_r > view, bool drawSurfaces = true, bool highlightMaterial = false )

nodiscard

group()

actsvg::svg::object ActsPlugins::Svg::group ( const std::vector< actsvg::svg::object > & objects, const std::string & name )

static

Create a group.

Parameters

objects	are the individual objects to be grouped
name	is the name of the group

Returns

a single svg object as a group

infoBox()

actsvg::svg::object ActsPlugins::Svg::infoBox ( double xPos, double yPos, const std::string & title, const Style & titleStyle, const std::vector< std::string > & info, const Style & infoStyle, const actsvg::svg::object & object, const std::vector< std::string > & highlights = {"mouseover", "mouseout"} )

static

Parameters

xPos	the minimum x value
yPos	the maximum x value
title	the title of the info box
titleStyle	the title of the info box
info	the text of the info box
infoStyle	the style of the info box (body)
object	the connected object
highlights	the highlight events

Returns

an svg object

measure()

actsvg::svg::object ActsPlugins::Svg::measure ( double xStart, double yStart, double xEnd, double yEnd, const std::string & variable = "", double value = 0., const std::string & unit = "" )

static

Helper method to a measure.

Parameters

xStart	the start position x
yStart	the start position y
xEnd	the end position x
yEnd	the end position y
variable	the variable name
value	the value
unit	the unit

Returns

a single svg object as a measure

toFile()

void ActsPlugins::Svg::toFile ( const std::vector< actsvg::svg::object > & objects, const std::string & fileName )

static

Helper method to write to file.

Parameters

objects	to be written out
fileName	the file name is to be given

Variable Documentation

defaultGridStyle

const Style ActsPlugins::Svg::defaultGridStyle

static

Initial value:

{{0, 0, 0},
                                           0.0,
                                           {100, 100, 100},
                                           {"mouseover", "mouseout"},
                                           0.25,
                                           {0, 0, 0},
                                           3.,
                                           {0, 0, 0},
                                           {},
                                           14u,
                                           {0},
                                           72u}

Default style for grid objects.

defaultSensitiveStyle

const Style ActsPlugins::Svg::defaultSensitiveStyle

static

Initial value:

{{66, 166, 245},
                                                0.85,
                                                {245, 166, 66},
                                                {"mouseover", "mouseout"},
                                                0.25,
                                                {0, 0, 0},
                                                2.,
                                                {0, 0, 0},
                                                {},
                                                14u,
                                                {0},
                                                72u}

Default style for sensitive objects.

noLimitPhi

const std::array<double, 2> ActsPlugins::Svg::noLimitPhi

static

Initial value:

= {-std::numbers::pi,
                                                 std::numbers::pi}

noLimitZ

const std::array<double, 2> ActsPlugins::Svg::noLimitZ

static

Initial value:

= {
    std::numeric_limits<double>::lowest(), std::numeric_limits<double>::max()}