R: Read a NIfTI-1 format file

readNifti {RNiftyReg} | R Documentation

## Read a NIfTI-1 format file

### Description

This function reads one or more NIfTI-1 files into R, using the standard NIfTI-1 C library. It extends the equivalent function from the `RNifti` package with source and target image parameters.

### Usage

    readNifti(file, source = NULL, target = NULL, internal = FALSE)

### Arguments

`file` | A character vector of file names.
`source, target` | If the specified `file` contains a transformation, these parameters can be used to specify the associated source and target images, which are stored in attributes of the same name. Only used if `file` is of unit length.
`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.

### Value

An array or internal image, with class `"niftiImage"`, and possibly also `"internalImage"`.

### Author(s)

Jon Clayden <code@clayden.org>

[Package RNiftyReg version 2.6.0 Index]