MriImageMetadata: Class representing metadata associated with an MRI image
Description
This class represents MRI image metadata. An object of this class contains various information about an image, such as its image and voxel dimensions, coordinate origin and storage data type. An object of type MriImage can be treated as a metadata object, since the latter is always embedded in it.Usage
isMriImageMetadata(object)
Value
- A list object (see
list.object) with class c("metadata.image.mri", "list.object", "list") and the following function elements. - getDataType()Retrieve a list describing the storage data type of the image. See
getDataTypeByNiftiCode for details. - getDimensionality()Retrieve a numeric vector of length 1 giving the number of dimensions in the image.
- getDimensions()Retrieve a numeric vector giving the dimensions of the image in voxels.
- getEndianness()Retrieve the endianness of the original or stored image. Either "big" or "little".
- getFieldOfView()Retrieve a numeric vector giving the dimensions of the image in spatial units, typically mm.
- getOrigin()Retrieve the coordinate origin of the image.
- getSource()Retrieve a character vector of length 1 giving the source file for the image. Returns "internal" if the image was not read from a file.
- getVoxelDimensions()Retrieve a numeric vector giving the dimensions of the image voxels in spatial units, typically mm.
- getVoxelUnit()Retrieve the spatial unit used by getVoxelDimensions(). The most common value is "mm".
- isInternal()Retrieve a logical value indicating whether the image was generated by a function, rather than read from a file.
- setEndianness(newEndian)Set the storage endianness of the image.
- setSource(newSource)Set the source of the image.
- summarise()Prints a summary of the metadata at output level
OL$Info (see output). isMriImageMetadata returns TRUE if object is an MriImageMetadata object.