The public interface to the RDataFrame federation of classes.
Proxied | One of the "node" base types (e.g. RLoopManager, RFilterBase). The user never specifies this type manually. |
DataSource | The type of the RDataSource which is providing the data to the data frame. There is no source by default. |
The documentation of each method features a one liner illustrating how to use the method, for example showing how the majority of the template parameters are automatically deduced requiring no or very little effort by the user.
Definition at line 90 of file RInterface.hxx.
Public Member Functions | |
RInterface (const RInterface &)=default | |
Copy-ctor for RInterface. | |
template<typename T = Proxied, typename std::enable_if< std::is_same< T, RLoopManager >::value, int >::type = 0> | |
RInterface (const std::shared_ptr< Proxied > &proxied) | |
Only enabled when building a RInterface<RLoopManager> | |
RInterface (RInterface &&)=default | |
Move-ctor for RInterface. | |
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, DS_t > | Alias (std::string_view alias, std::string_view columnName) |
Allow to refer to a column with a different name. | |
template<typename... ColumnTypes, typename Helper > | |
RResultPtr< typename 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. | |
RResultPtr< ULong64_t > | Count () |
Return the number of entries processed (lazy action) | |
template<typename F , typename std::enable_if<!std::is_convertible< F, std::string >::value, int >::type = 0> | |
RInterface< Proxied, DS_t > | Define (std::string_view name, F expression, const ColumnNames_t &columns={}) |
Creates a custom column. | |
RInterface< Proxied, DS_t > | Define (std::string_view name, std::string_view expression) |
Creates a custom column. | |
template<typename F > | |
RInterface< Proxied, DS_t > | DefineSlot (std::string_view name, F expression, const ColumnNames_t &columns={}) |
Creates a custom column with a value dependent on the processing slot. | |
template<typename F > | |
RInterface< Proxied, DS_t > | DefineSlotEntry (std::string_view name, F expression, const ColumnNames_t &columns={}) |
Creates a custom column with a value dependent on the processing slot and the current entry. | |
template<typename... ColumnTypes> | |
RResultPtr< RDisplay > | Display (const ColumnNames_t &columnList, const int &nRows=5) |
Provides a representation of the columns in the dataset. | |
RResultPtr< RDisplay > | Display (const ColumnNames_t &columnList, const int &nRows=5) |
Provides a representation of the columns in the dataset. | |
RResultPtr< RDisplay > | Display (std::initializer_list< std::string > columnList, const int &nRows=5) |
Provides a representation of the columns in the dataset. | |
RResultPtr< RDisplay > | Display (std::string_view columnNameRegexp="", const int &nRows=5) |
Provides a representation of the columns in the dataset. | |
template<typename FirstColumn , typename... OtherColumns, typename T > | |
RResultPtr< 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 T > | |
RResultPtr< 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 , typename std::enable_if<!std::is_convertible< F, std::string >::value, int >::type = 0> | |
RInterface< RDFDetail::RFilter< F, Proxied >, DS_t > | Filter (F f, const ColumnNames_t &columns={}, std::string_view name="") |
Append a filter to the call graph. | |
template<typename F > | |
RInterface< RDFDetail::RFilter< F, Proxied >, DS_t > | Filter (F f, const std::initializer_list< std::string > &columns) |
Append a filter to the call graph. | |
template<typename F , typename std::enable_if<!std::is_convertible< F, std::string >::value, int >::type = 0> | |
RInterface< RDFDetail::RFilter< F, Proxied >, DS_t > | Filter (F f, std::string_view name) |
Append a filter to the call graph. | |
RInterface< RDFDetail::RJittedFilter, DS_t > | Filter (std::string_view expression, std::string_view name="") |
Append a filter to the call graph. | |
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) | |
ColumnNames_t | GetColumnNames () |
Returns the names of the available columns. | |
std::string | GetColumnType (std::string_view column) |
Return the type of a given column as a string. | |
ColumnNames_t | GetDefinedColumnNames () |
Returns the names of the defined columns. | |
std::vector< std::string > | GetFilterNames () |
Returns the names of the filters created. | |
unsigned int | GetNRuns () const |
Gets the number of event loops run. | |
unsigned int | GetNSlots () const |
Gets the number of data processing slots. | |
template<typename V1 = RDFDetail::RInferredType, typename V2 = RDFDetail::RInferredType> | |
RResultPtr<::TGraph > | Graph (std::string_view v1Name="", std::string_view v2Name="") |
Fill and return a graph (lazy action) | |
bool | HasColumn (std::string_view columnName) |
Checks if a column is present in the dataset. | |
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 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) | |
operator RNode () const | |
Cast any RDataFrame node to a common type ROOT::RDF::RNode. | |
RInterface & | operator= (const RInterface &)=default |
Copy-assignment operator for RInterface. | |
template<typename V1 , typename V2 , typename W > | |
RResultPtr<::TProfile > | Profile1D (const TProfile1DModel &model) |
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) |
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 >, DS_t > | 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 >, DS_t > | 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. | |
template<typename... ColumnTypes> | |
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 treename in file filename . | |
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 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 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 treename in file filename . | |
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) | |
Protected Member Functions | |
RInterface (const std::shared_ptr< Proxied > &proxied, RLoopManager &lm, const RDFInternal::RBookedDefines &columns, RDataSource *ds) | |
template<typename... ColumnTypes> | |
void | CheckAndFillDSColumns (ColumnNames_t validCols, TTraits::TypeList< ColumnTypes... > typeList) |
RLoopManager * | GetLoopManager () const |
const std::shared_ptr< Proxied > & | GetProxiedPtr () const |
ColumnNames_t | GetValidatedColumnNames (const unsigned int nColumns, const ColumnNames_t &columns) |
Prepare the call to the GetValidatedColumnNames routine, making sure that GetBranchNames, which is expensive in terms of runtime, is called at most once. | |
Private Types | |
using | ColumnNames_t = RDFDetail::ColumnNames_t |
using | DS_t = DataSource |
using | RFilterBase = RDFDetail::RFilterBase |
using | RLoopManager = RDFDetail::RLoopManager |
using | RRangeBase = RDFDetail::RRangeBase |
Private Member Functions | |
void | AddDefaultColumns () |
template<typename... ColTypes, std::size_t... S> | |
RInterface< RLoopManager > | CacheImpl (const ColumnNames_t &columnList, std::index_sequence< S... >) |
Implementation of cache. | |
void | CheckIMTDisabled (std::string_view callerName) |
template<typename ActionTag , typename... ColTypes, typename ActionResultType , typename HelperArgType = ActionResultType, typename std::enable_if<!RDFInternal::RNeedJitting< ColTypes... >::value, int >::type = 0> | |
RResultPtr< ActionResultType > | CreateAction (const ColumnNames_t &columns, const std::shared_ptr< ActionResultType > &r, const std::shared_ptr< HelperArgType > &helperArg) |
Create RAction object, return RResultPtr for the action Overload for the case in which all column types were specified (no jitting). | |
template<typename ActionTag , typename... ColTypes, typename ActionResultType , typename HelperArgType = ActionResultType, typename std::enable_if< RDFInternal::RNeedJitting< ColTypes... >::value, int >::type = 0> | |
RResultPtr< ActionResultType > | CreateAction (const ColumnNames_t &columns, const std::shared_ptr< ActionResultType > &r, const std::shared_ptr< HelperArgType > &helperArg, const int nColumns=-1) |
Create RAction object, return RResultPtr for the action Overload for the case in which one or more column types were not specified (RTTI + jitting). | |
template<typename F , typename DefineType , typename RetType = typename TTraits::CallableTraits<F>::ret_type> | |
std::enable_if< std::is_default_constructible< RetType >::value, RInterface< Proxied, DS_t > >::type | DefineImpl (std::string_view name, F &&expression, const ColumnNames_t &columns) |
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<!IsFStringConv &&!IsRetTypeDefConstr, RInterface< Proxied, DS_t > >::type | DefineImpl (std::string_view, F, const ColumnNames_t &) |
std::vector< std::string > | GetColumnTypeNamesList (const ColumnNames_t &columnList) |
template<typename... ColumnTypes> | |
RResultPtr< RInterface< RLoopManager > > | SnapshotImpl (std::string_view fullTreeName, std::string_view filename, const ColumnNames_t &columnList, const RSnapshotOptions &options) |
Private Attributes | |
RDataSource * | fDataSource = nullptr |
Non-owning pointer to a data-source object. Null if no data-source. RLoopManager has ownership of the object. | |
RDFInternal::RBookedDefines | fDefines |
Contains the custom columns defined up to this node. | |
RLoopManager * | fLoopManager |
std::shared_ptr< Proxied > | fProxiedPtr |
Smart pointer to the graph node encapsulated by this RInterface. | |
Friends | |
template<typename T , typename W > | |
class | RInterface |
class | RDFInternal::GraphDrawing::GraphCreatorHelper |
#include <ROOT/RDF/RInterface.hxx>
|
private |
Definition at line 92 of file RInterface.hxx.
|
private |
Definition at line 91 of file RInterface.hxx.
|
private |
Definition at line 93 of file RInterface.hxx.
|
private |
Definition at line 95 of file RInterface.hxx.
|
private |
Definition at line 94 of file RInterface.hxx.
|
default |
Copy-ctor for RInterface.
|
default |
Move-ctor for RInterface.
|
inline |
Only enabled when building a RInterface<RLoopManager>
Definition at line 127 of file RInterface.hxx.
|
inlineprotected |
Definition at line 2429 of file RInterface.hxx.
|
inlineprivate |
Definition at line 2215 of file RInterface.hxx.
|
inline |
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 initialised to this value (or is default-constructed if the parameter is omitted) |
RResultPtr
.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. See RResultPtr documentation.
Example usage:
Definition at line 2035 of file RInterface.hxx.
|
inline |
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. |
RResultPtr
.See previous Aggregate overload for more information.
Definition at line 2070 of file RInterface.hxx.
|
inline |
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 401 of file RInterface.hxx.
|
inline |
Book execution of a custom action using a user-defined helper object.
ColumnTypes | List of types of 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. |
RResultPtr
.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 minimum required interface for the helper is the following (more methods can be present, e.g. a constructor that takes the number of worker threads is usually useful):
See ActionHelpers.hxx for the helpers used by standard RDF actions. This action is lazy: upon invocation of this method the calculation is booked but not executed. See RResultPtr documentation.
Definition at line 2113 of file RInterface.hxx.
|
inline |
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 (Filter
ed) data that fits in memory and that will be accessed many times.
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 591 of file RInterface.hxx.
|
inline |
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 603 of file RInterface.hxx.
|
inline |
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 670 of file RInterface.hxx.
|
inline |
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 649 of file RInterface.hxx.
|
inlineprivate |
Implementation of cache.
Definition at line 2411 of file RInterface.hxx.
|
inlineprotected |
Definition at line 2448 of file RInterface.hxx.
|
inlineprivate |
Definition at line 2260 of file RInterface.hxx.
|
inline |
Return the number of entries processed (lazy action)
RResultPtr
.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. See RResultPtr documentation.
Definition at line 855 of file RInterface.hxx.
|
inlineprivate |
Create RAction object, return RResultPtr for the action Overload for the case in which all column types were specified (no jitting).
For most actions, r
and helperArg
will refer to the same object, because the only argument to forward to the action helper is the result value itself. We need the distinction for actions such as Snapshot or Cache, for which the constructor arguments of the action helper are different from the returned value.
Definition at line 2277 of file RInterface.hxx.
|
inlineprivate |
Create RAction object, return RResultPtr for the action Overload for the case in which one or more column types were not specified (RTTI + jitting).
This overload has a nColumns
optional argument. If present, the number of required columns for this action is taken equal to nColumns, otherwise it is assumed to be sizeof...(ColTypes).
Definition at line 2301 of file RInterface.hxx.
|
inline |
Creates a custom column.
[in] | name | The name of the custom column. |
[in] | expression | Function, lambda expression, functor class or any other callable object producing the temporary value. Returns the value that will be assigned to the custom column. |
[in] | columns | Names of the columns/branches in input to the producer function. |
Create a custom column that will be visible from all subsequent nodes of the functional chain. The expression
is only evaluated for entries that pass all the preceding filters. A new variable is created called name
, accessible as if it was contained in the dataset from subsequent transformations/actions.
Use cases include:
An exception is thrown if the name of the new column is already in use in this branch of the computation graph.
Definition at line 294 of file RInterface.hxx.
|
inline |
Creates a custom column.
[in] | name | The name of the custom column. |
[in] | expression | An expression in C++ which represents the temporary value |
The expression is just-in-time compiled and used to produce the column entries. It must be valid C++ syntax in which variable names are substituted with the names of branches/columns.
Refer to the first overload of this method for the full documentation.
Definition at line 370 of file RInterface.hxx.
|
inlineprivate |
Definition at line 2329 of file RInterface.hxx.
|
inlineprivate |
Definition at line 2375 of file RInterface.hxx.
|
inline |
Creates a custom column with a value dependent on the processing slot.
[in] | name | The name of the custom column. |
[in] | expression | Function, lambda expression, functor class or any other callable object producing the temporary value. Returns the value that will be assigned to the custom column. |
[in] | columns | Names of the columns/branches in input to the producer function (excluding the slot number). |
This alternative implementation of Define
is meant as a helper in writing thread-safe custom columns. The expression must be a callable of signature R(unsigned int, T1, T2, ...) where T1, T2...
are the types of the columns that the expression takes as input. The first parameter is reserved for an unsigned integer representing a "slot number". RDataFrame guarantees that different threads will invoke the expression with different slot numbers - slot numbers will range from zero to ROOT::GetThreadPoolSize()-1.
The following two calls are equivalent, although DefineSlot
is slightly more performant:
See Define for more information.
Definition at line 323 of file RInterface.hxx.
|
inline |
Creates a custom column with a value dependent on the processing slot and the current entry.
[in] | name | The name of the custom column. |
[in] | expression | Function, lambda expression, functor class or any other callable object producing the temporary value. Returns the value that will be assigned to the custom column. |
[in] | columns | Names of the columns/branches in input to the producer function (excluding slot and entry). |
This alternative implementation of Define
is meant as a helper in writing entry-specific, thread-safe custom columns. The expression must be a callable of signature R(unsigned int, ULong64_t, T1, T2, ...) where T1, T2...
are the types of the columns that the expression takes as input. The first parameter is reserved for an unsigned integer representing a "slot number". RDataFrame guarantees that different threads will invoke the expression with different slot numbers - slot numbers will range from zero to ROOT::GetThreadPoolSize()-1. The second parameter is reserved for a ULong64_t
representing the current entry being processed by the current thread.
The following two Define
s are equivalent, although DefineSlotEntry
is slightly more performant:
See Define for more information.
Definition at line 353 of file RInterface.hxx.
|
inline |
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. |
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 Print()
or will return a complete version through AsString()
.
This action is lazy: upon invocation of this method the calculation is booked but not executed. See RResultPtr documentation.
Example usage:
Definition at line 2161 of file RInterface.hxx.
|
inline |
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. |
RDisplay
instance wrapped in a RResultPtr
.This overload automatically infers the column types. See the previous overloads for further details.
Definition at line 2177 of file RInterface.hxx.
|
inline |
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. |
RDisplay
instance wrapped in a RResultPtr
.See the previous overloads for further details.
Definition at line 2208 of file RInterface.hxx.
|
inline |
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. |
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 2194 of file RInterface.hxx.
|
inline |
Return an object of type T on which T::Fill
will be called once per event (lazy action)
T must be a type that provides a copy- or move-constructor and a T::Fill
method that takes as many arguments as the column names pass as columnList. The arguments of T::Fill
must have type equal to the one of the specified columns (these types are passed as template parameters to this method).
FirstColumn | The first type of the column the values of which are used to fill the object. |
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 |
RResultPtr
.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. See RResultPtr documentation.
Definition at line 1502 of file RInterface.hxx.
|
inline |
Return an object of type T on which T::Fill
will be called once per event (lazy action)
This overload infers the types of the columns specified in columnList at runtime and just-in-time compiles the method with these types. See previous overload for more information.
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 | The name of the columns read to fill the object. |
RResultPtr
.This overload of Fill
infers the type of the specified columns at runtime and just-in-time compiles the previous overload. Check the previous overload for more details on Fill
.
Definition at line 1531 of file RInterface.hxx.
|
inline |
Append a filter to the call graph.
[in] | f | Function, lambda expression, functor class or any other callable object. It must return a bool signalling whether the event has passed the selection (true) or not (false). |
[in] | columns | Names of the columns/branches in input to the filter function. |
[in] | name | Optional name of this filter. See Report . |
Append a filter node at the point of the call graph corresponding to the object this method is called on. The callable f
should not have side-effects (e.g. modification of an external or static variable) to ensure correct results when implicit multi-threading is active.
RDataFrame only evaluates filters when necessary: if multiple filters are chained one after another, they are executed in order and the first one returning false causes the event to be discarded. Even if multiple actions or transformations depend on the same filter, it is executed once per entry. If its result is requested more than once, the cached result is served.
Definition at line 188 of file RInterface.hxx.
|
inline |
Append a filter to the call graph.
[in] | f | Function, lambda expression, functor class or any other callable object. It must return a bool signalling whether the event has passed the selection (true) or not (false). |
[in] | columns | Names of the columns/branches in input to the filter function. |
Refer to the first overload of this method for the full documentation.
Definition at line 228 of file RInterface.hxx.
|
inline |
Append a filter to the call graph.
[in] | f | Function, lambda expression, functor class or any other callable object. It must return a bool signalling whether the event has passed the selection (true) or not (false). |
[in] | name | Optional name of this filter. See Report . |
Refer to the first overload of this method for the full documentation.
Definition at line 212 of file RInterface.hxx.
|
inline |
Append a filter to the call graph.
[in] | expression | The filter expression in C++ |
[in] | name | Optional name of this filter. See Report . |
The expression is just-in-time compiled and used to filter entries. It must be valid C++ syntax in which variable names are substituted with the names of branches/columns.
Definition at line 248 of file RInterface.hxx.
|
inline |
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 736 of file RInterface.hxx.
|
inline |
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 766 of file RInterface.hxx.
|
inline |
Returns the names of the available columns.
This is not an action nor a transformation, just a query to the RDataFrame object.
Definition at line 1821 of file RInterface.hxx.
|
inline |
Return the type of a given column as a string.
This is not an action nor a transformation, just a query to the RDataFrame object.
Definition at line 1861 of file RInterface.hxx.
|
inlineprivate |
Definition at line 2250 of file RInterface.hxx.
|
inline |
Returns the names of the defined columns.
This is not an action nor a transformation, just a simple utility to get the columns names that have been defined up to the node. If no custom column has been defined, e.g. on a root node, it returns an empty collection.
Definition at line 1909 of file RInterface.hxx.
|
inline |
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 1892 of file RInterface.hxx.
|
inlineprotected |
Definition at line 2435 of file RInterface.hxx.
|
inline |
Gets the number of event loops run.
This method returns the number of events loops run so far by this RDataFrame instance.
Example usage:
Definition at line 1983 of file RInterface.hxx.
|
inline |
Gets the number of data processing slots.
This method returns the number of data processing slots used by this RDataFrame instance. This number is influenced by the global switch ROOT::EnableImplicitMT().
Example usage:
Definition at line 1967 of file RInterface.hxx.
|
inlineprotected |
Definition at line 2437 of file RInterface.hxx.
|
inlineprotected |
Prepare the call to the GetValidatedColumnNames routine, making sure that GetBranchNames, which is expensive in terms of runtime, is called at most once.
Definition at line 2441 of file RInterface.hxx.
|
inline |
Fill and return a graph (lazy action)
V1 | The type of the column used to fill the x axis of the graph. |
V2 | The type of the column used to fill the y axis of the graph. |
[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. |
RResultPtr
.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. 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 graph is given based on the input column names.
This action is lazy: upon invocation of this method the calculation is booked but not executed. See RResultPtr documentation.
Definition at line 1267 of file RInterface.hxx.
|
inline |
Checks if a column is present in the dataset.
This method checks if a column is part of the input ROOT dataset, has been defined or can be provided by the data source.
Example usage:
Definition at line 1937 of file RInterface.hxx.
|
inline |
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. |
RResultPtr
.See the description of the first Histo1D overload for more details.
Definition at line 993 of file RInterface.hxx.
|
inline |
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. |
RResultPtr
.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 1048 of file RInterface.hxx.
|
inline |
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. |
RResultPtr
.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. See RResultPtr documentation.
Definition at line 929 of file RInterface.hxx.
|
inline |
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. |
RResultPtr
.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 966 of file RInterface.hxx.
|
inline |
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. |
RResultPtr
.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 1028 of file RInterface.hxx.
|
inline |
Definition at line 1139 of file RInterface.hxx.
|
inline |
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. |
RResultPtr
.This action is lazy: upon invocation of this method the calculation is booked but not executed. See RResultPtr documentation. The user gives up ownership of the model histogram.
Definition at line 1121 of file RInterface.hxx.
|
inline |
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. |
RResultPtr
.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. See RResultPtr documentation.
Definition at line 1078 of file RInterface.hxx.
|
inline |
Definition at line 1236 of file RInterface.hxx.
|
inline |
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. |
RResultPtr
.This action is lazy: upon invocation of this method the calculation is booked but not executed. See RResultPtr documentation.
Definition at line 1217 of file RInterface.hxx.
|
inline |
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. |
RResultPtr
.This action is lazy: upon invocation of this method the calculation is booked but not executed. See RResultPtr documentation.
Definition at line 1170 of file RInterface.hxx.
|
inline |
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. |
RResultPtr
.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. See RResultPtr documentation.
Definition at line 1664 of file RInterface.hxx.
|
inline |
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. |
RResultPtr
.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. See RResultPtr documentation.
Definition at line 1693 of file RInterface.hxx.
|
inline |
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. |
RResultPtr
.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. See RResultPtr documentation.
Definition at line 1634 of file RInterface.hxx.
|
inline |
Cast any RDataFrame node to a common type ROOT::RDF::RNode.
Different RDataFrame methods return different C++ types. All nodes, however, can be cast to this common type at the cost of a small performance penalty. This allows, for example, storing RDataFrame nodes in a vector, or passing them around via (non-template, C++11) helper functions. Example usage:
Note that it is not a problem to pass RNode's by value.
Definition at line 151 of file RInterface.hxx.
|
default |
Copy-assignment operator for RInterface.
|
inline |
Definition at line 1374 of file RInterface.hxx.
|
inline |
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. |
RResultPtr
.This action is lazy: upon invocation of this method the calculation is booked but not executed. See RResultPtr documentation.
Definition at line 1355 of file RInterface.hxx.
|
inline |
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. |
RResultPtr
.This action is lazy: upon invocation of this method the calculation is booked but not executed. See RResultPtr documentation.
Definition at line 1311 of file RInterface.hxx.
|
inline |
Definition at line 1472 of file RInterface.hxx.
|
inline |
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. |
RResultPtr
.This action is lazy: upon invocation of this method the calculation is booked but not executed. See RResultPtr documentation.
Definition at line 1452 of file RInterface.hxx.
|
inline |
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. |
V2 | 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. |
RResultPtr
.This action is lazy: upon invocation of this method the calculation is booked but not executed. See RResultPtr documentation.
Definition at line 1405 of file RInterface.hxx.
|
inline |
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 694 of file RInterface.hxx.
|
inline |
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 716 of file RInterface.hxx.
|
inline |
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 initialised to this value. |
RResultPtr
.See the description of the first Reduce overload for more information.
Definition at line 837 of file RInterface.hxx.
|
inline |
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. |
RResultPtr
.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. See RResultPtr documentation.
Definition at line 814 of file RInterface.hxx.
|
inline |
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 1786 of file RInterface.hxx.
|
inline |
Save selected columns to disk, in a new TTree treename
in file filename
.
ColumnTypes | variadic list of branch/column types. |
[in] | treename | The name of the output TTree. |
[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. |
RDataFrame
that wraps the snapshotted dataset.Support for writing of nested branches 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.
To book a Snapshot without triggering the event loop, one needs to set the appropriate flag in RSnapshotOptions
:
Definition at line 465 of file RInterface.hxx.
|
inline |
Save selected columns to disk, in a new TTree treename
in file filename
.
[in] | treename | The name of the output TTree. |
[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. |
RDataFrame
that wraps the snapshotted dataset.This function returns a RDataFrame
built with the output tree as a source. The types of the columns are automatically inferred and do not need to be specified.
See above for a more complete description and example usages.
Definition at line 483 of file RInterface.hxx.
|
inline |
Save selected columns to disk, in a new TTree treename
in file filename
.
[in] | treename | The name of the output TTree. |
[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. |
RDataFrame
that wraps the snapshotted dataset.This function returns a RDataFrame
built with the output tree as a source. The types of the columns are automatically inferred and do not need to be specified.
See above for a more complete description and example usages.
Definition at line 552 of file RInterface.hxx.
|
inline |
Save selected columns to disk, in a new TTree treename
in file filename
.
[in] | treename | The name of the output TTree. |
[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 |
RDataFrame
that wraps the snapshotted dataset.This function returns a RDataFrame
built with the output tree as a source. The types of the columns are automatically inferred and do not need to be specified.
See above for a more complete description and example usages.
Definition at line 521 of file RInterface.hxx.
|
inlineprivate |
Definition at line 2383 of file RInterface.hxx.
|
inline |
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. |
RResultPtr
.Definition at line 1588 of file RInterface.hxx.
|
inline |
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. |
RResultPtr
.Definition at line 1556 of file RInterface.hxx.
|
inline |
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. |
RResultPtr
.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. See RResultPtr documentation.
Definition at line 1721 of file RInterface.hxx.
|
inline |
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. |
RResultPtr
.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. See RResultPtr documentation.
Definition at line 1753 of file RInterface.hxx.
|
inline |
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. |
RResultPtr
.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. See RResultPtr documentation.
Definition at line 888 of file RInterface.hxx.
|
friend |
Definition at line 100 of file RInterface.hxx.
|
friend |
Definition at line 97 of file RInterface.hxx.
|
private |
Non-owning pointer to a data-source object. Null if no data-source. RLoopManager has ownership of the object.
Definition at line 106 of file RInterface.hxx.
|
private |
Contains the custom columns defined up to this node.
Definition at line 109 of file RInterface.hxx.
|
private |
Definition at line 104 of file RInterface.hxx.
|
private |
Smart pointer to the graph node encapsulated by this RInterface.
The RLoopManager at the root of this computation graph. Never null.
Definition at line 102 of file RInterface.hxx.