iAIO Class Reference

Class currently containing most IO operations (file reading and writing). More...

#include <iAIO.h>

Inheritance diagram for iAIO:

Collaboration diagram for iAIO:

Signals
void	done (bool active=false)
void	failed ()
Signals inherited from iAAlgorithm
void	aprogress (int i)
void	startUpdate (int ch=1)

Public Member Functions
	iAIO (iALogger *logger, QWidget *parent, std::vector< vtkSmartPointer< vtkImageData > > *volumes, std::vector< QString > *fileNames=0)
	iAIO (vtkImageData *i, vtkPolyData *p, iALogger *logger, QWidget *parent=0, std::vector< vtkSmartPointer< vtkImageData > > *volumes=0, std::vector< QString > *fileNames=0)
virtual	~iAIO ()
QString const &	additionalInfo ()
	Get additional information (if any, e.g. for a volume stack) More...
QString const &	fileName ()
	Get the name of the file that was read. More...
void	init (QWidget *par)
	initialize variables More...
int	ioID () const
	Get the type of file being read. More...
QSharedPointer< iAModalityList >	modalities ()
	Get the list of modalities that were read. More...
void	setAdditionalInfo (QString const &additionalInfo)
	Set additional information for the current file. More...
bool	setupIO (iAIOType type, QString fileName, bool compression=false, int channel=-1)
	Set up the file IO specified by the parameters. More...
Public Member Functions inherited from iAAlgorithm
	iAAlgorithm (QString fn, vtkImageData *i, vtkPolyData *p, iALogger *l, QObject *parent=nullptr)
virtual	~iAAlgorithm ()
void	AddImage (vtkImageData *i)
void	addMsg (QString txt)
void	allocConnectors (int size)
QVector< iAConnector * > const &	Connectors () const
	get all connectors More...
bool	deleteConnector (iAConnector *c)
iAConnector *	getConnector () const
	return first element of the connectors More...
QString	getFilterName () const
vtkImageData *	getVtkImageData ()
vtkPolyData *	getVtkPolyData ()
iALogger *	logger () const
iAProgress *	ProgressObserver ()
virtual void	SafeTerminate ()
	probably NOT "safe", just calls QThread::terminate (note there: "Warning: This function is dangerous and its use is discouraged.") There is no safe way to terminate algorithms implemented yet. More...
void	setup (QString fn, vtkImageData *i, vtkPolyData *p, iALogger *l)
void	Start ()
	Start counting the running time and set the start time. More...
int	Stop ()
	Get the elapsed time since Start call. More...

Static Public Attributes
static const QString	VolstackExtension

Protected Member Functions
void	run () override
	Performs the actual work. More...
Protected Member Functions inherited from iAAlgorithm
virtual void	performWork ()
	Method that performs the algorithm's work, to be overridden in child classes. More...
void	setImageData (vtkImageData *imgData)
	sets the image data More...

Additional Inherited Members
Public Slots inherited from iAAlgorithm
void	updateVtkImageData (int ch)

Detailed Description

Class currently containing most IO operations (file reading and writing).

Should be split up into readers for specific formats!

Constructor & Destructor Documentation

iAIO() [1/2]

iAIO::iAIO	(	vtkImageData *	i,
		vtkPolyData *	p,
		iALogger *	logger,
		QWidget *	parent = 0,
		std::vector< vtkSmartPointer< vtkImageData > > *	volumes = 0,
		std::vector< QString > *	fileNames = 0
	)

iAIO() [2/2]

iAIO::iAIO	(	iALogger *	logger,
		QWidget *	parent,
		std::vector< vtkSmartPointer< vtkImageData > > *	volumes,
		std::vector< QString > *	fileNames = 0
	)

~iAIO()

iAIO::~iAIO ( )

virtual

Member Function Documentation

additionalInfo()

QString const & iAIO::additionalInfo

(

)

Get additional information (if any, e.g. for a volume stack)

done

void iAIO::done ( bool  active = false )

signal

failed

void iAIO::failed ( )

signal

fileName()

QString const & iAIO::fileName

(

)

Get the name of the file that was read.

init()

void iAIO::init

(

QWidget *

par

)

initialize variables

ioID()

int iAIO::ioID

(

)

const

Get the type of file being read.

modalities()

QSharedPointer< iAModalityList > iAIO::modalities

(

)

Get the list of modalities that were read.

run()

void iAIO::run ( )

overrideprotectedvirtual

Performs the actual work.

The method in this class performs some basic actions (like printing messages when the algorithm started and stopped, and basic error checking by catching any exceptions). Typically you will not want to override this method but the "performWork" method below

Reimplemented from iAAlgorithm.

setAdditionalInfo()

void iAIO::setAdditionalInfo

(

QString const &

additionalInfo

)

Set additional information for the current file.

setupIO()

bool iAIO::setupIO	(	iAIOType	type,
		QString	fileName,
		bool	compression = false,
		int	channel = -1
	)

Set up the file IO specified by the parameters.

Parameters

type	type of the file to read
fileName	name of the file to read
compression	whether to use compression (if file format supports it)
channel	which channel to read/write (if file format supports more than one)

Returns

true if successful, false if not.

Member Data Documentation

VolstackExtension

const QString iAIO::VolstackExtension

static

---

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

• libs/guibase/io/iAIO.h
• libs/guibase/io/iAIO.cpp