ROOT 6.10/09 Reference Guide |
The public interface to the TDataFrame federation of classes.
T | One of the "node" base types (e.g. TLoopManager, TFilterBase). The user never specifies this type manually. |
Definition at line 93 of file TDFInterface.hxx.
Public Member Functions | |
TResultProxy< unsigned int > | Count () |
Return the number of entries processed (lazy action) More... | |
template<typename F , typename std::enable_if<!std::is_convertible< F, std::string >::value, int >::type = 0> | |
TInterface< TCustomColumnBase > | Define (std::string_view name, F expression, const ColumnNames_t &bl={}) |
Creates a temporary branch. More... | |
TInterface< TCustomColumnBase > | Define (std::string_view name, std::string_view expression) |
Creates a temporary branch. More... | |
template<typename FirstBranch , typename... OtherBranches, typename T > | |
TResultProxy< T > | Fill (T &&model, const ColumnNames_t &bl) |
Fill and return any entity with a Fill method (lazy action) More... | |
template<typename T > | |
TResultProxy< T > | Fill (T &&model, const ColumnNames_t &bl) |
template<typename F , typename std::enable_if<!std::is_convertible< F, std::string >::value, int >::type = 0> | |
TInterface< TFilterBase > | Filter (F f, const ColumnNames_t &bn={}, std::string_view name="") |
Append a filter to the call graph. More... | |
template<typename F , typename std::enable_if<!std::is_convertible< F, std::string >::value, int >::type = 0> | |
TInterface< TFilterBase > | Filter (F f, std::string_view name) |
Append a filter to the call graph. More... | |
template<typename F > | |
TInterface< TFilterBase > | Filter (F f, const std::initializer_list< std::string > &bn) |
Append a filter to the call graph. More... | |
TInterface< TFilterBase > | Filter (std::string_view expression, std::string_view name="") |
Append a filter to the call graph. More... | |
template<typename F > | |
void | Foreach (F f, const ColumnNames_t &bl={}) |
Execute a user-defined function on each entry (instant action) More... | |
template<typename F > | |
void | ForeachSlot (F f, const ColumnNames_t &bl={}) |
Execute a user-defined function requiring a processing slot index on each entry (instant action) More... | |
template<typename V = TDFDetail::TInferType> | |
TResultProxy<::TH1F > | Histo1D (::TH1F &&model=::TH1F{"", "", 128u, 0., 0.}, std::string_view vName="") |
Fill and return a one-dimensional histogram with the values of a branch (lazy action) More... | |
template<typename V = TDFDetail::TInferType> | |
TResultProxy<::TH1F > | Histo1D (std::string_view vName) |
template<typename V = TDFDetail::TInferType, typename W = TDFDetail::TInferType> | |
TResultProxy<::TH1F > | Histo1D (::TH1F &&model, std::string_view vName, std::string_view wName) |
Fill and return a one-dimensional histogram with the values of a branch (lazy action) More... | |
template<typename V = TDFDetail::TInferType, typename W = TDFDetail::TInferType> | |
TResultProxy<::TH1F > | Histo1D (std::string_view vName, std::string_view wName) |
template<typename V , typename W > | |
TResultProxy<::TH1F > | Histo1D (::TH1F &&model=::TH1F{"", "", 128u, 0., 0.}) |
template<typename V1 = TDFDetail::TInferType, typename V2 = TDFDetail::TInferType> | |
TResultProxy<::TH2F > | Histo2D (::TH2F &&model, std::string_view v1Name="", std::string_view v2Name="") |
Fill and return a two-dimensional histogram (lazy action) More... | |
template<typename V1 = TDFDetail::TInferType, typename V2 = TDFDetail::TInferType, typename W = TDFDetail::TInferType> | |
TResultProxy<::TH2F > | Histo2D (::TH2F &&model, std::string_view v1Name, std::string_view v2Name, std::string_view wName) |
Fill and return a two-dimensional histogram (lazy action) More... | |
template<typename V1 , typename V2 , typename W > | |
TResultProxy<::TH2F > | Histo2D (::TH2F &&model) |
template<typename V1 = TDFDetail::TInferType, typename V2 = TDFDetail::TInferType, typename V3 = TDFDetail::TInferType> | |
TResultProxy<::TH3F > | Histo3D (::TH3F &&model, std::string_view v1Name="", std::string_view v2Name="", std::string_view v3Name="") |
Fill and return a three-dimensional histogram (lazy action) More... | |
template<typename V1 = TDFDetail::TInferType, typename V2 = TDFDetail::TInferType, typename V3 = TDFDetail::TInferType, typename W = TDFDetail::TInferType> | |
TResultProxy<::TH3F > | Histo3D (::TH3F &&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) More... | |
template<typename V1 , typename V2 , typename V3 , typename W > | |
TResultProxy<::TH3F > | Histo3D (::TH3F &&model) |
template<typename T = TDFDetail::TInferType> | |
TResultProxy< double > | Max (std::string_view branchName="") |
Return the maximum of processed branch values (lazy action) More... | |
template<typename T = TDFDetail::TInferType> | |
TResultProxy< double > | Mean (std::string_view branchName="") |
Return the mean of processed branch values (lazy action) More... | |
template<typename T = TDFDetail::TInferType> | |
TResultProxy< double > | Min (std::string_view branchName="") |
Return the minimum of processed branch values (lazy action) More... | |
template<typename V1 = TDFDetail::TInferType, typename V2 = TDFDetail::TInferType> | |
TResultProxy<::TProfile > | Profile1D (::TProfile &&model, std::string_view v1Name="", std::string_view v2Name="") |
Fill and return a one-dimensional profile (lazy action) More... | |
template<typename V1 = TDFDetail::TInferType, typename V2 = TDFDetail::TInferType, typename W = TDFDetail::TInferType> | |
TResultProxy<::TProfile > | Profile1D (::TProfile &&model, std::string_view v1Name, std::string_view v2Name, std::string_view wName) |
Fill and return a one-dimensional profile (lazy action) More... | |
template<typename V1 , typename V2 , typename W > | |
TResultProxy<::TProfile > | Profile1D (::TProfile &&model) |
template<typename V1 = TDFDetail::TInferType, typename V2 = TDFDetail::TInferType, typename V3 = TDFDetail::TInferType> | |
TResultProxy<::TProfile2D > | Profile2D (::TProfile2D &&model, std::string_view v1Name="", std::string_view v2Name="", std::string_view v3Name="") |
Fill and return a two-dimensional profile (lazy action) More... | |
template<typename V1 = TDFDetail::TInferType, typename V2 = TDFDetail::TInferType, typename V3 = TDFDetail::TInferType, typename W = TDFDetail::TInferType> | |
TResultProxy<::TProfile2D > | Profile2D (::TProfile2D &&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) More... | |
template<typename V1 , typename V2 , typename V3 , typename W > | |
TResultProxy<::TProfile2D > | Profile2D (::TProfile2D &&model) |
TInterface< TRangeBase > | Range (unsigned int start, unsigned int stop, unsigned int stride=1) |
Creates a node that filters entries based on range. More... | |
TInterface< TRangeBase > | Range (unsigned int stop) |
Creates a node that filters entries based on range. More... | |
template<typename F , typename T = typename TDFInternal::TFunctionTraits<F>::Ret_t> | |
TResultProxy< T > | Reduce (F f, std::string_view branchName={}) |
Execute a user-defined reduce operation on the values of a branch. More... | |
template<typename F , typename T = typename TDFInternal::TFunctionTraits<F>::Ret_t> | |
TResultProxy< T > | Reduce (F f, std::string_view branchName, const T &initValue) |
Execute a user-defined reduce operation on the values of a branch. More... | |
void | Report () |
Print filtering statistics on screen. More... | |
template<typename... BranchTypes> | |
TInterface< TLoopManager > | Snapshot (std::string_view treename, std::string_view filename, const ColumnNames_t &bnames) |
Create a snapshot of the dataset on disk in the form of a TTree. More... | |
TInterface< TLoopManager > | Snapshot (std::string_view treename, std::string_view filename, const ColumnNames_t &bnames) |
Create a snapshot of the dataset on disk in the form of a TTree. More... | |
TInterface< TLoopManager > | Snapshot (std::string_view treename, std::string_view filename, std::string_view columnNameRegexp="") |
Create a snapshot of the dataset on disk in the form of a TTree. More... | |
template<typename T , typename COLL = std::vector<T>> | |
TResultProxy< COLL > | Take (std::string_view branchName="") |
Return a collection of values of a branch (lazy action) More... | |
Protected Member Functions | |
TInterface (const std::shared_ptr< Proxied > &proxied, const std::weak_ptr< TLoopManager > &impl) | |
template<typename T = Proxied, typename std::enable_if< std::is_same< T, TLoopManager >::value, int >::type = 0> | |
TInterface (const std::shared_ptr< Proxied > &proxied) | |
Only enabled when building a TInterface<TLoopManager> More... | |
std::shared_ptr< TLoopManager > | GetDataFrameChecked () |
Get the TLoopManager if reachable. If not, throw. More... | |
const ColumnNames_t | GetDefaultBranchNames (unsigned int nExpectedBranches, std::string_view actionNameForErr) |
template<typename... Args, int... S> | |
TInterface< TLoopManager > | SnapshotImpl (std::string_view treename, std::string_view filename, const ColumnNames_t &bnames, TDFInternal::TStaticSeq< S... >) |
Implementation of snapshot. More... | |
Protected Attributes | |
std::weak_ptr< TLoopManager > | fImplWeakPtr |
std::shared_ptr< Proxied > | fProxiedPtr |
Private Types | |
using | ColumnNames_t = TDFDetail::ColumnNames_t |
using | TCustomColumnBase = TDFDetail::TCustomColumnBase |
using | TFilterBase = TDFDetail::TFilterBase |
using | TLoopManager = TDFDetail::TLoopManager |
using | TRangeBase = TDFDetail::TRangeBase |
Private Member Functions | |
template<typename ActionType , typename... BranchTypes, typename ActionResultType , typename std::enable_if<!TDFInternal::TNeedJitting< BranchTypes... >::value, int >::type = 0> | |
TResultProxy< ActionResultType > | CreateAction (const ColumnNames_t &bl, const std::shared_ptr< ActionResultType > &r) |
template<typename ActionType , typename... BranchTypes, typename ActionResultType , typename std::enable_if< TDFInternal::TNeedJitting< BranchTypes... >::value, int >::type = 0> | |
TResultProxy< ActionResultType > | CreateAction (const ColumnNames_t &bl, const std::shared_ptr< ActionResultType > &r) |
template<typename T1 , typename T2 = void, typename T3 = void, typename T4 = void> | |
ColumnNames_t | GetBranchNames (const std::vector< std::string_view > &bl, std::string_view actionNameForErr) |
Returns the default branches if needed, takes care of the error handling. More... | |
const char * | GetNodeTypeName () |
template<> | |
const char * | GetNodeTypeName () |
template<> | |
const char * | GetNodeTypeName () |
template<> | |
const char * | GetNodeTypeName () |
template<> | |
const char * | GetNodeTypeName () |
Friends | |
template<typename T > | |
class | TInterface |
std::string | cling::printValue (ROOT::Experimental::TDataFrame *tdf) |
template<typename TDFNode , typename ActionType , typename... BranchTypes, typename ActionResultType > | |
void | TDFInternal::CallBuildAndBook (TDFNode *, const TDFDetail::ColumnNames_t &, unsigned int nSlots, const std::shared_ptr< ActionResultType > &) |
#include <ROOT/TDFInterface.hxx>
|
private |
Definition at line 94 of file TDFInterface.hxx.
|
private |
Definition at line 97 of file TDFInterface.hxx.
|
private |
Definition at line 95 of file TDFInterface.hxx.
|
private |
Definition at line 98 of file TDFInterface.hxx.
|
private |
Definition at line 96 of file TDFInterface.hxx.
|
inlineprotected |
Definition at line 1218 of file TDFInterface.hxx.
|
inlineprotected |
Only enabled when building a TInterface<TLoopManager>
Definition at line 1225 of file TDFInterface.hxx.
|
inline |
Return the number of entries processed (lazy action)
This action is lazy: upon invocation of this method the calculation is booked but not executed. See TResultProxy documentation.
Definition at line 491 of file TDFInterface.hxx.
|
inlineprivate |
Definition at line 1016 of file TDFInterface.hxx.
|
inlineprivate |
Definition at line 1028 of file TDFInterface.hxx.
|
inline |
Creates a temporary branch.
[in] | name | The name of the temporary branch. |
[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 temporary branch. |
[in] | bl | Names of the branches in input to the producer function. |
Create a temporary branch 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 branch is already in use for another branch in the TTree.
Definition at line 215 of file TDFInterface.hxx.
|
inline |
Creates a temporary branch.
[in] | name | The name of the temporary branch. |
[in] | expression | An expression in C++ which represents the temporary value |
The expression is just in time compiled and used to produce new values. The variable names to be used inside are the names of the branches. Only valid C++ is accepted. Refer to the first overload of this method for the full documentation.
Definition at line 240 of file TDFInterface.hxx.
|
inline |
Fill and return any entity with a Fill method (lazy action)
BranchTypes | The types of the branches the values of which are used to fill the object. |
[in] | model | The model to be considered to build the new return value. |
[in] | bl | The name of the branches read to fill the object. |
The returned object is independent of the input one. This action is lazy: upon invocation of this method the calculation is booked but not executed. See TResultProxy documentation. The user gives up ownership of the model object. It is compulsory to express the branches to be considered.
Definition at line 831 of file TDFInterface.hxx.
|
inline |
Definition at line 841 of file TDFInterface.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] | bn | Names of the 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.
TDataFrame 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 127 of file TDFInterface.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 150 of file TDFInterface.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] | bn | Names of the branches in input to the filter function. |
Refer to the first overload of this method for the full documentation.
Definition at line 165 of file TDFInterface.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. The variable names to be used inside are the names of the branches. Only valid C++ is accepted. Refer to the first overload of this method for the full documentation.
Definition at line 179 of file TDFInterface.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] | bl | Names of the 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 400 of file TDFInterface.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] | bl | Names of the 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 TDataFrame
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 424 of file TDFInterface.hxx.
|
inlineprivate |
Returns the default branches if needed, takes care of the error handling.
Definition at line 922 of file TDFInterface.hxx.
|
inlineprotected |
Get the TLoopManager if reachable. If not, throw.
Definition at line 1042 of file TDFInterface.hxx.
|
inlineprotected |
Definition at line 1051 of file TDFInterface.hxx.
|
inlineprivate |
Definition at line 918 of file TDFInterface.hxx.
|
inlineprivate |
Definition at line 1234 of file TDFInterface.hxx.
|
inlineprivate |
Definition at line 1240 of file TDFInterface.hxx.
|
inlineprivate |
Definition at line 1246 of file TDFInterface.hxx.
|
inlineprivate |
Definition at line 1252 of file TDFInterface.hxx.
|
inline |
Fill and return a one-dimensional histogram with the values of a branch (lazy action)
V | The type of the branch used to fill the histogram. |
[in] | model | The returned histogram will be constructed using this as a model. |
[in] | vName | The name of the branch that will fill the histogram. |
The default branches, if available, will be used instead of branches whose names are left empty. Branches 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 branches 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 TResultProxy documentation. The user gives up ownership of the model histogram.
Definition at line 540 of file TDFInterface.hxx.
|
inline |
Definition at line 550 of file TDFInterface.hxx.
|
inline |
Fill and return a one-dimensional histogram with the values of a branch (lazy action)
V | The type of the branch used to fill the histogram. |
[in] | model | The returned histogram will be constructed using this as a model. |
[in] | vName | The name of the branch that will fill the histogram. |
[in] | wName | The name of the branch that will provide the weights. |
The default branches, if available, will be used instead of branches whose names are left empty. Branches 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 branches 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 TResultProxy documentation. The user gives up ownership of the model histogram.
Definition at line 571 of file TDFInterface.hxx.
|
inline |
Definition at line 579 of file TDFInterface.hxx.
|
inline |
Definition at line 585 of file TDFInterface.hxx.
|
inline |
Fill and return a two-dimensional histogram (lazy action)
V1 | The type of the branch used to fill the x axis of the histogram. |
V2 | The type of the branch 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 branch that will fill the x axis. |
[in] | v2Name | The name of the branch that will fill the y axis. |
This action is lazy: upon invocation of this method the calculation is booked but not executed. See TResultProxy documentation. The user gives up ownership of the model histogram.
Definition at line 602 of file TDFInterface.hxx.
|
inline |
Fill and return a two-dimensional histogram (lazy action)
V1 | The type of the branch used to fill the x axis of the histogram. |
V2 | The type of the branch used to fill the y axis of the histogram. |
W | The type of the branch 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 branch that will fill the x axis. |
[in] | v2Name | The name of the branch that will fill the y axis. |
[in] | wName | The name of the branch that will provide the weights. |
This action is lazy: upon invocation of this method the calculation is booked but not executed. See TResultProxy documentation. The user gives up ownership of the model histogram.
Definition at line 627 of file TDFInterface.hxx.
|
inline |
Definition at line 639 of file TDFInterface.hxx.
|
inline |
Fill and return a three-dimensional histogram (lazy action)
V1 | The type of the branch used to fill the x axis of the histogram. |
V2 | The type of the branch used to fill the y axis of the histogram. |
V3 | The type of the branch used to fill the z axis of the histogram. |
[in] | model | The returned histogram will be constructed using this as a model. |
[in] | v1Name | The name of the branch that will fill the x axis. |
[in] | v2Name | The name of the branch that will fill the y axis. |
[in] | v3Name | The name of the branch that will fill the z axis. |
This action is lazy: upon invocation of this method the calculation is booked but not executed. See TResultProxy documentation. The user gives up ownership of the model histogram.
Definition at line 659 of file TDFInterface.hxx.
|
inline |
Fill and return a three-dimensional histogram (lazy action)
V1 | The type of the branch used to fill the x axis of the histogram. |
V2 | The type of the branch used to fill the y axis of the histogram. |
V3 | The type of the branch used to fill the z axis of the histogram. |
W | The type of the branch 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 branch that will fill the x axis. |
[in] | v2Name | The name of the branch that will fill the y axis. |
[in] | v3Name | The name of the branch that will fill the z axis. |
[in] | wName | The name of the branch that will provide the weights. |
This action is lazy: upon invocation of this method the calculation is booked but not executed. See TResultProxy documentation. The user gives up ownership of the model histogram.
Definition at line 687 of file TDFInterface.hxx.
|
inline |
Definition at line 699 of file TDFInterface.hxx.
|
inline |
Return the maximum of processed branch values (lazy action)
T | The type of the branch. |
[in] | branchName | The name of the branch to be treated. |
If no branch type is specified, the implementation will try to guess one.
This action is lazy: upon invocation of this method the calculation is booked but not executed. See TResultProxy documentation.
Definition at line 877 of file TDFInterface.hxx.
|
inline |
Return the mean of processed branch values (lazy action)
T | The type of the branch. |
[in] | branchName | The name of the branch to be treated. |
If no branch type is specified, the implementation will try to guess one.
This action is lazy: upon invocation of this method the calculation is booked but not executed. See TResultProxy documentation.
Definition at line 894 of file TDFInterface.hxx.
|
inline |
Return the minimum of processed branch values (lazy action)
T | The type of the branch. |
[in] | branchName | The name of the branch to be treated. |
If no branch type is specified, the implementation will try to guess one.
This action is lazy: upon invocation of this method the calculation is booked but not executed. See TResultProxy documentation.
Definition at line 860 of file TDFInterface.hxx.
|
inline |
Fill and return a one-dimensional profile (lazy action)
V1 | The type of the branch the values of which are used to fill the profile. |
V2 | The type of the branch the values of which are used to fill the profile. |
[in] | model | The model to be considered to build the new return value. |
[in] | v1Name | The name of the branch that will fill the x axis. |
[in] | v2Name | The name of the branch that will fill the y axis. |
This action is lazy: upon invocation of this method the calculation is booked but not executed. See TResultProxy documentation. The user gives up ownership of the model profile object.
Definition at line 716 of file TDFInterface.hxx.
|
inline |
Fill and return a one-dimensional profile (lazy action)
V1 | The type of the branch the values of which are used to fill the profile. |
V2 | The type of the branch the values of which are used to fill the profile. |
W | The type of the branch the weights of which are used to fill the profile. |
[in] | model | The model to be considered to build the new return value. |
[in] | v1Name | The name of the branch that will fill the x axis. |
[in] | v2Name | The name of the branch that will fill the y axis. |
[in] | wName | The name of the branch that will provide the weights. |
This action is lazy: upon invocation of this method the calculation is booked but not executed. See TResultProxy documentation. The user gives up ownership of the model profile object.
Definition at line 742 of file TDFInterface.hxx.
|
inline |
Definition at line 754 of file TDFInterface.hxx.
|
inline |
Fill and return a two-dimensional profile (lazy action)
V1 | The type of the branch used to fill the x axis of the histogram. |
V2 | The type of the branch used to fill the y axis of the histogram. |
V2 | The type of the branch used to fill the z axis of the histogram. |
[in] | model | The returned profile will be constructed using this as a model. |
[in] | v1Name | The name of the branch that will fill the x axis. |
[in] | v2Name | The name of the branch that will fill the y axis. |
[in] | v3Name | The name of the branch that will fill the z axis. |
This action is lazy: upon invocation of this method the calculation is booked but not executed. See TResultProxy documentation. The user gives up ownership of the model profile.
Definition at line 774 of file TDFInterface.hxx.
|
inline |
Fill and return a two-dimensional profile (lazy action)
V1 | The type of the branch used to fill the x axis of the histogram. |
V2 | The type of the branch used to fill the y axis of the histogram. |
V3 | The type of the branch used to fill the z axis of the histogram. |
W | The type of the branch 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 branch that will fill the x axis. |
[in] | v2Name | The name of the branch that will fill the y axis. |
[in] | v3Name | The name of the branch that will fill the z axis. |
[in] | wName | The name of the branch that will provide the weights. |
This action is lazy: upon invocation of this method the calculation is booked but not executed. See TResultProxy documentation. The user gives up ownership of the model profile.
Definition at line 802 of file TDFInterface.hxx.
|
inline |
Definition at line 814 of file TDFInterface.hxx.
|
inline |
Creates a node that filters entries based on range.
[in] | start | How many entries to discard before resuming processing. |
[in] | stop | Total number of entries that will be processed before stopping. 0 means "never stop". |
[in] | stride | Process one entry every stride entries. Must be strictly greater than 0. |
Ranges are only available if EnableImplicitMT has not been called. Multi-thread ranges are not supported.
Definition at line 364 of file TDFInterface.hxx.
|
inline |
Creates a node that filters entries based on range.
[in] | stop | Total number of entries that will be processed before stopping. 0 means "never stop". |
See the other Range overload for a detailed description.
Definition at line 386 of file TDFInterface.hxx.
|
inline |
Execute a user-defined reduce operation on the values of a branch.
F | The type of the reduce callable. Automatically deduced. |
T | The type of the branch to apply the reduction to. Automatically deduced. |
[in] | f | A callable with signature T(T,T) |
[in] | branchName | The branch to be reduced. If omitted, the default branch is used instead. |
A reduction takes two values of a branch and merges them into one (e.g. by summing them, taking the maximum, etc). This action performs the specified reduction operation on all branch 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 branch.
This action is lazy: upon invocation of this method the calculation is booked but not executed. See TResultProxy documentation.
Definition at line 454 of file TDFInterface.hxx.
|
inline |
Execute a user-defined reduce operation on the values of a branch.
F | The type of the reduce callable. Automatically deduced. |
T | The type of the branch to apply the reduction to. Automatically deduced. |
[in] | f | A callable with signature T(T,T) |
[in] | branchName | The branch to be reduced. If omitted, the default branch is used instead. |
[in] | initValue | The reduced object is initialised to this value rather than being default-constructed |
See the description of the other Reduce overload for more information.
Definition at line 471 of file TDFInterface.hxx.
|
inline |
Print filtering statistics on screen.
Calling Report
on the main TDataFrame
object prints 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) prints the stats for all named filters in the chain section between the original TDataFrame
and that node (included). Stats are printed in the same order as the named filters have been added to the graph.
Definition at line 910 of file TDFInterface.hxx.
|
inline |
Create a snapshot of the dataset on disk in the form of a TTree.
BranchTypes | variadic list of branch/column types |
[in] | treename | The name of the output TTree |
[in] | filename | The name of the output TFile |
[in] | bnames | The list of names of the branches to be written |
This function returns a TDataFrame
built with the output tree as a source.
Definition at line 264 of file TDFInterface.hxx.
|
inline |
Create a snapshot of the dataset on disk in the form of a TTree.
[in] | treename | The name of the output TTree |
[in] | filename | The name of the output TFile |
[in] | bnames | The list of names of the branches to be written |
This function returns a TDataFrame
built with the output tree as a source. The types of the branches are automatically inferred and do not need to be specified.
Definition at line 279 of file TDFInterface.hxx.
|
inline |
Create a snapshot of the dataset on disk in the form of a TTree.
[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. See the documentation of TRegexp for more details. An empty string signals the selection of all columns. |
This function returns a TDataFrame
built with the output tree as a source. The types of the branches are automatically inferred and do not need to be specified.
Definition at line 317 of file TDFInterface.hxx.
|
inlineprotected |
Implementation of snapshot.
[in] | treename | The name of the TTree |
[in] | filename | The name of the TFile |
[in] | bnames | The list of names of the branches to be written The implementation exploits Foreach. The association of the addresses to the branches takes place at the first event. This is possible because since there are no copies, the address of the value passed by reference is the address pointing to the storage of the read/created object in/by the TTreeReaderValue/TemporaryBranch |
Definition at line 1082 of file TDFInterface.hxx.
|
inline |
Return a collection of values of a branch (lazy action)
T | The type of the branch. |
COLL | The type of collection used to store the values. |
[in] | branchName | The name of the branch of which the values are to be collected |
This action is lazy: upon invocation of this method the calculation is booked but not executed. See TResultProxy documentation.
Definition at line 512 of file TDFInterface.hxx.
Definition at line 101 of file TDFInterface.hxx.
|
friend |
|
friend |
|
protected |
Definition at line 1230 of file TDFInterface.hxx.
|
protected |
Definition at line 1229 of file TDFInterface.hxx.