ROOT::RDF::RSnapshotOptions Struct Reference

A collection of options to steer the creation of the dataset on file.

Definition at line 29 of file RSnapshotOptions.hxx.

Public Types
using	ECAlgo = ROOT::RCompressionSetting::EAlgorithm::EValues

Public Member Functions
	RSnapshotOptions ()=default
	RSnapshotOptions (const RSnapshotOptions &)=default
	RSnapshotOptions (RSnapshotOptions &&)=default
	RSnapshotOptions (std::string_view mode, ECAlgo comprAlgo, int comprLevel, int autoFlush, int splitLevel, bool lazy, bool overwriteIfExists=false, bool vector2RVec=true, int basketSize=-1, ESnapshotOutputFormat outputFormat=ESnapshotOutputFormat::kDefault)

Public Attributes
int	fAutoFlush = 0
	AutoFlush value for output tree.
int	fBasketSize = -1
	Set a custom basket size option.
ECAlgo	fCompressionAlgorithm
	Compression algorithm of output file.
int	fCompressionLevel = 1
	Compression level of output file.
bool	fLazy = false
	Do not start the event loop when Snapshot is called.
std::string	fMode = "RECREATE"
	Mode of creation of output file.
ESnapshotOutputFormat	fOutputFormat = ESnapshotOutputFormat::kDefault
	Which data format to write to.
bool	fOverwriteIfExists = false
	If fMode is "UPDATE", overwrite object in output file if it already exists.
int	fSplitLevel = 99
	Split level of output tree.
bool	fVector2RVec = true
	If set to true will convert std::vector columns to RVec when saving to disk.

#include <ROOT/RSnapshotOptions.hxx>

Member Typedef Documentation

ECAlgo

using ROOT::RDF::RSnapshotOptions::ECAlgo = ROOT::RCompressionSetting::EAlgorithm::EValues

Definition at line 30 of file RSnapshotOptions.hxx.

Constructor & Destructor Documentation

RSnapshotOptions() [1/4]

ROOT::RDF::RSnapshotOptions::RSnapshotOptions ( )

default

RSnapshotOptions() [2/4]

ROOT::RDF::RSnapshotOptions::RSnapshotOptions ( const RSnapshotOptions & )

default

RSnapshotOptions() [3/4]

ROOT::RDF::RSnapshotOptions::RSnapshotOptions ( RSnapshotOptions && )

default

RSnapshotOptions() [4/4]

ROOT::RDF::RSnapshotOptions::RSnapshotOptions ( std::string_view mode, ECAlgo comprAlgo, int comprLevel, int autoFlush, int splitLevel, bool lazy, bool overwriteIfExists = false, bool vector2RVec = true, int basketSize = -1, ESnapshotOutputFormat outputFormat = ESnapshotOutputFormat::kDefault )

inline

Definition at line 34 of file RSnapshotOptions.hxx.

Member Data Documentation

fAutoFlush

int ROOT::RDF::RSnapshotOptions::fAutoFlush = 0

AutoFlush value for output tree.

Definition at line 53 of file RSnapshotOptions.hxx.

fBasketSize

int ROOT::RDF::RSnapshotOptions::fBasketSize = -1

Set a custom basket size option.

For more details, see https://root.cern/manual/trees/#baskets-clusters-and-the-tree-header

Definition at line 58 of file RSnapshotOptions.hxx.

fCompressionAlgorithm

ECAlgo ROOT::RDF::RSnapshotOptions::fCompressionAlgorithm

Initial value:

=
      ROOT::RCompressionSetting::EAlgorithm::kZLIB

Compression algorithm of output file.

Definition at line 50 of file RSnapshotOptions.hxx.

fCompressionLevel

int ROOT::RDF::RSnapshotOptions::fCompressionLevel = 1

Compression level of output file.

Definition at line 52 of file RSnapshotOptions.hxx.

fLazy

bool ROOT::RDF::RSnapshotOptions::fLazy = false

Do not start the event loop when Snapshot is called.

Definition at line 55 of file RSnapshotOptions.hxx.

fMode

std::string ROOT::RDF::RSnapshotOptions::fMode = "RECREATE"

Mode of creation of output file.

Definition at line 49 of file RSnapshotOptions.hxx.

fOutputFormat

ESnapshotOutputFormat ROOT::RDF::RSnapshotOptions::fOutputFormat = ESnapshotOutputFormat::kDefault

Which data format to write to.

Definition at line 60 of file RSnapshotOptions.hxx.

fOverwriteIfExists

bool ROOT::RDF::RSnapshotOptions::fOverwriteIfExists = false

If fMode is "UPDATE", overwrite object in output file if it already exists.

Definition at line 56 of file RSnapshotOptions.hxx.

fSplitLevel

int ROOT::RDF::RSnapshotOptions::fSplitLevel = 99

Split level of output tree.

Definition at line 54 of file RSnapshotOptions.hxx.

fVector2RVec

bool ROOT::RDF::RSnapshotOptions::fVector2RVec = true

If set to true will convert std::vector columns to RVec when saving to disk.

Definition at line 57 of file RSnapshotOptions.hxx.

Collaboration diagram for ROOT::RDF::RSnapshotOptions:

---

The documentation for this struct was generated from the following file:

• tree/dataframe/inc/ROOT/RSnapshotOptions.hxx