vtkNIFTIImageWriter Class Reference

Write NIfTI-1 and NIfTI-2 medical image files. More...

#include <vtkNIFTIImageWriter.h>

Inheritance diagram for vtkNIFTIImageWriter:

Collaboration diagram for vtkNIFTIImageWriter:

Public Member Functions
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetNIFTIVersion (int)
virtual int	GetNIFTIVersion ()
virtual void	SetDescription (const char *)
virtual char *	GetDescription ()
virtual int	GetTimeDimension ()
virtual void	SetTimeDimension (int)
virtual double	GetTimeSpacing ()
virtual void	SetTimeSpacing (double)
virtual void	SetRescaleSlope (double)
virtual double	GetRescaleSlope ()
virtual void	SetRescaleIntercept (double)
virtual double	GetRescaleIntercept ()
virtual bool	GetPlanarRGB ()
virtual void	SetPlanarRGB (bool)
virtual void	PlanarRGBOn ()
virtual void	PlanarRGBOff ()
virtual void	SetQFac (double)
virtual double	GetQFac ()
void	SetQFormMatrix (vtkMatrix4x4 *)
vtkMatrix4x4 *	GetQFormMatrix ()
void	SetSFormMatrix (vtkMatrix4x4 *)
vtkMatrix4x4 *	GetSFormMatrix ()
void	SetNIFTIHeader (vtkNIFTIImageHeader *hdr)
vtkNIFTIImageHeader *	GetNIFTIHeader ()
Public Member Functions inherited from vtkImageWriter
vtkImageWriter *	NewInstance () const
virtual void	Write ()
void	DeleteFiles ()
virtual void	SetFileName (const char *)
virtual char *	GetFileName ()
virtual void	SetFilePrefix (const char *)
virtual char *	GetFilePrefix ()
virtual void	SetFilePattern (const char *)
virtual char *	GetFilePattern ()
virtual void	SetFileDimensionality (int)
virtual int	GetFileDimensionality ()
vtkImageData *	GetInput ()
Public Member Functions inherited from vtkImageAlgorithm
vtkImageAlgorithm *	NewInstance () const
vtkImageData *	GetOutput ()
vtkImageData *	GetOutput (int)
virtual void	SetOutput (vtkDataObject *d)
virtual int	ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void	SetInputData (vtkDataObject *)
void	SetInputData (int, vtkDataObject *)
vtkDataObject *	GetInput (int port)
vtkDataObject *	GetInput ()
vtkImageData *	GetImageDataInput (int port)
virtual void	AddInputData (vtkDataObject *)
virtual void	AddInputData (int, vtkDataObject *)
Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const
int	HasExecutive ()
vtkExecutive *	GetExecutive ()
virtual void	SetExecutive (vtkExecutive *executive)
virtual int	ModifyRequest (vtkInformation *request, int when)
vtkInformation *	GetInputPortInformation (int port)
vtkInformation *	GetOutputPortInformation (int port)
int	GetNumberOfInputPorts ()
int	GetNumberOfOutputPorts ()
void	UpdateProgress (double amount)
vtkInformation *	GetInputArrayInformation (int idx)
void	RemoveAllInputs ()
vtkDataObject *	GetOutputDataObject (int port)
virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	RemoveInputConnection (int port, int idx)
virtual void	RemoveAllInputConnections (int port)
int	GetNumberOfInputConnections (int port)
int	GetTotalNumberOfInputConnections ()
vtkAlgorithmOutput *	GetInputConnection (int port, int index)
vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
vtkAlgorithm *	GetInputAlgorithm (int port, int index)
vtkExecutive *	GetInputExecutive (int port, int index)
vtkInformation *	GetInputInformation (int port, int index)
vtkInformation *	GetOutputInformation (int port)
virtual void	UpdateInformation ()
virtual void	UpdateDataObject ()
virtual void	PropagateUpdateExtent ()
virtual void	UpdateWholeExtent ()
void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
int	SetUpdateExtentToWholeExtent (int port)
int	SetUpdateExtentToWholeExtent ()
void	SetUpdateExtent (int port, int extent[6])
int	ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int	ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformation *	GetInformation ()
virtual void	SetInformation (vtkInformation *)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
virtual void	SetAbortExecute (int)
virtual int	GetAbortExecute ()
virtual void	AbortExecuteOn ()
virtual void	AbortExecuteOff ()
virtual void	SetProgress (double)
virtual double	GetProgress ()
void	SetProgressText (const char *ptext)
virtual char *	GetProgressText ()
virtual unsigned long	GetErrorCode ()
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
vtkDataObject *	GetInputDataObject (int port, int connection)
virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	SetInputConnection (vtkAlgorithmOutput *input)
virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	AddInputConnection (vtkAlgorithmOutput *input)
virtual void	SetInputDataObject (int port, vtkDataObject *data)
virtual void	SetInputDataObject (vtkDataObject *data)
virtual void	AddInputDataObject (int port, vtkDataObject *data)
virtual void	AddInputDataObject (vtkDataObject *data)
vtkAlgorithmOutput *	GetOutputPort (int index)
vtkAlgorithmOutput *	GetOutputPort ()
vtkAlgorithm *	GetInputAlgorithm ()
vtkExecutive *	GetInputExecutive ()
vtkInformation *	GetInputInformation ()
virtual void	Update (int port)
virtual void	Update ()
virtual void	SetReleaseDataFlag (int)
virtual int	GetReleaseDataFlag ()
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
int	UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)
void	SetUpdateExtent (int extent[6])
int *	GetUpdateExtent ()
int *	GetUpdateExtent (int port)
void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
void	GetUpdateExtent (int extent[6])
void	GetUpdateExtent (int port, int extent[6])
int	GetUpdatePiece ()
int	GetUpdatePiece (int port)
int	GetUpdateNumberOfPieces ()
int	GetUpdateNumberOfPieces (int port)
int	GetUpdateGhostLevel ()
int	GetUpdateGhostLevel (int port)
void	SetProgressObserver (vtkProgressObserver *)
virtual vtkProgressObserver *	GetProgressObserver ()
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Protected Member Functions
	vtkNIFTIImageWriter ()
	~vtkNIFTIImageWriter ()
int	GenerateHeader (vtkInformation *info, bool singleFile)
virtual int	RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
Protected Member Functions inherited from vtkImageWriter
	vtkImageWriter ()
	~vtkImageWriter ()
virtual void	RecursiveWrite (int dim, vtkImageData *region, vtkInformation *inInfo, ofstream *file)
virtual void	RecursiveWrite (int dim, vtkImageData *cache, vtkImageData *data, vtkInformation *inInfo, ofstream *file)
virtual void	WriteFile (ofstream *file, vtkImageData *data, int extent[6], int wExtent[6])
virtual void	WriteFileHeader (ofstream *, vtkImageData *, int[6])
virtual void	WriteFileTrailer (ofstream *, vtkImageData *)
Protected Member Functions inherited from vtkImageAlgorithm
	vtkImageAlgorithm ()
	~vtkImageAlgorithm ()
virtual int	RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int	RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void	CopyInputArrayAttributesToOutput (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual void	ExecuteDataWithInformation (vtkDataObject *output, vtkInformation *outInfo)
virtual void	ExecuteData (vtkDataObject *output)
virtual void	Execute ()
virtual void	AllocateOutputData (vtkImageData *out, vtkInformation *outInfo, int *uExtent)
virtual vtkImageData *	AllocateOutputData (vtkDataObject *out, vtkInformation *outInfo)
virtual void	CopyAttributeData (vtkImageData *in, vtkImageData *out, vtkInformationVector **inputVector)
virtual int	FillOutputPortInformation (int port, vtkInformation *info)
virtual int	FillInputPortInformation (int port, vtkInformation *info)
Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()
	~vtkAlgorithm ()
virtual void	SetNumberOfInputPorts (int n)
virtual void	SetNumberOfOutputPorts (int n)
int	InputPortIndexInRange (int index, const char *action)
int	OutputPortIndexInRange (int index, const char *action)
int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutive *	CreateDefaultExecutive ()
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	SetNumberOfInputConnections (int port, int n)
int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int	GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
void	SetInputDataInternal (int port, vtkDataObject *input)
void	AddInputDataInternal (int port, vtkDataObject *input)
virtual void	SetErrorCode (unsigned long)
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Static Protected Member Functions
static char *	ReplaceExtension (const char *fname, const char *ext1, const char *ext2)
Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Protected Attributes
double	QFac
char *	Description
bool	PlanarRGB
int	TimeDimension
double	TimeSpacing
double	RescaleIntercept
double	RescaleSlope
vtkMatrix4x4 *	QFormMatrix
vtkMatrix4x4 *	SFormMatrix
vtkNIFTIImageHeader *	NIFTIHeader
vtkNIFTIImageHeader *	OwnHeader
int	NIFTIVersion
Protected Attributes inherited from vtkImageWriter
int	FileDimensionality
char *	FilePrefix
char *	FilePattern
char *	FileName
int	FileNumber
int	FileLowerLeft
char *	InternalFileName
int	MinimumFileNumber
int	MaximumFileNumber
int	FilesDeleted
Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information
double	Progress
char *	ProgressText
vtkProgressObserver *	ProgressObserver
unsigned long	ErrorCode
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers
typedef vtkImageWriter	Superclass
static vtkNIFTIImageWriter *	New ()
static int	IsTypeOf (const char *type)
static vtkNIFTIImageWriter *	SafeDownCast (vtkObjectBase *o)
virtual int	IsA (const char *type)
vtkNIFTIImageWriter *	NewInstance () const
virtual vtkObjectBase *	NewInstanceInternal () const

Additional Inherited Members
Public Types inherited from vtkImageWriter
typedef vtkImageAlgorithm	Superclass
Public Types inherited from vtkImageAlgorithm
typedef vtkAlgorithm	Superclass
Public Types inherited from vtkAlgorithm
typedef vtkObject	Superclass
enum	DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass
Static Public Member Functions inherited from vtkImageWriter
static vtkImageWriter *	New ()
static int	IsTypeOf (const char *type)
static vtkImageWriter *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkImageAlgorithm
static int	IsTypeOf (const char *type)
static vtkImageAlgorithm *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()
static int	IsTypeOf (const char *type)
static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()
static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()
static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()
static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()
static vtkInformationIntegerKey *	INPUT_PORT ()
static vtkInformationIntegerKey *	INPUT_CONNECTION ()
static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()
static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()
Public Attributes inherited from vtkAlgorithm
int	AbortExecute
Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

Write NIfTI-1 and NIfTI-2 medical image files.

This class writes NIFTI files, either in .nii format or as separate .img and .hdr files. If told to write a file that ends in ".gz", then the writer will automatically compress the file with zlib. Images of type unsigned char that have 3 or 4 scalar components will automatically be written as RGB or RGBA respectively. Images of type float or double that have 2 components will automatically be written as complex values.

Thanks:

This class was contributed to VTK by the Calgary Image Processing and Analysis Centre (CIPAC).

See also

vtkNIFTIImageReader

Tests:

vtkNIFTIImageWriter (Tests)

Definition at line 44 of file vtkNIFTIImageWriter.h.

Member Typedef Documentation

typedef vtkImageWriter vtkNIFTIImageWriter::Superclass

Static method for construction.

Definition at line 50 of file vtkNIFTIImageWriter.h.

Constructor & Destructor Documentation

vtkNIFTIImageWriter::vtkNIFTIImageWriter ( )

protected

vtkNIFTIImageWriter::~vtkNIFTIImageWriter ( )

protected

Member Function Documentation

static vtkNIFTIImageWriter* vtkNIFTIImageWriter::New ( )

static

Static method for construction.

static int vtkNIFTIImageWriter::IsTypeOf ( const char *  type )

static

Static method for construction.

virtual int vtkNIFTIImageWriter::IsA ( const char *  type )

virtual

Static method for construction.

Reimplemented from vtkImageWriter.

static vtkNIFTIImageWriter* vtkNIFTIImageWriter::SafeDownCast ( vtkObjectBase *  o )

static

Static method for construction.

virtual vtkObjectBase* vtkNIFTIImageWriter::NewInstanceInternal ( ) const

protectedvirtual

Static method for construction.

Reimplemented from vtkImageWriter.

vtkNIFTIImageWriter* vtkNIFTIImageWriter::NewInstance

(

)

const

Static method for construction.

virtual void vtkNIFTIImageWriter::PrintSelf ( ostream &  os, vtkIndent  indent  )

virtual

Print information about this object.

Reimplemented from vtkImageWriter.

virtual void vtkNIFTIImageWriter::SetNIFTIVersion ( int  )

virtual

Set the version number for the NIfTI file format to use. This can be 1, 2, or 0 (the default). If set to zero, then it will save as NIfTI version 1 unless SetNIFTIHeader() provided header information from a NIfTI version 2 file.

virtual int vtkNIFTIImageWriter::GetNIFTIVersion ( )

virtual

Set the version number for the NIfTI file format to use. This can be 1, 2, or 0 (the default). If set to zero, then it will save as NIfTI version 1 unless SetNIFTIHeader() provided header information from a NIfTI version 2 file.

virtual void vtkNIFTIImageWriter::SetDescription ( const char *  )

virtual

Set a short description (max 80 chars) of how the file was produced. The default description is "VTKX.Y" where X.Y is the VTK version.

virtual char* vtkNIFTIImageWriter::GetDescription ( )

virtual

Set a short description (max 80 chars) of how the file was produced. The default description is "VTKX.Y" where X.Y is the VTK version.

virtual int vtkNIFTIImageWriter::GetTimeDimension ( )

virtual

Set the time dimension to use in the NIFTI file (or zero if none). The number of components of the input data must be divisible by the time dimension if the time dimension is not set to zero. The vector dimension will be set to the number of components divided by the time dimension.

virtual void vtkNIFTIImageWriter::SetTimeDimension ( int  )

virtual

Set the time dimension to use in the NIFTI file (or zero if none). The number of components of the input data must be divisible by the time dimension if the time dimension is not set to zero. The vector dimension will be set to the number of components divided by the time dimension.

virtual double vtkNIFTIImageWriter::GetTimeSpacing ( )

virtual

Set the time dimension to use in the NIFTI file (or zero if none). The number of components of the input data must be divisible by the time dimension if the time dimension is not set to zero. The vector dimension will be set to the number of components divided by the time dimension.

virtual void vtkNIFTIImageWriter::SetTimeSpacing ( double  )

virtual

Set the time dimension to use in the NIFTI file (or zero if none). The number of components of the input data must be divisible by the time dimension if the time dimension is not set to zero. The vector dimension will be set to the number of components divided by the time dimension.

virtual void vtkNIFTIImageWriter::SetRescaleSlope ( double  )

virtual

Set the slope and intercept for calibrating the scalar values. Other programs that read the NIFTI file can use the equation v = u*RescaleSlope + RescaleIntercept to rescale the data to real values. If both the slope and the intercept are zero, then the SclSlope and SclIntercept in the header info provided via SetNIFTIHeader() are used instead.

virtual double vtkNIFTIImageWriter::GetRescaleSlope ( )

virtual

Set the slope and intercept for calibrating the scalar values. Other programs that read the NIFTI file can use the equation v = u*RescaleSlope + RescaleIntercept to rescale the data to real values. If both the slope and the intercept are zero, then the SclSlope and SclIntercept in the header info provided via SetNIFTIHeader() are used instead.

virtual void vtkNIFTIImageWriter::SetRescaleIntercept ( double  )

virtual

Set the slope and intercept for calibrating the scalar values. Other programs that read the NIFTI file can use the equation v = u*RescaleSlope + RescaleIntercept to rescale the data to real values. If both the slope and the intercept are zero, then the SclSlope and SclIntercept in the header info provided via SetNIFTIHeader() are used instead.

virtual double vtkNIFTIImageWriter::GetRescaleIntercept ( )

virtual

Set the slope and intercept for calibrating the scalar values. Other programs that read the NIFTI file can use the equation v = u*RescaleSlope + RescaleIntercept to rescale the data to real values. If both the slope and the intercept are zero, then the SclSlope and SclIntercept in the header info provided via SetNIFTIHeader() are used instead.

virtual bool vtkNIFTIImageWriter::GetPlanarRGB ( )

virtual

Write planar RGB (separate R, G, and B planes), rather than packed RGB. Use this option with extreme caution: the NIFTI standard requires RGB pixels to be packed. The Analyze format, however, was used to store both planar RGB and packed RGB depending on the software, without any indication in the header about which convention was being used.

virtual void vtkNIFTIImageWriter::SetPlanarRGB ( bool  )

virtual

Write planar RGB (separate R, G, and B planes), rather than packed RGB. Use this option with extreme caution: the NIFTI standard requires RGB pixels to be packed. The Analyze format, however, was used to store both planar RGB and packed RGB depending on the software, without any indication in the header about which convention was being used.

virtual void vtkNIFTIImageWriter::PlanarRGBOn ( )

virtual

Write planar RGB (separate R, G, and B planes), rather than packed RGB. Use this option with extreme caution: the NIFTI standard requires RGB pixels to be packed. The Analyze format, however, was used to store both planar RGB and packed RGB depending on the software, without any indication in the header about which convention was being used.

virtual void vtkNIFTIImageWriter::PlanarRGBOff ( )

virtual

Write planar RGB (separate R, G, and B planes), rather than packed RGB. Use this option with extreme caution: the NIFTI standard requires RGB pixels to be packed. The Analyze format, however, was used to store both planar RGB and packed RGB depending on the software, without any indication in the header about which convention was being used.

virtual void vtkNIFTIImageWriter::SetQFac ( double  )

virtual

The QFac sets the ordering of the slices in the NIFTI file. If QFac is -1, then the slice ordering in the file will be reversed as compared to VTK. Use with caution.

virtual double vtkNIFTIImageWriter::GetQFac ( )

virtual

The QFac sets the ordering of the slices in the NIFTI file. If QFac is -1, then the slice ordering in the file will be reversed as compared to VTK. Use with caution.

void vtkNIFTIImageWriter::SetQFormMatrix

(

vtkMatrix4x4 *

)

Set the "qform" orientation and offset for the image data. The 3x3 portion of the matrix must be orthonormal and have a positive determinant, it will be used to compute the quaternion. The last column of the matrix will be used for the offset. In the NIFTI header, the qform_code will be set to 1.

vtkMatrix4x4* vtkNIFTIImageWriter::GetQFormMatrix ( )

inline

Set the "qform" orientation and offset for the image data. The 3x3 portion of the matrix must be orthonormal and have a positive determinant, it will be used to compute the quaternion. The last column of the matrix will be used for the offset. In the NIFTI header, the qform_code will be set to 1.

Definition at line 124 of file vtkNIFTIImageWriter.h.

void vtkNIFTIImageWriter::SetSFormMatrix

(

vtkMatrix4x4 *

)

Set a matrix for the "sform" transformation stored in the file. Unlike the qform matrix, the sform matrix can contain scaling information. Before being stored in the NIFTI header, the first three columns of the matrix will be multipled by the voxel spacing. In the NIFTI header, the sform_code will be set to 2.

vtkMatrix4x4* vtkNIFTIImageWriter::GetSFormMatrix ( )

inline

Set a matrix for the "sform" transformation stored in the file. Unlike the qform matrix, the sform matrix can contain scaling information. Before being stored in the NIFTI header, the first three columns of the matrix will be multipled by the voxel spacing. In the NIFTI header, the sform_code will be set to 2.

Definition at line 134 of file vtkNIFTIImageWriter.h.

void vtkNIFTIImageWriter::SetNIFTIHeader

(

vtkNIFTIImageHeader *

hdr

)

Set the NIFTI header information to use when writing the file. The data dimensions and pixdim from the supplied header will be ignored. Likewise, the QForm and SForm information in the supplied header will be ignored if you have called SetQFormMatrix() or SetSFormMatrix() to provide the orientation information for the file.

vtkNIFTIImageHeader* vtkNIFTIImageWriter::GetNIFTIHeader

(

)

Set the NIFTI header information to use when writing the file. The data dimensions and pixdim from the supplied header will be ignored. Likewise, the QForm and SForm information in the supplied header will be ignored if you have called SetQFormMatrix() or SetSFormMatrix() to provide the orientation information for the file.

int vtkNIFTIImageWriter::GenerateHeader ( vtkInformation *  info, bool  singleFile  )

protected

Generate the header information for the file.

virtual int vtkNIFTIImageWriter::RequestData ( vtkInformation *  request, vtkInformationVector **  inputVector, vtkInformationVector *  outputVector  )

protectedvirtual

The main execution method, which writes the file.

Reimplemented from vtkImageWriter.

static char* vtkNIFTIImageWriter::ReplaceExtension ( const char *  fname, const char *  ext1, const char *  ext2  )

staticprotected

Make a new filename by replacing extension "ext1" with "ext2". The extensions must include a period, must be three characters long, and must be lower case. A new string is returned that must be deleted by the caller.

Member Data Documentation

int vtkNIFTIImageWriter::TimeDimension

protected

The size and spacing of the Time dimension to use in the file.

Definition at line 172 of file vtkNIFTIImageWriter.h.

double vtkNIFTIImageWriter::TimeSpacing

protected

The size and spacing of the Time dimension to use in the file.

Definition at line 173 of file vtkNIFTIImageWriter.h.

double vtkNIFTIImageWriter::RescaleIntercept

protected

Information for rescaling data to quantitative units.

Definition at line 178 of file vtkNIFTIImageWriter.h.

double vtkNIFTIImageWriter::RescaleSlope

protected

Information for rescaling data to quantitative units.

Definition at line 179 of file vtkNIFTIImageWriter.h.

double vtkNIFTIImageWriter::QFac

protected

Is -1 if VTK slice order is opposite to NIFTI slice order, +1 otherwise.

Definition at line 184 of file vtkNIFTIImageWriter.h.

vtkMatrix4x4* vtkNIFTIImageWriter::QFormMatrix

protected

The orientation matrices for the NIFTI file.

Definition at line 188 of file vtkNIFTIImageWriter.h.

vtkMatrix4x4* vtkNIFTIImageWriter::SFormMatrix

protected

The orientation matrices for the NIFTI file.

Definition at line 189 of file vtkNIFTIImageWriter.h.

char* vtkNIFTIImageWriter::Description

protected

A description of how the file was produced.

Definition at line 193 of file vtkNIFTIImageWriter.h.

vtkNIFTIImageHeader* vtkNIFTIImageWriter::NIFTIHeader

protected

The header information.

Definition at line 197 of file vtkNIFTIImageWriter.h.

vtkNIFTIImageHeader* vtkNIFTIImageWriter::OwnHeader

protected

The header information.

Definition at line 198 of file vtkNIFTIImageWriter.h.

int vtkNIFTIImageWriter::NIFTIVersion

protected

The header information.

Definition at line 199 of file vtkNIFTIImageWriter.h.

bool vtkNIFTIImageWriter::PlanarRGB

protected

Use planar RGB instead of the default (packed).

Definition at line 203 of file vtkNIFTIImageWriter.h.

---

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

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/IO/Image/vtkNIFTIImageWriter.h