Package edu.illinois.cs.cs125.mp6.lib

Class RecognizePhoto

java.lang.Object

edu.illinois.cs.cs125.mp6.lib.RecognizePhoto

public final class RecognizePhoto
extends java.lang.Object

Image recognition class. Each function takes the JSON returned by the Microsoft Cognitive Services API and extracts some piece of information from it.

Constructor Summary

Constructors

Constructor	Description
RecognizePhoto()

Method Summary

Modifier and Type	Method	Description
static java.lang.String	getCaption(java.lang.String json)	Return the caption describing the image created by the Microsoft Cognitive Services API.
static java.lang.String	getFormat(java.lang.String json)	Get the image file type.
static int	getHeight(java.lang.String json)	Get the image height.
static int	getWidth(java.lang.String json)	Get the image width.
static boolean	isACat(java.lang.String json, double minConfidence)	Determine whether the image contains a cat.
static boolean	isADog(java.lang.String json, double minConfidence)	Determine whether the image contains a dog.
static boolean	isRick(java.lang.String json)	Check if image contains Rick Astley.

Methods inherited from class java.lang.Object

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

Constructor Detail

RecognizePhoto

public RecognizePhoto()

Method Detail

getWidth

public static int getWidth(java.lang.String json)

Get the image width.

Parameters:

json - the JSON string returned by the Microsoft Cognitive Services API

Returns:

the width of the image or 0 on failure

getHeight

public static int getHeight(java.lang.String json)

Get the image height.

Parameters:

json - the JSON string returned by the Microsoft Cognitive Services API

Returns:

the width of the image or 0 on failure

getFormat

public static java.lang.String getFormat(java.lang.String json)

Get the image file type.

Parameters:

json - the JSON string returned by the Microsoft Cognitive Services API

Returns:

the type of the image or null

getCaption

public static java.lang.String getCaption(java.lang.String json)

Return the caption describing the image created by the Microsoft Cognitive Services API. If multiple captions are provided your code should return the first one.

Parameters:

json - the JSON string returned by the Microsoft Cognitive Services API

Returns:

the caption describing the image created by the Microsoft or null on failure

isADog

public static boolean isADog(java.lang.String json,
                             double minConfidence)

Determine whether the image contains a dog. You should do this by examining the tags returned by the Cognitive Services API. If a tag with the name "dog" exists with at least the provided confidence, you should return true. Otherwise false.

Parameters:

json - the JSON string returned by the Microsoft Cognitive Services API

minConfidence - the minimum confidence required for this determination

Returns:

a boolean indicating whether the image contains a dog or false on failure

isACat

public static boolean isACat(java.lang.String json,
                             double minConfidence)

Determine whether the image contains a cat. You should do this by examining the tags returned by the Cognitive Services API. If a tag with the name "cat" exists with at least the provided confidence, you should return true. Otherwise false.

Parameters:

json - the JSON string returned by the Microsoft Cognitive Services API

minConfidence - the minimum confidence required for this determination

Returns:

a boolean indicating whether the image contains a cat or false on failure

isRick

public static boolean isRick(java.lang.String json)

Check if image contains Rick Astley. We leave it to you to determine how to do this by examining the JSON returned for various images. Note that you do not need to consider the confidence value to complete this function.

Parameters:

json - the JSON returned by the Microsoft Cognitive Services API

Returns:

true if you've Rickrolled yourself

See Also:

Rickrolling