itk::NiftiImageIO Class Reference

#include <itkNiftiImageIO.h>

Inheritance diagram for itk::NiftiImageIO:

Collaboration diagram for itk::NiftiImageIO:

Detailed Description

Class that defines how to read Nifti file format. Nifti IMAGE FILE FORMAT - As much information as I can determine from sourceforge.net/projects/Niftilib.

Author

Hans J. Johnson, The University of Iowa 2002 The specification for this file format is taken from the web site http://analyzedirect.com/support/10.0Documents/Analyze_Resource_01.pdf

Definition at line 42 of file itkNiftiImageIO.h.

Public Types
typedef SmartPointer< Self >	Pointer
typedef NiftiImageIO	Self
typedef ImageIOBase	Superclass
Public Types inherited from itk::ImageIOBase
typedef std::vector< std::string >	ArrayOfExtensionsType
typedef ::itk::OffsetValueType	BufferSizeType
enum	ByteOrder {   BigEndian,   LittleEndian,   OrderNotApplicable }
enum	FileType {   ASCII,   Binary,   TypeNotApplicable }
typedef ::itk::IndexValueType	IndexValueType
enum	IOComponentType {   UNKNOWNCOMPONENTTYPE,   UCHAR,   CHAR,   USHORT,   SHORT,   UINT,   INT,   ULONG,   LONG,   ULONGLONG,   LONGLONG,   FLOAT,   DOUBLE }
enum	IOPixelType {   UNKNOWNPIXELTYPE,   SCALAR,   RGB,   RGBA,   OFFSET,   VECTOR,   POINT,   COVARIANTVECTOR,   SYMMETRICSECONDRANKTENSOR,   DIFFUSIONTENSOR3D,   COMPLEX,   FIXEDARRAY,   MATRIX }
typedef SmartPointer< Self >	Pointer
typedef ImageIOBase	Self
typedef ::itk::intmax_t	SizeType
typedef ::itk::SizeValueType	SizeValueType
typedef LightProcessObject	Superclass
Public Types inherited from itk::LightProcessObject
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef LightProcessObject	Self
typedef Object	Superclass
Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef Object	Self
typedef LightObject	Superclass
Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef LightObject	Self

Public Member Functions
virtual bool	CanReadFile (const char *FileNameToRead) override
virtual bool	CanWriteFile (const char *FileNameToWrite) override
virtual ::itk::LightObject::Pointer	CreateAnother () const
virtual ImageIORegion	GenerateStreamableReadRegionFromRequestedRegion (const ImageIORegion &requestedRegion) const override
virtual const char *	GetNameOfClass () const
virtual void	Read (void *buffer) override
virtual void	ReadImageInformation () override
virtual void	Write (const void *buffer) override
virtual void	WriteImageInformation () override
virtual void	SetLegacyAnalyze75Mode (bool _arg)
virtual bool	GetLegacyAnalyze75Mode () const
Public Member Functions inherited from itk::ImageIOBase
virtual bool	CanStreamRead ()
virtual bool	CanStreamWrite ()
virtual unsigned int	GetActualNumberOfSplitsForWriting (unsigned int numberOfRequestedSplits, const ImageIORegion &pasteRegion, const ImageIORegion &largestPossibleRegion)
std::string	GetByteOrderAsString (ByteOrder) const
virtual unsigned int	GetComponentSize () const
virtual IOComponentType	GetComponentType () const
virtual const std::type_info &	GetComponentTypeInfo () const
virtual std::vector< double >	GetDefaultDirection (unsigned int i) const
virtual SizeValueType	GetDimensions (unsigned int i) const
virtual std::vector< double >	GetDirection (unsigned int i) const
std::string	GetFileTypeAsString (FileType) const
SizeType	GetImageSizeInBytes () const
SizeType	GetImageSizeInComponents () const
SizeType	GetImageSizeInPixels () const
virtual bool	GetIsReadAsScalarPlusPalette () const
virtual unsigned int	GetNumberOfDimensions () const
virtual double	GetOrigin (unsigned int i) const
virtual SizeType	GetPixelStride () const
virtual double	GetSpacing (unsigned int i) const
virtual ImageIORegion	GetSplitRegionForWriting (unsigned int ithPiece, unsigned int numberOfActualSplits, const ImageIORegion &pasteRegion, const ImageIORegion &largestPossibleRegion)
const ArrayOfExtensionsType &	GetSupportedReadExtensions () const
const ArrayOfExtensionsType &	GetSupportedWriteExtensions () const
void	SetByteOrderToLittleEndian ()
virtual void	SetComponentType (const IOComponentType _arg)
virtual void	SetDirection (unsigned int i, const std::vector< double > &direction)
virtual void	SetDirection (unsigned int i, const vnl_vector< double > &direction)
void	SetFileTypeToBinary ()
void	SetNumberOfDimensions (unsigned int)
virtual void	SetOrigin (unsigned int i, double origin)
template<typename TPixel , unsigned VLength>
void	SetPixelTypeInfo (const SymmetricSecondRankTensor< TPixel, VLength > *)
template<typename TPixel >
void	SetPixelTypeInfo (const DiffusionTensor3D< TPixel > *)
template<typename TPixel , unsigned VLength>
void	SetPixelTypeInfo (const Matrix< TPixel, VLength, VLength > *)
template<typename TPixel >
void	SetPixelTypeInfo (const std::complex< TPixel > *)
template<unsigned VLength>
void	SetPixelTypeInfo (const Offset< VLength > *)
virtual void	SetSpacing (unsigned int i, double spacing)
template<typename TPixel >
void	SetTypeInfo (const TPixel *)
virtual bool	SupportsDimension (unsigned long dim)
virtual void	SetFileName (const char *_arg)
virtual const char *	GetFileName () const
virtual void	SetDimensions (unsigned int i, SizeValueType dim)
virtual void	SetIORegion (ImageIORegion _arg)
virtual const ImageIORegion &	GetIORegion () const
virtual void	SetPixelType (const IOPixelType _arg)
virtual IOPixelType	GetPixelType () const
virtual void	SetNumberOfComponents (unsigned int _arg)
virtual const unsigned int &	GetNumberOfComponents () const
virtual void	SetUseCompression (bool _arg)
virtual bool	GetUseCompression () const
virtual void	UseCompressionOn ()
virtual void	UseCompressionOff ()
virtual void	SetUseStreamedReading (bool _arg)
virtual bool	GetUseStreamedReading () const
virtual void	UseStreamedReadingOn ()
virtual void	UseStreamedReadingOff ()
virtual void	SetUseStreamedWriting (bool _arg)
virtual bool	GetUseStreamedWriting () const
virtual void	UseStreamedWritingOn ()
virtual void	UseStreamedWritingOff ()
virtual void	SetExpandRGBPalette (bool _arg)
virtual bool	GetExpandRGBPalette () const
virtual void	ExpandRGBPaletteOn ()
virtual void	ExpandRGBPaletteOff ()
virtual void	SetFileType (const FileType _arg)
virtual FileType	GetFileType () const
void	SetFileTypeToASCII ()
virtual void	SetByteOrder (const ByteOrder _arg)
virtual ByteOrder	GetByteOrder () const
void	SetByteOrderToBigEndian ()
template<typename TPixel >
void	SetPixelTypeInfo (const TPixel *)
template<typename TPixel >
void	SetPixelTypeInfo (const RGBPixel< TPixel > *)
template<typename TPixel >
void	SetPixelTypeInfo (const RGBAPixel< TPixel > *)
template<typename TPixel , unsigned VLength>
void	SetPixelTypeInfo (const Vector< TPixel, VLength > *)
template<typename TPixel >
void	SetPixelTypeInfo (const VariableLengthVector< TPixel > *)
template<typename TPixel , unsigned VLength>
void	SetPixelTypeInfo (const CovariantVector< TPixel, VLength > *)
template<typename TPixel , unsigned VLength>
void	SetPixelTypeInfo (const FixedArray< TPixel, VLength > *)
Public Member Functions inherited from itk::LightProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual const bool &	GetAbortGenerateData () const
virtual void	SetAbortGenerateData (bool _arg)
virtual void	UpdateOutputData ()
void	UpdateProgress (float amount)
virtual void	SetProgress (float _arg)
virtual const float &	GetProgress () const
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary ()
const MetaDataDictionary &	GetMetaDataDictionary () const
virtual ModifiedTimeType	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
virtual void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int) override
virtual void	UnRegister () const noexceptoverride
virtual void	SetObjectName (std::string _arg)
virtual const std::string &	GetObjectName () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from itk::ImageIOBase
static std::string	GetComponentTypeAsString (IOComponentType)
static IOComponentType	GetComponentTypeFromString (const std::string &typeString)
static std::string	GetPixelTypeAsString (IOPixelType)
static IOPixelType	GetPixelTypeFromString (const std::string &pixelString)
Static Public Member Functions inherited from itk::LightProcessObject
static Pointer	New ()
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
static void	SetGlobalWarningDisplay (bool flag)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()

Protected Member Functions
virtual bool	GetUseLegacyModeForTwoFileWriting (void) const
	NiftiImageIO ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const override
	~NiftiImageIO () override
Protected Member Functions inherited from itk::ImageIOBase
void	AddSupportedReadExtension (const char *extension)
void	AddSupportedWriteExtension (const char *extension)
void	ComputeStrides ()
virtual unsigned int	GetActualNumberOfSplitsForWritingCanStreamWrite (unsigned int numberOfRequestedSplits, const ImageIORegion &pasteRegion) const
SizeType	GetComponentStride () const
virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const
virtual unsigned int	GetPixelSize () const
SizeType	GetRowStride () const
SizeType	GetSliceStride () const
virtual ImageIORegion	GetSplitRegionForWritingCanStreamWrite (unsigned int ithPiece, unsigned int numberOfActualSplits, const ImageIORegion &pasteRegion) const
	ImageIOBase ()
virtual void	OpenFileForReading (std::ifstream &inputStream, const std::string &filename, bool ascii=false)
virtual void	OpenFileForWriting (std::ofstream &outputStream, const std::string &filename, bool truncate=true, bool ascii=false)
virtual void	ReadBufferAsASCII (std::istream &os, void *buffer, IOComponentType ctype, SizeType numberOfBytesToBeRead)
bool	ReadBufferAsBinary (std::istream &os, void *buffer, SizeType numberOfBytesToBeRead)
virtual void	Reset (const bool freeDynamic=true)
void	Resize (const unsigned int numDimensions, const unsigned int *dimensions)
virtual void	WriteBufferAsASCII (std::ostream &os, const void *buffer, IOComponentType ctype, SizeType numberOfBytesToWrite)
	~ImageIOBase () override
Protected Member Functions inherited from itk::LightProcessObject
virtual void	GenerateData ()
	LightProcessObject ()
	~LightProcessObject () override
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object () override
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Private Member Functions
void	DefineHeaderObjectDataType ()
unsigned int	getQFormCodeFromDictionary () const
unsigned int	getSFormCodeFromDictionary () const
bool	MustRescale ()
void	SetImageIOMetadataFromNIfTI ()
void	SetImageIOOrientationFromNIfTI (unsigned short int dims)
void	SetNIfTIOrientationFromImageIO (unsigned short int origdims, unsigned short int dims)

Private Attributes
bool	m_LegacyAnalyze75Mode
NiftiImageProxy &	m_NiftiImage
const AutoPointer < NiftiImageProxy >	m_NiftiImageHolder
IOComponentType	m_OnDiskComponentType
double	m_RescaleIntercept
double	m_RescaleSlope

Additional Inherited Members
Protected Attributes inherited from itk::ImageIOBase
ByteOrder	m_ByteOrder
IOComponentType	m_ComponentType
std::vector< SizeValueType >	m_Dimensions
std::vector< std::vector < double > >	m_Direction
bool	m_ExpandRGBPalette
std::string	m_FileName
FileType	m_FileType
bool	m_Initialized
ImageIORegion	m_IORegion
bool	m_IsReadAsScalarPlusPalette
unsigned int	m_NumberOfComponents
unsigned int	m_NumberOfDimensions
std::vector< double >	m_Origin
IOPixelType	m_PixelType
std::vector< double >	m_Spacing
std::vector< SizeType >	m_Strides
bool	m_UseCompression
bool	m_UseStreamedReading
bool	m_UseStreamedWriting
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

typedef SmartPointer< Self > itk::NiftiImageIO::Pointer

Definition at line 48 of file itkNiftiImageIO.h.

typedef NiftiImageIO itk::NiftiImageIO::Self

Standard class typedefs.

Definition at line 46 of file itkNiftiImageIO.h.

typedef ImageIOBase itk::NiftiImageIO::Superclass

Definition at line 47 of file itkNiftiImageIO.h.

Constructor & Destructor Documentation

itk::NiftiImageIO::NiftiImageIO ( )

protected

itk::NiftiImageIO::~NiftiImageIO ( )

overrideprotected

Member Function Documentation

virtual bool itk::NiftiImageIO::CanReadFile ( const char *  FileNameToRead )

overridevirtual

Determine if the file can be read with this ImageIO implementation.

Author

Hans J Johnson

Parameters

FileNameToRead

The name of the file to test for reading.

Postcondition

Sets classes ImageIOBase::m_FileName variable to be FileNameToWrite

Returns

Returns true if this ImageIO can read the file specified.

Implements itk::ImageIOBase.

virtual bool itk::NiftiImageIO::CanWriteFile ( const char *  FileNameToWrite )

overridevirtual

Determine if the file can be written with this ImageIO implementation.

Parameters

FileNameToWrite

The name of the file to test for writing.

Author

Hans J. Johnson

Postcondition

Sets classes ImageIOBase::m_FileName variable to be FileNameToWrite

Returns

Returns true if this ImageIO can write the file specified.

Implements itk::ImageIOBase.

virtual::itk::LightObject::Pointer itk::NiftiImageIO::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::LightProcessObject.

void itk::NiftiImageIO::DefineHeaderObjectDataType ( )

private

virtual ImageIORegion itk::NiftiImageIO::GenerateStreamableReadRegionFromRequestedRegion ( const ImageIORegion &  requestedRegion ) const

overridevirtual

Calculate the region of the image that can be efficiently read in response to a given requested region.

Reimplemented from itk::ImageIOBase.

virtual bool itk::NiftiImageIO::GetLegacyAnalyze75Mode ( ) const

virtual

A mode to allow the Nifti filter to read and write to the LegacyAnalyze75 format as interpreted by the nifti library maintainers. This format does not properly respect the file orientation fields. The itkAnalyzeImageIO file reader/writer should be used to match the Analyze75 file definitions as specified by the Mayo Clinic BIR laboratory. By default this is set to false.

virtual const char* itk::NiftiImageIO::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageIOBase.

unsigned int itk::NiftiImageIO::getQFormCodeFromDictionary ( ) const

private

unsigned int itk::NiftiImageIO::getSFormCodeFromDictionary ( ) const

private

virtual bool itk::NiftiImageIO::GetUseLegacyModeForTwoFileWriting ( void  ) const

inlineprotectedvirtual

Definition at line 112 of file itkNiftiImageIO.h.

bool itk::NiftiImageIO::MustRescale ( )

private

static Pointer itk::NiftiImageIO::New ( )

static

Method for creation through the object factory.

virtual void itk::NiftiImageIO::PrintSelf ( std::ostream &  os, Indent  indent  ) const

overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::ImageIOBase.

virtual void itk::NiftiImageIO::Read ( void *  buffer )

overridevirtual

Reads the data from disk into the memory buffer provided.

Implements itk::ImageIOBase.

virtual void itk::NiftiImageIO::ReadImageInformation ( )

overridevirtual

Set the spacing and dimension information for the set filename.

Implements itk::ImageIOBase.

void itk::NiftiImageIO::SetImageIOMetadataFromNIfTI ( )

private

void itk::NiftiImageIO::SetImageIOOrientationFromNIfTI ( unsigned short int  dims )

private

virtual void itk::NiftiImageIO::SetLegacyAnalyze75Mode ( bool  _arg )

virtual

A mode to allow the Nifti filter to read and write to the LegacyAnalyze75 format as interpreted by the nifti library maintainers. This format does not properly respect the file orientation fields. The itkAnalyzeImageIO file reader/writer should be used to match the Analyze75 file definitions as specified by the Mayo Clinic BIR laboratory. By default this is set to false.

void itk::NiftiImageIO::SetNIfTIOrientationFromImageIO ( unsigned short int  origdims, unsigned short int  dims  )

private

virtual void itk::NiftiImageIO::Write ( const void *  buffer )

overridevirtual

Writes the data to disk from the memory buffer provided. Make sure that the IORegions has been set properly.

Implements itk::ImageIOBase.

virtual void itk::NiftiImageIO::WriteImageInformation ( )

overridevirtual

Set the spacing and dimension information for the set filename.

For Nifti this does not write a file, it only fills in the appropriate header information.

Implements itk::ImageIOBase.

Member Data Documentation

bool itk::NiftiImageIO::m_LegacyAnalyze75Mode

private

Definition at line 147 of file itkNiftiImageIO.h.

NiftiImageProxy& itk::NiftiImageIO::m_NiftiImage

private

Definition at line 140 of file itkNiftiImageIO.h.

const AutoPointer<NiftiImageProxy> itk::NiftiImageIO::m_NiftiImageHolder

private

Definition at line 134 of file itkNiftiImageIO.h.

IOComponentType itk::NiftiImageIO::m_OnDiskComponentType

private

Definition at line 145 of file itkNiftiImageIO.h.

double itk::NiftiImageIO::m_RescaleIntercept

private

Definition at line 143 of file itkNiftiImageIO.h.

double itk::NiftiImageIO::m_RescaleSlope

private

Definition at line 142 of file itkNiftiImageIO.h.

---

The documentation for this class was generated from the following file:

• itkNiftiImageIO.h