LabeledImage (Java Image Hash 1.0.0 API)

java.lang.Object
- dev.brachtendorf.jimagehash.matcher.categorize.supervised.LabeledImage

All Implemented Interfaces:

Comparable<LabeledImage>
```
public class LabeledImage
extends Object
implements Comparable<LabeledImage>
```
A labeled image used to benchmark hashing algorithms.
Labeled images bind an image to a category. All images in the same category are expected to produce a match if an image matcher is queried.

Since:

2.0.0, 2.1.1 moved to new file, 2.2.0 renamed to LabeledImage previously TestData

Author:

Kilian

Field Summary

Fields
Modifier and Type	Field	Description
`protected BufferedImage`	`bImage`	The image to test
`protected int`	`category`	The category of the image.
`protected String`	`name`	A character representation of the file for easy feedback

Constructor Summary

Constructors
Constructor Description

LabeledImage(int category, File f)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`compareTo(LabeledImage o)`
`boolean`	`equals(Object obj)`
`BufferedImage`	`getbImage()`
`int`	`getCategory()`
`String`	`getName()`
`int`	`hashCode()`
`String`	`toString()`

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

- Field Detail
  - name
```
protected String name
```
    A character representation of the file for easy feedback
  - category
```
protected int category
```
    The category of the image. Same categories equals similar images
  - bImage
```
protected BufferedImage bImage
```
    The image to test
- Constructor Detail
  - LabeledImage
```
public LabeledImage(int category,
                    File f)
```
    Parameters:
    
    category - The image category. Images with the same category are expected to be classified as similar images
    
    f - The Fie pointing to the image
- Method Detail
  - compareTo
```
public int compareTo(LabeledImage o)
```
    Specified by:
    
    compareTo in interface Comparable<LabeledImage>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - getName
```
public String getName()
```
    Returns:
    
    the name
  - getCategory
```
public int getCategory()
```
    Returns:
    
    the category
  - getbImage
```
public BufferedImage getbImage()
```
    Returns:
    
    the bImage