This function serves as an easy (but slightly inflexible) way to export a high-quality, tight-layout, colorbar figure to disk. If no colorbar is required, one can use vislayout.from.coloredmeshes instead.
vis.export.from.coloredmeshes(
coloredmeshes,
colorbar_legend = NULL,
img_only = TRUE,
horizontal = TRUE,
silent = TRUE,
quality = 1L,
output_img = "fsbrain_arranged.png",
image.plot_extra_options = NULL,
large_legend = TRUE,
view_angles = get.view.angle.names(angle_set = "t4"),
style = "default",
grid_like = TRUE,
background_color = "white",
transparency_color = NULL,
...
)magick image instance or named list, depending on the value of 'img_only'. If the latter, the list contains the fields 'rev_vl', 'rev_cb', and 'rev_ex', which are the return values of the functions vislayout.from.coloredmeshes, coloredmesh.plot.colorbar.separate, and combine.colorbar.with.brainview.image, respectively.
list of coloredmesh. A coloredmesh is a named list as returned by the `coloredmesh.from*` functions (like coloredmesh.from.morph.native). It has the entries 'mesh' of type tmesh3d, a 'col', which is a color specification for such a mesh. The `vis*` functions (like vis.subject.morph.native) all return a list of coloredmeshes.
character string or NULL, the title for the colorbar.
logical, whether to return only the resulting image
logical, whether to plot the colorbar horizontally (TRUE) or vertically (FALSE). Pass 'NULL' to force no colorbar at all.
logical, whether to suppress messages
integer, an arbitrary quality. This is the resolution per tile before trimming, divided by 1000, in pixels. Example: 1L means 1000x1000 pixels per tile before trimming. Currently supported values: 1L..2L. Note that the resolution you can get is also limited by your screen resolution.
string, path to the output file. Defaults to "fsbrain_arranged.png"
named list, custom options for fields::image.plot. Overwrites those derived from the quality setting. If in doubt, leave this alone.
logical, whether to plot extra large legend text, affects the font size of the colorbar_legend and the tick labels.
list of strings. See get.view.angle.names for all valid strings.
the rendering style, see material3d or use a predefined style like 'default' or 'shiny'.
logical, passed to vislayout.from.coloredmeshes.
hex color string (like '#FFFFFF'), the color to use for the background. Ignored if 'transparency_color' is not NULL. To get a transparent background, use 'transparency_color' instead of this parameter. WARNING: Do not use color names (like 'gray'), as their interpretation differs between rgl and image magick!
hex color string (like '#FFFFFF'), the temporary background color that will get mapped to transparency, or NULL if you do not want a transparent background. If used, it can be any color that does not occur in the foreground. Try '#FFFFFF' (white) or '#000000' (black) if in doubt. WARNING: Do not use color names (like 'gray'), as their interpretation differs between rgl and image magick!
extra arguments passed to vislayout.from.coloredmeshes.
This function should not be used anymore, it will be deprecated soon. Please use the export function instead.
if (FALSE) {
rand_data = rnorm(327684, 5, 1.5);
cm = vis.data.on.fsaverage(morph_data_both=rand_data,
rglactions=list('no_vis'=T));
vis.export.from.coloredmeshes(cm, colorbar_legend='Random data',
output_img="~/fsbrain_arranged.png");
}
Run the code above in your browser using DataLab