WebcamMotionDetectorDefaultAlgorithm (Webcam Capture 0.3.12 API)

java.lang.Object
- com.github.sarxos.webcam.WebcamMotionDetectorDefaultAlgorithm

All Implemented Interfaces:: WebcamMotionDetectorAlgorithm

public class WebcamMotionDetectorDefaultAlgorithm
extends java.lang.Object
implements WebcamMotionDetectorAlgorithm

Author:: kevin

Field Summary

Fields
Modifier and Type	Field and Description
`static double`	`DEFAULT_AREA_THREASHOLD` Default percentage image area fraction threshold (set to 0.2%).
`static double`	`DEFAULT_AREA_THREASHOLD_MAX` Default max percentage image area fraction threshold (set to 100%).
`static int`	`DEFAULT_MAX_POINTS` The default for the max amount of points that can be detected at one time
`static int`	`DEFAULT_PIXEL_THREASHOLD` Default pixel difference intensity threshold (set to 25).
`static int`	`DEFAULT_RANGE` The default minimum range between each point where motion has been detected

Constructor Summary

Constructors
Constructor and Description
`WebcamMotionDetectorDefaultAlgorithm()` Creates default motion detector algorithm with default pixel and area thresholds.
`WebcamMotionDetectorDefaultAlgorithm(int pixelThreshold, double areaThreshold)` Creates default motion detector algorithm.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`detect(java.awt.image.BufferedImage previousModified, java.awt.image.BufferedImage currentModified)` 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 `WebcamMotionDetectorAlgorithm.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
`java.util.ArrayList<java.lang.Integer>`	`getThresholds()`
`void`	`setAreaThreshold(double threshold)` Set percentage fraction of detected motion area threshold above which it is classified as "moved".
`void`	`setDoNotEngageZones(java.util.List<java.awt.Rectangle> doNotEngageZones)` Set list of the rectangular zones where motion detection should be ignored.
`void`	`setMaxAreaThreshold(double threshold)` Set max percentage fraction of detected motion area threshold, below which it is classified as "moved".
`void`	`setMaxPoints(int i)` Set the max amount of points that can be detected at one time
`void`	`setPixelThreshold(int threshold)` Set pixel intensity difference threshold above which pixel is classified as "moved".
`void`	`setPointRange(int i)` Set the minimum range between each point detected

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

- Field Detail
  - DEFAULT_PIXEL_THREASHOLD
```
public static final int DEFAULT_PIXEL_THREASHOLD
```
    Default pixel difference intensity threshold (set to 25).
    
    See Also:
    
    Constant Field Values
  - DEFAULT_AREA_THREASHOLD
```
public static final double DEFAULT_AREA_THREASHOLD
```
    Default percentage image area fraction threshold (set to 0.2%).
    
    See Also:
    
    Constant Field Values
  - DEFAULT_AREA_THREASHOLD_MAX
```
public static final double DEFAULT_AREA_THREASHOLD_MAX
```
    Default max percentage image area fraction threshold (set to 100%).
    
    See Also:
    
    Constant Field Values
  - DEFAULT_RANGE
```
public static final int DEFAULT_RANGE
```
    The default minimum range between each point where motion has been detected
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_POINTS
```
public static final int DEFAULT_MAX_POINTS
```
    The default for the max amount of points that can be detected at one time
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - WebcamMotionDetectorDefaultAlgorithm
```
public WebcamMotionDetectorDefaultAlgorithm()
```
    Creates default motion detector algorithm with default pixel and area thresholds.
    
    See Also:
    
    DEFAULT_PIXEL_THREASHOLD, DEFAULT_AREA_THREASHOLD
  - WebcamMotionDetectorDefaultAlgorithm
```
public WebcamMotionDetectorDefaultAlgorithm(int pixelThreshold,
                                            double areaThreshold)
```
    Creates default motion detector algorithm.
    
    Parameters:
    
    pixelThreshold - intensity threshold (0 - 255)
    
    areaThreshold - percentage threshold of image covered by motion
- Method Detail
  - filter
```
public java.awt.image.BufferedImage filter(java.awt.image.BufferedImage original)
```
    Description copied from interface: WebcamMotionDetectorAlgorithm
    
    WebcamMotionDetector calls this method for each image used as parameter of the method WebcamMotionDetectorAlgorithm.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.
    
    Specified by:
    
    filter in interface WebcamMotionDetectorAlgorithm
    
    Parameters:
    
    original - image
    
    Returns:
    
    modified image
  - detect
```
public boolean detect(java.awt.image.BufferedImage previousModified,
                      java.awt.image.BufferedImage currentModified)
```
    Description copied from interface: WebcamMotionDetectorAlgorithm
    
    Detects motion by comparison of the two specified images content. WebcamMotionDetectorAlgorithm.filter(BufferedImage) method was called for both specified images.
    
    Specified by:
    
    detect in interface WebcamMotionDetectorAlgorithm
    
    Returns:
    
    If the motion was detected returns true, otherwise returns false
  - getCog
```
public java.awt.Point getCog()
```
    Description copied from interface: WebcamMotionDetectorAlgorithm
    
    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.
    
    Specified by:
    
    getCog in interface WebcamMotionDetectorAlgorithm
    
    Returns:
    
    Center of gravity point
  - getArea
```
public double getArea()
```
    Description copied from interface: WebcamMotionDetectorAlgorithm
    
    Get percentage fraction of image covered by motion. 0 means no motion on image and 100 means full image covered by spontaneous motion.
    
    Specified by:
    
    getArea in interface WebcamMotionDetectorAlgorithm
    
    Returns:
    
    Return percentage image fraction covered by motion
  - setPixelThreshold
```
public void setPixelThreshold(int threshold)
```
    Set pixel intensity difference threshold above which pixel is classified as "moved". Minimum value is 0 and maximum is 255. Default value is 10. This value is equal for all RGB components difference.
    
    Parameters:
    
    threshold - the pixel intensity difference threshold
    
    See Also:
    
    DEFAULT_PIXEL_THREASHOLD
  - setAreaThreshold
```
public void setAreaThreshold(double threshold)
```
    Set percentage fraction of detected motion area threshold above which it is classified as "moved". Minimum value for this is 0 and maximum is 100, which corresponds to full image covered by spontaneous motion.
    
    Parameters:
    
    threshold - the percentage fraction of image area
    
    See Also:
    
    DEFAULT_AREA_THREASHOLD
  - setMaxAreaThreshold
```
public void setMaxAreaThreshold(double threshold)
```
    Set max percentage fraction of detected motion area threshold, below which it is classified as "moved". The max is optionally used to help filter false positives caused by sudden exposure changes. Minimum value for this is 0 and maximum is 100, which corresponds to full image covered by spontaneous motion.
    
    Parameters:
    
    threshold - the percentage fraction of image area
    
    See Also:
    
    DEFAULT_AREA_THREASHOLD_MAX
  - getThresholds
```
public java.util.ArrayList<java.lang.Integer> getThresholds()
```
  - setPointRange
```
public void setPointRange(int i)
```
    Set the minimum range between each point detected
    
    Specified by:
    
    setPointRange in interface WebcamMotionDetectorAlgorithm
    
    Parameters:
    
    i - the range to set
  - getPointRange
```
public int getPointRange()
```
    Get the current minimum range between each point
    
    Specified by:
    
    getPointRange in interface WebcamMotionDetectorAlgorithm
    
    Returns:
    
    The current range
  - setMaxPoints
```
public void setMaxPoints(int i)
```
    Set the max amount of points that can be detected at one time
    
    Specified by:
    
    setMaxPoints in interface WebcamMotionDetectorAlgorithm
    
    Parameters:
    
    i - The amount of points that can be detected
  - getMaxPoints
```
public int getMaxPoints()
```
    Get the current max amount of points that can be detected at one time
    
    Specified by:
    
    getMaxPoints in interface WebcamMotionDetectorAlgorithm
    
    Returns:
  - getPoints
```
public java.util.ArrayList<java.awt.Point> getPoints()
```
    Returns the currently stored points that have been detected
    
    Specified by:
    
    getPoints in interface WebcamMotionDetectorAlgorithm
    
    Returns:
    
    The current points
  - setDoNotEngageZones
```
public void setDoNotEngageZones(java.util.List<java.awt.Rectangle> doNotEngageZones)
```
    Description copied from interface: WebcamMotionDetectorAlgorithm
    
    Set list of the rectangular zones where motion detection should be ignored.
    
    Specified by:
    
    setDoNotEngageZones in interface WebcamMotionDetectorAlgorithm
    
    Parameters:
    
    doNotEngageZones - the list of rectangles to ignore

Class WebcamMotionDetectorDefaultAlgorithm

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_PIXEL_THREASHOLD

DEFAULT_AREA_THREASHOLD

DEFAULT_AREA_THREASHOLD_MAX

DEFAULT_RANGE

DEFAULT_MAX_POINTS

Constructor Detail

WebcamMotionDetectorDefaultAlgorithm

WebcamMotionDetectorDefaultAlgorithm

Method Detail

filter

detect

getCog

getArea

setPixelThreshold

setAreaThreshold

setMaxAreaThreshold

getThresholds

setPointRange

getPointRange

setMaxPoints

getMaxPoints

getPoints

setDoNotEngageZones