descrip-methods: Extract Image Attribute 'descrip'

descrip-methodsR Documentation

Extract Image Attribute descrip

Description

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

Usage

descrip(object)

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

## S4 method for signature 'anlz'
descrip(object)

descrip(object) <- value

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

## S4 replacement method for signature 'anlz'
descrip(object) <- value

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

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

Arguments

object

is an object of class nifti or anlz.

value

is the value to assign to the descrip 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

## Not run: 
url <- "http://nifti.nimh.nih.gov/nifti-1/data/avg152T1_LR_nifti.nii.gz"
urlfile <- file.path(system.file("nifti", package="oro.nifti"),
                     "mniLR.nii.gz")
download.file(url, urlfile, quiet=TRUE)

## End(Not run)
urlfile <- file.path(system.file("nifti", package="oro.nifti"),
                     "mniLR.nii.gz")
mniLR <- readNIfTI(urlfile)
descrip(mniLR)
## Not run: 
descrip(mniLR) <- paste(descrip(mniLR), version$version.string, sep="; ")
descrip(mniLR)

## End(Not run)
file = system.file("extdata", "example.nii.gz", package = "RNifti")
img = RNifti::readNifti(file)
descrip(img)
file = system.file("extdata", "example.nii.gz", package = "RNifti")
img = RNifti::readNifti(file)
descrip(img) = "a file"
descrip(img)
stopifnot(descrip(img) == "a file")

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