de.unihalle.informatik.MiToBo.features

Interface FeatureCalculatorResult

All Known Implementing Classes:

FeatureCalculatorHaralickMeasuresResult, FeatureCalculatorIntensityStatsResult, FeatureCalculatorLBPResult

public interface FeatureCalculatorResult

Interface for result data returned from classes extending FeatureCalculator.

In principal any kind of object could be used as result object. For easier handling of the result object, in particular in a generic fashion, it is only mandatory to implement the method toString() which should return a proper textual representation of the result. This textual value is for example used within the result table shown in the GUI or on writing the results to file.

Author:

moeller

Method Summary

Modifier and Type	Method and Description
int	getDimensionality() Returns the dimension of the result object.
double	getNumericalValue(int dim) Returns a numerical value representing the requested result component.
String	getOpIdentifier() Method returns an identifier characterizing the operator.
Object	getResult() Returns the result data object of the calculator.
String	getResultIdentifier(int dim) Method returns an identifier characterizing the related component of the result.
String	getTableEntry(int dim) Returns entry in requested field as string representation.
boolean	isConvertableToNumericalData() Indicates if result data can be 'condensed' to numerical values, e.g., for visualization purposes.

Method Detail

getResult

Object getResult()

Returns the result data object of the calculator.

Returns:

Result data object.

getDimensionality

int getDimensionality()

Returns the dimension of the result object.

If a single object or value is calculated the dimension should be one. In case of, e.g., arrays containing multiple values the length of the array should be returned.

Returns:

Dimensionality of the result data.

isConvertableToNumericalData

boolean isConvertableToNumericalData()

Indicates if result data can be 'condensed' to numerical values, e.g., for visualization purposes.

If this method returns true it is expected that for each component of the result the method getNumericalValue(int) returns a proper numerical value.

Returns:

True, if result data can be represented numerically.

getNumericalValue

double getNumericalValue(int dim)

Returns a numerical value representing the requested result component.

This method is linked to isConvertableToNumericalData(), i.e. is only expected to return proper results if that function returns true.

Parameters:

dim - Index of the desired component of the result.

Returns:

Numerical result value.

getTableEntry

String getTableEntry(int dim)

Returns entry in requested field as string representation.

Parameters:

dim - Index of the desired component of the result.

Returns:

String representation of the value.

getOpIdentifier

String getOpIdentifier()

Method returns an identifier characterizing the operator.

The string is for example included in the headers of result tables.

Returns:

Identifier string.

getResultIdentifier

String getResultIdentifier(int dim)

Method returns an identifier characterizing the related component of the result.

Parameters:

dim - Dimension identifier is requested for.

Returns:

Identifier string.