iAToolsVTK.h File Reference

#include "iAbase_export.h"
#include <vtkSmartPointer.h>
#include <QMap>
#include <QStringList>

Macros
#define	FOR_VTKIMG_PIXELS(img, x, y, z)
#define	FOR_VTKIMG_PIXELS_IDX(img, idx)   for (size_t idx = 0; idx < img->GetDimensions()[0]*img->GetDimensions()[1]*img->GetDimensions()[2]; ++idx)

Enumerations
enum	iACameraPosition {   PX , MX , PY , MY ,   PZ , MZ , Iso }

Functions
iAbase_API void	addImages (vtkSmartPointer< vtkImageData > imgDst, vtkSmartPointer< vtkImageData > const imgToAdd)
	add values of one image to the values of another image More...
iAbase_API vtkSmartPointer< vtkImageData >	allocateImage (int vtkType, int const dimensions[3], double const spacing[3])
	Create a VTK image with the given properties. More...
iAbase_API vtkSmartPointer< vtkImageData >	allocateImage (int vtkType, int const dimensions[3], double const spacing[3], int numComponents)
	Create a VTK image with the given properties. More...
iAbase_API vtkSmartPointer< vtkImageData >	allocateImage (vtkSmartPointer< vtkImageData > img)
	Create a VTK image that has the same properties (type, size, spacing) as the given image. More...
iAbase_API void	fillImage (vtkSmartPointer< vtkImageData > img, double const value)
	fill all pixels in the given image with the given value More...
iAbase_API bool	isVtkIntegerImage (vtkImageData *img)
	Check whether the given image holds integer numbers. More...
iAbase_API int	mapReadableDataTypeToVTKType (QString const &dataTypeName)
	Maps a given data type string to the corresponding VTK type identifier. More...
iAbase_API int	mapRenderModeToEnum (QString const &)
iAbase_API QString	mapVTKTypeToReadableDataType (int vtkType)
	Maps a given VTK type to the corresponding readable data type. More...
iAbase_API size_t	mapVTKTypeToSize (int vtkType)
	Returns the size (in bytes) of the given VTK type. More...
iAbase_API void	multiplyImage (vtkSmartPointer< vtkImageData > imgDst, double value)
	multiply all values of an image with the given value More...
iAbase_API QStringList const &	readableDataTypeList (bool withLongLongTypes)
	Returns a human-readable list of available data types for a single pixel/voxel. More...
iAbase_API void	readImage (QString const &filename, bool releaseFlag, vtkSmartPointer< vtkImageData > &ptr)
	Read an image from disk into a VTK image. More...
iAbase_API QMap< int, QString > const &	RenderModeMap ()
iAbase_API void	setCamPosition (vtkCamera *cam, iACameraPosition mode)
iAbase_API void	storeImage (vtkSmartPointer< vtkImageData > img, QString const &filename, bool useCompression=true)
	Stores an image on disk (typically in .mhd format). More...
iAbase_API void	writeSingleSliceImage (QString const &filename, vtkImageData *img)
	Write a single slice image to a common 2D picture format. More...

Macro Definition Documentation

FOR_VTKIMG_PIXELS

#define FOR_VTKIMG_PIXELS	(		img,
			x,
			y,
			z
	)

Value:

for (int z = 0; z < img->GetDimensions()[2]; ++z) \
    for (int y = 0; y < img->GetDimensions()[1]; ++y) \
        for (int x = 0; x < img->GetDimensions()[0]; ++x)

FOR_VTKIMG_PIXELS_IDX

#define FOR_VTKIMG_PIXELS_IDX	(		img,
			idx
	)		for (size_t idx = 0; idx < img->GetDimensions()[0]*img->GetDimensions()[1]*img->GetDimensions()[2]; ++idx)

Enumeration Type Documentation

iACameraPosition

enum iACameraPosition

Enumerator
PX
MX
PY
MY
PZ
MZ
Iso

Function Documentation

addImages()

iAbase_API void addImages	(	vtkSmartPointer< vtkImageData >	imgDst,
		vtkSmartPointer< vtkImageData > const	imgToAdd
	)

add values of one image to the values of another image

Parameters

imgDst	destination image (will be modified)
imgToAdd	image with values to be added to imgDst (will not be modified)

allocateImage() [1/3]

iAbase_API vtkSmartPointer< vtkImageData > allocateImage	(	int	vtkType,
		int const	dimensions[3],
		double const	spacing[3]
	)

Create a VTK image with the given properties.

Parameters

vtkType	the VTK type identifier (VTK_INT, VTK_UNSIGNED_CHAR, ...) for the voxel data type to use in the new image
dimensions	the size of the image in the 3 dimensions.
spacing	the spacing (distance of voxels) in each of the 3 dimension directions.

Returns

an image with a single component and the type, size and spacing as the given parameters, with allocated but uninitialized pixel data.

allocateImage() [2/3]

iAbase_API vtkSmartPointer< vtkImageData > allocateImage	(	int	vtkType,
		int const	dimensions[3],
		double const	spacing[3],
		int	numComponents
	)

Create a VTK image with the given properties.

Parameters

vtkType	the VTK type identifier (VTK_INT, VTK_UNSIGNED_CHAR, ...) for the voxel data type to use in the new image
dimensions	the size of the image in the 3 dimensions.
spacing	the spacing (distance of voxels) in each of the 3 dimension directions.
numComponents	the number of components in each voxel.

Returns

an image with the type, size, spacing and number of components as the given parameters, with allocated but uninitialized pixel data.

allocateImage() [3/3]

iAbase_API vtkSmartPointer< vtkImageData > allocateImage

(

vtkSmartPointer< vtkImageData >

img

)

Create a VTK image that has the same properties (type, size, spacing) as the given image.

Parameters

img	image whose type, size and spacing will be used to create the result image; its data will not be copied over to the new image

Returns

an image that has the same type, size and spacing as the image given as parameter, with allocated but uninitialized pixel data.

fillImage()

iAbase_API void fillImage	(	vtkSmartPointer< vtkImageData >	img,
		double const	value
	)

fill all pixels in the given image with the given value

Parameters

img	image to be filled
value	used to fill each voxel in given image

isVtkIntegerImage()

iAbase_API bool isVtkIntegerImage

(

vtkImageData *

img

)

Check whether the given image holds integer numbers.

Parameters

img	a VTK image

Returns

true if the values in the given VTK image are integer numbers, false if it holds floating point numbers

mapReadableDataTypeToVTKType()

iAbase_API int mapReadableDataTypeToVTKType

(

QString const &

dataTypeName

)

Maps a given data type string to the corresponding VTK type identifier.

Parameters

dataTypeName

an entry from the list of readable data types (see readableDataTypeList())

Returns

the VTK type identifier (VTK_INT, VTK_UNSIGNED_CHAR, ...) for the given readable data type name, or -1 if the given name is not on the list

mapRenderModeToEnum()

iAbase_API int mapRenderModeToEnum

(

QString const &

modeName

)

mapVTKTypeToReadableDataType()

iAbase_API QString mapVTKTypeToReadableDataType

(

int

vtkType

)

Maps a given VTK type to the corresponding readable data type.

Parameters

vtkType

the VTK type identifier (VTK_INT, VTK_UNSIGNED_CHAR, ...)

Returns

the name (in the list as returned by readableDataTypeList()) of the given VTK type identifier, or -1 if the given VTK type identifier is unknown

mapVTKTypeToSize()

iAbase_API size_t mapVTKTypeToSize

(

int

vtkType

)

Returns the size (in bytes) of the given VTK type.

Parameters

vtkType

a VTK type identifier (VTK_INT, VTK_UNSIGNED_CHAR, ...)

Returns

the size in bytes of the given type (VTK_CHAR -> 1, ...), or 0 if it's an unknown type

multiplyImage()

iAbase_API void multiplyImage	(	vtkSmartPointer< vtkImageData >	imgDst,
		double	value
	)

multiply all values of an image with the given value

Parameters

imgDst	the image to be multiplied
value	multiplier used for each voxel

readableDataTypeList()

iAbase_API QStringList const & readableDataTypeList

(

bool

withLongLongTypes

)

Returns a human-readable list of available data types for a single pixel/voxel.

Parameters

withLongLongTypes

readImage()

iAbase_API void readImage	(	QString const &	filename,
		bool	releaseFlag,
		vtkSmartPointer< vtkImageData > &	ptr
	)

Read an image from disk into a VTK image.

Parameters

filename	the name of the file to read.
releaseFlag	whether the ITK release flag should be set on the ITK image reader
ptr	the smart pointer in which to store the loaded image (it will be assigned a new vtkImageData)

RenderModeMap()

iAbase_API QMap< int, QString > const & RenderModeMap

(

)

setCamPosition()

iAbase_API void setCamPosition	(	vtkCamera *	cam,
		iACameraPosition	mode
	)

storeImage()

iAbase_API void storeImage	(	vtkSmartPointer< vtkImageData >	img,
		QString const &	filename,
		bool	useCompression = true
	)

Stores an image on disk (typically in .mhd format).

Parameters

img	the image to store
filename	the name of the file to write to.
useCompression	whether the file should be compressed (.zraw) or not (.raw) in case we are storing .mhd files

writeSingleSliceImage()

iAbase_API void writeSingleSliceImage	(	QString const &	filename,
		vtkImageData *	img
	)

Write a single slice image to a common 2D picture format.

Parameters

filename	the name of the file to write to; this is expected to have an extension of tif, png, jpg or bmp; the type of the file written will be chosen according to this extension
img	the image to write; this already needs to be a 2D image (i.e., size in Z dimension = 1)