vtkMINCImageWriter Class Reference

#include <vtkMINCImageWriter.h>

Inheritance diagram for vtkMINCImageWriter:

[legend]

Collaboration diagram for vtkMINCImageWriter:

[legend]

List of all members.

Detailed Description

A writer for MINC files.

MINC is a NetCDF-based medical image file format that was developed at the Montreal Neurological Institute in 1992. The data is written slice-by-slice, and this writer is therefore suitable for streaming MINC data that is larger than the memory size through VTK. This writer can also produce files with up to 4 dimensions, where the fourth dimension is provided by using AddInput() to specify multiple input data sets. If you want to set header information for the file, you must supply a vtkMINCImageAttributes

See also:: vtkMINCImageReader vtkMINCImageAttributes

Thanks:: Thanks to David Gobbi for writing this class and Atamai Inc. for contributing it to VTK.

Tests:: vtkMINCImageWriter (Tests)

Definition at line 83 of file vtkMINCImageWriter.h.


Public Types
typedef vtkImageWriter	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetFileName (const char *name)
virtual void	Write ()

virtual const char *	GetFileExtensions ()

virtual const char *	GetDescriptiveName ()

virtual void	SetDirectionCosines (vtkMatrix4x4 *matrix)
virtual vtkMatrix4x4 *	GetDirectionCosines ()

virtual void	SetRescaleSlope (double)
virtual double	GetRescaleSlope ()
virtual void	SetRescaleIntercept (double)
virtual double	GetRescaleIntercept ()

virtual void	SetImageAttributes (vtkMINCImageAttributes *attributes)
virtual vtkMINCImageAttributes *	GetImageAttributes ()

virtual void	SetStrictValidation (int)
virtual void	StrictValidationOn ()
virtual void	StrictValidationOff ()
virtual int	GetStrictValidation ()

virtual void	SetHistoryAddition (const char *)
virtual char *	GetHistoryAddition ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkMINCImageWriter *	SafeDownCast (vtkObject *o)
static vtkMINCImageWriter *	New ()
Protected Member Functions
	vtkMINCImageWriter ()
	~vtkMINCImageWriter ()
virtual int	OpenNetCDFFile (const char *filename, int &ncid)
virtual int	CloseNetCDFFile (int ncid)
virtual int	IndexFromDimensionName (const char *dimName)
virtual void	ComputePermutationFromOrientation (int permutation[3], int flip[3])
virtual int	CreateMINCDimensions (vtkImageData input, int timeStep, int dimids)
virtual int	CreateMINCVariables (vtkImageData input, int timeStep, int dimids)
virtual int	WriteMINCFileAttributes (vtkImageData *input, int timeStep)
virtual int	WriteMINCData (vtkImageData *input, int frameNumber)
virtual void	FindRescale (double &rescaleSlope, double &rescaleIntercept)
virtual void	FindMINCValidRange (double range[2])
virtual int	FillInputPortInformation (int port, vtkInformation *info)
virtual int	RequestInformation (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)
virtual int	RequestUpdateExtent (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)
virtual int	RequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)
Protected Attributes
int	MINCImageType
int	MINCImageTypeSigned
int	MINCImageMinMaxDims
vtkMatrix4x4 *	DirectionCosines
double	RescaleSlope
double	RescaleIntercept
int	StrictValidation
int	DataUpdateExtent [6]
int	FileDataType
double	FileValidRange [2]
double	InternalRescaleSlope
double	InternalRescaleIntercept
int	ComputeValidRangeFromScalarRange
vtkStringArray *	FileDimensionNames
vtkMINCImageAttributes *	ImageAttributes
int	Permutation [3]
int	Flip [3]
int	MismatchedInputs
int	MINCFileId
char *	HistoryAddition

Member Typedef Documentation

typedef vtkImageWriter vtkMINCImageWriter::Superclass

Reimplemented from vtkImageWriter.

Definition at line 86 of file vtkMINCImageWriter.h.

Constructor & Destructor Documentation

vtkMINCImageWriter::vtkMINCImageWriter ( ) [protected]

vtkMINCImageWriter::~vtkMINCImageWriter ( ) [protected]

Member Function Documentation

virtual const char* vtkMINCImageWriter::GetClassName ( ) [virtual]

Reimplemented from vtkImageWriter.

static int vtkMINCImageWriter::IsTypeOf ( const char * name ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImageWriter.

virtual int vtkMINCImageWriter::IsA ( const char * name ) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImageWriter.

static vtkMINCImageWriter* vtkMINCImageWriter::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkImageWriter.

static vtkMINCImageWriter* vtkMINCImageWriter::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkImageWriter.

virtual void vtkMINCImageWriter::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[virtual]`

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

virtual const char* vtkMINCImageWriter::GetFileExtensions ( ) [inline, virtual]

Get the entension for this file format.

Definition at line 93 of file vtkMINCImageWriter.h.

virtual const char* vtkMINCImageWriter::GetDescriptiveName ( ) [inline, virtual]

Get the name of this file format.

Definition at line 99 of file vtkMINCImageWriter.h.

virtual void vtkMINCImageWriter::SetFileName ( const char * name ) [virtual]

Set the file name.

Reimplemented from vtkImageWriter.

virtual void vtkMINCImageWriter::Write ( ) [virtual]

Write the data. This will attempt to stream the data slice-by-slice through the pipeline and out to the file, unless the whole extent of the input has already been updated.

Reimplemented from vtkImageWriter.

virtual void vtkMINCImageWriter::SetDirectionCosines ( vtkMatrix4x4 * matrix ) [virtual]

Set a matrix that describes the orientation of the data. The three columns of this matrix should give the unit-vector directions for the VTK x, y and z dimensions respectively. The writer will use this information to determine how to map the VTK dimensions to the canonical MINC dimensions, and if necessary, the writer will re-order one or more dimensions back-to-front to ensure that no MINC dimension ends up with a direction cosines vector whose dot product with the canonical unit vector for that dimension is negative.

virtual vtkMatrix4x4* vtkMINCImageWriter::GetDirectionCosines ( ) [virtual]

Set a matrix that describes the orientation of the data. The three columns of this matrix should give the unit-vector directions for the VTK x, y and z dimensions respectively. The writer will use this information to determine how to map the VTK dimensions to the canonical MINC dimensions, and if necessary, the writer will re-order one or more dimensions back-to-front to ensure that no MINC dimension ends up with a direction cosines vector whose dot product with the canonical unit vector for that dimension is negative.

virtual void vtkMINCImageWriter::SetRescaleSlope ( double ) [virtual]

Set the slope and intercept for rescaling the intensities. The default values are zero, which indicates to the reader that no rescaling is to be performed.

virtual double vtkMINCImageWriter::GetRescaleSlope ( ) [virtual]

Set the slope and intercept for rescaling the intensities. The default values are zero, which indicates to the reader that no rescaling is to be performed.

virtual void vtkMINCImageWriter::SetRescaleIntercept ( double ) [virtual]

Set the slope and intercept for rescaling the intensities. The default values are zero, which indicates to the reader that no rescaling is to be performed.

virtual double vtkMINCImageWriter::GetRescaleIntercept ( ) [virtual]

Set the slope and intercept for rescaling the intensities. The default values are zero, which indicates to the reader that no rescaling is to be performed.

virtual void vtkMINCImageWriter::SetImageAttributes ( vtkMINCImageAttributes * attributes ) [virtual]

Set the image attributes, which contain patient information and other useful metadata.

virtual vtkMINCImageAttributes* vtkMINCImageWriter::GetImageAttributes ( ) [inline, virtual]

Set the image attributes, which contain patient information and other useful metadata.

Definition at line 138 of file vtkMINCImageWriter.h.

virtual void vtkMINCImageWriter::SetStrictValidation ( int ) [virtual]

Set whether to validate that all variable attributes that have been set are ones that are listed in the MINC standard.

virtual void vtkMINCImageWriter::StrictValidationOn ( ) [virtual]

Set whether to validate that all variable attributes that have been set are ones that are listed in the MINC standard.

virtual void vtkMINCImageWriter::StrictValidationOff ( ) [virtual]

Set whether to validate that all variable attributes that have been set are ones that are listed in the MINC standard.

virtual int vtkMINCImageWriter::GetStrictValidation ( ) [virtual]

Set whether to validate that all variable attributes that have been set are ones that are listed in the MINC standard.

virtual void vtkMINCImageWriter::SetHistoryAddition ( const char * ) [virtual]

Set a string value to append to the history of the file. This string should describe, briefly, how the file was processed.

virtual char* vtkMINCImageWriter::GetHistoryAddition ( ) [virtual]

Set a string value to append to the history of the file. This string should describe, briefly, how the file was processed.

virtual int vtkMINCImageWriter::OpenNetCDFFile	(	const char *	filename,
		int &	ncid
	)			`[protected, virtual]`

virtual int vtkMINCImageWriter::CloseNetCDFFile ( int ncid ) [protected, virtual]

virtual int vtkMINCImageWriter::IndexFromDimensionName ( const char * dimName ) [protected, virtual]

virtual void vtkMINCImageWriter::ComputePermutationFromOrientation	(	int	permutation[3],
		int	flip[3]
	)			`[protected, virtual]`

virtual int vtkMINCImageWriter::CreateMINCDimensions	(	vtkImageData *	input,
		int	timeStep,
		int *	dimids
	)			`[protected, virtual]`

virtual int vtkMINCImageWriter::CreateMINCVariables	(	vtkImageData *	input,
		int	timeStep,
		int *	dimids
	)			`[protected, virtual]`

virtual int vtkMINCImageWriter::WriteMINCFileAttributes	(	vtkImageData *	input,
		int	timeStep
	)			`[protected, virtual]`

virtual int vtkMINCImageWriter::WriteMINCData	(	vtkImageData *	input,
		int	frameNumber
	)			`[protected, virtual]`

virtual void vtkMINCImageWriter::FindRescale	(	double &	rescaleSlope,
		double &	rescaleIntercept
	)			`[protected, virtual]`

virtual void vtkMINCImageWriter::FindMINCValidRange ( double range[2] ) [protected, virtual]

virtual int vtkMINCImageWriter::FillInputPortInformation	(	int	port,
		vtkInformation *	info
	)			`[protected, virtual]`

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkImageAlgorithm.

virtual int vtkMINCImageWriter::RequestInformation	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)			`[protected, virtual]`

Reimplemented from vtkImageAlgorithm.

virtual int vtkMINCImageWriter::RequestUpdateExtent	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)			`[protected, virtual]`

Reimplemented from vtkImageAlgorithm.

virtual int vtkMINCImageWriter::RequestData	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)			`[protected, virtual]`