RooJSONFactoryWSTool Class Reference

When using RooFit, statistical models can be conveniently handled and stored as a RooWorkspace.

However, for the sake of interoperability with other statistical frameworks, and also ease of manipulation, it may be useful to store statistical models in text form.

The RooJSONFactoryWSTool is a helper class to achieve exactly this, exporting to and importing from JSON.

In order to import a workspace from a JSON file, you can do

ws = ROOT.RooWorkspace("ws")
tool = ROOT.RooJSONFactoryWSTool(ws)
tool.importJSON("myjson.json")

Similarly, in order to export a workspace to a JSON file, you can do

tool = ROOT.RooJSONFactoryWSTool(ws)
tool.exportJSON("myjson.json")

Analogously, in C++, you can do

#include "RooFitHS3/RooJSONFactoryWSTool.h"
// ...
RooWorkspace ws("ws");
RooJSONFactoryWSTool tool(ws);
tool.importJSON("myjson.json");

and

#include "RooFitHS3/RooJSONFactoryWSTool.h"
// ...
RooJSONFactoryWSTool tool(ws);
tool.exportJSON("myjson.json");

For more details, consult the tutorial rf515_hfJSON.

The RooJSONFactoryWSTool only knows about a limited set of classes for import and export. If import or export of a class you're interested in fails, you might need to add your own importer or exporter. Please consult the relevant section in the RooFit Developer Documentation to learn how to do that (Implement JSON I/O for a RooFit class with RooFit HS3).

You can always get a list of all the available importers and exporters by calling the following functions:

ROOT.RooFit.JSONIO.printImporters()
ROOT.RooFit.JSONIO.printExporters()
ROOT.RooFit.JSONIO.printFactoryExpressions()
ROOT.RooFit.JSONIO.printExportKeys()

Alternatively, you can generate a LaTeX version of the available importers and exporters by calling

tool = ROOT.RooJSONFactoryWSTool(ws)
tool.writedoc("hs3.tex")

Definition at line 38 of file RooJSONFactoryWSTool.h.

Classes
struct	CombinedData
class	DependencyMissingError

Public Member Functions
	RooJSONFactoryWSTool (RooWorkspace &ws)
	~RooJSONFactoryWSTool ()
void	exportCategory (RooAbsCategory const &cat, RooFit::Detail::JSONNode &node)
	Export a RooAbsCategory object to a JSONNode.
bool	exportJSON (std::ostream &os)
	Export the workspace to JSON format and write to the output stream.
bool	exportJSON (std::string const &fileName)
	Export the workspace to JSON format and write to the specified file.
std::string	exportJSONtoString ()
	Export the workspace to a JSON string.
std::string	exportTransformed (const RooAbsReal *original, const std::string &suffix, const std::string &formula)
bool	exportYML (std::ostream &os)
	Export the workspace to YML format and write to the output stream.
bool	exportYML (std::string const &fileName)
	Export the workspace to YML format and write to the specified file.
std::string	exportYMLtoString ()
	Export the workspace to a YML string.
std::string	getStringAttribute (const std::string &obj, const std::string &attrib)
bool	hasAttribute (const std::string &obj, const std::string &attrib)
void	importFunction (const RooFit::Detail::JSONNode &n, bool importAllDependants)
	Import a function from the JSONNode into the workspace.
void	importFunction (const std::string &jsonString, bool importAllDependants)
	Import a function from a JSON string into the workspace.
bool	importJSON (std::istream &os)
	Imports a JSON file from the given input stream to the workspace.
bool	importJSON (std::string const &filename)
	Imports a JSON file from the given filename to the workspace.
void	importJSONElement (const std::string &name, const std::string &jsonString)
bool	importJSONfromString (const std::string &s)
	Import the workspace from a JSON string.
void	importVariableElement (const RooFit::Detail::JSONNode &n)
bool	importYML (std::istream &os)
	Imports a YML file from the given input stream to the workspace.
bool	importYML (std::string const &filename)
	Imports a YML file from the given filename to the workspace.
bool	importYMLfromString (const std::string &s)
	Import the workspace from a YML string.
void	queueExport (RooAbsArg const &arg)
void	queueExportTemporary (RooAbsArg *arg)
template<class T >
T *	request (const std::string &objname, const std::string &requestAuthor)
template<class T >
T *	requestArg (const RooFit::Detail::JSONNode &node, const std::string &key)
template<class T >
RooArgList	requestArgList (const RooFit::Detail::JSONNode &node, const std::string &seqName)
template<class T >
RooArgSet	requestArgSet (const RooFit::Detail::JSONNode &node, const std::string &seqName)
template<class T , class Coll_t >
Coll_t	requestCollection (const RooFit::Detail::JSONNode &node, const std::string &seqName)
void	setAttribute (const std::string &obj, const std::string &attrib)
void	setStringAttribute (const std::string &obj, const std::string &attrib, const std::string &value)
RooWorkspace *	workspace ()
template<class Obj_t , typename... Args_t>
Obj_t &	wsEmplace (RooStringView name, Args_t &&...args)
template<class Obj_t >
Obj_t &	wsImport (Obj_t const &obj)

Static Public Member Functions
static RooFit::Detail::JSONNode &	appendNamedChild (RooFit::Detail::JSONNode &node, std::string const &name)
static RooWorkspace	cleanWS (const RooWorkspace &ws, bool onlyModelConfig=false)
static std::unique_ptr< RooFit::Detail::JSONTree >	createNewJSONTree ()
	Create a new JSON tree with version information.
static void	error (const char *s)
	Writes an error message to the RooFit message service and throws a runtime_error.
static void	error (const std::string &s)
static void	exportArray (std::size_t n, double const *contents, RooFit::Detail::JSONNode &output)
	Export an array of doubles to a JSONNode.
static void	exportHisto (RooArgSet const &vars, std::size_t n, double const *contents, RooFit::Detail::JSONNode &output)
	Export histogram data to a JSONNode.
static void	fillSeq (RooFit::Detail::JSONNode &node, RooAbsCollection const &coll, size_t nMax=-1)
static void	fillSeqSanitizedName (RooFit::Detail::JSONNode &node, RooAbsCollection const &coll, size_t nMax=-1)
static RooFit::Detail::JSONNode const *	findNamedChild (RooFit::Detail::JSONNode const &node, std::string const &name)
template<typename... Keys_t>
static RooFit::Detail::JSONNode &	getRooFitInternal (RooFit::Detail::JSONNode &node, Keys_t const &...keys)
static bool	isValidName (const std::string &str)
	Check if a string is a valid name.
static RooFit::Detail::JSONNode &	makeVariablesNode (RooFit::Detail::JSONNode &rootNode)
static std::string	name (const RooFit::Detail::JSONNode &n)
static RooArgSet	readAxes (const RooFit::Detail::JSONNode &node)
	Read axes from the JSONNode and create a RooArgSet representing them.
static std::unique_ptr< RooDataHist >	readBinnedData (const RooFit::Detail::JSONNode &n, const std::string &namecomp, RooArgSet const &vars)
	Read binned data from the JSONNode and create a RooDataHist object.
static void	rebuildModelConfigInWorkspace (RooStats::ModelConfig *mc, RooWorkspace &ws)
static std::string	sanitizeName (const std::string str)
	Cleans up names to the HS3 standard.
static RooWorkspace	sanitizeWS (const RooWorkspace &ws)
static bool	testValidName (const std::string &str, bool forcError)
static std::ostream &	warning (const std::string &s)
	Writes a warning message to the RooFit message service.

Static Public Attributes
static bool	allowExportInvalidNames
static bool	allowSanitizeNames
static constexpr bool	useListsInsteadOfDicts = true

Private Member Functions
void	exportAllObjects (RooFit::Detail::JSONNode &n)
	Export all objects in the workspace to a JSONNode.
RooJSONFactoryWSTool::CombinedData	exportCombinedData (RooAbsData const &data)
	Export combined data from the workspace to a custom struct.
void	exportData (RooAbsData const &data)
	Export data from the workspace to a JSONNode.
void	exportModelConfig (RooFit::Detail::JSONNode &rootnode, RooStats::ModelConfig const &mc, const std::vector< RooJSONFactoryWSTool::CombinedData > &combined, const std::vector< RooAbsData * > &single)
void	exportObject (RooAbsArg const &func, std::set< std::string > &exportedObjectNames)
	Export an object from the workspace to a JSONNode.
template<class T >
void	exportObjects (T const &args, std::set< std::string > &exportedObjectNames)
void	exportSingleModelConfig (RooFit::Detail::JSONNode &rootnode, RooStats::ModelConfig const &mc, std::string const &analysisName, std::map< std::string, std::string > const *dataComponents)
void	exportVariable (const RooAbsArg *v, RooFit::Detail::JSONNode &n)
	Export a variable from the workspace to a JSONNode.
void	exportVariables (const RooArgSet &allElems, RooFit::Detail::JSONNode &n)
	Export variables from the workspace to a JSONNode.
void	importAllNodes (const RooFit::Detail::JSONNode &n)
	Imports all nodes of the JSON data and adds them to the workspace.
void	importDependants (const RooFit::Detail::JSONNode &n)
	Import all dependants (servers) of a node into the workspace.
void	importVariable (const RooFit::Detail::JSONNode &n)
	Import a variable from the JSONNode into the workspace.
template<class T >
T *	requestImpl (const std::string &objname)
template<>
RooRealVar *	requestImpl (const std::string &objname)
template<>
RooAbsPdf *	requestImpl (const std::string &objname)
template<>
RooAbsReal *	requestImpl (const std::string &objname)

Private Attributes
const RooFit::Detail::JSONNode *	_attributesNode = nullptr
std::unique_ptr< RooFit::JSONIO::Detail::Domains >	_domains
const RooFit::Detail::JSONNode *	_rootnodeInput = nullptr
RooFit::Detail::JSONNode *	_rootnodeOutput = nullptr
std::vector< RooAbsArg const * >	_serversToDelete
std::vector< RooAbsArg const * >	_serversToExport
RooFit::Detail::JSONNode *	_varsNode = nullptr
RooWorkspace &	_workspace

#include <RooFitHS3/RooJSONFactoryWSTool.h>

Constructor & Destructor Documentation

RooJSONFactoryWSTool()

RooJSONFactoryWSTool::RooJSONFactoryWSTool

(

RooWorkspace &

ws

)

Definition at line 819 of file RooJSONFactoryWSTool.cxx.

~RooJSONFactoryWSTool()

RooJSONFactoryWSTool::~RooJSONFactoryWSTool

(

)

Definition at line 821 of file RooJSONFactoryWSTool.cxx.

Member Function Documentation

appendNamedChild()

JSONNode & RooJSONFactoryWSTool::appendNamedChild ( RooFit::Detail::JSONNode & node, std::string const & name )

static

Definition at line 863 of file RooJSONFactoryWSTool.cxx.

cleanWS()

RooWorkspace RooJSONFactoryWSTool::cleanWS ( const RooWorkspace & ws, bool onlyModelConfig = false )

static

Definition at line 2476 of file RooJSONFactoryWSTool.cxx.

createNewJSONTree()

std::unique_ptr< JSONTree > RooJSONFactoryWSTool::createNewJSONTree ( )

static

Create a new JSON tree with version information.

Returns

std::unique_ptr<JSONTree> A unique pointer to the created JSON tree.

Definition at line 2069 of file RooJSONFactoryWSTool.cxx.

error() [1/2]

void RooJSONFactoryWSTool::error ( const char * s )

static

Writes an error message to the RooFit message service and throws a runtime_error.

Parameters

s	The error message to be logged and thrown.

Returns

void

Definition at line 2437 of file RooJSONFactoryWSTool.cxx.

error() [2/2]

static void RooJSONFactoryWSTool::error ( const std::string & s )

inlinestatic

Definition at line 132 of file RooJSONFactoryWSTool.h.

exportAllObjects()

void RooJSONFactoryWSTool::exportAllObjects ( RooFit::Detail::JSONNode & n )

private

Export all objects in the workspace to a JSONNode.

This function exports all the objects in the workspace to the provided JSONNode. The objects' information is added as key-value pairs to the JSONNode.

Parameters

n	The JSONNode to which the objects will be exported.

Returns

void

Definition at line 1921 of file RooJSONFactoryWSTool.cxx.

exportArray()

void RooJSONFactoryWSTool::exportArray ( std::size_t n, double const * contents, RooFit::Detail::JSONNode & output )

static

Export an array of doubles to a JSONNode.

This function exports an array of doubles, represented by the provided size and contents, to a JSONNode. The array elements are added to the JSONNode as a sequence of values.

Parameters

n	The size of the array.
contents	A pointer to the array containing the double values.
output	The JSONNode to which the array will be exported.

Returns

void

Definition at line 1395 of file RooJSONFactoryWSTool.cxx.

exportCategory()

void RooJSONFactoryWSTool::exportCategory	(	RooAbsCategory const &	cat,
		RooFit::Detail::JSONNode &	node )

Export a RooAbsCategory object to a JSONNode.

This function exports a RooAbsCategory object, represented by the provided categories and indices, to a JSONNode. The category labels and corresponding indices are added to the JSONNode as key-value pairs.

Parameters

cat	The RooAbsCategory object to be exported.
node	The JSONNode to which the category data will be exported.

Returns

void

Definition at line 1419 of file RooJSONFactoryWSTool.cxx.

exportCombinedData()

RooJSONFactoryWSTool::CombinedData RooJSONFactoryWSTool::exportCombinedData ( RooAbsData const & data )

private

Export combined data from the workspace to a custom struct.

This function exports combined data from the workspace, represented by the provided RooAbsData object, to a CombinedData struct. The struct contains information such as variables, categories, and bin contents of the combined data.

Parameters

data	The RooAbsData object representing the combined data to be exported.

Returns

CombinedData A custom struct containing the exported combined data.

Definition at line 1452 of file RooJSONFactoryWSTool.cxx.

exportData()

void RooJSONFactoryWSTool::exportData ( RooAbsData const & data )

private

Export data from the workspace to a JSONNode.

This function exports data represented by the provided RooAbsData object, to a JSONNode. The data's information is added as key-value pairs to the JSONNode.

Parameters

data	The RooAbsData object representing the data to be exported.

Returns

void

Definition at line 1527 of file RooJSONFactoryWSTool.cxx.

exportHisto()

void RooJSONFactoryWSTool::exportHisto ( RooArgSet const & vars, std::size_t n, double const * contents, RooFit::Detail::JSONNode & output )

static

Export histogram data to a JSONNode.

This function exports histogram data, represented by the provided variables and contents, to a JSONNode. The histogram's axes information and bin contents are added as key-value pairs to the JSONNode.

Parameters

vars	The RooArgSet representing the variables associated with the histogram.
n	The number of bins in the histogram.
contents	A pointer to the array containing the bin contents of the histogram.
output	The JSONNode to which the histogram data will be exported.

Returns

void

Definition at line 1356 of file RooJSONFactoryWSTool.cxx.

exportJSON() [1/2]

bool RooJSONFactoryWSTool::exportJSON

(

std::ostream &

os

)

Export the workspace to JSON format and write to the output stream.

Parameters

os	The output stream to write the JSON data to.

Returns

bool Returns true on successful export, false otherwise.

Definition at line 2096 of file RooJSONFactoryWSTool.cxx.

exportJSON() [2/2]

bool RooJSONFactoryWSTool::exportJSON

(

std::string const &

filename

)

Export the workspace to JSON format and write to the specified file.

Parameters

filename

The name of the JSON file to create and write the data to.

Returns

bool Returns true on successful export, false otherwise.

Definition at line 2111 of file RooJSONFactoryWSTool.cxx.

exportJSONtoString()

std::string RooJSONFactoryWSTool::exportJSONtoString

(

)

Export the workspace to a JSON string.

Returns

std::string The JSON string representing the exported workspace.

Definition at line 2045 of file RooJSONFactoryWSTool.cxx.

exportModelConfig()

void RooJSONFactoryWSTool::exportModelConfig ( RooFit::Detail::JSONNode & rootnode, RooStats::ModelConfig const & mc, const std::vector< RooJSONFactoryWSTool::CombinedData > & combined, const std::vector< RooAbsData * > & single )

private

Definition at line 1782 of file RooJSONFactoryWSTool.cxx.

exportObject()

void RooJSONFactoryWSTool::exportObject ( RooAbsArg const & func, std::set< std::string > & exportedObjectNames )

private

Export an object from the workspace to a JSONNode.

This function exports an object, represented by the provided RooAbsArg, from the workspace to a JSONNode. The object's information is added to the JSONNode as key-value pairs.

Parameters

func	The RooAbsArg representing the object to be exported.
exportedObjectNames	A set of strings containing names of previously exported objects to avoid duplicates. This set is updated with the name of the newly exported object.

Returns

void

Definition at line 1082 of file RooJSONFactoryWSTool.cxx.

exportObjects()

template<class T >

void RooJSONFactoryWSTool::exportObjects ( T const & args, std::set< std::string > & exportedObjectNames )

inlineprivate

Definition at line 212 of file RooJSONFactoryWSTool.h.

exportSingleModelConfig()

void RooJSONFactoryWSTool::exportSingleModelConfig ( RooFit::Detail::JSONNode & rootnode, RooStats::ModelConfig const & mc, std::string const & analysisName, std::map< std::string, std::string > const * dataComponents )

private

Definition at line 1817 of file RooJSONFactoryWSTool.cxx.

exportTransformed()

std::string RooJSONFactoryWSTool::exportTransformed	(	const RooAbsReal *	original,
		const std::string &	suffix,
		const std::string &	formula )

Definition at line 1060 of file RooJSONFactoryWSTool.cxx.

exportVariable()

void RooJSONFactoryWSTool::exportVariable ( const RooAbsArg * v, RooFit::Detail::JSONNode & n )

private

Export a variable from the workspace to a JSONNode.

This function exports a variable, represented by the provided RooAbsArg pointer 'v', from the workspace to a JSONNode. The variable's information is added to the JSONNode as key-value pairs.

Parameters

v	The pointer to the RooAbsArg representing the variable to be exported.
node	The JSONNode to which the variable will be exported.

Returns

void

Definition at line 1007 of file RooJSONFactoryWSTool.cxx.

exportVariables()

void RooJSONFactoryWSTool::exportVariables ( const RooArgSet & allElems, RooFit::Detail::JSONNode & n )

private

Export variables from the workspace to a JSONNode.

This function exports variables, represented by the provided RooArgSet, from the workspace to a JSONNode. The variables' information is added to the JSONNode as key-value pairs.

Parameters

allElems	The RooArgSet representing the variables to be exported.
n	The JSONNode to which the variables will be exported.

Returns

void

Definition at line 1051 of file RooJSONFactoryWSTool.cxx.

exportYML() [1/2]

bool RooJSONFactoryWSTool::exportYML

(

std::ostream &

os

)

Export the workspace to YML format and write to the output stream.

Parameters

os	The output stream to write the YML data to.

Returns

bool Returns true on successful export, false otherwise.

Definition at line 2129 of file RooJSONFactoryWSTool.cxx.

exportYML() [2/2]

bool RooJSONFactoryWSTool::exportYML

(

std::string const &

filename

)

Export the workspace to YML format and write to the specified file.

Parameters

filename

The name of the YML file to create and write the data to.

Returns

bool Returns true on successful export, false otherwise.

Definition at line 2144 of file RooJSONFactoryWSTool.cxx.

exportYMLtoString()

std::string RooJSONFactoryWSTool::exportYMLtoString

(

)

Export the workspace to a YML string.

Returns

std::string The YML string representing the exported workspace.

Definition at line 2057 of file RooJSONFactoryWSTool.cxx.

fillSeq()

void RooJSONFactoryWSTool::fillSeq ( RooFit::Detail::JSONNode & node, RooAbsCollection const & coll, size_t nMax = -1 )

static

Definition at line 823 of file RooJSONFactoryWSTool.cxx.

fillSeqSanitizedName()

void RooJSONFactoryWSTool::fillSeqSanitizedName ( RooFit::Detail::JSONNode & node, RooAbsCollection const & coll, size_t nMax = -1 )

static

Definition at line 843 of file RooJSONFactoryWSTool.cxx.

findNamedChild()

JSONNode const * RooJSONFactoryWSTool::findNamedChild ( RooFit::Detail::JSONNode const & node, std::string const & name )

static

Definition at line 873 of file RooJSONFactoryWSTool.cxx.

getRooFitInternal()

template<typename... Keys_t>

static RooFit::Detail::JSONNode & RooJSONFactoryWSTool::getRooFitInternal ( RooFit::Detail::JSONNode & node, Keys_t const &... keys )

inlinestatic

Definition at line 179 of file RooJSONFactoryWSTool.h.

getStringAttribute()

std::string RooJSONFactoryWSTool::getStringAttribute	(	const std::string &	obj,
		const std::string &	attrib )

Definition at line 2178 of file RooJSONFactoryWSTool.cxx.

hasAttribute()

bool RooJSONFactoryWSTool::hasAttribute	(	const std::string &	obj,
		const std::string &	attrib )

Definition at line 2156 of file RooJSONFactoryWSTool.cxx.

importAllNodes()

void RooJSONFactoryWSTool::importAllNodes ( const RooFit::Detail::JSONNode & n )

private

Imports all nodes of the JSON data and adds them to the workspace.

Parameters

n	The JSONNode representing the root node of the JSON data.

Returns

void

Definition at line 2206 of file RooJSONFactoryWSTool.cxx.

importDependants()

void RooJSONFactoryWSTool::importDependants ( const RooFit::Detail::JSONNode & n )

private

Import all dependants (servers) of a node into the workspace.

This function imports all the dependants (servers) of the given JSONNode into the workspace. The dependants' information is read from the JSONNode and added to the workspace.

Parameters

n	The JSONNode representing the node whose dependants are to be imported.

Returns

void

Definition at line 1762 of file RooJSONFactoryWSTool.cxx.

importFunction() [1/2]

void RooJSONFactoryWSTool::importFunction	(	const RooFit::Detail::JSONNode &	n,
		bool	importAllDependants )

Import a function from the JSONNode into the workspace.

This function imports a function from the given JSONNode into the workspace. The function's information is read from the JSONNode and added to the workspace.

Parameters

p	The JSONNode representing the function to be imported.
importAllDependants	A boolean flag indicating whether to import all dependants (servers) of the function.

Returns

void

Definition at line 1234 of file RooJSONFactoryWSTool.cxx.

importFunction() [2/2]

void RooJSONFactoryWSTool::importFunction	(	const std::string &	jsonString,
		bool	importAllDependants )

Import a function from a JSON string into the workspace.

This function imports a function from the provided JSON string into the workspace. The function's information is read from the JSON string and added to the workspace.

Parameters

jsonString	The JSON string containing the function information.
importAllDependants	A boolean flag indicating whether to import all dependants (servers) of the function.

Returns

void

Definition at line 1339 of file RooJSONFactoryWSTool.cxx.

importJSON() [1/2]

bool RooJSONFactoryWSTool::importJSON

(

std::istream &

is

)

Imports a JSON file from the given input stream to the workspace.

Parameters

is	The input stream containing the JSON data.

Returns

bool Returns true on successful import, false otherwise.

Definition at line 2301 of file RooJSONFactoryWSTool.cxx.

importJSON() [2/2]

bool RooJSONFactoryWSTool::importJSON

(

std::string const &

filename

)

Imports a JSON file from the given filename to the workspace.

Parameters

filename

The name of the JSON file to import.

Returns

bool Returns true on successful import, false otherwise.

Definition at line 2318 of file RooJSONFactoryWSTool.cxx.

importJSONElement()

void RooJSONFactoryWSTool::importJSONElement	(	const std::string &	name,
		const std::string &	jsonString )

Definition at line 2364 of file RooJSONFactoryWSTool.cxx.

importJSONfromString()

bool RooJSONFactoryWSTool::importJSONfromString

(

const std::string &

s

)

Import the workspace from a JSON string.

Parameters

s	The JSON string containing the workspace data.

Returns

bool Returns true on successful import, false otherwise.

Definition at line 2022 of file RooJSONFactoryWSTool.cxx.

importVariable()

void RooJSONFactoryWSTool::importVariable ( const RooFit::Detail::JSONNode & n )

private

Import a variable from the JSONNode into the workspace.

This function imports a variable from the given JSONNode into the workspace. The variable's information is read from the JSONNode and added to the workspace.

Parameters

p	The JSONNode representing the variable to be imported.

Returns

void

Definition at line 1727 of file RooJSONFactoryWSTool.cxx.

importVariableElement()

void RooJSONFactoryWSTool::importVariableElement

(

const RooFit::Detail::JSONNode &

n

)

Definition at line 2382 of file RooJSONFactoryWSTool.cxx.

importYML() [1/2]

bool RooJSONFactoryWSTool::importYML

(

std::istream &

is

)

Imports a YML file from the given input stream to the workspace.

Parameters

is	The input stream containing the YML data.

Returns

bool Returns true on successful import, false otherwise.

Definition at line 2337 of file RooJSONFactoryWSTool.cxx.

importYML() [2/2]

bool RooJSONFactoryWSTool::importYML

(

std::string const &

filename

)

Imports a YML file from the given filename to the workspace.

Parameters

filename

The name of the YML file to import.

Returns

bool Returns true on successful import, false otherwise.

Definition at line 2351 of file RooJSONFactoryWSTool.cxx.

importYMLfromString()

bool RooJSONFactoryWSTool::importYMLfromString

(

const std::string &

s

)

Import the workspace from a YML string.

Parameters

s	The YML string containing the workspace data.

Returns

bool Returns true on successful import, false otherwise.

Definition at line 2034 of file RooJSONFactoryWSTool.cxx.

isValidName()

bool RooJSONFactoryWSTool::isValidName ( const std::string & str )

static

Check if a string is a valid name.

A valid name should start with a letter or an underscore, followed by letters, digits, or underscores. Only characters from the ASCII character set are allowed.

Parameters

str	The string to be checked.

Returns

bool Returns true if the string is a valid name; otherwise, returns false.

Definition at line 899 of file RooJSONFactoryWSTool.cxx.

makeVariablesNode()

JSONNode & RooJSONFactoryWSTool::makeVariablesNode ( RooFit::Detail::JSONNode & rootNode )

static

Definition at line 941 of file RooJSONFactoryWSTool.cxx.

name()

std::string RooJSONFactoryWSTool::name ( const RooFit::Detail::JSONNode & n )

static

Definition at line 936 of file RooJSONFactoryWSTool.cxx.

queueExport()

void RooJSONFactoryWSTool::queueExport ( RooAbsArg const & arg )

inline

Definition at line 191 of file RooJSONFactoryWSTool.h.

queueExportTemporary()

void RooJSONFactoryWSTool::queueExportTemporary ( RooAbsArg * arg )

inline

Definition at line 192 of file RooJSONFactoryWSTool.h.

readAxes()

RooArgSet RooJSONFactoryWSTool::readAxes ( const RooFit::Detail::JSONNode & node )

static

Read axes from the JSONNode and create a RooArgSet representing them.

This function reads axes information from the given JSONNode and creates a RooArgSet with variables representing these axes.

Parameters

topNode

The JSONNode containing the axes information to be read.

Returns

RooArgSet A RooArgSet containing the variables created from the JSONNode.

Definition at line 1634 of file RooJSONFactoryWSTool.cxx.

readBinnedData()

std::unique_ptr< RooDataHist > RooJSONFactoryWSTool::readBinnedData ( const RooFit::Detail::JSONNode & n, const std::string & name, RooArgSet const & vars )

static

Read binned data from the JSONNode and create a RooDataHist object.

This function reads binned data from the given JSONNode and creates a RooDataHist object. The binned data is associated with the specified name and variables (RooArgSet) in the workspace.

Parameters

n	The JSONNode representing the binned data to be read.
name	The name to be associated with the created RooDataHist object.
vars	The RooArgSet representing the variables associated with the binned data.

Returns

std::unique_ptr<RooDataHist> A unique pointer to the created RooDataHist object.

Definition at line 1675 of file RooJSONFactoryWSTool.cxx.

rebuildModelConfigInWorkspace()

static void RooJSONFactoryWSTool::rebuildModelConfigInWorkspace ( RooStats::ModelConfig * mc, RooWorkspace & ws )

static

request()

template<class T >

T * RooJSONFactoryWSTool::request ( const std::string & objname, const std::string & requestAuthor )

inline

Definition at line 68 of file RooJSONFactoryWSTool.h.

requestArg()

template<class T >

T * RooJSONFactoryWSTool::requestArg ( const RooFit::Detail::JSONNode & node, const std::string & key )

inline

Definition at line 77 of file RooJSONFactoryWSTool.h.

requestArgList()

template<class T >

RooArgList RooJSONFactoryWSTool::requestArgList ( const RooFit::Detail::JSONNode & node, const std::string & seqName )

inline

Definition at line 111 of file RooJSONFactoryWSTool.h.

requestArgSet()

template<class T >

RooArgSet RooJSONFactoryWSTool::requestArgSet ( const RooFit::Detail::JSONNode & node, const std::string & seqName )

inline

Definition at line 105 of file RooJSONFactoryWSTool.h.

requestCollection()

template<class T , class Coll_t >

Coll_t RooJSONFactoryWSTool::requestCollection ( const RooFit::Detail::JSONNode & node, const std::string & seqName )

inline

Definition at line 87 of file RooJSONFactoryWSTool.h.

requestImpl() [1/4]

template<class T >

T * RooJSONFactoryWSTool::requestImpl ( const std::string & objname )

private

requestImpl() [2/4]

template<>

RooRealVar * RooJSONFactoryWSTool::requestImpl ( const std::string & objname )

private

Definition at line 947 of file RooJSONFactoryWSTool.cxx.

requestImpl() [3/4]

template<>

RooAbsPdf * RooJSONFactoryWSTool::requestImpl ( const std::string & objname )

private

Definition at line 962 of file RooJSONFactoryWSTool.cxx.

requestImpl() [4/4]

template<>

RooAbsReal * RooJSONFactoryWSTool::requestImpl ( const std::string & objname )

private

Definition at line 977 of file RooJSONFactoryWSTool.cxx.

sanitizeName()

std::string RooJSONFactoryWSTool::sanitizeName ( const std::string str )

static

Cleans up names to the HS3 standard.

Parameters

str	The string to be sanitized.

Returns

std::string

Definition at line 2449 of file RooJSONFactoryWSTool.cxx.

sanitizeWS()

RooWorkspace RooJSONFactoryWSTool::sanitizeWS ( const RooWorkspace & ws )

static

Definition at line 2560 of file RooJSONFactoryWSTool.cxx.

setAttribute()

void RooJSONFactoryWSTool::setAttribute	(	const std::string &	obj,
		const std::string &	attrib )

Definition at line 2170 of file RooJSONFactoryWSTool.cxx.

setStringAttribute()

void RooJSONFactoryWSTool::setStringAttribute	(	const std::string &	obj,
		const std::string &	attrib,
		const std::string &	value )

Definition at line 2191 of file RooJSONFactoryWSTool.cxx.

testValidName()

bool RooJSONFactoryWSTool::testValidName ( const std::string & str, bool forcError )

static

Definition at line 920 of file RooJSONFactoryWSTool.cxx.

warning()

std::ostream & RooJSONFactoryWSTool::warning ( const std::string & s )

static

Writes a warning message to the RooFit message service.

Parameters

str	The warning message to be logged.

Returns

std::ostream& A reference to the output stream.

Definition at line 2426 of file RooJSONFactoryWSTool.cxx.

workspace()

RooWorkspace * RooJSONFactoryWSTool::workspace ( )

inline

Definition at line 116 of file RooJSONFactoryWSTool.h.

wsEmplace()

template<class Obj_t , typename... Args_t>

Obj_t & RooJSONFactoryWSTool::wsEmplace ( RooStringView name, Args_t &&... args )

inline

Definition at line 126 of file RooJSONFactoryWSTool.h.

wsImport()

template<class Obj_t >

Obj_t & RooJSONFactoryWSTool::wsImport ( Obj_t const & obj )

inline

Definition at line 119 of file RooJSONFactoryWSTool.h.

Member Data Documentation

_attributesNode

const RooFit::Detail::JSONNode* RooJSONFactoryWSTool::_attributesNode = nullptr

private

Definition at line 247 of file RooJSONFactoryWSTool.h.

_domains

std::unique_ptr<RooFit::JSONIO::Detail::Domains> RooJSONFactoryWSTool::_domains

private

Definition at line 253 of file RooJSONFactoryWSTool.h.

_rootnodeInput

const RooFit::Detail::JSONNode* RooJSONFactoryWSTool::_rootnodeInput = nullptr

private

Definition at line 246 of file RooJSONFactoryWSTool.h.

_rootnodeOutput

RooFit::Detail::JSONNode* RooJSONFactoryWSTool::_rootnodeOutput = nullptr

private

Definition at line 248 of file RooJSONFactoryWSTool.h.

_serversToDelete

std::vector<RooAbsArg const *> RooJSONFactoryWSTool::_serversToDelete

private

Definition at line 255 of file RooJSONFactoryWSTool.h.

_serversToExport

std::vector<RooAbsArg const *> RooJSONFactoryWSTool::_serversToExport

private

Definition at line 254 of file RooJSONFactoryWSTool.h.

_varsNode

RooFit::Detail::JSONNode* RooJSONFactoryWSTool::_varsNode = nullptr

private

Definition at line 249 of file RooJSONFactoryWSTool.h.

_workspace

RooWorkspace& RooJSONFactoryWSTool::_workspace

private

Definition at line 250 of file RooJSONFactoryWSTool.h.

allowExportInvalidNames

bool RooJSONFactoryWSTool::allowExportInvalidNames

static

Definition at line 41 of file RooJSONFactoryWSTool.h.

allowSanitizeNames

bool RooJSONFactoryWSTool::allowSanitizeNames

static

Definition at line 42 of file RooJSONFactoryWSTool.h.

useListsInsteadOfDicts

constexpr bool RooJSONFactoryWSTool::useListsInsteadOfDicts = true

staticconstexpr

Definition at line 40 of file RooJSONFactoryWSTool.h.

Libraries for RooJSONFactoryWSTool:

---

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

• roofit/hs3/inc/RooFitHS3/RooJSONFactoryWSTool.h
• roofit/hs3/src/RooJSONFactoryWSTool.cxx