CategorizationResult (Java Image Hash 1.0.0 API)

java.lang.Object
- dev.brachtendorf.jimagehash.matcher.categorize.CategorizationResult

```
public class CategorizationResult
extends Object
```
A categorization result describes the membership to a cluster. It contains the identifier of the category this image was matched to as well as a quality measurement.
The quality metric is depended on the the actual implementation of the categorizer.
Categorization results can be nested in case that multiple categorizers are chained together. The first result will point to the categorization result of the main matcher. The next to the first nested categorizer.
Categorization results are only valid at the time they are created and may represent an invalid state as soon as the categorizer who produces this stage was changed.

Since:

3.0.0

Author:

Kilian

See Also:

CategoricalImageMatcher

Field Summary

Fields
Modifier and Type Field Description

protected int category

protected double qualityMeasurement

protected CategorizationResult subResult

Constructor Summary

Constructors
Constructor Description

CategorizationResult(int category, double qualityMeasurement)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addCategory(CategorizationResult catgeorizationResult)`
`int`	`getCategory()`	Get the category of this result object.
`double`	`getQuality()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

category
```
protected int category
```

qualityMeasurement
```
protected double qualityMeasurement
```

subResult

protected CategorizationResult subResult

Constructor Detail

CategorizationResult

public CategorizationResult(int category,
                            double qualityMeasurement)

Method Detail
- getCategory
```
public int getCategory()
```
  Get the category of this result object. The category uniquely identifies the cluster this image was matched to.
  
  Returns:
  
  the category
- getQuality
```
public double getQuality()
```
- addCategory
```
public void addCategory(CategorizationResult catgeorizationResult)
```
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object