Skip to content

Tuple Tools

TupleTools can be added to the entire candidate, a particular node, or any collection of nodes by first making a selection on the graph, and then clikcing the green "+" button on the right side of the TupleTool table located below the node tree. Any existing tool can be removed by clicking the red button with a trash can icon corresponding to the particular tool. Similarly, TupleTools can be configured by clicking the edit pad button in the row corresponding to the TupleTool name. Each of these buttons can be seen in the screenshot below.

Launch tool configuration

Clicking the green "+" button will launch a popup containing a drop down menu of available TupleTools, shown in the screenshow below. If the name of the desired TupleTool is known, it can be found by typing it into the search box.

Add tool

Once a tool is selected from the drop down menu, a custom name can be given to the tool, and documentation for the tool can be seen in the popup window. The green "Add tool" button must be clicked in order to add the TupleTool onto the selected node(s), as shown below.

Add tool filled

TupleTools are configured with an interactive modal displaying the name, datatype, and input fields for all configurable parameters of the TupleTool. Information about each configurable parameter is displayed as an overlay tooltip when hovering over the circled question marks next to each parameter name, where available. The input field depends on the corresponding datatype. If the input field is a list, the means of providing user input again depends on the datatypes in the list. For example, a list of strings is configured via a text box, where a single list entry should be given per line, while a list of integers is input one by one. A screenshot of the modal for TupleToolTISTOS is shown below.

TupleToolTISTOS

At the bottom of the modal, the same documentation displayed in the "add tool" popup window can be found for the TupleTool in question, including links to the corresponding Doxygen pages where available.

TupleToolTISTOS_docs_1 TupleToolTISTOS_docs_2

In the case of "LoKi__Hybrid__TupleTool" and "LoKi__Hybrid__ArrayTupleTool", LoKi functors are added to the TupleTool by configuring a dictionary. The current implementation allows the user to provide a dictionary of strings, where the key corresponds to the name of the variable in the Ntuple, and the value corresponds to an existing LoKi functor name or expression of LoKi functors including mathematical and/or logical operators.

LoKi__Hybrid__TupleTool

The implementation of configuring "LoKi__Hybrid__TupleTool" and "LoKi__Hybrid__ArrayTupleTool" is under active development to (i) make the interface more intuitive, and (ii) expose LoKi functors and subsequent documentation within the application, allowing users to select them rather than key them in.

After adding TupleTools to the node tree, and configuring them as desired, it is important to save the changes you have made on the Ntuple configuration page. This can be done by clicking the blue "Save" button near the bottom of the page.

Save changes