open_iA 2021.08
A tool for the visual analysis and processing of volumetric datasets, with a focus on industrial computed tomography.
Public Slots | Signals | Public Member Functions | Protected Member Functions | List of all members
iAAlgorithm Class Reference

Base class for algorithms running in the background. More...

#include <iAAlgorithm.h>

Inheritance diagram for iAAlgorithm:
[legend]
Collaboration diagram for iAAlgorithm:
[legend]

Public Slots

void updateVtkImageData (int ch)
 

Signals

void aprogress (int i)
 
void startUpdate (int ch=1)
 

Public Member Functions

 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)
 
iAConnectorgetConnector () const
 return first element of the connectors More...
 
QString getFilterName () const
 
vtkImageData * getVtkImageData ()
 
vtkPolyData * getVtkPolyData ()
 
iALoggerlogger () const
 
iAProgressProgressObserver ()
 
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...
 

Protected Member Functions

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

Detailed Description

Base class for algorithms running in the background.

Deprecated:
For operations producing some kind of output (image or output values), derive from iAFilter instead. For other operations, there is no clear successor yet.

Constructor & Destructor Documentation

◆ iAAlgorithm()

iAAlgorithm::iAAlgorithm ( QString  fn,
vtkImageData *  i,
vtkPolyData *  p,
iALogger l,
QObject *  parent = nullptr 
)

◆ ~iAAlgorithm()

iAAlgorithm::~iAAlgorithm ( )
virtual

Member Function Documentation

◆ AddImage()

void iAAlgorithm::AddImage ( vtkImageData *  i)

◆ addMsg()

void iAAlgorithm::addMsg ( QString  txt)

◆ allocConnectors()

void iAAlgorithm::allocConnectors ( int  size)

◆ aprogress

void iAAlgorithm::aprogress ( int  i)
signal

◆ Connectors()

QVector< iAConnector * > const & iAAlgorithm::Connectors ( ) const

get all connectors

◆ deleteConnector()

bool iAAlgorithm::deleteConnector ( iAConnector c)

◆ getConnector()

iAConnector * iAAlgorithm::getConnector ( ) const

return first element of the connectors

◆ getFilterName()

QString iAAlgorithm::getFilterName ( ) const

◆ getVtkImageData()

vtkImageData * iAAlgorithm::getVtkImageData ( )

◆ getVtkPolyData()

vtkPolyData * iAAlgorithm::getVtkPolyData ( )

◆ logger()

iALogger * iAAlgorithm::logger ( ) const

◆ performWork()

void iAAlgorithm::performWork ( )
protectedvirtual

Method that performs the algorithm's work, to be overridden in child classes.

Reimplemented in iAFilterRunnerGUIThread.

◆ ProgressObserver()

iAProgress * iAAlgorithm::ProgressObserver ( )

◆ run()

void iAAlgorithm::run ( )
protectedvirtual

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 in iAIO.

◆ SafeTerminate()

void iAAlgorithm::SafeTerminate ( )
virtual

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.

◆ setImageData()

void iAAlgorithm::setImageData ( vtkImageData *  imgData)
protected

sets the image data

◆ setup()

void iAAlgorithm::setup ( QString  fn,
vtkImageData *  i,
vtkPolyData *  p,
iALogger l 
)

◆ Start()

void iAAlgorithm::Start ( )

Start counting the running time and set the start time.

◆ startUpdate

void iAAlgorithm::startUpdate ( int  ch = 1)
signal

◆ Stop()

int iAAlgorithm::Stop ( )

Get the elapsed time since Start call.

◆ updateVtkImageData

void iAAlgorithm::updateVtkImageData ( int  ch)
slot

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