 |
ROOT
Reference Guide |
|
| |
ROOT
Reference Guide |
|
Namespaces | |
| namespace | Experimental |
| namespace | Internal |
Classes | |
| class | RArrowDS |
| RDataFrame data source class to interface with Apache Arrow. More... | |
| class | RCsvDS |
| RDataFrame data source class for reading CSV files. More... | |
| class | RCutFlowReport |
| class | RDataSource |
| RDataSource defines an API that RDataFrame can use to read arbitrary data formats. More... | |
| class | RDFDescription |
| A DFDescription contains useful information about a given RDataFrame computation graph. More... | |
| class | RDFTypeNameGetter |
| Helper to get the contents of a given column. More... | |
| class | RDisplay |
| This class is the textual representation of the content of a columnar dataset. More... | |
| class | RInterface |
| The public interface to the RDataFrame federation of classes. More... | |
| class | RInterfaceBase |
| The base public interface to the RDataFrame federation of classes. More... | |
| class | RLazyDS |
| A RDataSource implementation which is built on top of result proxies. More... | |
| class | RNTupleDS |
| The RDataSource implementation for RNTuple. More... | |
| class | RResultHandle |
| A type-erased version of RResultPtr and RResultMap. More... | |
| class | RResultPtr |
| Smart pointer for the return type of actions. More... | |
| class | RSampleInfo |
| This type represents a sample identifier, to be used in conjunction with RDataFrame features such as DefinePerSample() and per-sample callbacks. More... | |
| struct | RSnapshotOptions |
| A collection of options to steer the creation of the dataset on disk through Snapshot(). More... | |
| class | RSqliteDS |
| RSqliteDS is an RDF data source implementation for SQL result sets from sqlite3 files. More... | |
| class | RTrivialDS |
| A simple data-source implementation, for demo purposes. More... | |
| class | RVariationsDescription |
| A descriptor for the systematic variations known to a given RDataFrame node. More... | |
| class | TCutInfo |
| class | TH1DModel |
| A struct which stores some basic parameters of a TH1D. More... | |
| class | TH2DModel |
| A struct which stores some basic parameters of a TH2D. More... | |
| class | TH3DModel |
| A struct which stores some basic parameters of a TH3D. More... | |
| class | THnDModel |
| A struct which stores some basic parameters of a THnD. More... | |
| class | THnSparseDModel |
| A struct which stores some basic parameters of a THnSparseD. More... | |
| class | TProfile1DModel |
| A struct which stores some basic parameters of a TProfile. More... | |
| class | TProfile2DModel |
| A struct which stores some basic parameters of a TProfile2D. More... | |
| class | VerifyValidColumnType |
| Helper to determine if a given Column is a supported type. More... | |
Typedefs | |
| using | ColumnNames_t = std::vector<std::string> |
| using | RNode = RInterface<::ROOT::Detail::RDF::RNodeBase> |
| using | SampleCallback_t = std::function<void(unsigned int, const ROOT::RDF::RSampleInfo &)> |
| The type of a data-block callback, registered with an RDataFrame computation graph via e.g. | |
Enumerations | |
| enum class | ESnapshotOutputFormat { kDefault , kTTree , kRNTuple } |
Functions | |
| template<typename AccFun, typename MergeFun, typename R = typename TTraits::CallableTraits<AccFun>::ret_type, typename ArgTypes = typename TTraits::CallableTraits<AccFun>::arg_types, typename ArgTypesNoDecay = typename TTraits::CallableTraits<AccFun>::arg_types_nodecay, typename U = TTraits::TakeFirstParameter_t<ArgTypes>, typename T = TTraits::TakeFirstParameter_t<TTraits::RemoveFirstParameter_t<ArgTypes>>> | |
| RResultPtr< U > | Aggregate (AccFun aggregator, MergeFun merger, std::string_view columnName, const U &aggIdentity) |
| Execute a user-defined accumulation operation on the processed column values in each processing slot. | |
| template<typename AccFun, typename MergeFun, typename R = typename TTraits::CallableTraits<AccFun>::ret_type, typename ArgTypes = typename TTraits::CallableTraits<AccFun>::arg_types, typename U = TTraits::TakeFirstParameter_t<ArgTypes>, typename T = TTraits::TakeFirstParameter_t<TTraits::RemoveFirstParameter_t<ArgTypes>>> | |
| RResultPtr< U > | Aggregate (AccFun aggregator, MergeFun merger, std::string_view columnName="") |
| Execute a user-defined accumulation operation on the processed column values in each processing slot. | |
| RInterface< Proxied > | Alias (std::string_view alias, std::string_view columnName) |
| Allow to refer to a column with a different name. | |
| template<typename NodeType> | |
| RNode | AsRNode (NodeType node) |
| Cast a RDataFrame node to the common type ROOT::RDF::RNode. | |
| template<typename FirstColumn = RDFDetail::RInferredType, typename... OtherColumns, typename Helper> | |
| RResultPtr< typename std::decay_t< Helper >::Result_t > | Book (Helper &&helper, const ColumnNames_t &columns={}) |
| Book execution of a custom action using a user-defined helper object. | |
| template<typename... ColumnTypes> | |
| RInterface< RLoopManager > | Cache (const ColumnNames_t &columnList) |
| Save selected columns in memory. | |
| RInterface< RLoopManager > | Cache (const ColumnNames_t &columnList) |
| Save selected columns in memory. | |
| RInterface< RLoopManager > | Cache (std::initializer_list< std::string > columnList) |
| Save selected columns in memory. | |
| RInterface< RLoopManager > | Cache (std::string_view columnNameRegexp="") |
| Save selected columns in memory. | |
| template<typename... ColTypes, std::size_t... S> | |
| RInterface< RLoopManager > | CacheImpl (const ColumnNames_t &columnList, std::index_sequence< S... >) |
| Implementation of cache. | |
| template<typename Helper, typename ActionResultType, typename... Others> | |
| RResultPtr< ActionResultType > | CallCreateActionWithoutColsIfPossible (const std::shared_ptr< ActionResultType > &, const std::shared_ptr< Helper > &, Others...) |
| template<typename Helper, typename ActionResultType> | |
| auto | CallCreateActionWithoutColsIfPossible (const std::shared_ptr< ActionResultType > &resPtr, const std::shared_ptr< Helper > &hPtr, TTraits::TypeList< RDFDetail::RInferredType >) -> decltype(hPtr->Exec(0u), RResultPtr< ActionResultType >{}) |
| RResultPtr< ULong64_t > | Count () |
| Return the number of entries processed (lazy action). | |
| template<typename F, typename DefineType, typename RetType = typename TTraits::CallableTraits<F>::ret_type> | |
| std::enable_if_t< std::is_default_constructible< RetType >::value, RInterface< Proxied > > | DefineImpl (std::string_view name, F &&expression, const ColumnNames_t &columns, const std::string &where) |
| template<typename F, typename DefineType, typename RetType = typename TTraits::CallableTraits<F>::ret_type, bool IsFStringConv = std::is_convertible<F, std::string>::value, bool IsRetTypeDefConstr = std::is_default_constructible<RetType>::value> | |
| std::enable_if_t<!IsFStringConv &&!IsRetTypeDefConstr, RInterface< Proxied > > | DefineImpl (std::string_view, F, const ColumnNames_t &, const std::string &) |
| template<typename... ColumnTypes> | |
| RResultPtr< RDisplay > | Display (const ColumnNames_t &columnList, size_t nRows=5, size_t nMaxCollectionElements=10) |
| Provides a representation of the columns in the dataset. | |
| RResultPtr< RDisplay > | Display (const ColumnNames_t &columnList, size_t nRows=5, size_t nMaxCollectionElements=10) |
| Provides a representation of the columns in the dataset. | |
| RResultPtr< RDisplay > | Display (std::initializer_list< std::string > columnList, size_t nRows=5, size_t nMaxCollectionElements=10) |
| Provides a representation of the columns in the dataset. | |
| RResultPtr< RDisplay > | Display (std::string_view columnNameRegexp="", size_t nRows=5, size_t nMaxCollectionElements=10) |
| Provides a representation of the columns in the dataset. | |
| template<typename FirstColumn = RDFDetail::RInferredType, typename... OtherColumns, typename T> | |
| RResultPtr< std::decay_t< T > > | Fill (T &&model, const ColumnNames_t &columnList) |
Return an object of type T on which T::Fill will be called once per event (lazy action). | |
| template<typename F> | |
| void | Foreach (F f, const ColumnNames_t &columns={}) |
| Execute a user-defined function on each entry (instant action). | |
| template<typename F> | |
| void | ForeachSlot (F f, const ColumnNames_t &columns={}) |
| Execute a user-defined function requiring a processing slot index on each entry (instant action). | |
| RDataFrame | FromArrow (std::shared_ptr< arrow::Table > table, std::vector< std::string > const &columnNames) |
| Factory method to create a Apache Arrow RDataFrame. | |
| RDataFrame | FromCSV (std::string_view fileName, bool readHeaders=true, char delimiter=',', Long64_t linesChunkSize=-1LL, std::unordered_map< std::string, char > &&colTypes={}) |
| Factory method to create a CSV RDataFrame. | |
| RDataFrame | FromCSV (std::string_view fileName, const RCsvDS::ROptions &options) |
| Factory method to create a CSV RDataFrame. | |
| RDataFrame | FromRNTuple (std::string_view ntupleName, const std::vector< std::string > &fileNames) |
| RDataFrame | FromRNTuple (std::string_view ntupleName, std::string_view fileName) |
| RDataFrame | FromSqlite (std::string_view fileName, std::string_view query) |
| Factory method to create a SQlite RDataFrame. | |
| template<typename T> | |
| std::shared_ptr< arrow::ChunkedArray > | getData (T p) |
| std::vector< std::string > | GetFilterNames () |
| Returns the names of the filters created. | |
| int | getNRecords (std::shared_ptr< arrow::Table > &table, std::vector< std::string > &columnNames) |
| const std::shared_ptr< Proxied > & | GetProxiedPtr () const |
| template<typename X = RDFDetail::RInferredType, typename Y = RDFDetail::RInferredType> | |
| RResultPtr<::TGraph > | Graph (std::string_view x="", std::string_view y="") |
| Fill and return a TGraph object (lazy action). | |
| template<typename X = RDFDetail::RInferredType, typename Y = RDFDetail::RInferredType, typename EXL = RDFDetail::RInferredType, typename EXH = RDFDetail::RInferredType, typename EYL = RDFDetail::RInferredType, typename EYH = RDFDetail::RInferredType> | |
| RResultPtr<::TGraphAsymmErrors > | GraphAsymmErrors (std::string_view x="", std::string_view y="", std::string_view exl="", std::string_view exh="", std::string_view eyl="", std::string_view eyh="") |
| Fill and return a TGraphAsymmErrors object (lazy action). | |
| template<typename ColumnType = RDFDetail::RInferredType, typename... ColumnTypes, typename BinContentType> | |
| RResultPtr< ROOT::Experimental::RHist< BinContentType > > | Hist (std::shared_ptr< ROOT::Experimental::RHist< BinContentType > > h, const ColumnNames_t &columnList) |
| Fill the provided RHist (lazy action). | |
| template<typename ColumnType = RDFDetail::RInferredType, typename... ColumnTypes, typename BinContentType> | |
| RResultPtr< ROOT::Experimental::RHist< BinContentType > > | Hist (std::shared_ptr< ROOT::Experimental::RHist< BinContentType > > h, const ColumnNames_t &columnList, std::string_view wName) |
| Fill the provided RHist with weights (lazy action). | |
| template<typename ColumnType = RDFDetail::RInferredType, typename... ColumnTypes, typename BinContentType> | |
| RResultPtr< ROOT::Experimental::RHistEngine< BinContentType > > | Hist (std::shared_ptr< ROOT::Experimental::RHistEngine< BinContentType > > h, const ColumnNames_t &columnList) |
| Fill the provided RHistEngine (lazy action). | |
| template<typename ColumnType = RDFDetail::RInferredType, typename... ColumnTypes, typename BinContentType> | |
| RResultPtr< ROOT::Experimental::RHistEngine< BinContentType > > | Hist (std::shared_ptr< ROOT::Experimental::RHistEngine< BinContentType > > h, const ColumnNames_t &columnList, std::string_view wName) |
| Fill the provided RHistEngine with weights (lazy action). | |
| template<typename BinContentType = double, typename V = RDFDetail::RInferredType> | |
| RResultPtr< ROOT::Experimental::RHist< BinContentType > > | Hist (std::uint64_t nNormalBins, std::pair< double, double > interval, std::string_view vName) |
| Fill and return a one-dimensional RHist (lazy action). | |
| template<typename BinContentType = ROOT::Experimental::RBinWithError, typename V = RDFDetail::RInferredType, typename W = RDFDetail::RInferredType> | |
| RResultPtr< ROOT::Experimental::RHist< BinContentType > > | Hist (std::uint64_t nNormalBins, std::pair< double, double > interval, std::string_view vName, std::string_view wName) |
| Fill and return a one-dimensional RHist with weights (lazy action). | |
| template<typename BinContentType = double, typename ColumnType = RDFDetail::RInferredType, typename... ColumnTypes> | |
| RResultPtr< ROOT::Experimental::RHist< BinContentType > > | Hist (std::vector< ROOT::Experimental::RAxisVariant > axes, const ColumnNames_t &columnList) |
| Fill and return an RHist (lazy action). | |
| template<typename BinContentType = ROOT::Experimental::RBinWithError, typename ColumnType = RDFDetail::RInferredType, typename... ColumnTypes> | |
| RResultPtr< ROOT::Experimental::RHist< BinContentType > > | Hist (std::vector< ROOT::Experimental::RAxisVariant > axes, const ColumnNames_t &columnList, std::string_view wName) |
| Fill and return an RHist with weights (lazy action). | |
| template<typename V = RDFDetail::RInferredType, typename W = RDFDetail::RInferredType> | |
| RResultPtr<::TH1D > | Histo1D (const TH1DModel &model, std::string_view vName, std::string_view wName) |
| Fill and return a one-dimensional histogram with the weighted values of a column (lazy action). | |
| template<typename V, typename W> | |
| RResultPtr<::TH1D > | Histo1D (const TH1DModel &model={"", "", 128u, 0., 0.}) |
| Fill and return a one-dimensional histogram with the weighted values of a column (lazy action). | |
| template<typename V = RDFDetail::RInferredType> | |
| RResultPtr<::TH1D > | Histo1D (const TH1DModel &model={"", "", 128u, 0., 0.}, std::string_view vName="") |
| Fill and return a one-dimensional histogram with the values of a column (lazy action). | |
| template<typename V = RDFDetail::RInferredType> | |
| RResultPtr<::TH1D > | Histo1D (std::string_view vName) |
| Fill and return a one-dimensional histogram with the values of a column (lazy action). | |
| template<typename V = RDFDetail::RInferredType, typename W = RDFDetail::RInferredType> | |
| RResultPtr<::TH1D > | Histo1D (std::string_view vName, std::string_view wName) |
| Fill and return a one-dimensional histogram with the weighted values of a column (lazy action). | |
| template<typename V1, typename V2, typename W> | |
| RResultPtr<::TH2D > | Histo2D (const TH2DModel &model) |
| template<typename V1 = RDFDetail::RInferredType, typename V2 = RDFDetail::RInferredType, typename W = RDFDetail::RInferredType> | |
| RResultPtr<::TH2D > | Histo2D (const TH2DModel &model, std::string_view v1Name, std::string_view v2Name, std::string_view wName) |
| Fill and return a weighted two-dimensional histogram (lazy action). | |
| template<typename V1 = RDFDetail::RInferredType, typename V2 = RDFDetail::RInferredType> | |
| RResultPtr<::TH2D > | Histo2D (const TH2DModel &model, std::string_view v1Name="", std::string_view v2Name="") |
| Fill and return a two-dimensional histogram (lazy action). | |
| template<typename V1, typename V2, typename V3, typename W> | |
| RResultPtr<::TH3D > | Histo3D (const TH3DModel &model) |
| template<typename V1 = RDFDetail::RInferredType, typename V2 = RDFDetail::RInferredType, typename V3 = RDFDetail::RInferredType, typename W = RDFDetail::RInferredType> | |
| RResultPtr<::TH3D > | Histo3D (const TH3DModel &model, std::string_view v1Name, std::string_view v2Name, std::string_view v3Name, std::string_view wName) |
| Fill and return a three-dimensional histogram (lazy action). | |
| template<typename V1 = RDFDetail::RInferredType, typename V2 = RDFDetail::RInferredType, typename V3 = RDFDetail::RInferredType> | |
| RResultPtr<::TH3D > | Histo3D (const TH3DModel &model, std::string_view v1Name="", std::string_view v2Name="", std::string_view v3Name="") |
| Fill and return a three-dimensional histogram (lazy action). | |
| template<typename FirstColumn, typename... OtherColumns> | |
| RResultPtr<::THnD > | HistoND (const THnDModel &model, const ColumnNames_t &columnList, std::string_view wName="") |
| Fill and return an N-dimensional histogram (lazy action). | |
| RResultPtr<::THnD > | HistoND (const THnDModel &model, const ColumnNames_t &columnList, std::string_view wName="") |
| Fill and return an N-dimensional histogram (lazy action). | |
| template<typename FirstColumn, typename... OtherColumns> | |
| RResultPtr<::THnSparseD > | HistoNSparseD (const THnSparseDModel &model, const ColumnNames_t &columnList, std::string_view wName="") |
| Fill and return a sparse N-dimensional histogram (lazy action). | |
| RResultPtr<::THnSparseD > | HistoNSparseD (const THnSparseDModel &model, const ColumnNames_t &columnList, std::string_view wName="") |
| Fill and return a sparse N-dimensional histogram (lazy action). | |
| RInterface< Proxied > | JittedVaryImpl (const std::vector< std::string > &colNames, std::string_view expression, const std::vector< std::string > &variationTags, std::string_view variationName, bool isSingleColumn) |
| template<typename... ColumnTypes> | |
| RDataFrame | MakeLazyDataFrame (std::pair< std::string, RResultPtr< std::vector< ColumnTypes > > > &&... colNameProxyPairs) |
| Factory method to create a Lazy RDataFrame. | |
| RInterface< RDFDetail::RLoopManager > | MakeTrivialDataFrame () |
| Make a RDF wrapping a RTrivialDS with infinite entries, for demo purposes. | |
| RInterface< RDFDetail::RLoopManager > | MakeTrivialDataFrame (ULong64_t size, bool skipEvenEntries=false) |
| Make a RDF wrapping a RTrivialDS with the specified amount of entries. | |
| template<typename T = RDFDetail::RInferredType> | |
| RResultPtr< RDFDetail::MaxReturnType_t< T > > | Max (std::string_view columnName="") |
| Return the maximum of processed column values (lazy action). | |
| template<typename T = RDFDetail::RInferredType> | |
| RResultPtr< double > | Mean (std::string_view columnName="") |
| Return the mean of processed column values (lazy action). | |
| template<typename T = RDFDetail::RInferredType> | |
| RResultPtr< RDFDetail::MinReturnType_t< T > > | Min (std::string_view columnName="") |
| Return the minimum of processed column values (lazy action). | |
| template<typename F, typename Args = typename ROOT::TypeTraits::CallableTraits<std::decay_t<F>>::arg_types_nodecay, typename Ret = typename ROOT::TypeTraits::CallableTraits<std::decay_t<F>>::ret_type> | |
| auto | Not (F &&f) -> decltype(RDFInternal::NotHelper(Args(), std::forward< F >(f))) |
| Given a callable with signature bool(T1, T2, ...) return a callable with same signature that returns the negated result. | |
| template<class T1, class T2> | |
| bool | operator!= (const RResultPtr< T1 > &lhs, const RResultPtr< T2 > &rhs) |
| template<class T1> | |
| bool | operator!= (const RResultPtr< T1 > &lhs, std::nullptr_t rhs) |
| template<class T1> | |
| bool | operator!= (std::nullptr_t lhs, const RResultPtr< T1 > &rhs) |
| std::ostream & | operator<< (std::ostream &os, const RDFDescription &description) |
| template<class T1, class T2> | |
| bool | operator== (const RResultPtr< T1 > &lhs, const RResultPtr< T2 > &rhs) |
| template<class T1> | |
| bool | operator== (const RResultPtr< T1 > &lhs, std::nullptr_t rhs) |
| template<class T1> | |
| bool | operator== (std::nullptr_t lhs, const RResultPtr< T1 > &rhs) |
| template<std::size_t N, typename T, typename F> | |
| auto | PassAsVec (F &&f) -> RDFInternal::PassAsVecHelper< std::make_index_sequence< N >, T, F > |
| PassAsVec is a callable generator that allows passing N variables of type T to a function as a single collection. | |
| template<typename V1, typename V2, typename W> | |
| RResultPtr<::TProfile > | Profile1D (const TProfile1DModel &model) |
| Fill and return a one-dimensional profile (lazy action). See the first Profile1D() overload for more details. | |
| template<typename V1 = RDFDetail::RInferredType, typename V2 = RDFDetail::RInferredType, typename W = RDFDetail::RInferredType> | |
| RResultPtr<::TProfile > | Profile1D (const TProfile1DModel &model, std::string_view v1Name, std::string_view v2Name, std::string_view wName) |
| Fill and return a one-dimensional profile (lazy action). | |
| template<typename V1 = RDFDetail::RInferredType, typename V2 = RDFDetail::RInferredType> | |
| RResultPtr<::TProfile > | Profile1D (const TProfile1DModel &model, std::string_view v1Name="", std::string_view v2Name="") |
| Fill and return a one-dimensional profile (lazy action). | |
| template<typename V1, typename V2, typename V3, typename W> | |
| RResultPtr<::TProfile2D > | Profile2D (const TProfile2DModel &model) |
| Fill and return a two-dimensional profile (lazy action). See the first Profile2D() overload for more details. | |
| template<typename V1 = RDFDetail::RInferredType, typename V2 = RDFDetail::RInferredType, typename V3 = RDFDetail::RInferredType, typename W = RDFDetail::RInferredType> | |
| RResultPtr<::TProfile2D > | Profile2D (const TProfile2DModel &model, std::string_view v1Name, std::string_view v2Name, std::string_view v3Name, std::string_view wName) |
| Fill and return a two-dimensional profile (lazy action). | |
| template<typename V1 = RDFDetail::RInferredType, typename V2 = RDFDetail::RInferredType, typename V3 = RDFDetail::RInferredType> | |
| RResultPtr<::TProfile2D > | Profile2D (const TProfile2DModel &model, std::string_view v1Name="", std::string_view v2Name="", std::string_view v3Name="") |
| Fill and return a two-dimensional profile (lazy action). | |
| RInterface< RDFDetail::RRange< Proxied > > | Range (unsigned int begin, unsigned int end, unsigned int stride=1) |
| Creates a node that filters entries based on range: [begin, end). | |
| RInterface< RDFDetail::RRange< Proxied > > | Range (unsigned int end) |
| Creates a node that filters entries based on range. | |
| template<typename F, typename T = typename TTraits::CallableTraits<F>::ret_type> | |
| RResultPtr< T > | Reduce (F f, std::string_view columnName, const T &redIdentity) |
| Execute a user-defined reduce operation on the values of a column. | |
| template<typename F, typename T = typename TTraits::CallableTraits<F>::ret_type> | |
| RResultPtr< T > | Reduce (F f, std::string_view columnName="") |
| Execute a user-defined reduce operation on the values of a column. | |
| RResultPtr< RCutFlowReport > | Report () |
| Gather filtering statistics. | |
| RInterface (const std::shared_ptr< Proxied > &proxied, RLoopManager &lm, const RDFInternal::RColumnRegister &colRegister) | |
| unsigned int | RunGraphs (std::vector< RResultHandle > handles) |
| Run the event loops of multiple RDataFrames concurrently. | |
| template<typename NodeType> | |
| std::string | SaveGraph (NodeType node) |
| Create a graphviz representation of the dataframe computation graph, return it as a string. | |
| template<typename NodeType> | |
| void | SaveGraph (NodeType node, const std::string &outputFile) |
| Create a graphviz representation of the dataframe computation graph, write it to the specified file. | |
| template<typename... ColumnTypes> | |
| RResultPtr< RInterface< RLoopManager > > | Snapshot (std::string_view treename, std::string_view filename, const ColumnNames_t &columnList, const RSnapshotOptions &options=RSnapshotOptions()) |
| RResultPtr< RInterface< RLoopManager > > | Snapshot (std::string_view treename, std::string_view filename, const ColumnNames_t &columnList, const RSnapshotOptions &options=RSnapshotOptions()) |
Save selected columns to disk, in a new TTree or RNTuple treename in file filename. | |
| RResultPtr< RInterface< RLoopManager > > | Snapshot (std::string_view treename, std::string_view filename, std::initializer_list< std::string > columnList, const RSnapshotOptions &options=RSnapshotOptions()) |
Save selected columns to disk, in a new TTree or RNTuple treename in file filename. | |
| RResultPtr< RInterface< RLoopManager > > | Snapshot (std::string_view treename, std::string_view filename, std::string_view columnNameRegexp="", const RSnapshotOptions &options=RSnapshotOptions()) |
Save selected columns to disk, in a new TTree or RNTuple treename in file filename. | |
| void | splitInEqualRanges (std::vector< std::pair< ULong64_t, ULong64_t > > &ranges, int nRecords, unsigned int nSlots) |
| template<typename V = RDFDetail::RInferredType, typename W = RDFDetail::RInferredType> | |
| RResultPtr< TStatistic > | Stats (std::string_view value, std::string_view weight) |
| Return a TStatistic object, filled once per event (lazy action). | |
| template<typename V = RDFDetail::RInferredType> | |
| RResultPtr< TStatistic > | Stats (std::string_view value="") |
| Return a TStatistic object, filled once per event (lazy action). | |
| template<typename T = RDFDetail::RInferredType> | |
| RResultPtr< double > | StdDev (std::string_view columnName="") |
| Return the unbiased standard deviation of processed column values (lazy action). | |
| template<typename T = RDFDetail::RInferredType> | |
| RResultPtr< RDFDetail::SumReturnType_t< T > > | Sum (std::string_view columnName="", const RDFDetail::SumReturnType_t< T > &initValue=RDFDetail::SumReturnType_t< T >{}) |
| Return the sum of processed column values (lazy action). | |
| template<typename T, typename COLL = std::vector<T>> | |
| RResultPtr< COLL > | Take (std::string_view column="") |
| Return a collection of values of a column (lazy action, returns a std::vector by default). | |
| RInterface< Proxied > | Vary (const std::vector< std::string > &colNames, std::string_view expression, const std::vector< std::string > &variationTags, std::string_view variationName) |
| Register systematic variations for multiple existing columns using custom variation tags. | |
| RInterface< Proxied > | Vary (const std::vector< std::string > &colNames, std::string_view expression, std::size_t nVariations, std::string_view variationName) |
| Register systematic variations for multiple existing columns using auto-generated variation tags. | |
| RInterface< Proxied > | Vary (std::initializer_list< std::string > colNames, std::string_view expression, std::size_t nVariations, std::string_view variationName) |
| Register systematic variations for multiple existing columns using auto-generated variation tags. | |
| template<typename Proxied> | |
| ROOT::RDF::RInterface RInterfaceBase | Vary (std::string_view colName, std::string_view expression, std::size_t nVariations, std::string_view variationName="") |
| Register systematic variations for a single existing column using auto-generated variation tags. | |
| template<bool IsSingleColumn, typename F> | |
| RInterface< Proxied > | VaryImpl (const std::vector< std::string > &colNames, F &&expression, const ColumnNames_t &inputColumns, const std::vector< std::string > &variationTags, std::string_view variationName) |
| typedef std::vector< std::string > ROOT::RDF::ColumnNames_t = std::vector<std::string> |
Definition at line 35 of file RInterfaceBase.hxx.
| typedef RInterface<::ROOT::Detail::RDF::RNodeBase > ROOT::RDF::RNode = RInterface<::ROOT::Detail::RDF::RNodeBase> |
Definition at line 55 of file InterfaceUtils.hxx.
| using ROOT::RDF::SampleCallback_t = std::function<void(unsigned int, const ROOT::RDF::RSampleInfo &)> |
The type of a data-block callback, registered with an RDataFrame computation graph via e.g.
DefinePerSample() or by certain actions (e.g. Snapshot()).
Definition at line 140 of file RSampleInfo.hxx.
|
strong |
| Enumerator | |
|---|---|
| kDefault | |
| kTTree | |
| kRNTuple | |
Definition at line 21 of file RSnapshotOptions.hxx.
| RResultPtr< U > ROOT::RDF::Aggregate | ( | AccFun | aggregator, |
| MergeFun | merger, | ||
| std::string_view | columnName, | ||
| const U & | aggIdentity ) |
Execute a user-defined accumulation operation on the processed column values in each processing slot.
| F | The type of the aggregator callable. Automatically deduced. |
| U | The type of the aggregator variable. Must be default-constructible, copy-constructible and copy-assignable. Automatically deduced. |
| T | The type of the column to apply the reduction to. Automatically deduced. |
| [in] | aggregator | A callable with signature U(U,T) or void(U&,T), where T is the type of the column, U is the type of the aggregator variable |
| [in] | merger | A callable with signature U(U,U) or void(std::vector<U>&) used to merge the results of the accumulations of each thread |
| [in] | columnName | The column to be aggregated. If omitted, the first default column is used instead. |
| [in] | aggIdentity | The aggregator variable of each thread is initialized to this value (or is default-constructed if the parameter is omitted) |
An aggregator callable takes two values, an aggregator variable and a column value. The aggregator variable is initialized to aggIdentity or default-constructed if aggIdentity is omitted. This action calls the aggregator callable for each processed entry, passing in the aggregator variable and the value of the column columnName. If the signature is U(U,T) the aggregator variable is then copy-assigned the result of the execution of the callable. Otherwise the signature of aggregator must be void(U&,T).
The merger callable is used to merge the partial accumulation results of each processing thread. It is only called in multi-thread executions. If its signature is U(U,U) the aggregator variables of each thread are merged two by two. If its signature is void(std::vector<U>& a) it is assumed that it merges all aggregators in a[0].
This action is lazy: upon invocation of this method the calculation is booked but not executed. Also see RResultPtr.
Example usage:
Definition at line 3515 of file RInterface.hxx.
| RResultPtr< U > ROOT::RDF::Aggregate | ( | AccFun | aggregator, |
| MergeFun | merger, | ||
| std::string_view | columnName = "" ) |
Execute a user-defined accumulation operation on the processed column values in each processing slot.
| F | The type of the aggregator callable. Automatically deduced. |
| U | The type of the aggregator variable. Must be default-constructible, copy-constructible and copy-assignable. Automatically deduced. |
| T | The type of the column to apply the reduction to. Automatically deduced. |
| [in] | aggregator | A callable with signature U(U,T) or void(U,T), where T is the type of the column, U is the type of the aggregator variable |
| [in] | merger | A callable with signature U(U,U) or void(std::vector<U>&) used to merge the results of the accumulations of each thread |
| [in] | columnName | The column to be aggregated. If omitted, the first default column is used instead. |
See previous Aggregate overload for more information.
Definition at line 3549 of file RInterface.hxx.
| RInterface< Proxied > ROOT::RDF::Alias | ( | std::string_view | alias, |
| std::string_view | columnName ) |
Allow to refer to a column with a different name.
| [in] | alias | name of the column alias |
| [in] | columnName | of the column to be aliased |
Aliasing an alias is supported.
Definition at line 1290 of file RInterface.hxx.
| RNode ROOT::RDF::AsRNode | ( | NodeType | node | ) |
Cast a RDataFrame node to the common type ROOT::RDF::RNode.
| [in] | node | Any node of a RDataFrame graph |
Definition at line 158 of file RDFHelpers.hxx.
| RResultPtr< typename std::decay_t< Helper >::Result_t > ROOT::RDF::Book | ( | Helper && | helper, |
| const ColumnNames_t & | columns = {} ) |
Book execution of a custom action using a user-defined helper object.
| FirstColumn | The type of the first column used by this action. Inferred together with OtherColumns if not present. |
| OtherColumns | A list of the types of the other columns used by this action |
| Helper | The type of the user-defined helper. See below for the required interface it should expose. |
| [in] | helper | The Action Helper to be scheduled. |
| [in] | columns | The names of the columns on which the helper acts. |
This method books a custom action for execution. The behavior of the action is completely dependent on the Helper object provided by the caller. The required interface for the helper is described below (more methods that the ones required can be present, e.g. a constructor that takes the number of worker threads is usually useful):
Helper must publicly inherit from ROOT::Detail::RDF::RActionImpl<Helper>Helper::Result_t: public alias for the type of the result of this action helper. Result_t must be default-constructible.Helper(Helper &&): a move-constructor is required. Copy-constructors are discouraged.std::shared_ptr<Result_t> GetResultPtr() const: return a shared_ptr to the result of this action (of type Result_t). The RResultPtr returned by Book will point to this object. Note that this method can be called before Initialize(), because the RResultPtr is constructed before the event loop is started.void Initialize(): this method is called once before starting the event-loop. Useful for setup operations. It must reset the state of the helper to the expected state at the beginning of the event loop: the same helper, or copies of it, might be used for multiple event loops (e.g. in the presence of systematic variations).void InitTask(TTreeReader *, unsigned int slot): each working thread shall call this method during the event loop, before processing a batch of entries. The pointer passed as argument, if not null, will point to the TTreeReader that RDataFrame has set up to read the task's batch of entries. It is passed to the helper to allow certain advanced optimizations it should not usually serve any purpose for the Helper. This method is often no-op for simple helpers.void Exec(unsigned int slot, ColumnTypes...columnValues): each working thread shall call this method during the event-loop, possibly concurrently. No two threads will ever call Exec with the same 'slot' value: this parameter is there to facilitate writing thread-safe helpers. The other arguments will be the values of the requested columns for the particular entry being processed.void Finalize(): this method is called at the end of the event loop. Commonly used to finalize the contents of the result.std::string GetActionName(): it returns a string identifier for this type of action that RDataFrame will use in diagnostics, SaveGraph(), etc.If these methods are implemented they enable extra functionality as per the description below.
Result_t &PartialUpdate(unsigned int slot): if present, it must return the value of the partial result of this action for the given 'slot'. Different threads might call this method concurrently, but will do so with different 'slot' numbers. RDataFrame leverages this method to implement RResultPtr::OnPartialResult().ROOT::RDF::SampleCallback_t GetSampleCallback(): if present, it must return a callable with the appropriate signature (see ROOT::RDF::SampleCallback_t) that will be invoked at the beginning of the processing of every sample, as in DefinePerSample().Helper MakeNew(void *newResult, std::string_view variation = "nominal"): if implemented, it enables varying the action's result with VariationsFor(). It takes a type-erased new result that can be safely cast to a std::shared_ptr<Result_t> * (a pointer to shared pointer) and should be used as the action's output result. The function optionally takes the name of the current variation which could be useful in customizing its behaviour.In case Book is called without specifying column types as template arguments, corresponding typed code will be just-in-time compiled by RDataFrame. In that case the Helper class needs to be known to the ROOT interpreter.
This action is lazy: upon invocation of this method the calculation is booked but not executed. Also see RResultPtr.
See this tutorial for an example implementation of an action helper.
It is also possible to inspect the code used by built-in RDataFrame actions at ActionHelpers.hxx.
Definition at line 3621 of file RInterface.hxx.
| RInterface< RLoopManager > ROOT::RDF::Cache | ( | const ColumnNames_t & | columnList | ) |
Save selected columns in memory.
| ColumnTypes | variadic list of branch/column types. |
| [in] | columnList | columns to be cached in memory. |
RDataFrame that wraps the cached dataset.This action returns a new RDataFrame object, completely detached from the originating RDataFrame. The new dataframe only contains the cached columns and stores their content in memory for fast, zero-copy subsequent access.
Use Cache if you know you will only need a subset of the (Filtered) data that fits in memory and that will be accessed many times.
#columnname. These are special columns made available by some data sources (e.g. RNTupleDS) that represent the size of column columnname, and are not meant to be written out with that name (which is not a valid C++ variable name). Instead, go through an Alias(): df.Alias("nbar", "#bar").Cache<std::size_t>(..., {"nbar"}).Types and columns specified:
Types inferred and columns specified (this invocation relies on jitting):
Types inferred and columns selected with a regexp (this invocation relies on jitting):
Definition at line 1634 of file RInterface.hxx.
| RInterface< RLoopManager > ROOT::RDF::Cache | ( | const ColumnNames_t & | columnList | ) |
Save selected columns in memory.
| [in] | columnList | columns to be cached in memory |
RDataFrame that wraps the cached dataset.See the previous overloads for more information.
Definition at line 1646 of file RInterface.hxx.
| RInterface< RLoopManager > ROOT::RDF::Cache | ( | std::initializer_list< std::string > | columnList | ) |
Save selected columns in memory.
| [in] | columnList | columns to be cached in memory. |
RDataFrame that wraps the cached dataset.See the previous overloads for more information.
Definition at line 1717 of file RInterface.hxx.
| RInterface< RLoopManager > ROOT::RDF::Cache | ( | std::string_view | columnNameRegexp = "" | ) |
Save selected columns in memory.
| [in] | columnNameRegexp | The regular expression to match the column names to be selected. The presence of a '^' and a '$' at the end of the string is implicitly assumed if they are not specified. The dialect supported is PCRE via the TPRegexp class. An empty string signals the selection of all columns. |
RDataFrame that wraps the cached dataset.The existing columns are matched against the regular expression. If the string provided is empty, all columns are selected. See the previous overloads for more information.
Definition at line 1695 of file RInterface.hxx.
|
private |
Implementation of cache.
Definition at line 3798 of file RInterface.hxx.
|
private |
Definition at line 3900 of file RInterface.hxx.
|
private |
Definition at line 3890 of file RInterface.hxx.
| RResultPtr< ULong64_t > ROOT::RDF::Count | ( | ) |
Return the number of entries processed (lazy action).
Useful e.g. for counting the number of entries passing a certain filter (see also Report). This action is lazy: upon invocation of this method the calculation is booked but not executed. Also see RResultPtr.
Definition at line 1900 of file RInterface.hxx.
|
private |
Definition at line 3737 of file RInterface.hxx.
|
private |
Definition at line 3788 of file RInterface.hxx.
| RResultPtr< RDisplay > ROOT::RDF::Display | ( | const ColumnNames_t & | columnList, |
| size_t | nRows = 5, | ||
| size_t | nMaxCollectionElements = 10 ) |
Provides a representation of the columns in the dataset.
| ColumnTypes | variadic list of branch/column types. |
| [in] | columnList | Names of the columns to be displayed. |
| [in] | nRows | Number of events for each column to be displayed. |
| [in] | nMaxCollectionElements | Maximum number of collection elements to display per row. |
RDisplay instance wrapped in a RResultPtr.This function returns a RResultPtr<RDisplay> containing all the entries to be displayed, organized in a tabular form. RDisplay will either print on the standard output a summarized version through RDisplay::Print() or will return a complete version through RDisplay::AsString().
This action is lazy: upon invocation of this method the calculation is booked but not executed. Also see RResultPtr.
Example usage:
Definition at line 3666 of file RInterface.hxx.
| RResultPtr< RDisplay > ROOT::RDF::Display | ( | const ColumnNames_t & | columnList, |
| size_t | nRows = 5, | ||
| size_t | nMaxCollectionElements = 10 ) |
Provides a representation of the columns in the dataset.
| [in] | columnList | Names of the columns to be displayed. |
| [in] | nRows | Number of events for each column to be displayed. |
| [in] | nMaxCollectionElements | Maximum number of collection elements to display per row. |
RDisplay instance wrapped in a RResultPtr.This overload automatically infers the column types. See the previous overloads for further details.
Invoked when no types are specified to Display
Definition at line 3689 of file RInterface.hxx.
| RResultPtr< RDisplay > ROOT::RDF::Display | ( | std::initializer_list< std::string > | columnList, |
| size_t | nRows = 5, | ||
| size_t | nMaxCollectionElements = 10 ) |
Provides a representation of the columns in the dataset.
| [in] | columnList | Names of the columns to be displayed. |
| [in] | nRows | Number of events for each column to be displayed. |
| [in] | nMaxCollectionElements | Number of maximum elements in collection. |
RDisplay instance wrapped in a RResultPtr.See the previous overloads for further details.
Definition at line 3728 of file RInterface.hxx.
| RResultPtr< RDisplay > ROOT::RDF::Display | ( | std::string_view | columnNameRegexp = "", |
| size_t | nRows = 5, | ||
| size_t | nMaxCollectionElements = 10 ) |
Provides a representation of the columns in the dataset.
| [in] | columnNameRegexp | A regular expression to select the columns. |
| [in] | nRows | Number of events for each column to be displayed. |
| [in] | nMaxCollectionElements | Maximum number of collection elements to display per row. |
RDisplay instance wrapped in a RResultPtr.The existing columns are matched against the regular expression. If the string provided is empty, all columns are selected. See the previous overloads for further details.
Definition at line 3712 of file RInterface.hxx.
| RResultPtr< std::decay_t< T > > ROOT::RDF::Fill | ( | T && | model, |
| const ColumnNames_t & | columnList ) |
Return an object of type T on which T::Fill will be called once per event (lazy action).
Type T must provide at least:
Fill method that accepts as many arguments and with same types as the column names passed as columnList (these types can also be passed as template parameters to this method)Merge method with signature Merge(TCollection *) or Merge(const std::vector<T *>&) that merges the objects passed as argument into the object on which Merge was called (an analogous of TH1::Merge). Note that if the signature that takes a TCollection* is used, then T must inherit from TObject (to allow insertion in the TCollection*).| FirstColumn | The first type of the column the values of which are used to fill the object. Inferred together with OtherColumns if not present. |
| OtherColumns | A list of the other types of the columns the values of which are used to fill the object. |
| T | The type of the object to fill. Automatically deduced. |
| [in] | model | The model to be considered to build the new return value. |
| [in] | columnList | A list containing the names of the columns that will be passed when calling Fill |
The user gives up ownership of the model object. The list of column names to be used for filling must always be specified. This action is lazy: upon invocation of this method the calculation is booked but not executed. Also see RResultPtr.
Definition at line 3170 of file RInterface.hxx.
| void ROOT::RDF::Foreach | ( | F | f, |
| const ColumnNames_t & | columns = {} ) |
Execute a user-defined function on each entry (instant action).
| [in] | f | Function, lambda expression, functor class or any other callable object performing user defined calculations. |
| [in] | columns | Names of the columns/branches in input to the user function. |
The callable f is invoked once per entry. This is an instant action: upon invocation, an event loop as well as execution of all scheduled actions is triggered. Users are responsible for the thread-safety of this callable when executing with implicit multi-threading enabled (i.e. ROOT::EnableImplicitMT).
Definition at line 1782 of file RInterface.hxx.
| void ROOT::RDF::ForeachSlot | ( | F | f, |
| const ColumnNames_t & | columns = {} ) |
Execute a user-defined function requiring a processing slot index on each entry (instant action).
| [in] | f | Function, lambda expression, functor class or any other callable object performing user defined calculations. |
| [in] | columns | Names of the columns/branches in input to the user function. |
Same as Foreach, but the user-defined function takes an extra unsigned int as its first parameter, the processing slot index. This slot index will be assigned a different value, 0 to poolSize - 1, for each thread of execution. This is meant as a helper in writing thread-safe Foreach actions when using RDataFrame after ROOT::EnableImplicitMT(). The user-defined processing callable is able to follow different streams of processing indexed by the first parameter. ForeachSlot works just as well with single-thread execution: in that case slot will always be 0.
Definition at line 1812 of file RInterface.hxx.
| RDataFrame ROOT::RDF::FromArrow | ( | std::shared_ptr< arrow::Table > | table, |
| std::vector< std::string > const & | columnNames ) |
Factory method to create a Apache Arrow RDataFrame.
Creates a RDataFrame using an arrow::Table as input.
| [in] | table | an apache::arrow table to use as a source / to observe. |
| [in] | columnNames | the name of the columns to use In case columnNames is empty, we use all the columns found in the table |
Definition at line 606 of file RArrowDS.cxx.
| RDataFrame ROOT::RDF::FromCSV | ( | std::string_view | fileName, |
| bool | readHeaders = true, | ||
| char | delimiter = ',', | ||
| Long64_t | linesChunkSize = -1LL, | ||
| std::unordered_map< std::string, char > && | colTypes = {} ) |
Factory method to create a CSV RDataFrame.
| [in] | fileName | Path of the CSV file. |
| [in] | readHeaders | true if the CSV file contains headers as first row, false otherwise (default true). |
| [in] | delimiter | Delimiter character (default ','). |
| [in] | linesChunkSize | bunch of lines to read, use -1 to read all |
| [in] | colTypes | Allow user to specify custom column types, accepts an unordered map with keys being column type, values being type alias ('O' for boolean, 'D' for double, 'L' for Long64_t, 'T' for std::string) |
Definition at line 650 of file RCsvDS.cxx.
| RDataFrame ROOT::RDF::FromCSV | ( | std::string_view | fileName, |
| const RCsvDS::ROptions & | options ) |
Factory method to create a CSV RDataFrame.
| [in] | fileName | Path of the CSV file. |
| [in] | options | File parsing settings. |
Definition at line 644 of file RCsvDS.cxx.
| ROOT::RDataFrame ROOT::RDF::FromRNTuple | ( | std::string_view | ntupleName, |
| const std::vector< std::string > & | fileNames ) |
Definition at line 986 of file RNTupleDS.cxx.
| ROOT::RDataFrame ROOT::RDF::FromRNTuple | ( | std::string_view | ntupleName, |
| std::string_view | fileName ) |
Definition at line 981 of file RNTupleDS.cxx.
| RDataFrame ROOT::RDF::FromSqlite | ( | std::string_view | fileName, |
| std::string_view | query ) |
Factory method to create a SQlite RDataFrame.
| [in] | fileName | Path of the sqlite file. |
| [in] | query | SQL query that defines the data set. |
Definition at line 524 of file RSqliteDS.cxx.
| std::shared_ptr< arrow::ChunkedArray > ROOT::RDF::getData | ( | T | p | ) |
Definition at line 542 of file RArrowDS.cxx.
| std::vector< std::string > ROOT::RDF::GetFilterNames | ( | ) |
Returns the names of the filters created.
If called on a root node, all the filters in the computation graph will be printed. For any other node, only the filters upstream of that node. Filters without a name are printed as "Unnamed Filter" This is not an action nor a transformation, just a query to the RDataFrame object.
Definition at line 3463 of file RInterface.hxx.
| int ROOT::RDF::getNRecords | ( | std::shared_ptr< arrow::Table > & | table, |
| std::vector< std::string > & | columnNames ) |
Definition at line 535 of file RArrowDS.cxx.
|
protected |
Definition at line 3917 of file RInterface.hxx.
| RResultPtr<::TGraph > ROOT::RDF::Graph | ( | std::string_view | x = "", |
| std::string_view | y = "" ) |
Fill and return a TGraph object (lazy action).
| X | The type of the column used to fill the x axis. |
| Y | The type of the column used to fill the y axis. |
| [in] | x | The name of the column that will fill the x axis. |
| [in] | y | The name of the column that will fill the y axis. |
Columns can be of a container type (e.g. std::vector<double>), in which case the TGraph is filled with each one of the elements of the container. If Multithreading is enabled, the order in which points are inserted is undefined. If the Graph has to be drawn, it is suggested to the user to sort it on the x before printing. A name and a title to the TGraph is given based on the input column names.
This action is lazy: upon invocation of this method the calculation is booked but not executed. Also see RResultPtr.
Definition at line 2847 of file RInterface.hxx.
| RResultPtr<::TGraphAsymmErrors > ROOT::RDF::GraphAsymmErrors | ( | std::string_view | x = "", |
| std::string_view | y = "", | ||
| std::string_view | exl = "", | ||
| std::string_view | exh = "", | ||
| std::string_view | eyl = "", | ||
| std::string_view | eyh = "" ) |
Fill and return a TGraphAsymmErrors object (lazy action).
| [in] | x | The name of the column that will fill the x axis. |
| [in] | y | The name of the column that will fill the y axis. |
| [in] | exl | The name of the column of X low errors |
| [in] | exh | The name of the column of X high errors |
| [in] | eyl | The name of the column of Y low errors |
| [in] | eyh | The name of the column of Y high errors |
Columns can be of a container type (e.g. std::vector<double>), in which case the graph is filled with each one of the elements of the container. If Multithreading is enabled, the order in which points are inserted is undefined.
This action is lazy: upon invocation of this method the calculation is booked but not executed. Also see RResultPtr.
GraphAsymmErrors should also be used for the cases in which values associated only with one of the axes have associated errors. For example, only ey exist and ex are equal to zero. In such cases, user should do the following:
Definition at line 2912 of file RInterface.hxx.
| RResultPtr< ROOT::Experimental::RHist< BinContentType > > ROOT::RDF::Hist | ( | std::shared_ptr< ROOT::Experimental::RHist< BinContentType > > | h, |
| const ColumnNames_t & | columnList ) |
Fill the provided RHist (lazy action).
| [in] | h | The histogram that should be filled. |
| [in] | columnList | A list containing the names of the columns that will be passed when calling Fill |
This action is lazy: upon invocation of this method the calculation is booked but not executed. Also see RResultPtr.
During execution of the computation graph, the passed histogram must only be accessed with methods that are allowed during concurrent filling.
Definition at line 2617 of file RInterface.hxx.
| RResultPtr< ROOT::Experimental::RHist< BinContentType > > ROOT::RDF::Hist | ( | std::shared_ptr< ROOT::Experimental::RHist< BinContentType > > | h, |
| const ColumnNames_t & | columnList, | ||
| std::string_view | wName ) |
Fill the provided RHist with weights (lazy action).
| [in] | h | The histogram that should be filled. |
| [in] | columnList | A list containing the names of the columns that will be passed when calling Fill |
| [in] | wName | The name of the column that will provide the weights. |
This action is lazy: upon invocation of this method the calculation is booked but not executed. Also see RResultPtr.
This overload is not available for integral bin content types (see RHistEngine::SupportsWeightedFilling).
During execution of the computation graph, the passed histogram must only be accessed with methods that are allowed during concurrent filling.
Definition at line 2718 of file RInterface.hxx.
| RResultPtr< ROOT::Experimental::RHistEngine< BinContentType > > ROOT::RDF::Hist | ( | std::shared_ptr< ROOT::Experimental::RHistEngine< BinContentType > > | h, |
| const ColumnNames_t & | columnList ) |
Fill the provided RHistEngine (lazy action).
| [in] | h | The histogram that should be filled. |
| [in] | columnList | A list containing the names of the columns that will be passed when calling Fill |
This action is lazy: upon invocation of this method the calculation is booked but not executed. Also see RResultPtr.
During execution of the computation graph, the passed histogram must only be accessed with methods that are allowed during concurrent filling.
Definition at line 2759 of file RInterface.hxx.
| RResultPtr< ROOT::Experimental::RHistEngine< BinContentType > > ROOT::RDF::Hist | ( | std::shared_ptr< ROOT::Experimental::RHistEngine< BinContentType > > | h, |
| const ColumnNames_t & | columnList, | ||
| std::string_view | wName ) |
Fill the provided RHistEngine with weights (lazy action).
| [in] | h | The histogram that should be filled. |
| [in] | columnList | A list containing the names of the columns that will be passed when calling Fill |
| [in] | wName | The name of the column that will provide the weights. |
This action is lazy: upon invocation of this method the calculation is booked but not executed. Also see RResultPtr.
This overload is not available for integral bin content types (see RHistEngine::SupportsWeightedFilling).
During execution of the computation graph, the passed histogram must only be accessed with methods that are allowed during concurrent filling.
Definition at line 2795 of file RInterface.hxx.
| RResultPtr< ROOT::Experimental::RHist< BinContentType > > ROOT::RDF::Hist | ( | std::uint64_t | nNormalBins, |
| std::pair< double, double > | interval, | ||
| std::string_view | vName ) |
Fill and return a one-dimensional RHist (lazy action).
| BinContentType | The bin content type of the returned RHist. |
| [in] | nNormalBins | The returned histogram will be constructed using this number of normal bins. |
| [in] | interval | The axis interval of the constructed histogram (lower end inclusive, upper end exclusive). |
| [in] | vName | The name of the column that will fill the histogram. |
This action is lazy: upon invocation of this method the calculation is booked but not executed. Also see RResultPtr.
Definition at line 2559 of file RInterface.hxx.
| RResultPtr< ROOT::Experimental::RHist< BinContentType > > ROOT::RDF::Hist | ( | std::uint64_t | nNormalBins, |
| std::pair< double, double > | interval, | ||
| std::string_view | vName, | ||
| std::string_view | wName ) |
Fill and return a one-dimensional RHist with weights (lazy action).
| BinContentType | The bin content type of the returned RHist. |
| [in] | nNormalBins | The returned histogram will be constructed using this number of normal bins. |
| [in] | interval | The axis interval of the constructed histogram (lower end inclusive, upper end exclusive). |
| [in] | vName | The name of the column that will fill the histogram. |
| [in] | wName | The name of the column that will provide the weights. |
This action is lazy: upon invocation of this method the calculation is booked but not executed. Also see RResultPtr.
Definition at line 2650 of file RInterface.hxx.
| RResultPtr< ROOT::Experimental::RHist< BinContentType > > ROOT::RDF::Hist | ( | std::vector< ROOT::Experimental::RAxisVariant > | axes, |
| const ColumnNames_t & | columnList ) |
Fill and return an RHist (lazy action).
| BinContentType | The bin content type of the returned RHist. |
| [in] | axes | The returned histogram will be constructed using these axes. |
| [in] | columnList | A list containing the names of the columns that will be passed when calling Fill |
This action is lazy: upon invocation of this method the calculation is booked but not executed. Also see RResultPtr.
Definition at line 2585 of file RInterface.hxx.
| RResultPtr< ROOT::Experimental::RHist< BinContentType > > ROOT::RDF::Hist | ( | std::vector< ROOT::Experimental::RAxisVariant > | axes, |
| const ColumnNames_t & | columnList, | ||
| std::string_view | wName ) |
Fill and return an RHist with weights (lazy action).
| BinContentType | The bin content type of the returned RHist. |
| [in] | axes | The returned histogram will be constructed using these axes. |
| [in] | columnList | A list containing the names of the columns that will be passed when calling Fill |
| [in] | wName | The name of the column that will provide the weights. |
This action is lazy: upon invocation of this method the calculation is booked but not executed. Also see RResultPtr.
This overload is not available for integral bin content types (see RHistEngine::SupportsWeightedFilling).
Definition at line 2680 of file RInterface.hxx.
| RResultPtr<::TH1D > ROOT::RDF::Histo1D | ( | const TH1DModel & | model, |
| std::string_view | vName, | ||
| std::string_view | wName ) |
Fill and return a one-dimensional histogram with the weighted values of a column (lazy action).
| V | The type of the column used to fill the histogram. |
| W | The type of the column used as weights. |
| [in] | model | The returned histogram will be constructed using this as a model. |
| [in] | vName | The name of the column that will fill the histogram. |
| [in] | wName | The name of the column that will provide the weights. |
See the description of the first Histo1D() overload for more details.
Definition at line 2036 of file RInterface.hxx.
| RResultPtr<::TH1D > ROOT::RDF::Histo1D | ( | const TH1DModel & | model = {"", "", 128u, 0., 0.} | ) |
Fill and return a one-dimensional histogram with the weighted values of a column (lazy action).
| V | The type of the column used to fill the histogram. |
| W | The type of the column used as weights. |
| [in] | model | The returned histogram will be constructed using this as a model. |
This overload will use the first two default columns as column names. See the description of the first Histo1D() overload for more details.
Definition at line 2093 of file RInterface.hxx.
| RResultPtr<::TH1D > ROOT::RDF::Histo1D | ( | const TH1DModel & | model = {"", "", 128u, 0., 0.}, |
| std::string_view | vName = "" ) |
Fill and return a one-dimensional histogram with the values of a column (lazy action).
| V | The type of the column used to fill the histogram. |
| [in] | model | The returned histogram will be constructed using this as a model. |
| [in] | vName | The name of the column that will fill the histogram. |
Columns can be of a container type (e.g. std::vector<double>), in which case the histogram is filled with each one of the elements of the container. In case multiple columns of container type are provided (e.g. values and weights) they must have the same length for each one of the events (but possibly different lengths between events). This action is lazy: upon invocation of this method the calculation is booked but not executed. Also see RResultPtr.
Definition at line 1975 of file RInterface.hxx.
| RResultPtr<::TH1D > ROOT::RDF::Histo1D | ( | std::string_view | vName | ) |
Fill and return a one-dimensional histogram with the values of a column (lazy action).
| V | The type of the column used to fill the histogram. |
| [in] | vName | The name of the column that will fill the histogram. |
This overload uses a default model histogram TH1D(name, title, 128u, 0., 0.). The "name" and "title" strings are built starting from the input column name. See the description of the first Histo1D() overload for more details.
Definition at line 2010 of file RInterface.hxx.
| RResultPtr<::TH1D > ROOT::RDF::Histo1D | ( | std::string_view | vName, |
| std::string_view | wName ) |
Fill and return a one-dimensional histogram with the weighted values of a column (lazy action).
| V | The type of the column used to fill the histogram. |
| W | The type of the column used as weights. |
| [in] | vName | The name of the column that will fill the histogram. |
| [in] | wName | The name of the column that will provide the weights. |
This overload uses a default model histogram TH1D(name, title, 128u, 0., 0.). The "name" and "title" strings are built starting from the input column names. See the description of the first Histo1D() overload for more details.
Definition at line 2073 of file RInterface.hxx.
| RResultPtr<::TH2D > ROOT::RDF::Histo2D | ( | const TH2DModel & | model | ) |
Definition at line 2188 of file RInterface.hxx.
| RResultPtr<::TH2D > ROOT::RDF::Histo2D | ( | const TH2DModel & | model, |
| std::string_view | v1Name, | ||
| std::string_view | v2Name, | ||
| std::string_view | wName ) |
Fill and return a weighted two-dimensional histogram (lazy action).
| V1 | The type of the column used to fill the x axis of the histogram. |
| V2 | The type of the column used to fill the y axis of the histogram. |
| W | The type of the column used for the weights of the histogram. |
| [in] | model | The returned histogram will be constructed using this as a model. |
| [in] | v1Name | The name of the column that will fill the x axis. |
| [in] | v2Name | The name of the column that will fill the y axis. |
| [in] | wName | The name of the column that will provide the weights. |
This action is lazy: upon invocation of this method the calculation is booked but not executed. Also see RResultPtr.
See the documentation of the first Histo2D() overload for more details.
Definition at line 2170 of file RInterface.hxx.
| RResultPtr<::TH2D > ROOT::RDF::Histo2D | ( | const TH2DModel & | model, |
| std::string_view | v1Name = "", | ||
| std::string_view | v2Name = "" ) |
Fill and return a two-dimensional histogram (lazy action).
| V1 | The type of the column used to fill the x axis of the histogram. |
| V2 | The type of the column used to fill the y axis of the histogram. |
| [in] | model | The returned histogram will be constructed using this as a model. |
| [in] | v1Name | The name of the column that will fill the x axis. |
| [in] | v2Name | The name of the column that will fill the y axis. |
Columns can be of a container type (e.g. std::vector<double>), in which case the histogram is filled with each one of the elements of the container. In case multiple columns of container type are provided (e.g. values and weights) they must have the same length for each one of the events (but possibly different lengths between events). This action is lazy: upon invocation of this method the calculation is booked but not executed. Also see RResultPtr.
Definition at line 2127 of file RInterface.hxx.
| RResultPtr<::TH3D > ROOT::RDF::Histo3D | ( | const TH3DModel & | model | ) |
Definition at line 2292 of file RInterface.hxx.
| RResultPtr<::TH3D > ROOT::RDF::Histo3D | ( | const TH3DModel & | model, |
| std::string_view | v1Name, | ||
| std::string_view | v2Name, | ||
| std::string_view | v3Name, | ||
| std::string_view | wName ) |
Fill and return a three-dimensional histogram (lazy action).
| V1 | The type of the column used to fill the x axis of the histogram. Inferred if not present. |
| V2 | The type of the column used to fill the y axis of the histogram. Inferred if not present. |
| V3 | The type of the column used to fill the z axis of the histogram. Inferred if not present. |
| W | The type of the column used for the weights of the histogram. Inferred if not present. |
| [in] | model | The returned histogram will be constructed using this as a model. |
| [in] | v1Name | The name of the column that will fill the x axis. |
| [in] | v2Name | The name of the column that will fill the y axis. |
| [in] | v3Name | The name of the column that will fill the z axis. |
| [in] | wName | The name of the column that will provide the weights. |
This action is lazy: upon invocation of this method the calculation is booked but not executed. Also see RResultPtr.
See the documentation of the first Histo2D() overload for more details.
Definition at line 2273 of file RInterface.hxx.
| RResultPtr<::TH3D > ROOT::RDF::Histo3D | ( | const TH3DModel & | model, |
| std::string_view | v1Name = "", | ||
| std::string_view | v2Name = "", | ||
| std::string_view | v3Name = "" ) |
Fill and return a three-dimensional histogram (lazy action).
| V1 | The type of the column used to fill the x axis of the histogram. Inferred if not present. |
| V2 | The type of the column used to fill the y axis of the histogram. Inferred if not present. |
| V3 | The type of the column used to fill the z axis of the histogram. Inferred if not present. |
| [in] | model | The returned histogram will be constructed using this as a model. |
| [in] | v1Name | The name of the column that will fill the x axis. |
| [in] | v2Name | The name of the column that will fill the y axis. |
| [in] | v3Name | The name of the column that will fill the z axis. |
This action is lazy: upon invocation of this method the calculation is booked but not executed. Also see RResultPtr.
Definition at line 2224 of file RInterface.hxx.
| RResultPtr<::THnD > ROOT::RDF::HistoND | ( | const THnDModel & | model, |
| const ColumnNames_t & | columnList, | ||
| std::string_view | wName = "" ) |
Fill and return an N-dimensional histogram (lazy action).
| FirstColumn | The first type of the column the values of which are used to fill the object. Inferred if not present. |
| OtherColumns | A list of the other types of the columns the values of which are used to fill the object. |
| [in] | model | The returned histogram will be constructed using this as a model. |
| [in] | columnList | A list containing the names of the columns that will be passed when calling Fill. |
| [in] | wName | The name of the column that will provide the weights. |
This action is lazy: upon invocation of this method the calculation is booked but not executed. See RResultPtr documentation.
columnList, but instead be passed in the new argument wName: HistoND(model, cols, weightCol). Definition at line 2323 of file RInterface.hxx.
| RResultPtr<::THnD > ROOT::RDF::HistoND | ( | const THnDModel & | model, |
| const ColumnNames_t & | columnList, | ||
| std::string_view | wName = "" ) |
Fill and return an N-dimensional histogram (lazy action).
| [in] | model | The returned histogram will be constructed using this as a model. |
| [in] | columnList | A list containing the names of the columns that will be passed when calling Fill |
| [in] | wName | The name of the column that will provide the weights. |
This action is lazy: upon invocation of this method the calculation is booked but not executed. Also see RResultPtr.
columnList, but instead be passed in the new argument wName: HistoND(model, cols, weightCol). Definition at line 2380 of file RInterface.hxx.
| RResultPtr<::THnSparseD > ROOT::RDF::HistoNSparseD | ( | const THnSparseDModel & | model, |
| const ColumnNames_t & | columnList, | ||
| std::string_view | wName = "" ) |
Fill and return a sparse N-dimensional histogram (lazy action).
| FirstColumn | The first type of the column the values of which are used to fill the object. Inferred if not present. |
| OtherColumns | A list of the other types of the columns the values of which are used to fill the object. |
| [in] | model | The returned histogram will be constructed using this as a model. |
| [in] | columnList | A list containing the names of the columns that will be passed when calling Fill. |
| [in] | wName | The name of the column that will provide the weights. |
This action is lazy: upon invocation of this method the calculation is booked but not executed. See RResultPtr documentation.
columnList, but instead be passed in the new argument wName: HistoND(model, cols, weightCol). Definition at line 2444 of file RInterface.hxx.
| RResultPtr<::THnSparseD > ROOT::RDF::HistoNSparseD | ( | const THnSparseDModel & | model, |
| const ColumnNames_t & | columnList, | ||
| std::string_view | wName = "" ) |
Fill and return a sparse N-dimensional histogram (lazy action).
| [in] | model | The returned histogram will be constructed using this as a model. |
| [in] | columnList | A list containing the names of the columns that will be passed when calling Fill |
| [in] | wName | The name of the column that will provide the weights. |
This action is lazy: upon invocation of this method the calculation is booked but not executed. Also see RResultPtr.
columnList, but instead be passed in the new argument wName: HistoND(model, cols, weightCol). Definition at line 2503 of file RInterface.hxx.
|
private |
Definition at line 3853 of file RInterface.hxx.
| RDataFrame ROOT::RDF::MakeLazyDataFrame | ( | std::pair< std::string, RResultPtr< std::vector< ColumnTypes > > > &&... | colNameProxyPairs | ) |
Factory method to create a Lazy RDataFrame.
| [in] | colNameProxyPairs | the series of pairs to describe the columns of the data source, first element of the pair is the name of the column and the second is the RResultPtr to the column in the parent data frame. |
Definition at line 29 of file RLazyDS.hxx.
| RInterface< RDFDetail::RLoopManager > ROOT::RDF::MakeTrivialDataFrame | ( | ) |
Make a RDF wrapping a RTrivialDS with infinite entries, for demo purposes.
Definition at line 117 of file RTrivialDS.cxx.
| RInterface< RDFDetail::RLoopManager > ROOT::RDF::MakeTrivialDataFrame | ( | ULong64_t | size, |
| bool | skipEvenEntries = false ) |
Make a RDF wrapping a RTrivialDS with the specified amount of entries.
Constructing an RDataFrame as RDataFrame(nEntries) is a superior alternative. If size is std::numeric_limits<ULong64_t>::max(), this acts as an infinite data-source: it returns entries from GetEntryRanges forever or until a Range stops the event loop (for test purposes).
Definition at line 110 of file RTrivialDS.cxx.
| RResultPtr< RDFDetail::MaxReturnType_t< T > > ROOT::RDF::Max | ( | std::string_view | columnName = "" | ) |
Return the maximum of processed column values (lazy action).
| T | The type of the branch/column. |
| [in] | columnName | The name of the branch/column to be treated. |
If T is not specified, RDataFrame will infer it from the data and just-in-time compile the correct template specialization of this method. If the type of the column is inferred, the return type is double, the type of the column otherwise.
This action is lazy: upon invocation of this method the calculation is booked but not executed. Also see RResultPtr.
Definition at line 3304 of file RInterface.hxx.
| RResultPtr< double > ROOT::RDF::Mean | ( | std::string_view | columnName = "" | ) |
Return the mean of processed column values (lazy action).
| T | The type of the branch/column. |
| [in] | columnName | The name of the branch/column to be treated. |
If T is not specified, RDataFrame will infer it from the data and just-in-time compile the correct template specialization of this method. Note that internally, the summations are executed with Kahan sums in double precision, irrespective of the type of column that is read.
This action is lazy: upon invocation of this method the calculation is booked but not executed. Also see RResultPtr.
Definition at line 3335 of file RInterface.hxx.
| RResultPtr< RDFDetail::MinReturnType_t< T > > ROOT::RDF::Min | ( | std::string_view | columnName = "" | ) |
Return the minimum of processed column values (lazy action).
| T | The type of the branch/column. |
| [in] | columnName | The name of the branch/column to be treated. |
If T is not specified, RDataFrame will infer it from the data and just-in-time compile the correct template specialization of this method. If the type of the column is inferred, the return type is double, the type of the column otherwise.
This action is lazy: upon invocation of this method the calculation is booked but not executed. Also see RResultPtr.
Definition at line 3274 of file RInterface.hxx.
| auto ROOT::RDF::Not | ( | F && | f | ) | -> decltype(RDFInternal::NotHelper(Args(), std::forward<F>(f))) |
Given a callable with signature bool(T1, T2, ...) return a callable with same signature that returns the negated result.
The callable must have one single non-template definition of operator(). This is a limitation with respect to std::not_fn, required for interoperability with RDataFrame.
Definition at line 83 of file RDFHelpers.hxx.
| bool ROOT::RDF::operator!= | ( | const RResultPtr< T1 > & | lhs, |
| const RResultPtr< T2 > & | rhs ) |
Definition at line 428 of file RResultPtr.hxx.
| bool ROOT::RDF::operator!= | ( | const RResultPtr< T1 > & | lhs, |
| std::nullptr_t | rhs ) |
Definition at line 446 of file RResultPtr.hxx.
| bool ROOT::RDF::operator!= | ( | std::nullptr_t | lhs, |
| const RResultPtr< T1 > & | rhs ) |
Definition at line 452 of file RResultPtr.hxx.
| std::ostream & ROOT::RDF::operator<< | ( | std::ostream & | os, |
| const RDFDescription & | description ) |
Definition at line 34 of file RDFDescription.cxx.
| bool ROOT::RDF::operator== | ( | const RResultPtr< T1 > & | lhs, |
| const RResultPtr< T2 > & | rhs ) |
Definition at line 422 of file RResultPtr.hxx.
| bool ROOT::RDF::operator== | ( | const RResultPtr< T1 > & | lhs, |
| std::nullptr_t | rhs ) |
Definition at line 434 of file RResultPtr.hxx.
| bool ROOT::RDF::operator== | ( | std::nullptr_t | lhs, |
| const RResultPtr< T1 > & | rhs ) |
Definition at line 440 of file RResultPtr.hxx.
| auto ROOT::RDF::PassAsVec | ( | F && | f | ) | -> RDFInternal::PassAsVecHelper<std::make_index_sequence<N>, T, F> |
PassAsVec is a callable generator that allows passing N variables of type T to a function as a single collection.
PassAsVec<N, T>(func) returns a callable that takes N arguments of type T, passes them down to function func as an initializer list {t1, t2, t3,..., tN} and returns whatever f({t1, t2, t3, ..., tN}) returns.
Note that for this to work with RDataFrame the type of all columns that the callable is applied to must be exactly T. Example usage together with RDataFrame ("varX" columns must all be float variables):
Definition at line 103 of file RDFHelpers.hxx.
| RResultPtr<::TProfile > ROOT::RDF::Profile1D | ( | const TProfile1DModel & | model | ) |
Fill and return a one-dimensional profile (lazy action). See the first Profile1D() overload for more details.
Definition at line 3026 of file RInterface.hxx.
| RResultPtr<::TProfile > ROOT::RDF::Profile1D | ( | const TProfile1DModel & | model, |
| std::string_view | v1Name, | ||
| std::string_view | v2Name, | ||
| std::string_view | wName ) |
Fill and return a one-dimensional profile (lazy action).
| V1 | The type of the column the values of which are used to fill the profile. Inferred if not present. |
| V2 | The type of the column the values of which are used to fill the profile. Inferred if not present. |
| W | The type of the column the weights of which are used to fill the profile. Inferred if not present. |
| [in] | model | The model to be considered to build the new return value. |
| [in] | v1Name | The name of the column that will fill the x axis. |
| [in] | v2Name | The name of the column that will fill the y axis. |
| [in] | wName | The name of the column that will provide the weights. |
This action is lazy: upon invocation of this method the calculation is booked but not executed. Also see RResultPtr.
See the first Profile1D() overload for more details.
Definition at line 3004 of file RInterface.hxx.
| RResultPtr<::TProfile > ROOT::RDF::Profile1D | ( | const TProfile1DModel & | model, |
| std::string_view | v1Name = "", | ||
| std::string_view | v2Name = "" ) |
Fill and return a one-dimensional profile (lazy action).
| V1 | The type of the column the values of which are used to fill the profile. Inferred if not present. |
| V2 | The type of the column the values of which are used to fill the profile. Inferred if not present. |
| [in] | model | The model to be considered to build the new return value. |
| [in] | v1Name | The name of the column that will fill the x axis. |
| [in] | v2Name | The name of the column that will fill the y axis. |
This action is lazy: upon invocation of this method the calculation is booked but not executed. Also see RResultPtr.
Definition at line 2959 of file RInterface.hxx.
| RResultPtr<::TProfile2D > ROOT::RDF::Profile2D | ( | const TProfile2DModel & | model | ) |
Fill and return a two-dimensional profile (lazy action). See the first Profile2D() overload for more details.
Definition at line 3130 of file RInterface.hxx.
| RResultPtr<::TProfile2D > ROOT::RDF::Profile2D | ( | const TProfile2DModel & | model, |
| std::string_view | v1Name, | ||
| std::string_view | v2Name, | ||
| std::string_view | v3Name, | ||
| std::string_view | wName ) |
Fill and return a two-dimensional profile (lazy action).
| V1 | The type of the column used to fill the x axis of the histogram. Inferred if not present. |
| V2 | The type of the column used to fill the y axis of the histogram. Inferred if not present. |
| V3 | The type of the column used to fill the z axis of the histogram. Inferred if not present. |
| W | The type of the column used for the weights of the histogram. Inferred if not present. |
| [in] | model | The returned histogram will be constructed using this as a model. |
| [in] | v1Name | The name of the column that will fill the x axis. |
| [in] | v2Name | The name of the column that will fill the y axis. |
| [in] | v3Name | The name of the column that will fill the z axis. |
| [in] | wName | The name of the column that will provide the weights. |
This action is lazy: upon invocation of this method the calculation is booked but not executed. Also see RResultPtr.
See the first Profile2D() overload for more details.
Definition at line 3108 of file RInterface.hxx.
| RResultPtr<::TProfile2D > ROOT::RDF::Profile2D | ( | const TProfile2DModel & | model, |
| std::string_view | v1Name = "", | ||
| std::string_view | v2Name = "", | ||
| std::string_view | v3Name = "" ) |
Fill and return a two-dimensional profile (lazy action).
| V1 | The type of the column used to fill the x axis of the histogram. Inferred if not present. |
| V2 | The type of the column used to fill the y axis of the histogram. Inferred if not present. |
| V3 | The type of the column used to fill the z axis of the histogram. Inferred if not present. |
| [in] | model | The returned profile will be constructed using this as a model. |
| [in] | v1Name | The name of the column that will fill the x axis. |
| [in] | v2Name | The name of the column that will fill the y axis. |
| [in] | v3Name | The name of the column that will fill the z axis. |
This action is lazy: upon invocation of this method the calculation is booked but not executed. Also see RResultPtr.
Definition at line 3060 of file RInterface.hxx.
| RInterface< RDFDetail::RRange< Proxied > > ROOT::RDF::Range | ( | unsigned int | begin, |
| unsigned int | end, | ||
| unsigned int | stride = 1 ) |
Creates a node that filters entries based on range: [begin, end).
| [in] | begin | Initial entry number considered for this range. |
| [in] | end | Final entry number (excluded) considered for this range. 0 means that the range goes until the end of the dataset. |
| [in] | stride | Process one entry of the [begin, end) range every stride entries. Must be strictly greater than 0. |
Note that in case of previous Ranges and Filters the selected range refers to the transformed dataset. Ranges are only available if EnableImplicitMT has not been called. Multi-thread ranges are not supported.
Definition at line 1741 of file RInterface.hxx.
| RInterface< RDFDetail::RRange< Proxied > > ROOT::RDF::Range | ( | unsigned int | end | ) |
Creates a node that filters entries based on range.
| [in] | end | Final entry number (excluded) considered for this range. 0 means that the range goes until the end of the dataset. |
See the other Range overload for a detailed description.
Definition at line 1762 of file RInterface.hxx.
| RResultPtr< T > ROOT::RDF::Reduce | ( | F | f, |
| std::string_view | columnName, | ||
| const T & | redIdentity ) |
Execute a user-defined reduce operation on the values of a column.
| F | The type of the reduce callable. Automatically deduced. |
| T | The type of the column to apply the reduction to. Automatically deduced. |
| [in] | f | A callable with signature T(T,T) |
| [in] | columnName | The column to be reduced. If omitted, the first default column is used instead. |
| [in] | redIdentity | The reduced object of each thread is initialized to this value. |
See the description of the first Reduce overload for more information.
Definition at line 1882 of file RInterface.hxx.
| RResultPtr< T > ROOT::RDF::Reduce | ( | F | f, |
| std::string_view | columnName = "" ) |
Execute a user-defined reduce operation on the values of a column.
| F | The type of the reduce callable. Automatically deduced. |
| T | The type of the column to apply the reduction to. Automatically deduced. |
| [in] | f | A callable with signature T(T,T) |
| [in] | columnName | The column to be reduced. If omitted, the first default column is used instead. |
A reduction takes two values of a column and merges them into one (e.g. by summing them, taking the maximum, etc). This action performs the specified reduction operation on all processed column values, returning a single value of the same type. The callable f must satisfy the general requirements of a processing function besides having signature T(T,T) where T is the type of column columnName.
The returned reduced value of each thread (e.g. the initial value of a sum) is initialized to a default-constructed T object. This is commonly expected to be the neutral/identity element for the specific reduction operation f (e.g. 0 for a sum, 1 for a product). If a default-constructed T does not satisfy this requirement, users should explicitly specify an initialization value for T by calling the appropriate Reduce overload.
This action is lazy: upon invocation of this method the calculation is booked but not executed. Also see RResultPtr.
Definition at line 1859 of file RInterface.hxx.
| RResultPtr< RCutFlowReport > ROOT::RDF::Report | ( | ) |
Gather filtering statistics.
RCutFlowReport instance wrapped in a RResultPtr.Calling Report on the main RDataFrame object gathers stats for all named filters in the call graph. Calling this method on a stored chain state (i.e. a graph node different from the first) gathers the stats for all named filters in the chain section between the original RDataFrame and that node (included). Stats are gathered in the same order as the named filters have been added to the graph. A RResultPtr<RCutFlowReport> is returned to allow inspection of the effects cuts had.
This action is lazy: upon invocation of this method the calculation is booked but not executed. See RResultPtr documentation.
Definition at line 3428 of file RInterface.hxx.
|
protected |
Definition at line 3911 of file RInterface.hxx.
| unsigned int ROOT::RDF::RunGraphs | ( | std::vector< RResultHandle > | handles | ) |
Run the event loops of multiple RDataFrames concurrently.
| [in] | handles | A vector of RResultHandles whose event loops should be run. |
This function triggers the event loop of all computation graphs which relate to the given RResultHandles. The advantage compared to running the event loop implicitly by accessing the RResultPtr is that the event loops will run concurrently. Therefore, the overall computation of all results can be scheduled more efficiently. It should be noted that user-defined operations (e.g., Filters and Defines) of the different RDataFrame graphs are assumed to be safe to call concurrently. RDataFrame will pass slot numbers in the range [0, NThread-1] to all helpers used in nodes such as DefineSlot. NThread is the number of threads ROOT was configured with in EnableImplicitMT(). Slot numbers are unique across all graphs, so no two tasks with the same slot number will run concurrently. Note that it is not guaranteed that each slot number will be reached in every graph.
Definition at line 101 of file RDFHelpers.cxx.
| std::string ROOT::RDF::SaveGraph | ( | NodeType | node | ) |
Create a graphviz representation of the dataframe computation graph, return it as a string.
| [in] | node | any node of the graph. Called on the head (first) node, it prints the entire graph. Otherwise, only the branch the node belongs to. |
The output can be displayed with a command akin to dot -Tpng output.dot > output.png && open output.png.
Note that "hanging" Defines, i.e. Defines without downstream nodes, will not be displayed by SaveGraph as they are effectively optimized away from the computation graph.
Note that SaveGraph is not thread-safe and must not be called concurrently from different threads.
Definition at line 120 of file RDFHelpers.hxx.
| void ROOT::RDF::SaveGraph | ( | NodeType | node, |
| const std::string & | outputFile ) |
Create a graphviz representation of the dataframe computation graph, write it to the specified file.
| [in] | node | any node of the graph. Called on the head (first) node, it prints the entire graph. Otherwise, only the branch the node belongs to. |
| [in] | outputFile | file where to save the representation. |
The output can be displayed with a command akin to dot -Tpng output.dot > output.png && open output.png.
Note that "hanging" Defines, i.e. Defines without downstream nodes, will not be displayed by SaveGraph as they are effectively optimized away from the computation graph.
Note that SaveGraph is not thread-safe and must not be called concurrently from different threads.
Definition at line 139 of file RDFHelpers.hxx.
| RResultPtr< RInterface< RLoopManager > > ROOT::RDF::Snapshot | ( | std::string_view | treename, |
| std::string_view | filename, | ||
| const ColumnNames_t & | columnList, | ||
| const RSnapshotOptions & | options = RSnapshotOptions() ) |
Definition at line 1317 of file RInterface.hxx.
| RResultPtr< RInterface< RLoopManager > > ROOT::RDF::Snapshot | ( | std::string_view | treename, |
| std::string_view | filename, | ||
| const ColumnNames_t & | columnList, | ||
| const RSnapshotOptions & | options = RSnapshotOptions() ) |
Save selected columns to disk, in a new TTree or RNTuple treename in file filename.
| [in] | treename | The name of the output TTree or RNTuple. |
| [in] | filename | The name of the output TFile. |
| [in] | columnList | The list of names of the columns/branches/fields to be written. |
| [in] | options | RSnapshotOptions struct with extra options to pass to TFile and TTree/RNTuple. |
RDataFrame that wraps the snapshotted dataset.This function returns a RDataFrame built with the output TTree or RNTuple as a source. The types of the columns are automatically inferred and do not need to be specified.
Support for writing of nested branches/fields is limited (although RDataFrame is able to read them) and dot ('.') characters in input column names will be replaced by underscores ('_') in the branches produced by Snapshot. When writing a variable size array through Snapshot, it is required that the column indicating its size is also written out and it appears before the array in the columnList.
By default, in case of TTree, TChain or RNTuple inputs, Snapshot will try to write out all top-level branches. For other types of inputs, all columns returned by GetColumnNames() will be written out. Systematic variations of columns will be included if the corresponding flag is set in RSnapshotOptions. See Snapshot with Variations for more details. If friend trees or chains are present, by default all friend top-level branches that have names that do not collide with names of branches in the main TTree/TChain will be written out. Since v6.24, Snapshot will also write out friend branches with the same names of branches in the main TTree/TChain with names of the form <friendname>_<branchname> in order to differentiate them from the branches in the main tree/chain.
Snapshot supports writing the TTree or RNTuple in a sub-directory inside the TFile. It is sufficient to specify the directory path as part of the TTree or RNTuple name, e.g. df.Snapshot("subdir/t", "f.root") writes TTree t in the sub-directory subdir of file f.root (creating file and sub-directory as needed).
#columnname. These are special columns made available by some data sources (e.g. RNTupleDS) that represent the size of column columnname, and are not meant to be written out with that name (which is not a valid C++ variable name). Instead, go through an Alias(): df.Alias("nbar", "#bar").Snapshot(..., {"nbar"}).To book a Snapshot without triggering the event loop, one needs to set the appropriate flag in RSnapshotOptions:
To snapshot to the RNTuple data format, the fOutputFormat option in RSnapshotOptions needs to be set accordingly:
Snapshot systematic variations resulting from a Vary() call (see details here):
Definition at line 1398 of file RInterface.hxx.
| RResultPtr< RInterface< RLoopManager > > ROOT::RDF::Snapshot | ( | std::string_view | treename, |
| std::string_view | filename, | ||
| std::initializer_list< std::string > | columnList, | ||
| const RSnapshotOptions & | options = RSnapshotOptions() ) |
Save selected columns to disk, in a new TTree or RNTuple treename in file filename.
| [in] | treename | The name of the output TTree or RNTuple. |
| [in] | filename | The name of the output TFile. |
| [in] | columnList | The list of names of the columns/branches to be written. |
| [in] | options | RSnapshotOptions struct with extra options to pass to TFile and TTree/RNTuple. |
RDataFrame that wraps the snapshotted dataset.This function returns a RDataFrame built with the output TTree or RNTuple as a source. The types of the columns are automatically inferred and do not need to be specified.
See Snapshot(std::string_view, std::string_view, const ColumnNames_t&, const RSnapshotOptions &) for a more complete description and example usages.
Definition at line 1590 of file RInterface.hxx.
| RResultPtr< RInterface< RLoopManager > > ROOT::RDF::Snapshot | ( | std::string_view | treename, |
| std::string_view | filename, | ||
| std::string_view | columnNameRegexp = "", | ||
| const RSnapshotOptions & | options = RSnapshotOptions() ) |
Save selected columns to disk, in a new TTree or RNTuple treename in file filename.
| [in] | treename | The name of the output TTree or RNTuple. |
| [in] | filename | The name of the output TFile. |
| [in] | columnNameRegexp | The regular expression to match the column names to be selected. The presence of a '^' and a '$' at the end of the string is implicitly assumed if they are not specified. The dialect supported is PCRE via the TPRegexp class. An empty string signals the selection of all columns. |
| [in] | options | RSnapshotOptions struct with extra options to pass to TFile and TTree/RNTuple |
RDataFrame that wraps the snapshotted dataset.This function returns a RDataFrame built with the output TTree or RNTuple as a source. The types of the columns are automatically inferred and do not need to be specified.
See Snapshot(std::string_view, std::string_view, const ColumnNames_t&, const RSnapshotOptions &) for a more complete description and example usages.
Definition at line 1537 of file RInterface.hxx.
| void ROOT::RDF::splitInEqualRanges | ( | std::vector< std::pair< ULong64_t, ULong64_t > > & | ranges, |
| int | nRecords, | ||
| unsigned int | nSlots ) |
Definition at line 519 of file RArrowDS.cxx.
| RResultPtr< TStatistic > ROOT::RDF::Stats | ( | std::string_view | value, |
| std::string_view | weight ) |
Return a TStatistic object, filled once per event (lazy action).
| V | The type of the value column |
| W | The type of the weight column |
| [in] | value | The name of the column with the values to fill the statistics with. |
| [in] | weight | The name of the column with the weights to fill the statistics with. |
Definition at line 3228 of file RInterface.hxx.
| RResultPtr< TStatistic > ROOT::RDF::Stats | ( | std::string_view | value = "" | ) |
Return a TStatistic object, filled once per event (lazy action).
| V | The type of the value column |
| [in] | value | The name of the column with the values to fill the statistics with. |
Definition at line 3196 of file RInterface.hxx.
| RResultPtr< double > ROOT::RDF::StdDev | ( | std::string_view | columnName = "" | ) |
Return the unbiased standard deviation of processed column values (lazy action).
| T | The type of the branch/column. |
| [in] | columnName | The name of the branch/column to be treated. |
If T is not specified, RDataFrame will infer it from the data and just-in-time compile the correct template specialization of this method.
This action is lazy: upon invocation of this method the calculation is booked but not executed. Also see RResultPtr.
Definition at line 3363 of file RInterface.hxx.
| RResultPtr< RDFDetail::SumReturnType_t< T > > ROOT::RDF::Sum | ( | std::string_view | columnName = "", |
| const RDFDetail::SumReturnType_t< T > & | initValue = RDFDetail::SumReturnType_t<T>{} ) |
Return the sum of processed column values (lazy action).
| T | The type of the branch/column. |
| [in] | columnName | The name of the branch/column. |
| [in] | initValue | Optional initial value for the sum. If not present, the column values must be default-constructible. |
If T is not specified, RDataFrame will infer it from the data and just-in-time compile the correct template specialization of this method. If the type of the column is inferred, the return type is double, the type of the column otherwise.
This action is lazy: upon invocation of this method the calculation is booked but not executed. Also see RResultPtr.
Definition at line 3395 of file RInterface.hxx.
| RResultPtr< COLL > ROOT::RDF::Take | ( | std::string_view | column = "" | ) |
Return a collection of values of a column (lazy action, returns a std::vector by default).
| T | The type of the column. |
| COLL | The type of collection used to store the values. |
| [in] | column | The name of the column to collect the values of. |
The collection type to be specified for C-style array columns is RVec<T>: in this case the returned collection is a std::vector<RVec<T>>.
This action is lazy: upon invocation of this method the calculation is booked but not executed. Also see RResultPtr.
Definition at line 1932 of file RInterface.hxx.
| RInterface< Proxied > ROOT::RDF::Vary | ( | const std::vector< std::string > & | colNames, |
| std::string_view | expression, | ||
| const std::vector< std::string > & | variationTags, | ||
| std::string_view | variationName ) |
Register systematic variations for multiple existing columns using custom variation tags.
| [in] | colNames | set of names of the columns for which varied values are provided. |
| [in] | expression | a string containing valid C++ code that evaluates to an RVec or RVecs containing the varied values for the specified columns. |
| [in] | variationTags | names for each of the varied values, e.g. "up" and "down". |
| [in] | variationName | a generic name for this set of varied values, e.g. "ptvariation". |
This overload adds the possibility for the expression used to evaluate the varied values to be just-in-time compiled. The example below shows how Vary() is used while dealing with multiple columns. The tags are defined as {"down", "up"}.
For convenience, when a C++ expression is passed to Vary, the return type can be omitted if the string begins with '{' and ends with '}' (whitespace, tab and newline characters are excluded from the search). This means that the following is equivalent to the example above:
or also:
Definition at line 1272 of file RInterface.hxx.
| RInterface< Proxied > ROOT::RDF::Vary | ( | const std::vector< std::string > & | colNames, |
| std::string_view | expression, | ||
| std::size_t | nVariations, | ||
| std::string_view | variationName ) |
Register systematic variations for multiple existing columns using auto-generated variation tags.
| [in] | colNames | set of names of the columns for which varied values are provided. |
| [in] | expression | a string containing valid C++ code that evaluates to an RVec or RVecs containing the varied values for the specified columns. |
| [in] | nVariations | number of variations returned by the expression. The corresponding tags will be "0", "1", etc. |
| [in] | variationName | a generic name for this set of varied values, e.g. "ptvariation". |
This overload adds the possibility for the expression used to evaluate the varied values to be just-in-time compiled. It takes an nVariations parameter instead of a list of tag names. The varied results will be accessible via the keys of the dictionary with the form variationName:N where N is the corresponding sequential tag starting at 0 and going up to nVariations - 1. The example below shows how Vary() is used while dealing with multiple columns.
For convenience, when a C++ expression is passed to Vary, the return type can be omitted if the string begins with '{' and ends with '}' (whitespace, tab and newline characters are excluded from the search). This means that the following is equivalent to the example above:
or also:
Definition at line 1195 of file RInterface.hxx.
| RInterface< Proxied > ROOT::RDF::Vary | ( | std::initializer_list< std::string > | colNames, |
| std::string_view | expression, | ||
| std::size_t | nVariations, | ||
| std::string_view | variationName ) |
Register systematic variations for multiple existing columns using auto-generated variation tags.
| [in] | colNames | set of names of the columns for which varied values are provided. |
| [in] | expression | a string containing valid C++ code that evaluates to an RVec containing the varied values for the specified column. |
| [in] | nVariations | number of variations returned by the expression. The corresponding tags will be "0", "1", etc. |
| [in] | variationName | a generic name for this set of varied values, e.g. "ptvariation". colName is used if none is provided. |
Definition at line 1219 of file RInterface.hxx.
| ROOT::RDF::RInterface RInterfaceBase ROOT::RDF::Vary | ( | std::string_view | colName, |
| std::string_view | expression, | ||
| std::size_t | nVariations, | ||
| std::string_view | variationName = "" ) |
Register systematic variations for a single existing column using auto-generated variation tags.
| [in] | colName | name of the column for which varied values are provided. |
| [in] | expression | a string containing valid C++ code that evaluates to an RVec containing the varied values for the specified column. |
| [in] | nVariations | number of variations returned by the expression. The corresponding tags will be "0", "1", etc. |
| [in] | variationName | a generic name for this set of varied values, e.g. "ptvariation". colName is used if none is provided. |
This overload adds the possibility for the expression used to evaluate the varied values to be a just-in-time compiled. The example below shows how Vary() is used while dealing with a single column. The variation tags are auto-generated.
For convenience, when a C++ expression is passed to Vary, the return type can be omitted if the string begins with '{' and ends with '}' (whitespace, tab and newline characters are excluded from the search). This means that the following is equivalent to the example above:
Definition at line 106 of file RInterface.hxx.
|
private |
Definition at line 3820 of file RInterface.hxx.
