ITK  4.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
itk::NiftiImageIO Class Reference

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. More...

#include <itkNiftiImageIO.h>

Inheritance diagram for itk::NiftiImageIO:
Collaboration diagram for itk::NiftiImageIO:

List of all members.

Public Types

typedef SmartPointer< SelfPointer
typedef NiftiImageIO Self
typedef ImageIOBase Superclass

Public Member Functions

virtual bool CanReadFile (const char *FileNameToRead)
virtual bool CanWriteFile (const char *FileNameToWrite)
virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual ImageIORegion GenerateStreamableReadRegionFromRequestedRegion (const ImageIORegion &requestedRegion) const
virtual const char * GetNameOfClass () const
virtual void Read (void *buffer)
virtual void ReadImageInformation ()
virtual void Write (const void *buffer)
virtual void WriteImageInformation ()

Static Public Member Functions

static Pointer New ()

Protected Member Functions

virtual bool GetUseLegacyModeForTwoFileWriting (void) const

Private Member Functions

void DefineHeaderObjectDataType ()
bool MustRescale ()
 NiftiImageIO (const Self &)
void operator= (const Self &)
void SetImageIOMetadataFromNIfTI ()
void SetImageIOOrientationFromNIfTI (unsigned short int dims)
void SetNIfTIOrientationFromImageIO (unsigned short int origdims, unsigned short int dims)

Private Attributes

bool m_LegacyAnalyze75Mode
nifti_image * m_NiftiImage
IOComponentType m_OnDiskComponentType
double m_RescaleIntercept
double m_RescaleSlope
virtual void SetLegacyAnalyze75Mode (bool _arg)
virtual bool GetLegacyAnalyze75Mode () const
 NiftiImageIO ()
 ~NiftiImageIO ()
void PrintSelf (std::ostream &os, Indent indent) const

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

Definition at line 44 of file itkNiftiImageIO.h.


Member Typedef Documentation

Reimplemented from itk::ImageIOBase.

Definition at line 50 of file itkNiftiImageIO.h.

Standard class typedefs.

Reimplemented from itk::ImageIOBase.

Definition at line 48 of file itkNiftiImageIO.h.

Reimplemented from itk::ImageIOBase.

Definition at line 49 of file itkNiftiImageIO.h.


Constructor & Destructor Documentation

itk::NiftiImageIO::NiftiImageIO ( ) [protected]

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.

itk::NiftiImageIO::~NiftiImageIO ( ) [protected]

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.

itk::NiftiImageIO::NiftiImageIO ( const Self ) [private]

Member Function Documentation

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

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

Author:
Hans J Johnson
Parameters:
FileNameToReadThe 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) [virtual]

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

Parameters:
FileNameToWriteThe 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 ( void  ) 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 [virtual]

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.

virtual bool itk::NiftiImageIO::GetUseLegacyModeForTwoFileWriting ( void  ) const [inline, protected, virtual]

Definition at line 109 of file itkNiftiImageIO.h.

bool itk::NiftiImageIO::MustRescale ( ) [private]
static Pointer itk::NiftiImageIO::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::LightProcessObject.

void itk::NiftiImageIO::operator= ( const Self ) [private]

This method causes the filter to generate its output.

Reimplemented from itk::ImageIOBase.

void itk::NiftiImageIO::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, 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.

Reimplemented from itk::ImageIOBase.

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

Reads the data from disk into the memory buffer provided.

Implements itk::ImageIOBase.

virtual void itk::NiftiImageIO::ReadImageInformation ( ) [virtual]

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) [virtual]

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 ( ) [virtual]

Set the spacing and dimension information for the set filename.

Implements itk::ImageIOBase.


Member Data Documentation

Definition at line 128 of file itkNiftiImageIO.h.

nifti_image* itk::NiftiImageIO::m_NiftiImage [private]

Definition at line 121 of file itkNiftiImageIO.h.

Definition at line 126 of file itkNiftiImageIO.h.

Definition at line 124 of file itkNiftiImageIO.h.

Definition at line 123 of file itkNiftiImageIO.h.


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