Graph and node tips#

This notebook is about helpful tips or tricks you can use when working with nodes of a custom interface graph you have built.

It assumes that you have already explored the notebook on creating custom interfaces, which is a pre-requisite to understanding the content here.

[1]:

%matplotlib widget
import plopp as pp
import scipp as sc
import numpy as np

Node operators#

47d5b6b8623044edbbc27bb732c76489 New in version 23.04.0.

We have seen in the previous notebook how functions/callables wrapped in a Node are used to represent operations between different data sources.

It can sometimes be useful to know that nodes also have operators, and simple operations can be implemented in a short-hand way, instead of defining functions such as add or multiply.

Consider for example

[2]:

a = pp.Node(np.array([1, 2, 3, 4, 5]))
b = pp.Node(np.array([6, 7, 8, 9, 10]))

The ‘classical’ way of adding the data from a and b would be to wrap an add function in a Node as follows:

[3]:

def add(x, y):
    return x + y


c = pp.Node(add, a, b)
c()

[3]:

array([ 7,  9, 11, 13, 15])

However, this short-hand is also possible:

[4]:

c = a + b
c()

[4]:

array([ 7,  9, 11, 13, 15])

Operators also work with normal Python objects, which simply get wrapped in a Node:

[5]:

c = a * 33.0
c()

[5]:

array([ 33.,  66.,  99., 132., 165.])

A short example#

[6]:

noise = 0.5 * (np.random.random(100) - 0.5)
signal = np.sin(0.1 * np.arange(100.0)) + noise

# Noisy data
a = pp.Node(
    sc.DataArray(
        data=sc.array(dims=['time'], values=signal),
        coords={'time': sc.arange('time', 100.0, unit='s')},
    )
)
fig = pp.linefigure(a)
fig

[6]:

[7]:

b = pp.Node(
    sc.DataArray(
        data=sc.array(dims=['time'], values=noise),
        coords={'time': sc.arange('time', 100.0, unit='s')},
    )
)

# Remove noise from signal
diff = a - b
pp.linefigure(diff)

[7]:

Using plotting functions in a graph#

42b821f170264525bad3ac2b021eb2dd New in version 23.10.0.

All the examples for working with nodes and graphs presented so far have been using the lower-level linefigure, imagefigure and scatter3dfigure as views for the data.

These functions accept graph nodes as input, and provide visualizations for 1D, 2D or scatter 3D data.

However, say that at the end point of a graph, in the node that is providing the final result, the data still has three dimensions. One common way of visualizing such data is as a 2D image with a slider to navigate the third dimension.

Instead of having to manually set up a slider and a node for the slicing, it is possible to use Plopp’s higher-level plotting functions directly as part of a graph. In our present example, this would be the slicer plot.

[8]:

# Make a 3D array with random values
da = pp.data.random((100, 150, 200))
da

[9]:

import ipywidgets as ipw
from scipp.scipy.ndimage import gaussian_filter

# Raw data root node
data_node = pp.Node(da)

# Slider to control width of smoothing kernel
slider = ipw.IntSlider(min=1, max=20, description="Smoothing")
slider_node = pp.widget_node(slider)

# Node that performs the gaussian smoothing
smooth_node = pp.Node(gaussian_filter, data_node, sigma=slider_node)

pp.show_graph(smooth_node)

[9]:

../../_images/user-guide_customization_graph-node-tips_15_0.svg

[10]:

# Attach the `slicer` plot to the bottom node
fig = pp.slicer(smooth_node)
ipw.VBox([slider, fig])

[10]:

We now have a slider at the top that controls the width of the smoothing kernel, and a second slider at the bottom that can navigate the z dimension.

The final node graph is

[11]:

pp.show_graph(data_node)

[11]:

../../_images/user-guide_customization_graph-node-tips_18_0.svg