ROOT::RDF::Experimental::RDatasetSpec Class Reference

A dataset specification for RDataFrame.

Definition at line 36 of file RDatasetSpec.hxx.

Classes
struct	REntryRange

Public Member Functions
	RDatasetSpec ()=default
RDatasetSpec &	AddSample (RSample sample)
Long64_t	GetEntryRangeBegin () const
Long64_t	GetEntryRangeEnd () const
const std::vector< std::string >	GetFileNameGlobs () const
const ROOT::TreeUtils::RFriendInfo &	GetFriendInfo () const
const std::vector< RMetaData >	GetMetaData () const
const std::vector< std::string >	GetSampleNames () const
const std::vector< std::string >	GetTreeNames () const
RDatasetSpec &	WithGlobalFriends (const std::string &treeName, const std::string &fileNameGlob, const std::string &alias="")
RDatasetSpec &	WithGlobalFriends (const std::string &treeName, const std::vector< std::string > &fileNameGlobs, const std::string &alias="")
	Add friend tree to RDatasetSpec object.
RDatasetSpec &	WithGlobalFriends (const std::vector< std::pair< std::string, std::string > > &treeAndFileNameGlobs, const std::string &alias="")
RDatasetSpec &	WithGlobalFriends (const std::vector< std::string > &treeNames, const std::vector< std::string > &fileNameGlobs, const std::string &alias="")
RDatasetSpec &	WithGlobalRange (const RDatasetSpec::REntryRange &entryRange={})

Private Member Functions
std::vector< RSample >	MoveOutSamples ()

Private Attributes
REntryRange	fEntryRange
	Start (inclusive) and end (exclusive) entry for the dataset processing.
ROOT::TreeUtils::RFriendInfo	fFriendInfo
	List of friends.
std::vector< RSample >	fSamples
	List of samples.

Friends
class	::ROOT::Detail::RDF::RLoopManager

#include <ROOT/RDF/RDatasetSpec.hxx>

Constructor & Destructor Documentation

RDatasetSpec()

ROOT::RDF::Experimental::RDatasetSpec::RDatasetSpec ( )

default

Member Function Documentation

AddSample()

RDatasetSpec & ROOT::RDF::Experimental::RDatasetSpec::AddSample

(

RSample

sample

)

Definition at line 89 of file RDatasetSpec.cxx.

GetEntryRangeBegin()

Long64_t ROOT::RDF::Experimental::RDatasetSpec::GetEntryRangeBegin

(

)

const

Definition at line 74 of file RDatasetSpec.cxx.

GetEntryRangeEnd()

Long64_t ROOT::RDF::Experimental::RDatasetSpec::GetEntryRangeEnd

(

)

const

Definition at line 79 of file RDatasetSpec.cxx.

GetFileNameGlobs()

const std::vector< std::string > ROOT::RDF::Experimental::RDatasetSpec::GetFileNameGlobs

(

)

const

Definition at line 50 of file RDatasetSpec.cxx.

GetFriendInfo()

const ROOT::TreeUtils::RFriendInfo & ROOT::RDF::Experimental::RDatasetSpec::GetFriendInfo

(

)

const

Definition at line 69 of file RDatasetSpec.cxx.

GetMetaData()

const std::vector< RMetaData > ROOT::RDF::Experimental::RDatasetSpec::GetMetaData

(

)

const

Definition at line 60 of file RDatasetSpec.cxx.

GetSampleNames()

const std::vector< std::string > ROOT::RDF::Experimental::RDatasetSpec::GetSampleNames

(

)

const

Definition at line 31 of file RDatasetSpec.cxx.

GetTreeNames()

const std::vector< std::string > ROOT::RDF::Experimental::RDatasetSpec::GetTreeNames

(

)

const

Definition at line 40 of file RDatasetSpec.cxx.

MoveOutSamples()

std::vector< RSample > ROOT::RDF::Experimental::RDatasetSpec::MoveOutSamples ( )

private

Definition at line 84 of file RDatasetSpec.cxx.

WithGlobalFriends() [1/4]

RDatasetSpec & ROOT::RDF::Experimental::RDatasetSpec::WithGlobalFriends	(	const std::string &	treeName,
		const std::string &	fileNameGlob,
		const std::string &	alias = ""
	)

Definition at line 97 of file RDatasetSpec.cxx.

WithGlobalFriends() [2/4]

RDatasetSpec & ROOT::RDF::Experimental::RDatasetSpec::WithGlobalFriends	(	const std::string &	treeName,
		const std::vector< std::string > &	fileNameGlobs,
		const std::string &	alias = ""
	)

Add friend tree to RDatasetSpec object.

Parameters

[in]	treeName	Name of the tree.
[in]	fileNameGlob	Path to the file. Refer to TChain::Add for globbing rules.
[in]	alias	Alias for this friend.

Example usage:

ROOT::RDF::Experimental::RDatasetSpec x;
std::vector<std::string> files = {"outputFile.root"};
//create RSample object with name myPhysicsDf and tree outputTree1
ROOT::RDF::Experimental::RSample r("myPhysicsDf", "outputTree1", files);
x.AddSample(r); //add RDatasetSpec to RDatasetSpec
x.WithGlobalFriends("outputTree2", files); //add friend tree outputTree2

Definition at line 119 of file RDatasetSpec.cxx.

WithGlobalFriends() [3/4]

RDatasetSpec & ROOT::RDF::Experimental::RDatasetSpec::WithGlobalFriends	(	const std::vector< std::pair< std::string, std::string > > &	treeAndFileNameGlobs,
		const std::string &	alias = ""
	)

Definition at line 127 of file RDatasetSpec.cxx.

WithGlobalFriends() [4/4]

RDatasetSpec & ROOT::RDF::Experimental::RDatasetSpec::WithGlobalFriends	(	const std::vector< std::string > &	treeNames,
		const std::vector< std::string > &	fileNameGlobs,
		const std::string &	alias = ""
	)

Definition at line 140 of file RDatasetSpec.cxx.

WithGlobalRange()

RDatasetSpec & ROOT::RDF::Experimental::RDatasetSpec::WithGlobalRange

(

const RDatasetSpec::REntryRange &

entryRange = {}

)

Definition at line 134 of file RDatasetSpec.cxx.

Friends And Related Symbol Documentation

::ROOT::Detail::RDF::RLoopManager

friend class ::ROOT::Detail::RDF::RLoopManager

friend

Definition at line 37 of file RDatasetSpec.hxx.

Member Data Documentation

fEntryRange

REntryRange ROOT::RDF::Experimental::RDatasetSpec::fEntryRange

private

Start (inclusive) and end (exclusive) entry for the dataset processing.

Definition at line 51 of file RDatasetSpec.hxx.

fFriendInfo

ROOT::TreeUtils::RFriendInfo ROOT::RDF::Experimental::RDatasetSpec::fFriendInfo

private

List of friends.

Definition at line 50 of file RDatasetSpec.hxx.

fSamples

std::vector<RSample> ROOT::RDF::Experimental::RDatasetSpec::fSamples

private

List of samples.

Definition at line 49 of file RDatasetSpec.hxx.

Libraries for ROOT::RDF::Experimental::RDatasetSpec:

---

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

• tree/dataframe/inc/ROOT/RDF/RDatasetSpec.hxx
• tree/dataframe/src/RDatasetSpec.cxx