nifti_header: Dump a NIfTI header

Description Usage Arguments Value Examples

Description

Extracts the contents of a NIfTI header, from a NIfTI file on disk or a NiftiArray object loaded into R.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
nifti_header(image)

## S4 method for signature 'NiftiArray'
nifti_header(image)

## S4 method for signature 'NiftiArrayList'
nifti_header(image)

## S4 method for signature 'DelayedArray'
nifti_header(image)

## S4 method for signature 'HDF5Array'
nifti_header(image)

## S4 method for signature 'HDF5ArraySeed'
nifti_header(image)

## S4 method for signature 'ANY'
nifti_header(image)

## S4 method for signature 'NiftiArraySeed'
nifti_header(image)

## S4 method for signature 'ReshapedNiftiArray'
nifti_header(image)

## S4 method for signature 'ReshapedNiftiArraySeed'
nifti_header(image)

Arguments

image

A file path to a NIfTI image on disk or a NiftiArray object loaded locally in R.

Value

A list of class niftiHeader, which has the NIfTI header information.

Examples

1
2
3
4
5
nii_fname = system.file("extdata",
"example.nii.gz", package = "RNifti")
nifti_header(nii_fname)
res = writeNiftiArray(nii_fname)
nifti_header(res)

muschellij2/niftiArray documentation built on June 12, 2020, 3:06 a.m.