R: Read a NIfTI-1 format file

readNifti {RNifti} | R Documentation

## Read a NIfTI-1 format file

### Description

This function reads one or more NIfTI-1 or ANALYZE-7.5 files into R, using the standard NIfTI-1 C library.

### Usage

    readNifti(file, internal = FALSE, volumes = NULL)

### Arguments

`file` | A character vector of file names.
`internal` | Logical value. If `FALSE` (the default), an array of class `"niftiImage"`, containing the image pixel or voxel values, will be returned. If `TRUE`, the return value will be an object of class `"internalImage"`, which contains only minimal metadata about the image. Either way, the return value has an attribute which points to a C data structure containing the full image.
`volumes` | An integer vector giving the volumes to read (counting along all dimensions beyond the third jointly), or `NULL`, the default, in which case every volume is read. This cannot currently be set differently for each file read.

### Value

An array or internal image, with class `"niftiImage"` (and possibly also `"internalImage"`), or a list of such objects if `file` has length greater than one.

### Note

If the `internal` argument is `FALSE` (the default), the data type of the image pointer will be set to match one of R's native numeric data types, i.e., 32-bit signed integer or 64-bit double-precision floating-point. In these circumstances the data type reported by the `niftiHeader` function will therefore not, in general, match the storage type used in the file. See also the `datatype` argument to `writeNifti`.

### Author(s)

Jon Clayden <code@clayden.org>

### References

The NIfTI-1 standard (http://www.nitrc.org/docman/view.php/26/64/nifti1.h).

### See Also

`writeNifti`

### Examples

    path <- system.file("extdata", "example.nii.gz", package="RNifti")
    readNifti(path)
    readNifti(path, internal=TRUE)

[Package RNifti version 0.9.0 Index]