Logo ROOT   master
Reference Guide
RNTupleOptions.hxx
Go to the documentation of this file.
1 /// \file ROOT/RNTupleOptions.hxx
2 /// \ingroup NTuple ROOT7
3 /// \author Jakob Blomer <jblomer@cern.ch>
4 /// \date 2019-08-25
5 /// \warning This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback
6 /// is welcome!
7 
8 /*************************************************************************
9  * Copyright (C) 1995-2019, Rene Brun and Fons Rademakers. *
10  * All rights reserved. *
11  * *
12  * For the licensing terms see $ROOTSYS/LICENSE. *
13  * For the list of contributors see $ROOTSYS/README/CREDITS. *
14  *************************************************************************/
15 
16 #ifndef ROOT7_RNTupleOptions
17 #define ROOT7_RNTupleOptions
18 
19 #include <Compression.h>
20 
21 namespace ROOT {
22 namespace Experimental {
23 
24 // clang-format off
25 /**
26 \class ROOT::Experimental::ENTupleContainerFormat
27 \ingroup NTuple
28 \brief Describes the options for wrapping RNTuple data in files
29 */
30 // clang-format on
32  kTFile, // ROOT TFile
33  kBare, // A thin envelope supporting a single RNTuple only
34 };
35 
36 
37 // clang-format off
38 /**
39 \class ROOT::Experimental::RNTupleWriteOptions
40 \ingroup NTuple
41 \brief Common user-tunable settings for storing ntuples
42 
43 All page sink classes need to support the common options.
44 */
45 // clang-format on
49 
50 public:
51  RNTupleWriteOptions() = default;
52 
53  int GetCompression() const { return fCompression; }
54  void SetCompression(int val) { fCompression = val; }
55  void SetCompression(RCompressionSetting::EAlgorithm algorithm, int compressionLevel) {
56  fCompression = CompressionSettings(algorithm, compressionLevel);
57  }
58 
61 };
62 
63 
64 // clang-format off
65 /**
66 \class ROOT::Experimental::RNTupleReadOptions
67 \ingroup NTuple
68 \brief Common user-tunable settings for reading ntuples
69 
70 All page source classes need to support the common options.
71 */
72 // clang-format on
74 };
75 
76 } // namespace Experimental
77 } // namespace ROOT
78 
79 #endif
ENTupleContainerFormat GetContainerFormat() const
Returns the available number of logical cores.
Definition: RNumpyDS.hxx:30
Describes the options for wrapping RNTuple data in files
void SetCompression(RCompressionSetting::EAlgorithm algorithm, int compressionLevel)
Common user-tunable settings for reading ntuples
int CompressionSettings(RCompressionSetting::EAlgorithm algorithm, int compressionLevel)
Use the default analysis setting; fast reading but poor compression ratio.
Definition: Compression.h:52
void SetContainerFormat(ENTupleContainerFormat val)
Common user-tunable settings for storing ntuples