ROOT::RDF::Experimental::RSample Class Reference

Class representing a sample (grouping of trees (and their fileglobs) and (optional) metadata)

This class should be passed to RDatasetSpec in order to build a RDataFrame.

Definition at line 29 of file RSample.hxx.

Public Member Functions
	RSample ()=delete
	RSample (const RSample &)=default
	RSample (const std::string &sampleName, const std::string &treeName, const std::string &fileNameGlob, const RMetaData &metaData={})
	RSample (const std::string &sampleName, const std::string &treeName, const std::vector< std::string > &fileNameGlobs, const RMetaData &metaData={})
	RSample (const std::string &sampleName, const std::vector< std::pair< std::string, std::string > > &treeAndFileNameGlobs, const RMetaData &metaData={})
	RSample (const std::string &sampleName, const std::vector< std::string > &treeNames, const std::vector< std::string > &fileNameGlobs, const RMetaData &metaData={})
	RSample (RSample &&)=default
const std::vector< std::string > &	GetFileNameGlobs () const
const RMetaData &	GetMetaData () const
const std::string &	GetSampleName () const
const std::vector< std::string > &	GetTreeNames () const
RSample &	operator= (const RSample &)=default
RSample &	operator= (RSample &&)=default

Private Attributes
std::vector< std::string >	fFileNameGlobs
	A list of file names.
RMetaData	fMetaData
unsigned int	fSampleId {0}
std::string	fSampleName
std::vector< std::string >	fTreeNames
	A list of names of trees.

#include <ROOT/RDF/RSample.hxx>

Constructor & Destructor Documentation

RSample() [1/7]

ROOT::RDF::Experimental::RSample::RSample ( RSample &&  )

default

RSample() [2/7]

ROOT::RDF::Experimental::RSample::RSample ( const RSample &  )

default

RSample() [3/7]

ROOT::RDF::Experimental::RSample::RSample ( )

delete

RSample() [4/7]

ROOT::RDF::Experimental::RSample::RSample	(	const std::string &	sampleName,
		const std::string &	treeName,
		const std::string &	fileNameGlob,
		const RMetaData &	metaData = {}
	)

Definition at line 19 of file RSample.cxx.

RSample() [5/7]

ROOT::RDF::Experimental::RSample::RSample	(	const std::string &	sampleName,
		const std::string &	treeName,
		const std::vector< std::string > &	fileNameGlobs,
		const RMetaData &	metaData = {}
	)

Definition at line 25 of file RSample.cxx.

RSample() [6/7]

ROOT::RDF::Experimental::RSample::RSample	(	const std::string &	sampleName,
		const std::vector< std::pair< std::string, std::string > > &	treeAndFileNameGlobs,
		const RMetaData &	metaData = {}
	)

Definition at line 31 of file RSample.cxx.

RSample() [7/7]

ROOT::RDF::Experimental::RSample::RSample	(	const std::string &	sampleName,
		const std::vector< std::string > &	treeNames,
		const std::vector< std::string > &	fileNameGlobs,
		const RMetaData &	metaData = {}
	)

Definition at line 54 of file RSample.cxx.

Member Function Documentation

GetFileNameGlobs()

const std::vector< std::string > & ROOT::RDF::Experimental::RSample::GetFileNameGlobs

(

)

const

Definition at line 84 of file RSample.cxx.

GetMetaData()

const RMetaData & ROOT::RDF::Experimental::RSample::GetMetaData

(

)

const

Definition at line 89 of file RSample.cxx.

GetSampleName()

const std::string & ROOT::RDF::Experimental::RSample::GetSampleName

(

)

const

Definition at line 74 of file RSample.cxx.

GetTreeNames()

const std::vector< std::string > & ROOT::RDF::Experimental::RSample::GetTreeNames

(

)

const

Definition at line 79 of file RSample.cxx.

operator=() [1/2]

RSample & ROOT::RDF::Experimental::RSample::operator= ( const RSample &  )

default

operator=() [2/2]

RSample & ROOT::RDF::Experimental::RSample::operator= ( RSample &&  )

default

Member Data Documentation

fFileNameGlobs

std::vector<std::string> ROOT::RDF::Experimental::RSample::fFileNameGlobs

private

A list of file names.

They can contain the globbing characters supported by TChain. See TChain::Add for more information.

Definition at line 42 of file RSample.hxx.

fMetaData

RMetaData ROOT::RDF::Experimental::RSample::fMetaData

private

Definition at line 43 of file RSample.hxx.

fSampleId

unsigned int ROOT::RDF::Experimental::RSample::fSampleId {0}

private

Definition at line 45 of file RSample.hxx.

fSampleName

std::string ROOT::RDF::Experimental::RSample::fSampleName

private

Definition at line 30 of file RSample.hxx.

fTreeNames

std::vector<std::string> ROOT::RDF::Experimental::RSample::fTreeNames

private

A list of names of trees.

This list should go in lockstep with fFileNameGlobs, only in case this dataset is a TChain where each file contains its own tree with a different name from the global name of the dataset. Otherwise, fTreeNames contains 1 treename, that is common for all file globs.

Definition at line 37 of file RSample.hxx.

Libraries for ROOT::RDF::Experimental::RSample:

---

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

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