#include "open_iA_Core_export.h"
#include <vtkSmartPointer.h>
#include <QMap>

Include dependency graph for iAToolsVTK.h:

This graph shows which files directly or indirectly include this file:

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
open_iA_Core_API vtkSmartPointer< vtkImageData >	allocateImage (int vtkType, int const dimensions[3], double const spacing[3])
	Create a VTK image with the given properties. More...

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

open_iA_Core_API vtkSmartPointer< vtkImageData >	allocateImage (vtkSmartPointer< vtkImageData > img)
	Create a VTK image that has the same properties (type, size, spacing) as the given image. More...

open_iA_Core_API vtkSmartPointer< vtkImageData >	castVTKImage (vtkSmartPointer< vtkImageData > img, int dstType)
	Cast the given VTK image to another data type. More...

open_iA_Core_API bool	isVtkIntegerType (int type)
	Check whether the given type is integer. More...

open_iA_Core_API int	mapReadableDataTypeToVTKType (QString const &dataTypeName)
	Maps a given data type string to the corresponding VTK type identifier. More...

open_iA_Core_API int	mapRenderModeToEnum (QString const &)

open_iA_Core_API QString	mapVTKTypeToReadableDataType (int vtkType)
	Maps a given VTK type to the corresponding readable data type. More...

open_iA_Core_API size_t	mapVTKTypeToSize (int vtkType)
	Returns the size (in bytes) of the given VTK type. More...

open_iA_Core_API const QStringList &	readableDataTypeList (bool withLongLongTypes)
	Returns a human-readable list of available data types for a single pixel/voxel. More...

open_iA_Core_API vtkSmartPointer< vtkImageData >	readImage (QString const &filename, bool releaseFlag)
	Read an image from disk into a VTK image. More...

open_iA_Core_API const QMap< int, QString > &	RenderModeMap ()

open_iA_Core_API void	setCamPosition (vtkCamera *cam, iACameraPosition mode)

open_iA_Core_API void	storeImage (vtkSmartPointer< vtkImageData > image, QString const &filename, bool useCompression=true)
	Stores an image on disk (typically in .mhd format). More...

open_iA_Core_API void	writeSingleSliceImage (QString const &filename, vtkImageData *imageData)
	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

◆ allocateImage() [1/3]

open_iA_Core_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]

open_iA_Core_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]

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

◆ castVTKImage()

open_iA_Core_API vtkSmartPointer<vtkImageData> castVTKImage	(	vtkSmartPointer< vtkImageData >	img,
		int	dstType
	)

Cast the given VTK image to another data type.

Parameters

img	the input image
dstType	the VTK type identifier (VTK_INT, VTK_UNSIGNED_CHAR, ...) to cast to

Returns: a VTK image of the specified type

◆ isVtkIntegerType()

open_iA_Core_API bool isVtkIntegerType ( int type )

Check whether the given type is integer.

Parameters

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

Returns: true if the given VTK type holds integer numbers, false if it holds floating point numbers

◆ mapReadableDataTypeToVTKType()

open_iA_Core_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()

open_iA_Core_API int mapRenderModeToEnum ( QString const & )

◆ mapVTKTypeToReadableDataType()

open_iA_Core_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()

open_iA_Core_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

◆ readableDataTypeList()

open_iA_Core_API const QStringList& readableDataTypeList ( bool withLongLongTypes )

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

Parameters

withLongLongTypes

◆ readImage()

open_iA_Core_API vtkSmartPointer<vtkImageData> readImage	(	QString const &	filename,
		bool	releaseFlag
	)

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

Returns: the vtk image as read from the given file

◆ RenderModeMap()

open_iA_Core_API const QMap<int, QString>& RenderModeMap ( )

◆ setCamPosition()

open_iA_Core_API void setCamPosition	(	vtkCamera *	cam,
		iACameraPosition	mode
	)

◆ storeImage()

open_iA_Core_API void storeImage	(	vtkSmartPointer< vtkImageData >	image,
		QString const &	filename,
		bool	useCompression = `true`
	)

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

Parameters

image	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()

open_iA_Core_API void writeSingleSliceImage	(	QString const &	filename,
		vtkImageData *	imageData
	)

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
imageData	the image to write; this already needs to be a 2D image (i.e., size in Z dimension = 1)

Macros

Enumerations

Functions

Macro Definition Documentation

◆ FOR_VTKIMG_PIXELS

◆ FOR_VTKIMG_PIXELS_IDX

Enumeration Type Documentation

◆ iACameraPosition

Function Documentation

◆ allocateImage() [1/3]

◆ allocateImage() [2/3]

◆ allocateImage() [3/3]

◆ castVTKImage()

◆ isVtkIntegerType()

◆ mapReadableDataTypeToVTKType()

◆ mapRenderModeToEnum()

◆ mapVTKTypeToReadableDataType()

◆ mapVTKTypeToSize()

◆ readableDataTypeList()

◆ readImage()

◆ RenderModeMap()

◆ setCamPosition()

◆ storeImage()

◆ writeSingleSliceImage()