vtkTeemNRRDWriter Class Reference

Writes NRRD files using the teem library. More...

#include <Libs/vtkTeem/vtkTeemNRRDWriter.h>

Inheritance diagram for vtkTeemNRRDWriter:

Collaboration diagram for vtkTeemNRRDWriter:

Public Types
typedef vtkWriter	Superclass

Public Member Functions
virtual void	ForceRangeAxisOff ()
virtual void	ForceRangeAxisOn ()
virtual vtkDoubleArray *	GetBValues ()
virtual const char *	GetClassName ()
virtual int	GetCompressionLevel ()
virtual vtkDoubleArray *	GetDiffusionGradients ()
virtual char *	GetFileName ()
virtual int	GetFileType ()
virtual bool	GetForceRangeAxis ()
virtual vtkMatrix4x4 *	GetIJKToRASMatrix ()
vtkImageData *	GetInput ()
	Get the input to this writer.
vtkImageData *	GetInput (int port)
virtual vtkMatrix4x4 *	GetMeasurementFrameMatrix ()
virtual int	GetSpace ()
virtual int	GetUseCompression ()
virtual int	GetWriteError ()
virtual int	IsA (const char *type)
void *	MakeNRRD ()
	Utility function to return image as a Nrrd*.
void	PrintSelf (ostream &os, vtkIndent indent) override
void	SetAttribute (const std::string &name, const std::string &value)
void	SetAxisLabel (unsigned int axis, const char *label)
	Method to set label for each axis.
void	SetAxisUnit (unsigned int axis, const char *unit)
	Method to set unit for each axis.
virtual void	SetBValues (vtkDoubleArray *)
virtual void	SetCompressionLevel (int)
virtual void	SetDiffusionGradients (vtkDoubleArray *)
virtual void	SetFileName (const char *)
	Specify file name of vtk polygon data file to write.
virtual void	SetFileType (int)
void	SetFileTypeToASCII ()
void	SetFileTypeToBinary ()
virtual void	SetForceRangeAxis (bool)
virtual void	SetIJKToRASMatrix (vtkMatrix4x4 *)
virtual void	SetMeasurementFrameMatrix (vtkMatrix4x4 *)
virtual void	SetSpace (int)
virtual void	SetUseCompression (int)
void	SetVectorAxisKind (int kind)
virtual void	SetWriteError (int)
virtual void	UseCompressionOff ()
virtual void	UseCompressionOn ()
void	vtkSetSpaceToLPS ()
	Set coordinate system to LPS.
void	vtkSetSpaceToLPST ()
void	vtkSetSpaceToRAS ()
	Set coordinate system to RAS.
void	vtkSetSpaceToRAST ()
virtual void	WriteErrorOff ()
virtual void	WriteErrorOn ()
	Flag that is set by WriteData() if writing fails.

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkTeemNRRDWriter *	New ()
static vtkTeemNRRDWriter *	SafeDownCast (vtkObject *o)

Protected Member Functions
int	FillInputPortInformation (int port, vtkInformation *info) override
	vtkTeemNRRDWriter ()
void	WriteData () override
	Write method. It is called by vtkWriter::Write();.
	~vtkTeemNRRDWriter () override

Protected Attributes
AttributeMapType *	Attributes
AxisInfoMapType *	AxisLabels
AxisInfoMapType *	AxisUnits
vtkDoubleArray *	BValues
int	CompressionLevel
vtkDoubleArray *	DiffusionGradients
char *	FileName
int	FileType
bool	ForceRangeAxis
vtkMatrix4x4 *	IJKToRASMatrix
vtkMatrix4x4 *	MeasurementFrameMatrix
int	Space
int	UseCompression
int	VectorAxisKind
int	WriteError
	Flag to set to on when a write error occurred.

Detailed Description

Writes NRRD files using the teem library.

This class was originally developed for writing DWI images and it is still the recommended writer for this purpose. The class was later extended to allow writing vector images, but it has some limitations: It can only write 3D images with voxel component axis kind scalar, RGB, RGBA, list, or a manually specified kind.

vtkITKImageWriter is a more general-purpose writer - it can be used for writing 3D image data with voxels containing scalars, RGB, RGBA, spatial vectors (displacement, speed, etc.), or generic list components. vtkITKImageSequenceWriter can be used for writing time sequence data (e.g., time sequence of displacement fields, RGB volumes, etc.).

See also

vtkTeemNRRDReader vtkITKImageWriter vtkITKImageSequenceWriter

Definition at line 29 of file vtkTeemNRRDWriter.h.

Member Typedef Documentation

Superclass

typedef vtkWriter vtkTeemNRRDWriter::Superclass

Definition at line 32 of file vtkTeemNRRDWriter.h.

Constructor & Destructor Documentation

vtkTeemNRRDWriter()

vtkTeemNRRDWriter::vtkTeemNRRDWriter ( )

protected

~vtkTeemNRRDWriter()

vtkTeemNRRDWriter::~vtkTeemNRRDWriter ( )

overrideprotected

Member Function Documentation

FillInputPortInformation()

int vtkTeemNRRDWriter::FillInputPortInformation ( int port, vtkInformation * info )

overrideprotected

ForceRangeAxisOff()

virtual void vtkTeemNRRDWriter::ForceRangeAxisOff ( )

virtual

ForceRangeAxisOn()

virtual void vtkTeemNRRDWriter::ForceRangeAxisOn ( )

virtual

GetBValues()

virtual vtkDoubleArray * vtkTeemNRRDWriter::GetBValues ( )

virtual

GetClassName()

virtual const char * vtkTeemNRRDWriter::GetClassName ( )

virtual

GetCompressionLevel()

virtual int vtkTeemNRRDWriter::GetCompressionLevel ( )

virtual

GetDiffusionGradients()

virtual vtkDoubleArray * vtkTeemNRRDWriter::GetDiffusionGradients ( )

virtual

GetFileName()

virtual char * vtkTeemNRRDWriter::GetFileName ( )

virtual

GetFileType()

virtual int vtkTeemNRRDWriter::GetFileType ( )

virtual

GetForceRangeAxis()

virtual bool vtkTeemNRRDWriter::GetForceRangeAxis ( )

virtual

GetIJKToRASMatrix()

virtual vtkMatrix4x4 * vtkTeemNRRDWriter::GetIJKToRASMatrix ( )

virtual

GetInput() [1/2]

vtkImageData * vtkTeemNRRDWriter::GetInput

(

)

Get the input to this writer.

GetInput() [2/2]

vtkImageData * vtkTeemNRRDWriter::GetInput

(

int

port

)

GetMeasurementFrameMatrix()

virtual vtkMatrix4x4 * vtkTeemNRRDWriter::GetMeasurementFrameMatrix ( )

virtual

GetSpace()

virtual int vtkTeemNRRDWriter::GetSpace ( )

virtual

GetUseCompression()

virtual int vtkTeemNRRDWriter::GetUseCompression ( )

virtual

GetWriteError()

virtual int vtkTeemNRRDWriter::GetWriteError ( )

virtual

IsA()

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

virtual

IsTypeOf()

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

static

MakeNRRD()

void * vtkTeemNRRDWriter::MakeNRRD

(

)

Utility function to return image as a Nrrd*.

New()

static vtkTeemNRRDWriter * vtkTeemNRRDWriter::New ( )

static

PrintSelf()

void vtkTeemNRRDWriter::PrintSelf ( ostream & os, vtkIndent indent )

override

SafeDownCast()

static vtkTeemNRRDWriter * vtkTeemNRRDWriter::SafeDownCast ( vtkObject * o )

static

SetAttribute()

void vtkTeemNRRDWriter::SetAttribute	(	const std::string &	name,
		const std::string &	value )

Method to set an attribute that will be passed into the NRRD file on write

SetAxisLabel()

void vtkTeemNRRDWriter::SetAxisLabel	(	unsigned int	axis,
		const char *	label )

Method to set label for each axis.

SetAxisUnit()

void vtkTeemNRRDWriter::SetAxisUnit	(	unsigned int	axis,
		const char *	unit )

Method to set unit for each axis.

SetBValues()

virtual void vtkTeemNRRDWriter::SetBValues ( vtkDoubleArray * )

virtual

SetCompressionLevel()

virtual void vtkTeemNRRDWriter::SetCompressionLevel ( int )

virtual

SetDiffusionGradients()

virtual void vtkTeemNRRDWriter::SetDiffusionGradients ( vtkDoubleArray * )

virtual

SetFileName()

virtual void vtkTeemNRRDWriter::SetFileName ( const char * )

virtual

Specify file name of vtk polygon data file to write.

SetFileType()

virtual void vtkTeemNRRDWriter::SetFileType ( int )

virtual

SetFileTypeToASCII()

void vtkTeemNRRDWriter::SetFileTypeToASCII ( )

inline

Definition at line 68 of file vtkTeemNRRDWriter.h.

SetFileTypeToBinary()

void vtkTeemNRRDWriter::SetFileTypeToBinary ( )

inline

Definition at line 69 of file vtkTeemNRRDWriter.h.

SetForceRangeAxis()

virtual void vtkTeemNRRDWriter::SetForceRangeAxis ( bool )

virtual

Force the addition of a range axis, even when the size of the first image dimension (components, or frame list) is 1. This is useful when attempting to write an image sequence with a single frame, as otherwise the range dimension would be omitted.

SetIJKToRASMatrix()

virtual void vtkTeemNRRDWriter::SetIJKToRASMatrix ( vtkMatrix4x4 * )

virtual

SetMeasurementFrameMatrix()

virtual void vtkTeemNRRDWriter::SetMeasurementFrameMatrix ( vtkMatrix4x4 * )

virtual

SetSpace()

virtual void vtkTeemNRRDWriter::SetSpace ( int )

virtual

Method to set the coordinate system written to the NRRD file. Currently the only valid coordinate systems are: RAS, RAST, LPS, and LPST.

SetUseCompression()

virtual void vtkTeemNRRDWriter::SetUseCompression ( int )

virtual

SetVectorAxisKind()

void vtkTeemNRRDWriter::SetVectorAxisKind

(

int

kind

)

Method to force axis kind for the non-spatial axis (4th dimension). If not set (or set to nrrdKindUnknown) then axis kind is guessed from the number of components and scalar type.

SetWriteError()

virtual void vtkTeemNRRDWriter::SetWriteError ( int )

virtual

UseCompressionOff()

virtual void vtkTeemNRRDWriter::UseCompressionOff ( )

virtual

UseCompressionOn()

virtual void vtkTeemNRRDWriter::UseCompressionOn ( )

virtual

vtkSetSpaceToLPS()

void vtkTeemNRRDWriter::vtkSetSpaceToLPS ( )

inline

Set coordinate system to LPS.

Definition at line 101 of file vtkTeemNRRDWriter.h.

vtkSetSpaceToLPST()

void vtkTeemNRRDWriter::vtkSetSpaceToLPST ( )

inline

Definition at line 102 of file vtkTeemNRRDWriter.h.

vtkSetSpaceToRAS()

void vtkTeemNRRDWriter::vtkSetSpaceToRAS ( )

inline

Set coordinate system to RAS.

Definition at line 97 of file vtkTeemNRRDWriter.h.

vtkSetSpaceToRAST()

void vtkTeemNRRDWriter::vtkSetSpaceToRAST ( )

inline

Definition at line 98 of file vtkTeemNRRDWriter.h.

WriteData()

void vtkTeemNRRDWriter::WriteData ( )

overrideprotected

Write method. It is called by vtkWriter::Write();.

WriteErrorOff()

virtual void vtkTeemNRRDWriter::WriteErrorOff ( )

virtual

WriteErrorOn()

virtual void vtkTeemNRRDWriter::WriteErrorOn ( )

virtual

Flag that is set by WriteData() if writing fails.

Member Data Documentation

Attributes

AttributeMapType* vtkTeemNRRDWriter::Attributes

protected

Definition at line 139 of file vtkTeemNRRDWriter.h.

AxisLabels

AxisInfoMapType* vtkTeemNRRDWriter::AxisLabels

protected

Definition at line 140 of file vtkTeemNRRDWriter.h.

AxisUnits

AxisInfoMapType* vtkTeemNRRDWriter::AxisUnits

protected

Definition at line 141 of file vtkTeemNRRDWriter.h.

BValues

vtkDoubleArray* vtkTeemNRRDWriter::BValues

protected

Definition at line 129 of file vtkTeemNRRDWriter.h.

CompressionLevel

int vtkTeemNRRDWriter::CompressionLevel

protected

Definition at line 136 of file vtkTeemNRRDWriter.h.

DiffusionGradients

vtkDoubleArray* vtkTeemNRRDWriter::DiffusionGradients

protected

Definition at line 130 of file vtkTeemNRRDWriter.h.

FileName

char* vtkTeemNRRDWriter::FileName

protected

Definition at line 127 of file vtkTeemNRRDWriter.h.

FileType

int vtkTeemNRRDWriter::FileType

protected

Definition at line 137 of file vtkTeemNRRDWriter.h.

ForceRangeAxis

bool vtkTeemNRRDWriter::ForceRangeAxis

protected

Definition at line 145 of file vtkTeemNRRDWriter.h.

IJKToRASMatrix

vtkMatrix4x4* vtkTeemNRRDWriter::IJKToRASMatrix

protected

Definition at line 132 of file vtkTeemNRRDWriter.h.

MeasurementFrameMatrix

vtkMatrix4x4* vtkTeemNRRDWriter::MeasurementFrameMatrix

protected

Definition at line 133 of file vtkTeemNRRDWriter.h.

Space

int vtkTeemNRRDWriter::Space

protected

Definition at line 143 of file vtkTeemNRRDWriter.h.

UseCompression

int vtkTeemNRRDWriter::UseCompression

protected

Definition at line 135 of file vtkTeemNRRDWriter.h.

VectorAxisKind

int vtkTeemNRRDWriter::VectorAxisKind

protected

Definition at line 142 of file vtkTeemNRRDWriter.h.

WriteError

int vtkTeemNRRDWriter::WriteError

protected

Flag to set to on when a write error occurred.

Definition at line 125 of file vtkTeemNRRDWriter.h.

---

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

• Libs/vtkTeem/vtkTeemNRRDWriter.h