vtkMINCImageReader Class Reference

#include <vtkMINCImageReader.h>

Inheritance diagram for vtkMINCImageReader:

[legend]

Collaboration diagram for vtkMINCImageReader:

[legend]

List of all members.

Detailed Description

A reader for MINC files.

MINC is a NetCDF-based medical image file format that was developed at the Montreal Neurological Institute in 1992. This class will read a MINC file into VTK, rearranging the data to match the VTK x, y, and z dimensions, and optionally rescaling real-valued data to VTK_FLOAT if RescaleRealValuesOn() is set. If RescaleRealValues is off, then the data will be stored in its original data type and the GetRescaleSlope(), GetRescaleIntercept() method can be used to retrieve global rescaling parameters. If the original file had a time dimension, the SetTimeStep() method can be used to specify a time step to read. All of the original header information can be accessed though the GetImageAttributes() method.

See also:: vtkMINCImageWriter vtkMINCImageAttributes

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

Tests:: vtkMINCImageReader (Tests)

Definition at line 86 of file vtkMINCImageReader.h.


Public Types
typedef vtkImageReader2	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 int	CanReadFile (const char *name)
virtual vtkMatrix4x4 *	GetDirectionCosines ()
virtual int	GetNumberOfTimeSteps ()
virtual vtkMINCImageAttributes *	GetImageAttributes ()

virtual const char *	GetFileExtensions ()

virtual const char *	GetDescriptiveName ()

virtual double	GetRescaleSlope ()
virtual double	GetRescaleIntercept ()

virtual void	SetRescaleRealValues (int)
virtual void	RescaleRealValuesOn ()
virtual void	RescaleRealValuesOff ()
virtual int	GetRescaleRealValues ()

virtual double *	GetDataRange ()
virtual void	GetDataRange (double range[2])

virtual void	SetTimeStep (int)
virtual int	GetTimeStep ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkMINCImageReader *	SafeDownCast (vtkObject *o)
static vtkMINCImageReader *	New ()
Protected Member Functions
	vtkMINCImageReader ()
	~vtkMINCImageReader ()
virtual int	OpenNetCDFFile (const char *filename, int &ncid)
virtual int	CloseNetCDFFile (int ncid)
virtual int	IndexFromDimensionName (const char *dimName)
virtual int	ReadMINCFileAttributes ()
virtual void	FindRangeAndRescaleValues ()
virtual void	ExecuteInformation ()
virtual void	ExecuteData (vtkDataObject *out)
Static Protected Member Functions
static int	ConvertMINCTypeToVTKType (int minctype, int mincsigned)
Protected Attributes
int	MINCImageType
int	MINCImageTypeSigned
double	ValidRange [2]
double	ImageRange [2]
double	DataRange [2]
int	NumberOfTimeSteps
int	TimeStep
vtkMatrix4x4 *	DirectionCosines
double	RescaleSlope
double	RescaleIntercept
int	RescaleRealValues
vtkMINCImageAttributes *	ImageAttributes
int	FileNameHasChanged

Member Typedef Documentation

typedef vtkImageReader2 vtkMINCImageReader::Superclass

Reimplemented from vtkImageReader2.

Definition at line 89 of file vtkMINCImageReader.h.

Constructor & Destructor Documentation

vtkMINCImageReader::vtkMINCImageReader ( ) [protected]

vtkMINCImageReader::~vtkMINCImageReader ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkImageReader2.

static int vtkMINCImageReader::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 vtkImageReader2.

virtual int vtkMINCImageReader::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 vtkImageReader2.

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

Reimplemented from vtkImageReader2.

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

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

Reimplemented from vtkImageReader2.

virtual void vtkMINCImageReader::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 vtkImageReader2.

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

Set the file name.

Reimplemented from vtkImageReader2.

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

Get the entension for this file format.

Reimplemented from vtkImageReader2.

Definition at line 99 of file vtkMINCImageReader.h.

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

Get the name of this file format.

Reimplemented from vtkImageReader2.

Definition at line 105 of file vtkMINCImageReader.h.

virtual int vtkMINCImageReader::CanReadFile ( const char * name ) [virtual]

Test whether the specified file can be read.

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

Get a matrix that describes the orientation of the data. The three columns of the matrix are the direction cosines for the x, y and z dimensions respectively.

virtual double vtkMINCImageReader::GetRescaleSlope ( ) [virtual]

Get the slope and intercept for rescaling the scalar values to real data values. To convert scalar values to real values, use the equation y = x*RescaleSlope + RescaleIntercept.

virtual double vtkMINCImageReader::GetRescaleIntercept ( ) [virtual]

Get the slope and intercept for rescaling the scalar values to real data values. To convert scalar values to real values, use the equation y = x*RescaleSlope + RescaleIntercept.

virtual void vtkMINCImageReader::SetRescaleRealValues ( int ) [virtual]

Rescale real data values to float. If this is done, the RescaleSlope and RescaleIntercept will be set to 1 and 0 respectively. This is off by default.

virtual void vtkMINCImageReader::RescaleRealValuesOn ( ) [virtual]

Rescale real data values to float. If this is done, the RescaleSlope and RescaleIntercept will be set to 1 and 0 respectively. This is off by default.

virtual void vtkMINCImageReader::RescaleRealValuesOff ( ) [virtual]

Rescale real data values to float. If this is done, the RescaleSlope and RescaleIntercept will be set to 1 and 0 respectively. This is off by default.

virtual int vtkMINCImageReader::GetRescaleRealValues ( ) [virtual]

Rescale real data values to float. If this is done, the RescaleSlope and RescaleIntercept will be set to 1 and 0 respectively. This is off by default.

virtual double* vtkMINCImageReader::GetDataRange ( ) [virtual]

Get the scalar range of the output from the information in the file header. This is more efficient that computing the scalar range, but in some cases the MINC file stores an incorrect valid_range and the DataRange will be incorrect.

virtual void vtkMINCImageReader::GetDataRange ( double range[2] ) [inline, virtual]

Get the scalar range of the output from the information in the file header. This is more efficient that computing the scalar range, but in some cases the MINC file stores an incorrect valid_range and the DataRange will be incorrect.

Definition at line 140 of file vtkMINCImageReader.h.

virtual int vtkMINCImageReader::GetNumberOfTimeSteps ( ) [virtual]

Get the number of time steps in the file.

virtual void vtkMINCImageReader::SetTimeStep ( int ) [virtual]

Set the time step to read.

virtual int vtkMINCImageReader::GetTimeStep ( ) [virtual]

Set the time step to read.

virtual vtkMINCImageAttributes* vtkMINCImageReader::GetImageAttributes ( ) [virtual]

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