Register (generic function) — register • SMARTR

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(s, filter = NULL, ...)

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

Arguments

...: additional parameters to pass to the SMART::registration2() function, besides 'input', 'coordinate', 'filter' & 'correspondance'
s: slice object
filter: (list) Wholebrain filter with parameters.
m: mouse object
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

s slice object

m mouse object

Examples

s <- register(s)
#> Error in register(s): object 's' not found
m <- register(m, slice_ID = '1_10', hemisphere = "left", filter = my_filter)
#> Error in register(m, slice_ID = "1_10", hemisphere = "left", filter = my_filter): object 'm' not found