Register (generic function) — register • SMARTTR

Register a slice in a mouse object. If a slice has been previously registered, the default behavior is to continue modifying the previous registration. Use the replace parameter to change this behavior.

Usage

register(x, ...)

# S3 method for slice
register(x, filter = NULL, ...)

# S3 method for mouse
register(
  x,
  slice_ID = NA,
  hemisphere = NULL,
  filter = NULL,
  replace = FALSE,
  ...
)

Arguments

x: a mouse or slice object
...: additional parameters to pass to the SMART::registration2() function, besides 'input', 'coordinate', 'filter' & 'correspondance'
filter: (list) Wholebrain filter with parameters.
slice_ID: (str) ID of slice
hemisphere: (str, default = NULL) 'left', 'right' or NULL if both hemispheres are included
replace: (bool, default = FALSE) Replace a registration already contained in a mouse object by resetting to NULL value before registration improvement loop.

Value

a mouse or slice object

s a slice object

m mouse object

Examples

if (FALSE) {
s <- register(s)
}
if (FALSE) {
m <- register(m, slice_ID = '1_10', hemisphere = "left", filter = my_filter)
}