|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
Method Summary | |
---|---|
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 |
---|
Object getResult()
int getDimensionality()
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.
boolean isConvertableToNumericalData()
If this method returns true it is expected that for each component of
the result the method getNumericalValue(int)
returns a
proper numerical value.
double getNumericalValue(int dim)
This method is linked to isConvertableToNumericalData()
, i.e.
is only expected to return proper results if that function returns true.
dim
- Index of the desired component of the result.
String getTableEntry(int dim)
dim
- Index of the desired component of the result.
String getOpIdentifier()
The string is for example included in the headers of result tables.
String getResultIdentifier(int dim)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |