at.mug.iqm.api.operator

Class AbstractOperatorDescriptor

java.lang.Object

javax.media.jai.OperationDescriptorImpl

at.mug.iqm.api.operator.AbstractOperatorDescriptor

All Implemented Interfaces:

IOperatorDescriptor, Serializable, javax.media.jai.OperationDescriptor, javax.media.jai.RegistryElementDescriptor

Direct Known Subclasses:

IqmOpACFDescriptor, IqmOpAffineDescriptor, IqmOpAlignDescriptor, IqmOpBorderDescriptor, IqmOpBUnwarpJDescriptor, IqmOpCalcImageDescriptor, IqmOpCalcValueDescriptor, IqmOpCoGRegDescriptor, IqmOpColDeconDescriptor, IqmOpComplexLogDepthDescriptor, IqmOpConvertDescriptor, IqmOpCreateFracSurfDescriptor, IqmOpCreateImageDescriptor, IqmOpCropDescriptor, IqmOpDFTDescriptor, IqmOpDirLocalDescriptor, IqmOpDistMapDescriptor, IqmOpEdgeDescriptor, IqmOpFracBoxDescriptor, IqmOpFracFFTDescriptor, IqmOpFracGenDimDescriptor, IqmOpFracHiguchiDescriptor, IqmOpFracHRMDescriptor, IqmOpFracIFSDescriptor, IqmOpFracLacDescriptor, IqmOpFracMinkowskiDescriptor, IqmOpFracPyramidDescriptor, IqmOpFracScanDescriptor, IqmOpFracSurrogateDescriptor, IqmOpHistoModifyDescriptor, IqmOpImgStabilizerDescriptor, IqmOpInvertDescriptor, IqmOpKMeansDescriptor, IqmOpKMeansFuzzyDescriptor, IqmOpMorphDescriptor, IqmOpNexelScanDescriptor, IqmOpRankDescriptor, IqmOpRegGrowDescriptor, IqmOpResizeDescriptor, IqmOpRGBRelativeDescriptor, IqmOpROISegmentDescriptor, IqmOpSmoothDescriptor, IqmOpStackStatDescriptor, IqmOpStatisticsDescriptor, IqmOpStatRegMergeDescriptor, IqmOpTempMatchDescriptor, IqmOpThresholdDescriptor, IqmOpTurboRegDescriptor, IqmOpUnsharpMaskDescriptor, IqmOpWatershedDescriptor, IqmOpWhiteBalanceDescriptor, PlotOpAutoCorrelationDescriptor, PlotOpComplLogDepthDescriptor, PlotOpCutDescriptor, PlotOpDCMGeneratorDescriptor, PlotOpEntropyDescriptor, PlotOpFFTDescriptor, PlotOpFilterDescriptor, PlotOpFracAllomScaleDescriptor, PlotOpFracHiguchiDescriptor, PlotOpFracHurstDescriptor, PlotOpFracSurrogateDescriptor, PlotOpFractalGeneratorDescriptor, PlotOpMathDescriptor, PlotOpPointFinderDescriptor, PlotOpSignalGeneratorDescriptor, PlotOpStatisticsDescriptor, PlotOpSymbolicAggregationDescriptor

public class AbstractOperatorDescriptor
extends javax.media.jai.OperationDescriptorImpl
implements IOperatorDescriptor

This is the abstract operator descriptor of IQM operators. Any descriptor has to inherit from this class. Note: This class extensively uses the JAI implementation of OperationDescriptor and extends it by some custom members and methods.

Author:

Philipp Kainz

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	numSources
protected List<DataType>	outputTypes A list of all data types, this operator can produce.
protected Class[]	paramClasses
protected Object[]	paramDefaults
protected String[]	paramNames
protected String[][]	resources
private static long	serialVersionUID The UID for serialization.
protected StackProcessingType	stackProcessingType The type of stack processing.
protected OperatorType	type The type of the operator.
protected javax.media.jai.util.Range[]	validParamValues

Fields inherited from class javax.media.jai.OperationDescriptorImpl

sourceNames, supportedModes

Fields inherited from interface javax.media.jai.OperationDescriptor

NO_PARAMETER_DEFAULT

Constructor Summary

Constructors

Constructor and Description
AbstractOperatorDescriptor(String[][] resources, int numSources, String[] paramNames, Class[] paramClasses, Object[] paramDefaults, javax.media.jai.util.Range[] validParamValues, OperatorType type, DataType[] outputTypes) This constructor builds an object for IQM use only.
AbstractOperatorDescriptor(String[][] resources, int numSources, String[] paramNames, Class[] paramClasses, Object[] paramDefaults, javax.media.jai.util.Range[] validParamValues, OperatorType type, DataType[] outputTypes, StackProcessingType stackProcessingType) This constructor builds an object for IQM use only.
AbstractOperatorDescriptor(String[][] resources, String[] supportedModes, int numSources, String[] paramNames, Class[] paramClasses, Object[] paramDefaults, javax.media.jai.util.Range[] validParamValues, OperatorType type, DataType[] outputTypes) This constructor builds an object for both JAI and IQM usage.
AbstractOperatorDescriptor(String[][] resources, String[] supportedModes, int numSources, String[] paramNames, Class[] paramClasses, Object[] paramDefaults, javax.media.jai.util.Range[] validParamValues, OperatorType type, DataType[] outputTypes, StackProcessingType stackProcessingType) This constructor builds an object for both JAI and IQM usage.

Method Summary

Modifier and Type	Method and Description
String	getArgumentDescription(int index)
String	getDescription()
String	getDocURL()
String	getName()
int	getNumSources() Returns the number of sources required by this operation.
List<DataType>	getOutputTypes() Returns a list of data types, this operator is able to produce.
Class[]	getParamClasses()
Object[]	getParamDefaults()
String[]	getParamNames()
protected ResourceBundle	getResourceBundle()
String[][]	getResources()
StackProcessingType	getStackProcessingType()
OperatorType	getType()
javax.media.jai.util.Range[]	getValidParamValues()
String	getVendor()
String	getVersion()
String	toString()

Methods inherited from class javax.media.jai.OperationDescriptorImpl

arePropertiesSupported, getDefaultSourceClass, getDestClass, getDestClass, getInvalidRegion, getNumParameters, getParamDefaultValue, getParameterListDescriptor, getParamMaxValue, getParamMinValue, getPropertyGenerators, getPropertyGenerators, getRenderableDestClass, getRenderableSourceClasses, getResourceBundle, getResources, getSourceClasses, getSourceClasses, getSourceNames, getSupportedModes, isImmediate, isModeSupported, isRenderableSupported, isRenderedSupported, makeDefaultSourceClassList, validateArguments, validateArguments, validateParameters, validateParameters, validateRenderableArguments, validateRenderableSources, validateSources, validateSources

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

The UID for serialization.

See Also:

Constant Field Values

type

protected OperatorType type

The type of the operator.

stackProcessingType

protected StackProcessingType stackProcessingType

The type of stack processing.

outputTypes

protected final List<DataType> outputTypes

A list of all data types, this operator can produce.

resources

protected final String[][] resources

numSources

protected final int numSources

paramNames

protected final String[] paramNames

paramClasses

protected final Class[] paramClasses

paramDefaults

protected final Object[] paramDefaults

validParamValues

protected final javax.media.jai.util.Range[] validParamValues

Constructor Detail

AbstractOperatorDescriptor

public AbstractOperatorDescriptor(String[][] resources,
                                  String[] supportedModes,
                                  int numSources,
                                  String[] paramNames,
                                  Class[] paramClasses,
                                  Object[] paramDefaults,
                                  javax.media.jai.util.Range[] validParamValues,
                                  OperatorType type,
                                  DataType[] outputTypes,
                                  StackProcessingType stackProcessingType)

This constructor builds an object for both JAI and IQM usage.

Parameters:

resources - the resources array

supportedModes - the supported modes, see also OperationDescriptorImpl.getSupportedModes()

numSources - the number of sources

paramNames - the names of the parameters

paramClasses - the classes of the parameters

paramDefaults - the default values of the parameters

validParamValues - valid parameter ranges

type - the type of the operator, see OperatorType

outputTypes - the DataTypes this operator is able to produce

stackProcessingType - the stack processing type of the operator, see StackProcessingType

AbstractOperatorDescriptor

public AbstractOperatorDescriptor(String[][] resources,
                                  String[] supportedModes,
                                  int numSources,
                                  String[] paramNames,
                                  Class[] paramClasses,
                                  Object[] paramDefaults,
                                  javax.media.jai.util.Range[] validParamValues,
                                  OperatorType type,
                                  DataType[] outputTypes)

This constructor builds an object for both JAI and IQM usage.

Parameters:

resources - the resources array

supportedModes - the supported modes, see also OperationDescriptorImpl.getSupportedModes()

numSources - the number of sources

paramNames - the names of the parameters

paramClasses - the classes of the parameters

paramDefaults - the default values of the parameters

validParamValues - valid parameter ranges

type - the type of the operator, see OperatorType

outputTypes - the DataTypes this operator is able to produce

AbstractOperatorDescriptor

public AbstractOperatorDescriptor(String[][] resources,
                                  int numSources,
                                  String[] paramNames,
                                  Class[] paramClasses,
                                  Object[] paramDefaults,
                                  javax.media.jai.util.Range[] validParamValues,
                                  OperatorType type,
                                  DataType[] outputTypes,
                                  StackProcessingType stackProcessingType)

This constructor builds an object for IQM use only.

The super constructor of OperationDescriptorImpl is overloaded and the value of supportedModes is overwritten by

 new String[] { "IQMCustom" }
 

Parameters:

resources - the resources array

numSources - the number of sources

paramNames - the names of the parameters

paramClasses - the classes of the parameters

paramDefaults - the default values of the parameters

validParamValues - valid parameter ranges

type - the type of the operator, see OperatorType

outputTypes - the DataTypes this operator is able to produce

stackProcessingType - the stack processing type of the operator, see StackProcessingType

AbstractOperatorDescriptor

public AbstractOperatorDescriptor(String[][] resources,
                                  int numSources,
                                  String[] paramNames,
                                  Class[] paramClasses,
                                  Object[] paramDefaults,
                                  javax.media.jai.util.Range[] validParamValues,
                                  OperatorType type,
                                  DataType[] outputTypes)

This constructor builds an object for IQM use only.

The super constructor of OperationDescriptorImpl is overloaded and the value of supportedModes is overwritten by

 new String[] { "IQMCustom" }
 

Parameters:

resources - the resources array

numSources - the number of sources

paramNames - the names of the parameters

paramClasses - the classes of the parameters

paramDefaults - the default values of the parameters

validParamValues - valid parameter ranges

type - the type of the operator, see OperatorType

outputTypes - the DataTypes this operator is able to produce

Method Detail

getNumSources

public int getNumSources()

Returns the number of sources required by this operation. All modes have the same number of sources.

Specified by:

getNumSources in interface IOperatorDescriptor

Specified by:

getNumSources in interface javax.media.jai.OperationDescriptor

Overrides:

getNumSources in class javax.media.jai.OperationDescriptorImpl

Returns:

the required number of sources

getName

public String getName()

Specified by:

getName in interface IOperatorDescriptor

Specified by:

getName in interface javax.media.jai.RegistryElementDescriptor

Overrides:

getName in class javax.media.jai.OperationDescriptorImpl

Returns:

the unique name of the operator

getType

public OperatorType getType()

Specified by:

getType in interface IOperatorDescriptor

Returns:

the OperatorType

getVendor

public String getVendor()

getDescription

public String getDescription()

getArgumentDescription

public String getArgumentDescription(int index)

getVersion

public String getVersion()

getDocURL

public String getDocURL()

getResources

public String[][] getResources()

Specified by:

getResources in interface IOperatorDescriptor

Returns:

the defined resources

getParamNames

public String[] getParamNames()

Specified by:

getParamNames in interface IOperatorDescriptor

Specified by:

getParamNames in interface javax.media.jai.OperationDescriptor

Overrides:

getParamNames in class javax.media.jai.OperationDescriptorImpl

Returns:

the parameters' names

getParamClasses

public Class[] getParamClasses()

Specified by:

getParamClasses in interface IOperatorDescriptor

Specified by:

getParamClasses in interface javax.media.jai.OperationDescriptor

Overrides:

getParamClasses in class javax.media.jai.OperationDescriptorImpl

Returns:

the parameters' classes

getParamDefaults

public Object[] getParamDefaults()

Specified by:

getParamDefaults in interface IOperatorDescriptor

Specified by:

getParamDefaults in interface javax.media.jai.OperationDescriptor

Overrides:

getParamDefaults in class javax.media.jai.OperationDescriptorImpl

Returns:

the default settings of the parameters

getValidParamValues

public javax.media.jai.util.Range[] getValidParamValues()

Specified by:

getValidParamValues in interface IOperatorDescriptor

Returns:

the valid ranges of the parameters

getResourceBundle

protected ResourceBundle getResourceBundle()

toString

public String toString()

Overrides:

toString in class Object

getStackProcessingType

public StackProcessingType getStackProcessingType()

Specified by:

getStackProcessingType in interface IOperatorDescriptor

Returns:

the StackProcessingType

getOutputTypes

public List<DataType> getOutputTypes()

Description copied from interface: IOperatorDescriptor

Returns a list of data types, this operator is able to produce.

Specified by:

getOutputTypes in interface IOperatorDescriptor

Returns:

a list of data types, this operator is able to produce