voxdims: Return voxel dimensions of an object

View source: R/im3d.R

voxdimsR Documentation

Return voxel dimensions of an object

Description

This would properly be thought of as the voxel spacing when voxels are assumed not to have a physical extent (only a location).

Usage

voxdims(x, ...)

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

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

## Default S3 method:
voxdims(x, dims, ...)

Arguments

x

An im3d object with associated voxel dimensions, a path to or a 2 x 3 BoundingBox matrix.

...

Additional arguments for methods

dims

The number of voxels in each dimension when x is a BoundingBox matrix.

Details

We follow Amira's convention of returning a voxel dimension equal to the bounding box size (rather than 0) for any dimension with only 1 voxel.

Value

A numeric vector of length 3, NA when missing.

See Also

boundingbox

Other im3d: as.im3d(), boundingbox(), im3d-coords, im3d-io, im3d(), imexpand.grid(), imslice(), is.im3d(), mask(), origin(), projection(), threshold(), unmask()


nat documentation built on May 29, 2024, 10:36 a.m.