xyzt_units-methods: Extract Image Attribute 'xyzt_units'

xyzt_units-methodsR Documentation

Extract Image Attribute xyzt_units

Description

Methods that act on the xyzt_units field in the NIfTI/ANALYZE header.

Usage

xyzt_units(object)

## S4 method for signature 'nifti'
xyzt_units(object)

xyzt_units(object) <- value

## S4 replacement method for signature 'nifti'
xyzt_units(object) <- value

xyzt.units(object)

## S4 method for signature 'nifti'
xyzt.units(object)

xyzt.units(object) <- value

## S4 replacement method for signature 'nifti'
xyzt.units(object) <- value

## S4 method for signature 'niftiImage'
xyzt_units(object)

## S4 replacement method for signature 'niftiImage'
xyzt_units(object) <- value

Arguments

object

is an object of class nifti or anlz.

value

is the value to assign to the xyzt_units field.

Details

See documentation on the ANALYZE and/or NIfTI data standards for more details.

Author(s)

John Muschelli muschellij2@gmail.com,
Brandon Whitcher bwhitcher@gmail.com

References

ANALYZE 7.5
http://eeg.sourceforge.net/ANALYZE75.pdf
NIfTI-1
http://nifti.nimh.nih.gov/

Examples

file = system.file("extdata", "example.nii.gz", package = "RNifti")
img = RNifti::readNifti(file)
xyzt_units(img)
xyzt_units(img) = 8
stopifnot(xyzt_units(img) ==  8)

oro.nifti documentation built on Aug. 10, 2022, 5:09 p.m.