nat.nblast (version 1.5)

show_similarity: Display two neurons with segments coloured by similarity

Description

Display two neurons with segments coloured by similarity

Usage

show_similarity(n1, n2, smat = get(getOption("nat.nblast.defaultsmat")),
  cols = colorRampPalette(c("#0000FF", "#FF0000")), col = "black",
  AbsoluteScale = FALSE, PlotVectors = TRUE, ...)

Arguments

n1

a neuron to compare and colour.

n2

the neuron to compare against.

smat

a score matrix.

cols

the function to use to colour the segments (e.g. heat.colors).

col

the colour with which to draw the comparison neuron.

AbsoluteScale

logical indicating whether the colours should be calculated based on the minimum and maximum similarities for the neuron (AbsoluteScale = FALSE) or on the minimum and maximum possible for all neurons.

PlotVectors

logical indicating whether the vectors of the dotprops representation should be plotted. If FALSE, only the points are plotted.

...

extra arguments to pass to plot3d.

Value

• show_similarity is called for the side effect of drawing the plot; a vector of object IDs is returned.