TTree / RDataFrame

本記事ではROOTでのデータ保存形式であるTTreeを, ROOTの機能であるRDataFrameを使って利用する方法を解説します.

上記に全て書いてありますが, 一応よく使いそうなケースを示します.

TTreeを読む
ROOTファイルの中身の確認
RDataFrameの構築
これまで必要だった記述
Treeのお絵描き
新しいcolumn (branch)の定義
Treeの保存
雑感

TTreeを読む

ROOTファイルの中身の確認

今, 中身をよく知らないrootファイルがあったとします. 実験をやっていると誰かの作ったrootファイルがあって, 中身についてのDocumentは全然ないということがよくあります. ここでは huge.root というファイルがあったとします.

最近のROOTには rootls というコマンドが同梱されています. まずこれで中身を確認します.

TNamedとか, TParameterなども入っていますが, ここではTTreeに着目します.

tree という名前のTTreeが入っていることがわかり, その中に nHit や x などの変数 (branch) が入っていることがわかります. このファイルが欲しかったBranchがあれば, 次に進みます. そうでなければ, ROOTファイル探しの旅を続けることになります.

これまでは, root -l huge.root として, ROOTのプロンプトで .ls する方法が主流でした. 好みの範囲に収まる程度の違いだと思います.

RDataFrameの構築

root と打ってROOTのPromptを起動して, RDataFrameを作ります.

ROOT::EnableImplicitMT(); // For multi-thread processing
ROOT::RDataFrame df ("tree", "huge.root")

rootマクロとしてではなく, C++としてコンパイルする場合は#include <ROOT/RDataFrame.hxx> が必要です.

df.Describe() 関数で中身を調べられます.

入っている変数の型もここでわかります.

💡

TTreeを読みたい場合はこれまで結構大変な記述が必要でしたがtree->SetBranchAddress() とか今や必要ありません.

‣

これまで必要だった記述

df.GetColumnNames() でBranch名 (RDataFrameの流儀ではColumn) をリストで受け取ることができるので,

for (auto c : df.GetColumnNames()){
	// Something to do
	std::cout << c << std::endl;
}

こんな感じでBranch全てに対して行う処理を実行できます.

Treeのお絵描き

まずはヒストグラム

auto h = df.Histo1D("nHit");
h->Draw();

これまで, tree->Draw("nHit") としていたものの代わりになります.

Cutをかけたければ,

auto h1 = df.Filter("nHit>0").Histo1D("eDep") とかでFilterしてください.

tree->Draw() の第二引数にCutを書くより, Filterの結果が使いまわされることに優位性があります.

たくさんTreeを作った場合も, 使う時 (つまり, ポインタにアクセスする際に作成が始まり, まとめられるときは一つのloopで行われます)

ヒストグラムをたくさん定義して,

auto h_x = df.Histo1D("x");
auto h_y = df.Histo1D("y");
auto h_z = df.Histo1D("z");
auto h_eDep = df.Histo1D("eDep");
auto h_eIn = df.Histo1D("eIn");

ヒストグラムを描画します.

h_x->Draw();

この描画しようとした瞬間にevent loopが走ります. 同じevent loopで h_y なども作られるため, 他のヒストグラムを書くのは爆速です.

df.Describe()のEvent loops runでloop回数を確認できます. この場合は5個ヒストグラムを作っていますが, event loopは1しか増えていないことが確認できます.

新しいcolumn (branch)の定義

df.Define() で追加します.

auto df_new = df.Define("new_column", "nHit*2")

nHit*2 の部分はラムダ式や関数を直接入れることが可能.

その場合は第三引数に値のリストを渡す必要がある. {"val1", "val2"} など

公式のExample

// assuming a function with signature:
double myComplexCalculation(const RVec<float> &muon_pts);
// we can pass it directly to Define
auto df_with_define = df.Define("newColumn", myComplexCalculation, {"muon_pts"});
// alternatively, we can pass the body of the function as a string, as in Filter:
auto df_with_define = df.Define("newColumn", "x*x + y*y");

Treeの保存

これまでの tree->Fill() , tree->Write(), file->Close() を完全に過去にしています.

df_new.Snapshot("new_tree", "new_file.root",
                    {"new_column", "x", "y", "z"});

これでできてしまいます.

雑感

宣言的プログラミングっぽさがあります.
ROOTはついに “ユーザーは愚かだからLoopを書かせない” という進化をしてきているのかもしれません.
煩雑なTTreeの手続きがかなり楽になっています. Branchに文字列でアクセスすることができるだけでかなり幸せです.
真面目に使おうとするとラムダ式とauto盛り盛りになるので, C++11に追いついてきていないユーザーには意味不明なコードになるでしょう.
printf デバッグをしてきた人は大変に, Unitテストを書く側からするとより楽になる気がします.