image.mrs_data: Image plot method for objects of class mrs_data.

Description Usage Arguments

View source: R/mrs_data_display.R

Description

Image plot method for objects of class mrs_data.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
## S3 method for class 'mrs_data'
image(
  x,
  xlim = NULL,
  mode = "re",
  col = NULL,
  plot_dim = NULL,
  x_pos = NULL,
  y_pos = NULL,
  z_pos = NULL,
  dyn = 1,
  coil = 1,
  restore_def_par = TRUE,
  y_ticks = NULL,
  vline = NULL,
  hline = NULL,
  ...
)

Arguments

x

object of class mrs_data.

xlim

the range of values to display on the x-axis, eg xlim = c(4,1).

mode

representation of the complex numbers to be plotted, can be one of: "re", "im", "mod" or "arg".

col

Colour map to use, defaults to viridis.

plot_dim

the dimension to display on the y-axis, can be one of: "dyn", "x", "y", "z", "coil" or NULL. If NULL (the default) all spectra will be collapsed into the dynamic dimension and displayed.

x_pos

the x index to plot.

y_pos

the y index to plot.

z_pos

the z index to plot.

dyn

the dynamic index to plot.

coil

the coil element number to plot.

restore_def_par

restore default plotting par values after the plot has been made.

y_ticks

a vector of indices specifying where to place tick marks.

vline

draw a vertical line at the value of vline.

hline

draw a horizontal line at the value of hline.

...

other arguments to pass to the plot method.


neuroconductor/spant documentation built on May 25, 2021, 1:49 a.m.