Plot a NeuroSlice
plot an NeuroVol as a series of 2D slices
Usage
# S4 method for class 'NeuroSlice'
plot(
x,
cmap = gray(seq(0, 1, length.out = 255)),
irange = range(x, na.rm = TRUE)
)
# S4 method for class 'NeuroVol'
plot(
x,
cmap = gray(seq(0, 1, length.out = 255)),
zlevels = unique(round(seq(1, dim(x)[3], length.out = 6))),
irange = range(x, na.rm = TRUE),
thresh = c(0, 0),
alpha = 1,
bgvol = NULL,
bgcmap = gray(seq(0, 1, length.out = 255))
)Arguments
- x
the object to display
- cmap
a color map consisting of a vector of colors in hex format (e.g.
gray(n=255))- irange
the intensity range indicating the low and high values of the color scale.
- zlevels
the series of slice indices to display.
- thresh
a 2-element vector indicating the lower and upper transparency thresholds.
- alpha
the level of alpha transparency
- bgvol
a background volume that serves as an image underlay (currently ignored).
- bgcmap
a color map for backround layer consisting of a vector of colors in hex format (e.g.
gray(n=255))
Details
The plot method uses ggplot2 to create a raster visualization of the slice data.
The intensity values are mapped to colors using the specified colormap and range.
when `x` is a NeuroSlice object, the plot method returns a ggplot2 object containing the raster visualization of the slice data.
The plot can be further customized using standard ggplot2 functions.
Examples
# Create example slice
slice_space <- NeuroSpace(c(100, 100))
slice_data <- matrix(rnorm(100*100), 100, 100)
slice <- NeuroSlice(slice_data, slice_space)
# \donttest{
# Basic plot
plot(slice)
#> List of 136
#> $ line :List of 6
#> ..$ colour : chr "black"
#> ..$ linewidth : num 0.5
#> ..$ linetype : num 1
#> ..$ lineend : chr "butt"
#> ..$ arrow : logi FALSE
#> ..$ inherit.blank: logi TRUE
#> ..- attr(*, "class")= chr [1:2] "element_line" "element"
#> $ rect :List of 5
#> ..$ fill : chr "white"
#> ..$ colour : chr "black"
#> ..$ linewidth : num 0.5
#> ..$ linetype : num 1
#> ..$ inherit.blank: logi TRUE
#> ..- attr(*, "class")= chr [1:2] "element_rect" "element"
#> $ text :List of 11
#> ..$ family : chr ""
#> ..$ face : chr "plain"
#> ..$ colour : chr "black"
#> ..$ size : num 11
#> ..$ hjust : num 0.5
#> ..$ vjust : num 0.5
#> ..$ angle : num 0
#> ..$ lineheight : num 0.9
#> ..$ margin : 'margin' num [1:4] 0points 0points 0points 0points
#> .. ..- attr(*, "unit")= int 8
#> ..$ debug : logi FALSE
#> ..$ inherit.blank: logi TRUE
#> ..- attr(*, "class")= chr [1:2] "element_text" "element"
#> $ title : NULL
#> $ aspect.ratio : NULL
#> $ axis.title : NULL
#> $ axis.title.x :List of 11
#> ..$ family : NULL
#> ..$ face : NULL
#> ..$ colour : NULL
#> ..$ size : NULL
#> ..$ hjust : NULL
#> ..$ vjust : num 1
#> ..$ angle : NULL
#> ..$ lineheight : NULL
#> ..$ margin : 'margin' num [1:4] 2.75points 0points 0points 0points
#> .. ..- attr(*, "unit")= int 8
#> ..$ debug : NULL
#> ..$ inherit.blank: logi TRUE
#> ..- attr(*, "class")= chr [1:2] "element_text" "element"
#> $ axis.title.x.top :List of 11
#> ..$ family : NULL
#> ..$ face : NULL
#> ..$ colour : NULL
#> ..$ size : NULL
#> ..$ hjust : NULL
#> ..$ vjust : num 0
#> ..$ angle : NULL
#> ..$ lineheight : NULL
#> ..$ margin : 'margin' num [1:4] 0points 0points 2.75points 0points
#> .. ..- attr(*, "unit")= int 8
#> ..$ debug : NULL
#> ..$ inherit.blank: logi TRUE
#> ..- attr(*, "class")= chr [1:2] "element_text" "element"
#> $ axis.title.x.bottom : NULL
#> $ axis.title.y :List of 11
#> ..$ family : NULL
#> ..$ face : NULL
#> ..$ colour : NULL
#> ..$ size : NULL
#> ..$ hjust : NULL
#> ..$ vjust : num 1
#> ..$ angle : num 90
#> ..$ lineheight : NULL
#> ..$ margin : 'margin' num [1:4] 0points 2.75points 0points 0points
#> .. ..- attr(*, "unit")= int 8
#> ..$ debug : NULL
#> ..$ inherit.blank: logi TRUE
#> ..- attr(*, "class")= chr [1:2] "element_text" "element"
#> $ axis.title.y.left : NULL
#> $ axis.title.y.right :List of 11
#> ..$ family : NULL
#> ..$ face : NULL
#> ..$ colour : NULL
#> ..$ size : NULL
#> ..$ hjust : NULL
#> ..$ vjust : num 1
#> ..$ angle : num -90
#> ..$ lineheight : NULL
#> ..$ margin : 'margin' num [1:4] 0points 0points 0points 2.75points
#> .. ..- attr(*, "unit")= int 8
#> ..$ debug : NULL
#> ..$ inherit.blank: logi TRUE
#> ..- attr(*, "class")= chr [1:2] "element_text" "element"
#> $ axis.text :List of 11
#> ..$ family : NULL
#> ..$ face : NULL
#> ..$ colour : chr "grey30"
#> ..$ size : 'rel' num 0.8
#> ..$ hjust : NULL
#> ..$ vjust : NULL
#> ..$ angle : NULL
#> ..$ lineheight : NULL
#> ..$ margin : NULL
#> ..$ debug : NULL
#> ..$ inherit.blank: logi TRUE
#> ..- attr(*, "class")= chr [1:2] "element_text" "element"
#> $ axis.text.x :List of 11
#> ..$ family : NULL
#> ..$ face : NULL
#> ..$ colour : NULL
#> ..$ size : NULL
#> ..$ hjust : NULL
#> ..$ vjust : num 1
#> ..$ angle : NULL
#> ..$ lineheight : NULL
#> ..$ margin : 'margin' num [1:4] 2.2points 0points 0points 0points
#> .. ..- attr(*, "unit")= int 8
#> ..$ debug : NULL
#> ..$ inherit.blank: logi TRUE
#> ..- attr(*, "class")= chr [1:2] "element_text" "element"
#> $ axis.text.x.top :List of 11
#> ..$ family : NULL
#> ..$ face : NULL
#> ..$ colour : NULL
#> ..$ size : NULL
#> ..$ hjust : NULL
#> ..$ vjust : num 0
#> ..$ angle : NULL
#> ..$ lineheight : NULL
#> ..$ margin : 'margin' num [1:4] 0points 0points 2.2points 0points
#> .. ..- attr(*, "unit")= int 8
#> ..$ debug : NULL
#> ..$ inherit.blank: logi TRUE
#> ..- attr(*, "class")= chr [1:2] "element_text" "element"
#> $ axis.text.x.bottom : NULL
#> $ axis.text.y :List of 11
#> ..$ family : NULL
#> ..$ face : NULL
#> ..$ colour : NULL
#> ..$ size : NULL
#> ..$ hjust : num 1
#> ..$ vjust : NULL
#> ..$ angle : NULL
#> ..$ lineheight : NULL
#> ..$ margin : 'margin' num [1:4] 0points 2.2points 0points 0points
#> .. ..- attr(*, "unit")= int 8
#> ..$ debug : NULL
#> ..$ inherit.blank: logi TRUE
#> ..- attr(*, "class")= chr [1:2] "element_text" "element"
#> $ axis.text.y.left : NULL
#> $ axis.text.y.right :List of 11
#> ..$ family : NULL
#> ..$ face : NULL
#> ..$ colour : NULL
#> ..$ size : NULL
#> ..$ hjust : num 0
#> ..$ vjust : NULL
#> ..$ angle : NULL
#> ..$ lineheight : NULL
#> ..$ margin : 'margin' num [1:4] 0points 0points 0points 2.2points
#> .. ..- attr(*, "unit")= int 8
#> ..$ debug : NULL
#> ..$ inherit.blank: logi TRUE
#> ..- attr(*, "class")= chr [1:2] "element_text" "element"
#> $ axis.text.theta : NULL
#> $ axis.text.r :List of 11
#> ..$ family : NULL
#> ..$ face : NULL
#> ..$ colour : NULL
#> ..$ size : NULL
#> ..$ hjust : num 0.5
#> ..$ vjust : NULL
#> ..$ angle : NULL
#> ..$ lineheight : NULL
#> ..$ margin : 'margin' num [1:4] 0points 2.2points 0points 2.2points
#> .. ..- attr(*, "unit")= int 8
#> ..$ debug : NULL
#> ..$ inherit.blank: logi TRUE
#> ..- attr(*, "class")= chr [1:2] "element_text" "element"
#> $ axis.ticks :List of 6
#> ..$ colour : chr "grey20"
#> ..$ linewidth : NULL
#> ..$ linetype : NULL
#> ..$ lineend : NULL
#> ..$ arrow : logi FALSE
#> ..$ inherit.blank: logi TRUE
#> ..- attr(*, "class")= chr [1:2] "element_line" "element"
#> $ axis.ticks.x : NULL
#> $ axis.ticks.x.top : NULL
#> $ axis.ticks.x.bottom : NULL
#> $ axis.ticks.y : NULL
#> $ axis.ticks.y.left : NULL
#> $ axis.ticks.y.right : NULL
#> $ axis.ticks.theta : NULL
#> $ axis.ticks.r : NULL
#> $ axis.minor.ticks.x.top : NULL
#> $ axis.minor.ticks.x.bottom : NULL
#> $ axis.minor.ticks.y.left : NULL
#> $ axis.minor.ticks.y.right : NULL
#> $ axis.minor.ticks.theta : NULL
#> $ axis.minor.ticks.r : NULL
#> $ axis.ticks.length : 'simpleUnit' num 2.75points
#> ..- attr(*, "unit")= int 8
#> $ axis.ticks.length.x : NULL
#> $ axis.ticks.length.x.top : NULL
#> $ axis.ticks.length.x.bottom : NULL
#> $ axis.ticks.length.y : NULL
#> $ axis.ticks.length.y.left : NULL
#> $ axis.ticks.length.y.right : NULL
#> $ axis.ticks.length.theta : NULL
#> $ axis.ticks.length.r : NULL
#> $ axis.minor.ticks.length : 'rel' num 0.75
#> $ axis.minor.ticks.length.x : NULL
#> $ axis.minor.ticks.length.x.top : NULL
#> $ axis.minor.ticks.length.x.bottom: NULL
#> $ axis.minor.ticks.length.y : NULL
#> $ axis.minor.ticks.length.y.left : NULL
#> $ axis.minor.ticks.length.y.right : NULL
#> $ axis.minor.ticks.length.theta : NULL
#> $ axis.minor.ticks.length.r : NULL
#> $ axis.line : list()
#> ..- attr(*, "class")= chr [1:2] "element_blank" "element"
#> $ axis.line.x : NULL
#> $ axis.line.x.top : NULL
#> $ axis.line.x.bottom : NULL
#> $ axis.line.y : NULL
#> $ axis.line.y.left : NULL
#> $ axis.line.y.right : NULL
#> $ axis.line.theta : NULL
#> $ axis.line.r : NULL
#> $ legend.background :List of 5
#> ..$ fill : NULL
#> ..$ colour : logi NA
#> ..$ linewidth : NULL
#> ..$ linetype : NULL
#> ..$ inherit.blank: logi TRUE
#> ..- attr(*, "class")= chr [1:2] "element_rect" "element"
#> $ legend.margin : 'margin' num [1:4] 5.5points 5.5points 5.5points 5.5points
#> ..- attr(*, "unit")= int 8
#> $ legend.spacing : 'simpleUnit' num 11points
#> ..- attr(*, "unit")= int 8
#> $ legend.spacing.x : NULL
#> $ legend.spacing.y : NULL
#> $ legend.key : NULL
#> $ legend.key.size : 'simpleUnit' num 1.2lines
#> ..- attr(*, "unit")= int 3
#> $ legend.key.height : NULL
#> $ legend.key.width : NULL
#> $ legend.key.spacing : 'simpleUnit' num 5.5points
#> ..- attr(*, "unit")= int 8
#> $ legend.key.spacing.x : NULL
#> $ legend.key.spacing.y : NULL
#> $ legend.frame : NULL
#> $ legend.ticks : NULL
#> $ legend.ticks.length : 'rel' num 0.2
#> $ legend.axis.line : NULL
#> $ legend.text :List of 11
#> ..$ family : NULL
#> ..$ face : NULL
#> ..$ colour : NULL
#> ..$ size : 'rel' num 0.8
#> ..$ hjust : NULL
#> ..$ vjust : NULL
#> ..$ angle : NULL
#> ..$ lineheight : NULL
#> ..$ margin : NULL
#> ..$ debug : NULL
#> ..$ inherit.blank: logi TRUE
#> ..- attr(*, "class")= chr [1:2] "element_text" "element"
#> $ legend.text.position : NULL
#> $ legend.title :List of 11
#> ..$ family : NULL
#> ..$ face : NULL
#> ..$ colour : NULL
#> ..$ size : NULL
#> ..$ hjust : num 0
#> ..$ vjust : NULL
#> ..$ angle : NULL
#> ..$ lineheight : NULL
#> ..$ margin : NULL
#> ..$ debug : NULL
#> ..$ inherit.blank: logi TRUE
#> ..- attr(*, "class")= chr [1:2] "element_text" "element"
#> $ legend.title.position : NULL
#> $ legend.position : chr "right"
#> $ legend.position.inside : NULL
#> $ legend.direction : NULL
#> $ legend.byrow : NULL
#> $ legend.justification : chr "center"
#> $ legend.justification.top : NULL
#> $ legend.justification.bottom : NULL
#> $ legend.justification.left : NULL
#> $ legend.justification.right : NULL
#> $ legend.justification.inside : NULL
#> $ legend.location : NULL
#> $ legend.box : NULL
#> $ legend.box.just : NULL
#> $ legend.box.margin : 'margin' num [1:4] 0cm 0cm 0cm 0cm
#> ..- attr(*, "unit")= int 1
#> $ legend.box.background : list()
#> ..- attr(*, "class")= chr [1:2] "element_blank" "element"
#> $ legend.box.spacing : 'simpleUnit' num 11points
#> ..- attr(*, "unit")= int 8
#> [list output truncated]
#> - attr(*, "class")= chr [1:2] "theme" "gg"
#> - attr(*, "complete")= logi TRUE
#> - attr(*, "validate")= logi TRUE
# }
dat <- matrix(rnorm(100*100), 100, 100)
slice <- NeuroSlice(dat, NeuroSpace(c(100,100)))
#plot(slice)