SelectionDiagram Namespace Reference

Functions
TString	Dot (const std::vector< SelectionStep > &steps, const TString &title)
	The steps as a Graphviz DOT graph.
TString	Mermaid (const std::vector< SelectionStep > &steps, const TString &title)
	The steps as a Mermaid flowchart.
void	Write (const std::vector< SelectionStep > &steps, const TString &dir, const TString &title)
	Write selection.dot and selection.mmd under dir, and render the DOT to selection.png and selection.pdf when dot is available.

Function Documentation

Dot()

TString SelectionDiagram::Dot	(	const std::vector< SelectionStep > &	steps,
		const TString &	title )

The steps as a Graphviz DOT graph.

Parameters

steps	From StripSumScatter::DescribeSelection().
title	Graph title, e.g. "37Cl event selection".

Definition at line 131 of file SelectionDiagram.cpp.

Referenced by Write().

Mermaid()

TString SelectionDiagram::Mermaid	(	const std::vector< SelectionStep > &	steps,
		const TString &	title )

The steps as a Mermaid flowchart.

Parameters

steps	From StripSumScatter::DescribeSelection().
title	Chart title (a --- front-matter block).

Definition at line 209 of file SelectionDiagram.cpp.

Referenced by Write().

Write()

void SelectionDiagram::Write	(	const std::vector< SelectionStep > &	steps,
		const TString &	dir,
		const TString &	title )

Write selection.dot and selection.mmd under dir, and render the DOT to selection.png and selection.pdf when dot is available.

Parameters

steps	From StripSumScatter::DescribeSelection().
dir	Output directory, created if missing.
title	Diagram title.

Definition at line 257 of file SelectionDiagram.cpp.

Referenced by StripSumScatter::Prepare().