Package: napari-clemreg
napari-clemrergAn automated point cloud based registration algorithm for correlative light and volume electron microscopyInstallationTo installnapari-clemregit is recommended to create a freshcondaenvironment with Python 3.9:conda create -n clemreg_env python=3.9Next, installnapariwith the following command viapip:pip install "napari[all]"Finally,napari-clemregcan be installed with:pip install napari-clemregWhen installingnapari-clemregon a Windows machine, the following error might appear:error Microsoft Visual C++ 14.0 is requiredEnsure thatVisual Studios C++ 14.00is installedUsageCLEM-reg is the combination of 5 main steps, MitoNet segmentation, LoG segmentation,
point cloud sampling, point cloud registration and lastly image warping. These 5 steps
can be run all at once using the run registration widget shown below with the tick next to it.
Alternatively, they can be run individually with the numbered widgets.Run RegistrationMoving Image- Here you select your light microscopy (LM) data which will
be warped to align with the fixed electron microscopy (EM) image.Fixed Image- Here you select your EM data which will
act as the reference point for the LM to be aligned to.Registration Algorithm- Here you can decide which type of registration algorith
will be used for the registration of inputted LM and EM. In terms of speed of each algorithm
the following is the generally true, Rigid CPD > Affine CPD > BCPD.MitoNet Segmentation Parameters- Here are the advanced options for the segmentation
of the mitochondria in the EM data.Prediction Across Three Axis - By selecting this option MitoNet will run segmentation
across all three axis of the EM volume and then these three predictions will be aggregate.LoG Segmentation Parameters- Here are the advanced options for the segmentation of
the mitochondria in the LM data.Sigma - Sigma value for the Laplacian of Gaussian filter.Threshold - Threshold value for the segmenting the LM data.Point Cloud Sampling- Here are the advanced options for the point cloud sampling of the
segmentations of the LM and EM data.Sampling Frequency - Frequency of point sampling from the fixed and moving segmentation. The greater the value the more points in the point cloud.Sigma - Sigma value for the canny edge filter.Point Cloud Registration- Here are the advanced options for the registration of the point clouds
of both the LM and EM data.Voxel Size - The size voxel size of each point. Smaller the size the less memory consumption.Subsampling - Downsampling of the point clouds to reduce memory consumption. Greater the number the fewer points in the point cloud.Maximum Iterations - The number of round of point cloud registration. If too small it won't converge on an opitmal registration.Image Warping- Here are the advanced options for the image warping of the moving LM images.Interpolation Order - The order of the spline interpolation.Aproximate Grid - Controls the "resolution" of the grid onto which you're warping. A higher value reduces the step size between coordinates.Sub-division Factor - Controls the size of the chunk when applying the warping.Save Parameters- Here you can select the option to save the advanced options you've selected
to a JSON file which can be kept for reproducibility as well as running the registration again.Visualise Intermediate Results- Here you can select to view the outputs of each step as they
are completed.Split RegistrationAs well as being able to run all the steps of CLEM-reg in one widget (theRun registrationwidget),
you are also able to do all these steps independently using theSplit Registrationfunctionality.There are four separate widgets that encapsulate the 5 steps of CLEM-reg each of which have
their own unique input and output:MitoNet SegmentationInput: EM ImageOutput: EM SegmentationLoG SegmentationInput: LM ImageOutput: LM SegmentationPoint Cloud SamplingInput: LM Segmentation & EM SegmentationOutput: LM Point Cloud & LM Point CloudPoint Cloud Registration & Image WarpingInput: EM Image, LM Image, LM Point Cloud & EM Point CloudOutput: Registered LM Image, Registered LM Point CloudRegistering Multiple LM ChannelsOne can register multiple LM channels at once by doing the following.Start by splitting the LM channels into the separate layers by right-clicking on
the layer and then selectingSplit Stack.This will result in each of the channels having their own individual layer.Once this is done we must link all the LM layers together, this is done
by selecting all the layers which will highlight them in blue, once again right-clicking
on the layer and then selectingLink Layers.When you finally go to run CLEM-reg ensure that for theMoving Imageyou select the LM layer that contains mitochondria.ContributingContributions are very welcome. Tests can be run withtox, please ensure
the coverage at least stays the same before you submit a pull request.LicenseDistributed under the terms of theMITlicense,
"napari-clemreg" is free and open source softwareIssuesIf you encounter any problems, pleasefile an issuealong with a detailed description.Thisnapariplugin was generated withCookiecutterusing@napari'scookiecutter-napari-plugintemplate.