NiBabel

Access a cacophony of neuro-imaging file formats

Previous topic

nibabel.nifti1.Nifti1Header

Next topic

nibabel.nifti1.Nifti1Pair

Reggie -- the one

nibabel.nifti1.Nifti1Image

digraph inheritanceed15b4d1ce { rankdir=LR; ratio=compress; fontsize=14; size="6.0, 8.0"; "Nifti1Image" [shape=ellipse,URL="#nibabel.nifti1.Nifti1Image",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,fontsize=14,color=dodgerblue1,style=filled,height=0.75]; "Nifti1Pair" -> "Nifti1Image" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Nifti1Pair" [shape=ellipse,URL="nibabel.nifti1.Nifti1Pair.html#nibabel.nifti1.Nifti1Pair",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,fontsize=14,color=dodgerblue1,style=filled,height=0.75]; "AnalyzeImage" -> "Nifti1Pair" [arrowsize=0.5,style="setlinewidth(0.5)"]; "SpatialImage" [shape=ellipse,URL="nibabel.spatialimages.SpatialImage.html#nibabel.spatialimages.SpatialImage",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,fontsize=14,color=dodgerblue1,style=filled,height=0.75]; "AnalyzeImage" [shape=ellipse,URL="nibabel.analyze.AnalyzeImage.html#nibabel.analyze.AnalyzeImage",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,fontsize=14,color=dodgerblue1,style=filled,height=0.75]; "SpatialImage" -> "AnalyzeImage" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

class nibabel.nifti1.Nifti1Image(data, affine, header=None, extra=None, file_map=None)

Initialize image

The image is a combination of (array, affine matrix, header), with optional metadata in extra, and filename / file-like objects contained in the file_map mapping.

Parameters :

data : object

image data. It should be some object that retuns an array from np.asanyarray. It should have a shape attribute or property

affine : None or (4,4) array-like

homogenous affine giving relationship between voxel coordinates and world coordinates. Affine can also be None. In this case, obj.get_affine() also returns None, and the affine as written to disk will depend on the file format.

header : None or mapping or header instance, optional

metadata for this image format

extra : None or mapping, optional

metadata to associate with image that cannot be stored in the metadata of this image type

file_map : mapping, optional

mapping giving file information for this image format

files_types = (('image', '.nii'),)
header_class

alias of Nifti1Header

update_header()

Harmonize header with image data and affine