com.explodingbacon.bcnlib.vision

Class Image

java.lang.Object

com.explodingbacon.bcnlib.vision.Image

Direct Known Subclasses:

Contour

public class Image
extends java.lang.Object

A wrapper class for OpenCV's Mat object.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.opencv.core.Mat	m

Constructor Summary

Constructors

Constructor and Description
Image()
Image(org.opencv.core.Mat m)

Method Summary

Modifier and Type	Method and Description
double	compareTo(Image i) Compares this Image to another Image.
Image	copy() Creates an identical copy of this Image.
void	drawArrow(double x, double y, double x2, double y2, Color c) Draws an arrow on this Image.
void	drawCircle(int x, int y, int radius, Color c) Draws a circle on this Image.
void	drawContours(java.util.List<Contour> con, Color c) Draws Contours onto this Image.
void	drawLine(int x, Color c) Draws a centered line the length of this Image onto this Image.
void	drawLine(int x, int height, Color c) Draws a centered line on this Image.
void	drawLine(int x, int y, int height, Color c) Draws a line on this Image.
void	drawRectangle(int x, int y, int x2, int y2, Color c) Draws a Rectangle on this Image.
void	drawRectangle(Rectangle r, Color c) Draws a Rectangle on this Image.
void	drawText(java.lang.String text, int x, int y, double scale, Color color) Draws text on this Image.
static Image	fromFile(java.lang.String fileName) Creates an Image from an existing image file.
java.util.List<Contour>	getContours() Gets the Contours in this Image.
java.util.List<Rectangle>	getFaces() Gets all the human faces in this Image.
double	getHeight() Gets the height of this Image.
org.opencv.core.Mat	getMat() Gets the internal Map of this Image.
double	getWidth() Gets the width of this Image.
Image	inRange(BCNScalar low, BCNScalar high) Finds objects within a certain range.
void	release() Releases this Image from memory.
Image	resize(int width, int height) Creates a resized version of this Image.
void	saveAs(java.lang.String fileName) Saves this Image as a file.
void	setMat(org.opencv.core.Mat newMat) Sets the internal Map of this Image.
byte[]	toBytes() Converts this Image to a byte array.
void	toHSV() Converts this image to HSV.

Methods inherited from class java.lang.Object

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

Field Detail

m

protected org.opencv.core.Mat m

Constructor Detail

Image

public Image()

Image

public Image(org.opencv.core.Mat m)

Method Detail

getWidth

public double getWidth()

Gets the width of this Image.

Returns:

The width of this Image.

getHeight

public double getHeight()

Gets the height of this Image.

Returns:

The height of this Image.

getContours

public java.util.List<Contour> getContours()

Gets the Contours in this Image.

Returns:

The Contours in this Image.

getFaces

public java.util.List<Rectangle> getFaces()

Gets all the human faces in this Image.

Returns:

All the human faces in this Image.

inRange

public Image inRange(BCNScalar low,
                     BCNScalar high)

Finds objects within a certain range. Anything outside this range becomes black, anything in the range becomes white.

Parameters:

low - The lowest value.

high - The highest value.

Returns:

This Image, for convenience.

toHSV

public void toHSV()

Converts this image to HSV.

copy

public Image copy()

Creates an identical copy of this Image.

Returns:

An identical copy of this Image.

drawLine

public void drawLine(int x,
                     int y,
                     int height,
                     Color c)

Draws a line on this Image.

Parameters:

x - The X coordinate of the line.

y - The Y coordinate of the line.

height - The height of the line.

c - The Color of the line.

drawLine

public void drawLine(int x,
                     int height,
                     Color c)

Draws a centered line on this Image.

Parameters:

x - The X coordinate of the line.

height - The height of the line.

c - The Color of the line.

drawLine

public void drawLine(int x,
                     Color c)

Draws a centered line the length of this Image onto this Image.

Parameters:

x - The X coordinate of the line.

c - The Color of the line.

drawRectangle

public void drawRectangle(Rectangle r,
                          Color c)

Draws a Rectangle on this Image.

Parameters:

r - The Rectangle to draw.

c - The Color of the Rectangle.

drawRectangle

public void drawRectangle(int x,
                          int y,
                          int x2,
                          int y2,
                          Color c)

Draws a Rectangle on this Image.

Parameters:

x - The X coordinate of the Rectangle.

y - The Y coordinate of the Rectangle.

x2 - The second X coordinate of the Rectangle.

y2 - The second Y coordinate of the Rectangle.

c - The Color of the Rectangle.

drawCircle

public void drawCircle(int x,
                       int y,
                       int radius,
                       Color c)

Draws a circle on this Image.

Parameters:

x - The X coordinate of the center of the circle.

y - The Y coordinate of the center of the circle.

radius - The radius of the circle.

c - The Color of the circle.

drawContours

public void drawContours(java.util.List<Contour> con,
                         Color c)

Draws Contours onto this Image.

Parameters:

con - The Contours to be drawn.

c - The Color of the Contours.

drawArrow

public void drawArrow(double x,
                      double y,
                      double x2,
                      double y2,
                      Color c)

Draws an arrow on this Image.

Parameters:

x - The X coordinate of the arrow.

y - The Y coordinate of the arrow.

x2 - The second X coordinate of the arrow.

y2 - The second Y coordinate of the arrow.

c - The Color of the arrow.

drawText

public void drawText(java.lang.String text,
                     int x,
                     int y,
                     double scale,
                     Color color)

Draws text on this Image.

Parameters:

text - The text to be drawn.

x - The X coordinate of the text's starting point.

y - The Y coordinate of the text's starting point.

scale - The scale of the text.

color - The Color of the text.

compareTo

public double compareTo(Image i)

Compares this Image to another Image.

Parameters:

i - The Image this Image is being compared to.

Returns:

How similar this Image is to the other Image.

resize

public Image resize(int width,
                    int height)

Creates a resized version of this Image. TODO: test

Returns:

A resized version of this Image.

toBytes

public byte[] toBytes()

Converts this Image to a byte array. TODO: test

Returns:

This Image in byte array form.

saveAs

public void saveAs(java.lang.String fileName)

Saves this Image as a file.

Parameters:

fileName - The name of the file.

release

public void release()

Releases this Image from memory. This object isn't usable after you call this.

getMat

public org.opencv.core.Mat getMat()

Gets the internal Map of this Image. Should be used when you need functionality not provided by BCNLib, but available in OpenCV.

Returns:

The internal Map of this Image.

setMat

public void setMat(org.opencv.core.Mat newMat)

Sets the internal Map of this Image.

Parameters:

newMat - The new Map to be used.

fromFile

public static Image fromFile(java.lang.String fileName)

Creates an Image from an existing image file.

Parameters:

fileName - The name of the image file.

Returns:

The new Image.