{ "cells": [ { "cell_type": "markdown", "id": "3cd4b70b", "metadata": {}, "source": [ "# rf104_classfactory\n", "Basic functionality: the class factory for functions and pdfs\n", "\n", "NOTE: This demo uses code that is generated by the macro,\n", " which can be compiled on the fly (set to MyPdfV3 below).\n", " To use MyPdfV1 or MyPdfV2, adjust lines below accordingly.\n", "\n", "\n", "\n", "\n", "**Author:** Clemens Lange, Wouter Verkerke (C++ version) \n", "This notebook tutorial was automatically generated with ROOTBOOK-izer from the macro found in the ROOT repository on Tuesday, May 19, 2026 at 08:28 PM." ] }, { "cell_type": "code", "execution_count": 1, "id": "07efa79d", "metadata": { "collapsed": false, "execution": { "iopub.execute_input": "2026-05-19T20:28:45.988401Z", "iopub.status.busy": "2026-05-19T20:28:45.988282Z", "iopub.status.idle": "2026-05-19T20:28:46.944727Z", "shell.execute_reply": "2026-05-19T20:28:46.944173Z" } }, "outputs": [], "source": [ "import ROOT" ] }, { "cell_type": "markdown", "id": "ecf2a7e2", "metadata": {}, "source": [ "Write class skeleton code\n", "--------------------------------------------------" ] }, { "cell_type": "markdown", "id": "3683d6e1", "metadata": {}, "source": [ "Write skeleton pdf class with variable x,a,b\n", "To use this class,\n", " - Edit the file MyPdfV1.cxx and implement the evaluate() method in terms of x,a and b\n", " - Compile and link class with '.x MyPdfV1.cxx+'" ] }, { "cell_type": "code", "execution_count": 2, "id": "305ef421", "metadata": { "collapsed": false, "execution": { "iopub.execute_input": "2026-05-19T20:28:46.953572Z", "iopub.status.busy": "2026-05-19T20:28:46.953431Z", "iopub.status.idle": "2026-05-19T20:28:47.094512Z", "shell.execute_reply": "2026-05-19T20:28:47.093444Z" } }, "outputs": [ { "data": { "text/plain": [ "False" ] }, "execution_count": 2, "metadata": {}, "output_type": "execute_result" } ], "source": [ "ROOT.RooClassFactory.makePdf(\"MyPdfV1\", \"x,A,B\")" ] }, { "cell_type": "markdown", "id": "72ae2a9d", "metadata": {}, "source": [ "With added initial value expression\n", "---------------------------------------------------------------------" ] }, { "cell_type": "markdown", "id": "7494f5ff", "metadata": {}, "source": [ "Write skeleton pdf class with variable x,a,b and given formula expression\n", "To use this class,\n", " - Compile and link class with '.x MyPdfV2.cxx+'" ] }, { "cell_type": "code", "execution_count": 3, "id": "992e99c2", "metadata": { "collapsed": false, "execution": { "iopub.execute_input": "2026-05-19T20:28:47.096192Z", "iopub.status.busy": "2026-05-19T20:28:47.096068Z", "iopub.status.idle": "2026-05-19T20:28:47.201439Z", "shell.execute_reply": "2026-05-19T20:28:47.200360Z" } }, "outputs": [ { "data": { "text/plain": [ "False" ] }, "execution_count": 3, "metadata": {}, "output_type": "execute_result" } ], "source": [ "ROOT.RooClassFactory.makePdf(\"MyPdfV2\", \"x,A,B\", \"\", \"A*fabs(x)+pow(x-B,2)\")" ] }, { "cell_type": "markdown", "id": "2e3c06be", "metadata": {}, "source": [ "With added analytical integral expression\n", "---------------------------------------------------------------------------------" ] }, { "cell_type": "markdown", "id": "3bad8338", "metadata": {}, "source": [ "Write skeleton pdf class with variable x,a,b, given formula expression _and_\n", "given expression for analytical integral over x\n", "To use this class,\n", " - Compile and link class with '.x MyPdfV3.cxx+'" ] }, { "cell_type": "code", "execution_count": 4, "id": "852f13f4", "metadata": { "collapsed": false, "execution": { "iopub.execute_input": "2026-05-19T20:28:47.203073Z", "iopub.status.busy": "2026-05-19T20:28:47.202947Z", "iopub.status.idle": "2026-05-19T20:28:47.308032Z", "shell.execute_reply": "2026-05-19T20:28:47.306958Z" } }, "outputs": [ { "data": { "text/plain": [ "False" ] }, "execution_count": 4, "metadata": {}, "output_type": "execute_result" } ], "source": [ "ROOT.RooClassFactory.makePdf(\n", " \"MyPdfV3\",\n", " \"x,A,B\",\n", " \"\",\n", " \"A*fabs(x)+pow(x-B,2)\",\n", " True,\n", " False,\n", " \"x:(A/2)*(pow(x.max(rangeName),2)+pow(x.min(rangeName),2))+(1./3)*(pow(x.max(rangeName)-B,3)-pow(x.min(rangeName)-B,3))\",\n", ")" ] }, { "cell_type": "markdown", "id": "4bf4b888", "metadata": {}, "source": [ "Use instance of created class\n", "---------------------------------------------------------" ] }, { "cell_type": "markdown", "id": "41b2cdc0", "metadata": {}, "source": [ "Compile MyPdfV3 class" ] }, { "cell_type": "code", "execution_count": 5, "id": "d206336c", "metadata": { "collapsed": false, "execution": { "iopub.execute_input": "2026-05-19T20:28:47.309683Z", "iopub.status.busy": "2026-05-19T20:28:47.309539Z", "iopub.status.idle": "2026-05-19T20:28:52.665028Z", "shell.execute_reply": "2026-05-19T20:28:52.664469Z" } }, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "(MyPdfV3) An instance of MyPdfV3.\n" ] }, { "data": { "text/plain": [ "94285276854512" ] }, "execution_count": 5, "metadata": {}, "output_type": "execute_result" }, { "name": "stderr", "output_type": "stream", "text": [ "Info in : creating shared library /github/home/master/notebooks/./MyPdfV3_cxx.so\n" ] } ], "source": [ "ROOT.gROOT.ProcessLineSync(\".x MyPdfV3.cxx+\")" ] }, { "cell_type": "markdown", "id": "b928ee31", "metadata": {}, "source": [ "Creat instance of MyPdfV3 class" ] }, { "cell_type": "code", "execution_count": 6, "id": "64d62c04", "metadata": { "collapsed": false, "execution": { "iopub.execute_input": "2026-05-19T20:28:52.666954Z", "iopub.status.busy": "2026-05-19T20:28:52.666826Z", "iopub.status.idle": "2026-05-19T20:28:52.810185Z", "shell.execute_reply": "2026-05-19T20:28:52.809651Z" } }, "outputs": [], "source": [ "a = ROOT.RooRealVar(\"a\", \"a\", 1)\n", "b = ROOT.RooRealVar(\"b\", \"b\", 2, -10, 10)\n", "y = ROOT.RooRealVar(\"y\", \"y\", -10, 10)\n", "pdf = ROOT.MyPdfV3(\"pdf\", \"pdf\", y, a, b)" ] }, { "cell_type": "markdown", "id": "ad5f4728", "metadata": {}, "source": [ "Generate toy data from pdf and plot data and pdf on frame" ] }, { "cell_type": "code", "execution_count": 7, "id": "486163c7", "metadata": { "collapsed": false, "execution": { "iopub.execute_input": "2026-05-19T20:28:52.812101Z", "iopub.status.busy": "2026-05-19T20:28:52.811974Z", "iopub.status.idle": "2026-05-19T20:28:53.111822Z", "shell.execute_reply": "2026-05-19T20:28:53.111312Z" } }, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "[#1] INFO:Fitting -- RooAbsPdf::fitTo(pdf_over_pdf_Int[y]) fixing normalization set for coefficient determination to observables in data\n", "[#1] INFO:Fitting -- using generic CPU library compiled with no vectorizations\n", "[#1] INFO:Fitting -- Creation of NLL object took 680.144 μs\n", "[#1] INFO:Fitting -- RooAddition::defaultErrorLevel(nll_pdf_over_pdf_Int[y]_pdfData) Summation contains a RooNLLVar, using its error level\n", "[#1] INFO:Minimization -- [fitFCN] No discrete parameters, performing continuous minimization only\n" ] }, { "data": { "text/plain": [ "" ] }, "execution_count": 7, "metadata": {}, "output_type": "execute_result" } ], "source": [ "frame1 = y.frame(Title=\"Compiled class MyPdfV3\")\n", "data = pdf.generate({y}, 1000)\n", "pdf.fitTo(data, PrintLevel=-1)\n", "data.plotOn(frame1)\n", "pdf.plotOn(frame1)" ] }, { "cell_type": "markdown", "id": "1c2dcb71", "metadata": {}, "source": [ "/\n", "Compiled version of example rf103#\n", "/" ] }, { "cell_type": "markdown", "id": "57e7a949", "metadata": {}, "source": [ "Declare observable x" ] }, { "cell_type": "code", "execution_count": 8, "id": "5ae219d4", "metadata": { "collapsed": false, "execution": { "iopub.execute_input": "2026-05-19T20:28:53.113814Z", "iopub.status.busy": "2026-05-19T20:28:53.113683Z", "iopub.status.idle": "2026-05-19T20:28:53.217008Z", "shell.execute_reply": "2026-05-19T20:28:53.216483Z" } }, "outputs": [], "source": [ "x = ROOT.RooRealVar(\"x\", \"x\", -20, 20)" ] }, { "cell_type": "markdown", "id": "317d81b2", "metadata": {}, "source": [ "The ROOT.RooClassFactory.makePdfInstance() function performs code writing, compiling, linking\n", "and object instantiation in one go and can serve as a straight\n", "replacement of ROOT.RooGenericPdf" ] }, { "cell_type": "code", "execution_count": 9, "id": "9e77dfd6", "metadata": { "collapsed": false, "execution": { "iopub.execute_input": "2026-05-19T20:28:53.229459Z", "iopub.status.busy": "2026-05-19T20:28:53.229323Z", "iopub.status.idle": "2026-05-19T20:28:58.451006Z", "shell.execute_reply": "2026-05-19T20:28:58.450553Z" } }, "outputs": [ { "name": "stderr", "output_type": "stream", "text": [ "Info in : creating shared library /github/home/master/notebooks/RooGenPdfPdf_cxx.so\n" ] } ], "source": [ "alpha = ROOT.RooRealVar(\"alpha\", \"alpha\", 5, 0.1, 10)\n", "genpdf = ROOT.RooClassFactory.makePdfInstance(\"GenPdf\", \"(1+0.1*fabs(x)+sin(sqrt(fabs(x*alpha+0.1))))\", [x, alpha])" ] }, { "cell_type": "markdown", "id": "c5662580", "metadata": {}, "source": [ "Generate a toy dataset from the interpreted pdf" ] }, { "cell_type": "code", "execution_count": 10, "id": "9330ef0a", "metadata": { "collapsed": false, "execution": { "iopub.execute_input": "2026-05-19T20:28:58.452400Z", "iopub.status.busy": "2026-05-19T20:28:58.452278Z", "iopub.status.idle": "2026-05-19T20:28:58.581469Z", "shell.execute_reply": "2026-05-19T20:28:58.581050Z" } }, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "[#1] INFO:NumericIntegration -- RooRealIntegral::init(GenPdf_Int[x]) using numeric integrator RooIntegrator1D to calculate Int(x)\n", "[#1] INFO:NumericIntegration -- RooRealIntegral::init(GenPdf_Int[x]) using numeric integrator RooIntegrator1D to calculate Int(x)\n" ] } ], "source": [ "data2 = genpdf.generate({x}, 50000)" ] }, { "cell_type": "markdown", "id": "3bd039bd", "metadata": {}, "source": [ "Fit the interpreted pdf to the generated data" ] }, { "cell_type": "code", "execution_count": 11, "id": "55a3ec6f", "metadata": { "collapsed": false, "execution": { "iopub.execute_input": "2026-05-19T20:28:58.582892Z", "iopub.status.busy": "2026-05-19T20:28:58.582768Z", "iopub.status.idle": "2026-05-19T20:28:58.725379Z", "shell.execute_reply": "2026-05-19T20:28:58.724925Z" } }, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "[#1] INFO:Fitting -- RooAbsPdf::fitTo(GenPdf_over_GenPdf_Int[x]) fixing normalization set for coefficient determination to observables in data\n", "[#1] INFO:Fitting -- Creation of NLL object took 740.642 μs\n", "[#1] INFO:Fitting -- RooAddition::defaultErrorLevel(nll_GenPdf_over_GenPdf_Int[x]_GenPdfData) Summation contains a RooNLLVar, using its error level\n", "[#1] INFO:Minimization -- [fitFCN] No discrete parameters, performing continuous minimization only\n", "[#1] INFO:NumericIntegration -- RooRealIntegral::init(GenPdf_Int[x]) using numeric integrator RooIntegrator1D to calculate Int(x)\n" ] }, { "data": { "text/plain": [ "" ] }, "execution_count": 11, "metadata": {}, "output_type": "execute_result" } ], "source": [ "genpdf.fitTo(data2, PrintLevel=-1)" ] }, { "cell_type": "markdown", "id": "1af57c80", "metadata": {}, "source": [ "Make a plot of the data and the pdf overlaid" ] }, { "cell_type": "code", "execution_count": 12, "id": "bf6bf2cb", "metadata": { "collapsed": false, "execution": { "iopub.execute_input": "2026-05-19T20:28:58.727277Z", "iopub.status.busy": "2026-05-19T20:28:58.727154Z", "iopub.status.idle": "2026-05-19T20:28:58.835110Z", "shell.execute_reply": "2026-05-19T20:28:58.834618Z" } }, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "[#1] INFO:NumericIntegration -- RooRealIntegral::init(GenPdf_Int[x]) using numeric integrator RooIntegrator1D to calculate Int(x)\n" ] }, { "data": { "text/plain": [ "" ] }, "execution_count": 12, "metadata": {}, "output_type": "execute_result" } ], "source": [ "frame2 = x.frame(Title=\"Compiled version of pdf of rf103\")\n", "data2.plotOn(frame2)\n", "genpdf.plotOn(frame2)" ] }, { "cell_type": "markdown", "id": "e2d72ece", "metadata": {}, "source": [ "Draw all frames on a canvas" ] }, { "cell_type": "code", "execution_count": 13, "id": "e8feaa88", "metadata": { "collapsed": false, "execution": { "iopub.execute_input": "2026-05-19T20:28:58.836770Z", "iopub.status.busy": "2026-05-19T20:28:58.836647Z", "iopub.status.idle": "2026-05-19T20:28:59.064222Z", "shell.execute_reply": "2026-05-19T20:28:59.063760Z" } }, "outputs": [ { "name": "stderr", "output_type": "stream", "text": [ "Info in : png file rf104_classfactory.png has been created\n" ] } ], "source": [ "c = ROOT.TCanvas(\"rf104_classfactory\", \"rf104_classfactory\", 800, 400)\n", "c.Divide(2)\n", "c.cd(1)\n", "ROOT.gPad.SetLeftMargin(0.15)\n", "frame1.GetYaxis().SetTitleOffset(1.4)\n", "frame1.Draw()\n", "c.cd(2)\n", "ROOT.gPad.SetLeftMargin(0.15)\n", "frame2.GetYaxis().SetTitleOffset(1.4)\n", "frame2.Draw()\n", "\n", "c.SaveAs(\"rf104_classfactory.png\")" ] }, { "cell_type": "markdown", "id": "4cbbfa96", "metadata": {}, "source": [ "Draw all canvases " ] }, { "cell_type": "code", "execution_count": 14, "id": "eeae6569", "metadata": { "collapsed": false, "execution": { "iopub.execute_input": "2026-05-19T20:28:59.066104Z", "iopub.status.busy": "2026-05-19T20:28:59.065974Z", "iopub.status.idle": "2026-05-19T20:28:59.252373Z", "shell.execute_reply": "2026-05-19T20:28:59.251910Z" } }, "outputs": [ { "data": { "text/html": [ "\n", "\n", "
\n", "
\n", "\n", "\n", "\n" ], "text/plain": [ "" ] }, "metadata": {}, "output_type": "display_data" } ], "source": [ "from ROOT import gROOT \n", "gROOT.GetListOfCanvases().Draw()" ] } ], "metadata": { "kernelspec": { "display_name": "Python 3", "language": "python", "name": "python3" }, "language_info": { "codemirror_mode": { "name": "ipython", "version": 3 }, "file_extension": ".py", "mimetype": "text/x-python", "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", "version": "3.12.12" } }, "nbformat": 4, "nbformat_minor": 5 }