at.mug.iqm.api.operator

Interface IOperator

All Superinterfaces:

ICancelable, IProgressEmitter

All Known Implementing Classes:

AbstractOperator, IqmOpACF, IqmOpAffine, IqmOpAlign, IqmOpBorder, IqmOpBUnwarpJ, IqmOpCalcImage, IqmOpCalcValue, IqmOpCoGReg, IqmOpColDecon, IqmOpComplexLogDepth, IqmOpConvert, IqmOpCreateFracSurf, IqmOpCreateImage, IqmOpCrop, IqmOpDFT, IqmOpDirLocal, IqmOpDistMap, IqmOpEdge, IqmOpFracBox, IqmOpFracFFT, IqmOpFracGenDim, IqmOpFracHiguchi, IqmOpFracHRM, IqmOpFracIFS, IqmOpFracLac, IqmOpFracMinkowski, IqmOpFracPyramid, IqmOpFracScan, IqmOpFracSurrogate, IqmOpHistoModify, IqmOpImgStabilizer, IqmOpInvert, IqmOpKMeans, IqmOpKMeansFuzzy, IqmOpMorph, IqmOpNexelScan, IqmOpRank, IqmOpRegGrow, IqmOpResize, IqmOpRGBRelative, IqmOpROISegment, IqmOpSmooth, IqmOpStackStat, IqmOpStatistics, IqmOpStatRegMerge, IqmOpTempMatch, IqmOpThreshold, IqmOpTurboReg, IqmOpUnsharpMask, IqmOpWatershed, IqmOpWhiteBalance, PlotOpAutoCorrelation, PlotOpComplLogDepth, PlotOpCut, PlotOpDCMGenerator, PlotOpEntropy, PlotOpFFT, PlotOpFilter, PlotOpFracAllomScale, PlotOpFracHiguchi, PlotOpFracHurst, PlotOpFracSurrogate, PlotOpFractalGenerator, PlotOpMath, PlotOpPointFinder, PlotOpSignalGenerator, PlotOpStatistics, PlotOpSymbolicAggregation

public interface IOperator
extends ICancelable, IProgressEmitter

This is the public interface for an IQM operator. Every operator can be cancelled by user interaction.

Author:

Philipp Kainz

Method Summary

Modifier and Type	Method and Description
String	getName() Gets the unique name of the IOperator by returning the "GlobalName" element from the resources[][] of the associated IOperatorDescriptor.
AbstractProcessingTask	getParentTask() Get the executing task of this operator.
PropertyChangeSupport	getPcs() Get the PropertyChangeSupport for the operator.
OperatorType	getType() Gets the type of the operator listed in an enumeration.
IResult	run(IWorkPackage workPackage) This method contains the entire logic (algorithm) of the operator.
void	setParentTask(AbstractProcessingTask parentTask) Set the executing task of this operator.

Methods inherited from interface at.mug.iqm.api.operator.ICancelable

isCancelable, isCancelled, setCancelable

Methods inherited from interface at.mug.iqm.api.events.handler.IProgressEmitter

addProgressListener, fireProgressChanged, getProgressListeners

Method Detail

run

IResult run(IWorkPackage workPackage)
     throws Exception

This method contains the entire logic (algorithm) of the operator. An IOperator does not declare any class members, since the execution of this code must be thread-safe.

Parameters:

workPackage - the parameters and sources

Returns:

a IResult containing all processed data

Throws:

Exception - if something went wrong

setParentTask

void setParentTask(AbstractProcessingTask parentTask)

Set the executing task of this operator.

Parameters:

parentTask -

getParentTask

AbstractProcessingTask getParentTask()

Get the executing task of this operator.

Returns:

the parent task of this operator

getName

String getName()

Gets the unique name of the IOperator by returning the "GlobalName" element from the resources[][] of the associated IOperatorDescriptor.

Returns:

the unique name of the operator

getType

OperatorType getType()

Gets the type of the operator listed in an enumeration.

Returns:

the OperatorType

getPcs

PropertyChangeSupport getPcs()

Get the PropertyChangeSupport for the operator. Property changes can be fired using getPcs() .firePropertyChanged(PropertyChangeEvent).

Returns:

the PropertyChangeSupport