com.github.sarxos.webcam

Interface WebcamMotionDetectorAlgorithm

All Known Implementing Classes:

WebcamMotionDetectorDefaultAlgorithm

public interface WebcamMotionDetectorAlgorithm

Implementation of this interface is responsible for decision whether the difference between two images represents movement or not. Instance may specified as parameter of WebcamMotionDetector constructor, otherwise WebcamMotionDetectorDefaultAlgorithm is used.

Method Summary

Modifier and Type	Method and Description
boolean	detect(java.awt.image.BufferedImage previous, java.awt.image.BufferedImage current) Detects motion by comparison of the two specified images content.
java.awt.image.BufferedImage	filter(java.awt.image.BufferedImage original) WebcamMotionDetector calls this method for each image used as parameter of the method detect(BufferedImage, BufferedImage).
double	getArea() Get percentage fraction of image covered by motion.
java.awt.Point	getCog() Get motion center of gravity.
int	getMaxPoints() Get the current max amount of points that can be detected at one time
int	getPointRange() Get the current minimum range between each point
java.util.ArrayList<java.awt.Point>	getPoints() Returns the currently stored points that have been detected
void	setDoNotEngageZones(java.util.List<java.awt.Rectangle> bounds) Set list of the rectangular zones where motion detection should be ignored.
void	setMaxPoints(int i) Set the max amount of points that can be detected at one time
void	setPointRange(int i) Set the minimum range between each point detected

Method Detail

filter

java.awt.image.BufferedImage filter(java.awt.image.BufferedImage original)

WebcamMotionDetector calls this method for each image used as parameter of the method detect(BufferedImage, BufferedImage). Implementation may transform the original image and prepare it for comparison of two images. May return the same instance if no there is no need to transform.

Parameters:

original - image

Returns:

modified image

detect

boolean detect(java.awt.image.BufferedImage previous,
               java.awt.image.BufferedImage current)

Detects motion by comparison of the two specified images content. filter(BufferedImage) method was called for both specified images.

Parameters:

previous -

current -

Returns:

If the motion was detected returns true, otherwise returns false

getCog

java.awt.Point getCog()

Get motion center of gravity. When no motion is detected this value points to the image center. May return null before the first movement check.

Returns:

Center of gravity point

getArea

double getArea()

Get percentage fraction of image covered by motion. 0 means no motion on image and 100 means full image covered by spontaneous motion.

Returns:

Return percentage image fraction covered by motion

setPointRange

void setPointRange(int i)

Set the minimum range between each point detected

Parameters:

i - the range to set

setMaxPoints

void setMaxPoints(int i)

Set the max amount of points that can be detected at one time

Parameters:

i - The amount of points that can be detected

getPointRange

int getPointRange()

Get the current minimum range between each point

Returns:

The current range

getMaxPoints

int getMaxPoints()

Get the current max amount of points that can be detected at one time

Returns:

getPoints

java.util.ArrayList<java.awt.Point> getPoints()

Returns the currently stored points that have been detected

Returns:

The current points

setDoNotEngageZones

void setDoNotEngageZones(java.util.List<java.awt.Rectangle> bounds)

Set list of the rectangular zones where motion detection should be ignored.

Parameters:

bounds - the list of rectangles to ignore