templatebrain-meths: Template brain methods

In nat.templatebrains: NeuroAnatomy Toolbox ('nat') Extension for Handling Template Brains

Template brain methods

Description

is.templatebrain tests if object is of class templatebrain

as.character.templatebrain converts template brain to character vector representation (normally used to extract the short name i.e. regName).

print.templatebrain prints templatebrain information in human-readable form

as.im3d converts a template brain to a nat::im3d object; this is probably useful for developers.

origin extracts the space origin of a templatebrain object.

dim extracts the dimensions (in number of pixels) of the image associated with a templatebrain object.

voxdims extracts the dimensions (in calibrated spatial units, e.g. microns) of voxels in the image associated with a templatebrain object.

boundingbox extracts the boundingbox (in calibrated spatial units, e.g. microns) of the image associated with a templatebrain object. See boundingbox for details.

Usage

is.templatebrain(x)

## S3 method for class 'templatebrain'
as.character(x, field = c("regName", "name"), ...)

## S3 method for class 'templatebrain'
print(x, ...)

## S3 method for class 'templatebrain'
as.im3d(x, ...)

## S3 method for class 'templatebrain'
origin(x, ...)

## S3 method for class 'templatebrain'
dim(x, ...)

## S3 method for class 'templatebrain'
voxdims(x, ...)

## S3 method for class 'templatebrain'
boundingbox(x, ...)

Arguments

x	an object (usually a templatebrain).
field	which field to use (defaults to 'regName').
...	additional arguments for methods.

Value

Return values are documented in the generic methods. is.templatebrain returns a logical indicating whether or not the object is a templatebrain.

as.character.templatebrain returns a character vector with the name of the template brain.

dim.templatebrain returns a 3-value integer vector.

See Also

im3d

origin

voxdims

boundingbox

Examples

data(FCWB.demo)
is.templatebrain(FCWB.demo)
origin(FCWB.demo)
dim(FCWB.demo)
voxdims(FCWB.demo)
boundingbox(FCWB.demo)
# print method
FCWB.demo

nat.templatebrains documentation built on Aug. 18, 2025, 5:31 p.m.