iAModality Class Reference

class holding the data of a single image channel More...

#include <iAModality.h>

Public Types
enum	RenderFlag {   NoRenderer = 0x0 , MainRenderer = 0x01 , MagicLens = 0x02 , BoundingBox = 0x04 ,   Slicer = 0x08 }

Public Member Functions
	iAModality (QString const &name, QString const &filename, int channelNo, vtkSmartPointer< vtkImageData > imgData, int renderFlags)
	create modality from name, file and image data More...
	iAModality (QString const &name, QString const &filename, std::vector< vtkSmartPointer< vtkImageData > > imgs, int renderFlags)
	create modality from name, file and image data More...
double const *	bounds () const
	Get the (axis-aligned) bounding box of the dataset. More...
int	channel () const
	return the channel in the specified file that the data in this class comes from (don't confuse with channelID!) More...
uint	channelID () const
	return ID of channel used in mdichild to represent this modality in slicer (don't confuse with channelID!) More...
vtkSmartPointer< vtkImageData >	component (size_t idx) const
	return a specific component of this modality More...
size_t	componentCount () const
	return the number of components in this modality More...
void	computeImageStatistics ()
iAImageCoordConverter const &	converter () const
int	depth () const
	The depth (in number of voxels) of the dataset. More...
QString	fileName () const
	returns file holding the modality data More...
bool	hasRenderFlag (RenderFlag flag) const
int	height () const
	The height (in number of voxels) of the dataset. More...
QSharedPointer< iAHistogramData > const	histogramData () const
vtkSmartPointer< vtkImageData >	image () const
	get the main image of this modality (typically only the one is available, unless there are multiple components, see ComponentCount() and GetComponent() More...
QString	imageName (int componentIdx)
	return the name of the given component More...
iAImageInfo &	info ()
	return statistical information about the image More...
void	loadTransferFunction ()
QString	name () const
	returns name of the modality More...
QString	orientationString ()
double const *	origin () const
	Get the coordinates of the origin (x,y,z). More...
QString	positionString ()
QSharedPointer< iAVolumeRenderer >	renderer ()
int	renderFlags () const
void	setChannelID (uint id)
	set ID of channel used in mdichild to represent this modality in slicer More...
void	setData (vtkSmartPointer< vtkImageData > imgData)
void	setFileName (QString const &fileName)
	set the filename (to be used if it has changed externally; does not save the file!) More...
void	setHistogramData (QSharedPointer< iAHistogramData > histoData)
void	setName (QString const &name)
	set name of the modality More...
void	setOrigin (double origin[3])
	Set the coordinates of the origin (x,y,z). More...
void	setRenderer (QSharedPointer< iAVolumeRenderer > renderer)
void	setRenderFlag (int renderFlag)
	set flag indicating location where to render More...
void	setSlicerOpacity (double opacity)
void	setSpacing (double spacing[3])
	Set the voxel spacing of the dataset in each (x,y,z) direction. More...
void	setStringSettings (QString const &pos, QString const &ori, QString const &tfFile)
void	setVolSettings (const iAVolumeSettings &volSettings)
void	setVolSettingsSavedStatusFalse ()
double	slicerOpacity ()
double const *	spacing () const
	Get the voxel spacing of the dataset in each (x,y,z) direction. More...
QSharedPointer< iAModalityTransfer >	transfer ()
QString	transferFileName () const
	get the name of the transfer function file More...
void	updateRenderer ()
bool	volSettingsSavedStatus ()
const iAVolumeSettings &	volumeSettings () const
int	width () const
	The width (in number of voxels) of the dataset. More...

Detailed Description

class holding the data of a single image channel

Member Enumeration Documentation

RenderFlag

enum iAModality::RenderFlag

Enumerator
NoRenderer
MainRenderer
MagicLens
BoundingBox
Slicer

Constructor & Destructor Documentation

iAModality() [1/2]

iAModality::iAModality	(	QString const &	name,
		QString const &	filename,
		int	channelNo,
		vtkSmartPointer< vtkImageData >	imgData,
		int	renderFlags
	)

create modality from name, file and image data

iAModality() [2/2]

iAModality::iAModality	(	QString const &	name,
		QString const &	filename,
		std::vector< vtkSmartPointer< vtkImageData > >	imgs,
		int	renderFlags
	)

create modality from name, file and image data

Member Function Documentation

bounds()

double const * iAModality::bounds

(

)

const

Get the (axis-aligned) bounding box of the dataset.

Returns

array of 6 double values: upper-left-top and lower-right-bottom coordinates (in that order)

channel()

int iAModality::channel

(

)

const

return the channel in the specified file that the data in this class comes from (don't confuse with channelID!)

channelID()

uint iAModality::channelID

(

)

const

return ID of channel used in mdichild to represent this modality in slicer (don't confuse with channelID!)

component()

vtkSmartPointer< vtkImageData > iAModality::component

(

size_t

idx

)

const

return a specific component of this modality

componentCount()

size_t iAModality::componentCount

(

)

const

return the number of components in this modality

computeImageStatistics()

void iAModality::computeImageStatistics

(

)

converter()

iAImageCoordConverter const & iAModality::converter

(

)

const

depth()

int iAModality::depth

(

)

const

The depth (in number of voxels) of the dataset.

fileName()

QString iAModality::fileName

(

)

const

returns file holding the modality data

hasRenderFlag()

bool iAModality::hasRenderFlag

(

RenderFlag

flag

)

const

height()

int iAModality::height

(

)

const

The height (in number of voxels) of the dataset.

histogramData()

QSharedPointer< iAHistogramData > const iAModality::histogramData

(

)

const

image()

vtkSmartPointer< vtkImageData > iAModality::image

(

)

const

get the main image of this modality (typically only the one is available, unless there are multiple components, see ComponentCount() and GetComponent()

imageName()

QString iAModality::imageName

(

int

componentIdx

)

return the name of the given component

info()

iAImageInfo & iAModality::info

(

)

return statistical information about the image

loadTransferFunction()

void iAModality::loadTransferFunction

(

)

name()

QString iAModality::name

(

)

const

returns name of the modality

orientationString()

QString iAModality::orientationString

(

)

origin()

double const * iAModality::origin

(

)

const

Get the coordinates of the origin (x,y,z).

Returns

array of 3 double values: x, y and z coordinate of the dataset origin.

positionString()

QString iAModality::positionString

(

)

renderer()

QSharedPointer< iAVolumeRenderer > iAModality::renderer

(

)

renderFlags()

int iAModality::renderFlags

(

)

const

setChannelID()

void iAModality::setChannelID

(

uint

id

)

set ID of channel used in mdichild to represent this modality in slicer

setData()

void iAModality::setData

(

vtkSmartPointer< vtkImageData >

imgData

)

setFileName()

void iAModality::setFileName

(

QString const &

fileName

)

set the filename (to be used if it has changed externally; does not save the file!)

setHistogramData()

void iAModality::setHistogramData

(

QSharedPointer< iAHistogramData >

histoData

)

setName()

void iAModality::setName

(

QString const &

name

)

set name of the modality

setOrigin()

void iAModality::setOrigin

(

double

origin[3]

)

Set the coordinates of the origin (x,y,z).

setRenderer()

void iAModality::setRenderer

(

QSharedPointer< iAVolumeRenderer >

renderer

)

setRenderFlag()

void iAModality::setRenderFlag

(

int

renderFlag

)

set flag indicating location where to render

setSlicerOpacity()

void iAModality::setSlicerOpacity ( double  opacity )

inline

setSpacing()

void iAModality::setSpacing

(

double

spacing[3]

)

Set the voxel spacing of the dataset in each (x,y,z) direction.

setStringSettings()

void iAModality::setStringSettings	(	QString const &	pos,
		QString const &	ori,
		QString const &	tfFile
	)

setVolSettings()

void iAModality::setVolSettings

(

const iAVolumeSettings &

volSettings

)

setVolSettingsSavedStatusFalse()

void iAModality::setVolSettingsSavedStatusFalse ( )

inline

slicerOpacity()

double iAModality::slicerOpacity ( )

inline

spacing()

double const * iAModality::spacing

(

)

const

Get the voxel spacing of the dataset in each (x,y,z) direction.

Returns

array of 3 double values: spacing in x, y and z direction

transfer()

QSharedPointer< iAModalityTransfer > iAModality::transfer

(

)

transferFileName()

QString iAModality::transferFileName

(

)

const

get the name of the transfer function file

updateRenderer()

void iAModality::updateRenderer

(

)

volSettingsSavedStatus()

bool iAModality::volSettingsSavedStatus ( )

inline

volumeSettings()

const iAVolumeSettings & iAModality::volumeSettings

(

)

const

width()

int iAModality::width

(

)

const

The width (in number of voxels) of the dataset.

---

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

• libs/guibase/iAModality.h
• libs/guibase/iAModality.cpp