Skip to content

Note

Click here to download the full example code

NBLAST using light-level data#

This example demonstrates how to use NBLAST to match light-level neurons against EM skeletons.

This example is not executed

In contrast to almost all other tutorials, this one is not executed when the documentation is built. Consequently, it also does not show any code output or figures. That's because this example requires downloading a large dataset (~1.8GB) and running an NBLAST against it, it is simply not feasible to run this as part of the documentation build process.

One of the applications of NBLAST is to match neurons across data sets. Here we will illustrate this by taking a light-level, confocal image stack and finding the same neuron in an EM connectome.

Specifically, we will use an image from Janelia's collection of split-Gal4 driver lines and match it against the neurons in the hemibrain connectome.

Before we get started make sure that:

  • NAVis is installed and up-to-date
  • flybrains is installed and you have downloaded the Saalfeld lab's and VFB bridging transforms (see flybrains.download_... functions)
  • download and extract hemibrain-v1.2-skeletons.tar (kindly provided by Stuart Berg, Janelia Research Campus)

Next we need to pick an image stack to use as query. You can browse the expression patterns of the Janelia split-Gal4 lines here. I ended up picking LH1112 which is a very clean line containing a couple of WED projection neurons. Among other data, you can download these stacks as "gendered" (i.e. female or male) or "unisex" space. Unfortunately, all image stacks are in Janelia's .h5j format which I haven't figured out how to read straight into Python.

Two options:

  1. Load them into Fiji and save the GFP signal channel as .nrrd file.
  2. Go to VirtualFlyBrain, search for your line of interested LH1112 (not all lines are be available on VFB) and download the "Signal(NRRD)" at the bottom of Term Info panel on the right hand side.

I went for option 2 here and downloaded a VFB_001013cg.nrrd. This is the neuron we'll be searching for:

LH1112 z-stack

Let's get started!

import navis

First we need to load the image stack and turn it into dotprops:

query = navis.read_nrrd("VFB_001013cg.nrrd", output="dotprops", k=20, threshold=100)
query.id = "LH1112"  # manually set the ID to the Janelia identifier
query

# Inspect the results
navis.plot3d(query)

Note

Depending on your image you will have to play around with the threshold parameter to get a decent dotprop representation.

Next we need to load the hemibrain skeletons and convert them to dotprops:

# Make sure to adjust the path to where you extracted the skeletons
sk = navis.read_swc(
    "hemibrain-v1.2-skeletons/", include_subdirs=True, fmt="{name,id:int}.swc"
)

These 97k skeletons include lots of small fragments - there are only ~25k proper neurons or substantial fragments thereof in the hemibrain dataset. So to make our life a little easier, we will keep only the largest 30k skeletons:

sk.sort_values("n_nodes")
sk = sk[:30_000]
sk

Next up: turning those skeletons into dotprops:

Note that we are resampling to 1 point for every micron of cable Because these skeletons are in 8nm voxels we have to use 1000/8

targets = navis.make_dotprops(sk, k=5, parallel=True, resample=1000 / 8)

Note

Making the dotprops may take a while (mostly because of the resampling). You can dedicate more cores via the n_cores parameter. It may also make sense to save the dotprops for future use e.g. by pickling them.

Last but not least we need to convert the image's dotprops from their current brain space (JRC2018U, U for "unisex") to hemibrain (JRCFIB2018Fraw, raw for voxels) space.

import flybrains

query_xf = navis.xform_brain(query, source="JRC2018U", target="JRCFIB2018Fraw")

Now we can run the actual NBLAST:

# Note that we convert from the JRCFIB2018F voxel (8x8x8nm) space to microns
scores = navis.nblast(query_xf / 125, targets / 125, scores="mean")
scores.head()

Note

You can greatly speed up NBLAST by installing the optional dependency pykdtree: 

pip3 install pykdtree

Now we can sort those scores to find the top matches:

scores.loc["LH1112"].sort_values(ascending=False)

So we did get a couple of hits here. Let's visualize the top 3:

fig = navis.plot3d([query_xf, targets.idx[[2030342003, 2214504597, 1069223047]]])

On a final note: the scores for those matches are rather low (1 = perfect match).

The main reason for this is that our image stack contains two neurons (the left and the right version) so half of our query won't have a match in any of the individual hemibrain neurons. We could have fixed that by subsetting the query to the approximate hemibrain bounding box. This is also a good idea for bilateral neurons that have parts of their arbour outside the hemibrain volume:

Remove the left-hand-side neuron based on the position along the x-axis (this is just one of the possible approaches) This is the approximate LHS boundary of the volume

flybrains.JRCFIB2018Fraw.mesh.vertices[:, 0].max()

query_ss = navis.subset_neuron(query_xf, query_xf.points[:, 0] <= 35_000)
query_ss

Using query_ss should yield much improved scores.

Another potential pitfall is the generation of dotprops from the image itself: if you compare the image- against the skeleton-derived dotprops, you might notice that the latter have fewer and less dense points. That's a natural consequence the image containing multiple individuals of the same cell type but we could have tried to ameliorate this by some pre-processing (e.g. downsampling or thinning the image).

Total running time of the script: ( 0 minutes 0.000 seconds)

Download Python source code: zzz_no_plot_02_nblast_hemibrain.py

Download Jupyter notebook: zzz_no_plot_02_nblast_hemibrain.ipynb

Gallery generated by mkdocs-gallery