fsbrain (version 0.0.3)

combine.colorbar.with.brainview.image: Combine a colorbar and a brainview image into a new figure.

Description

Combine a colorbar and a brainview image into a new figure.

Usage

combine.colorbar.with.brainview.image(brainview_img, colorbar_img,
  output_img, offset = "+0+0", extend_brainview_img_height_by = 0L,
  silent = FALSE, allow_colorbar_shrink = TRUE)

Arguments

brainview_img

path to the main image containing the view of the brain, usually an image in PNG format

colorbar_img

path to the main image containing the separate colorbar, usually an image in PNG format

output_img

path to output image that including the file extension

offset

offset string passed to [magick::image_composite()]. Allows you to shift the location of the colorbar in the final image.

extend_brainview_img_height_by

integer value in pixels, the size of the lower border to add to the brainview_img. Use this if the lower part of the colorbar is off the image canvas.

silent

logical, whether to silence all messages

allow_colorbar_shrink

logical, whether to shrink the colorbar to the width of the animation in case it is considerably wider (more than 20 percent). Defaults to TRUE.

See Also

Other colorbar functions: coloredmesh.plot.colorbar.separate, combine.colorbar.with.brainview.animation