ROOT::RDF::Experimental Namespace Reference

Classes
class	RDatasetSpec
	A dataset specification for RDataFrame. More...
class	RMetaData
	Class behaving as a heterogenuous dictionary to store dataset metadata. More...
class	RResultMap
class	RSample
	Class representing a sample (grouping of trees (and their fileglobs) and (optional) metadata) More...

Functions
RDataFrame	FromRNTuple (ROOT::Experimental::RNTuple *ntuple)
RDataFrame	FromRNTuple (std::string_view ntupleName, std::string_view fileName)
ROOT::RDataFrame	FromSpec (const std::string &jsonFile)
	Factory method to create an RDataFrame from a JSON specification file.
template<typename T >
RResultMap< T >	VariationsFor (RResultPtr< T > resPtr)
	Produce all required systematic variations for the given result.

Function Documentation

FromRNTuple() [1/2]

ROOT::RDataFrame ROOT::RDF::Experimental::FromRNTuple

(

ROOT::Experimental::RNTuple *

ntuple

)

Definition at line 366 of file RNTupleDS.cxx.

FromRNTuple() [2/2]

ROOT::RDataFrame ROOT::RDF::Experimental::FromRNTuple	(	std::string_view	ntupleName,
		std::string_view	fileName
	)

Definition at line 359 of file RNTupleDS.cxx.

FromSpec()

ROOT::RDataFrame ROOT::RDF::Experimental::FromSpec

(

const std::string &

jsonFile

)

Factory method to create an RDataFrame from a JSON specification file.

Parameters

[in]

jsonFile

Path of the JSON file, which should follow the format described in https://github.com/root-project/root/issues/11624

Definition at line 1493 of file RDataFrame.cxx.

VariationsFor()

template<typename T >

RResultMap< T > ROOT::RDF::Experimental::VariationsFor

(

RResultPtr< T >

resPtr

)

Produce all required systematic variations for the given result.

Parameters

[in]

resPtr

The result for which variations should be produced.

Returns

A RResultMap object with full variation names as strings (e.g. "pt:down") and the corresponding varied results as values.

A given input RResultPtr<T> produces a corresponding RResultMap<T> with a "nominal" key that will return a value identical to the one contained in the original RResultPtr. Other keys correspond to the varied values of this result, one for each variation that the result depends on. VariationsFor does not trigger the event loop. The event loop is only triggered upon first access to a valid key, similarly to what happens with RResultPtr.

If the result does not depend, directly or indirectly, from any registered systematic variation, the returned RResultMap will contain only the "nominal" key.

See RDataFrame's Vary method for more information and example usages.

Note

Currently, producing variations for the results of Display, Report and Snapshot actions is not supported.

Definition at line 214 of file RDFHelpers.hxx.