ortho2-methods: Orthographic Display, added options

In neuroconductor-releases/extrantsr: Extra Functions to Build on the 'ANTsR' Package

Description

Wrapper for of neurobase's ortho2 function to work with antsImages

Usage

## S4 method for signature 'antsImage'
ortho2(x, y = NULL, xyz = NULL, w = 1,
  col = gray(0:64/64), col.y = hotmetal(), zlim = NULL,
  zlim.y = NULL, NA.x = FALSE, NA.y = TRUE, crosshairs = TRUE,
  col.crosshairs = "red", xlab = "", ylab = "", axes = FALSE,
  oma = c(0, 0, 0, ifelse(ycolorbar, 5, 0)), mar = rep(0, 4),
  bg = "black", text = NULL, text.color = "white", text.cex = 2,
  text.x = 32, text.y = 32, add.orient = TRUE, mfrow = c(2, 2),
  ybreaks = NULL, breaks = NULL, addlegend = FALSE, leg.x = 32,
  leg.y = 32, legend, leg.col, leg.title = NULL, leg.cex,
  window = NULL, ycolorbar = FALSE, clabels = TRUE, add = TRUE,
  pdim = NULL, useRaster = TRUE, mask = NULL, ...)

## S4 method for signature 'niftiImage'
ortho2(x, y = NULL, xyz = NULL, w = 1,
  col = gray(0:64/64), col.y = oro.nifti::hotmetal(), zlim = NULL,
  zlim.y = NULL, NA.x = FALSE, NA.y = TRUE, crosshairs = TRUE,
  col.crosshairs = "red", xlab = "", ylab = "", axes = FALSE,
  oma = c(0, 0, 0, ifelse(ycolorbar, 5, 0)), mar = rep(0, 4),
  bg = "black", text = NULL, text.color = "white", text.cex = 2,
  text.x = 32, text.y = 32, add.orient = FALSE, mfrow = c(2, 2),
  ybreaks = NULL, breaks = NULL, addlegend = FALSE, leg.x = 32,
  leg.y = 32, legend, leg.col, leg.title = NULL, leg.cex,
  window = NULL, ycolorbar = FALSE, clabels = TRUE, add = TRUE,
  pdim = NULL, useRaster = is.null(y), mask = NULL, ...)

Arguments

x	is an object of class antsImage or similar.
y	is an object of class antsImage or similar for the overlay.
xyz	is the coordinate for the center of the crosshairs.
w	is the time point to be displayed (4D arrays only).
col	is grayscale (by default).
col.y	is hotmetal (by default).
zlim	is the minimum and maximum ‘z’ values passed into image.
zlim.y	is the minimum and maximum ‘z’ values passed into image for the overlay.
NA.x	Set any values of 0 in x to NA
NA.y	Set any values of 0 in y to NA
crosshairs	is a logical value for the presence of crosshairs in all three orthogonal planes (default = TRUE).
col.crosshairs	is the color of the crosshairs (default = red).
xlab	is set to "" since all margins are set to zero.
ylab	is set to "" since all margins are set to zero.
axes	is set to FALSE since all margins are set to zero.
oma	is the size of the outer margins in the par function.
mar	is the number of lines of margin in the par function.
bg	is the background color in the par function.
text	allows the user to specify text to appear in the fourth (unused) pane.
text.color	is the color of the user-specified text (default = “white").
text.cex	is the size of the user-specified text (default = 2).
text.x	x coordinate for text
text.y	y coordinate for text
add.orient	(logical) Add left/right, A/P, etc. orientation
mfrow	(numeric) layout of the 3 slices
ybreaks	(numeric) breaks for y to passed to image
breaks	(numeric) breaks for x to passed to image
addlegend	(logical) add legend?
leg.x	(numeric) x coord for legend
leg.y	(numeric) y coord for legend
legend	(character) legend text
leg.col	(character) Colors for legend
leg.title	(character) title for legend
leg.cex	(numeric) cex for legend
window	(vector) Length-2 vector to limit image to certain range
ycolorbar	(logical) Should a colorbar for y be plotted
clabels	Label for colorbar (see colorbar)
add	Should the y-plot be added or its own plot? Used in double_ortho
pdim	Pixel dimensions if passing in arrays.
useRaster	logical; if TRUE a bitmap raster is used to plot the image instead of polygons. Passed to image.
mask	If a mask is passed, drop_empty_dim is applied to both x and y
...	other arguments to the image function may be provided here.

Note

This will NOT do ants2oro to plot the image. If that is desired, users will have to do that before calling ortho2.

neuroconductor-releases/extrantsr documentation built on Dec. 10, 2019, 12:07 a.m.