Class: PamDiff

PamDiff(optionsopt, callbackopt)

new PamDiff(optionsopt, callbackopt)

Parameters:
Name Type Attributes Description
options Object <optional>
Properties
Name Type Attributes Default Description
difference Number <optional>
5 Pixel difference value, int 1 to 255
percent Number <optional>
5 Percent of pixels or blobs that exceed difference value, float 0.0 to 100.0
response String <optional>
percent Accepted values: percent or bounds or blobs
regions Array <optional>
Array of region objects
regions[i].name String Name of region
regions[i].difference Number <optional>
options.difference Difference value for region, int 1 to 255
regions[i].percent Number <optional>
options.percent Percent value for region, float 0.0 to 100.0
regions[i].polygon Array Array of x y coordinates [{x:0,y:0},{x:0,y:360},{x:160,y:360},{x:160,y:0}]
mask Boolean <optional>
false Indicate if regions should be used as masks of pixels to ignore
draw Boolean <optional>
false If true and response is 'bounds' or 'blobs', return a pixel buffer with drawn bounding box
debug Boolean <optional>
false If true, debug object will be attached to output
callback function <optional>
Function to be called when diff event occurs. Deprecated
Source:

Members

callback

Deprecated:
  • Yes
Source:

callback

Deprecated:
  • Yes
Source:

config

Source:

config

Source:

debug

Source:

debug

Source:

difference

Source:

difference

Source:

draw

Source:

draw

Source:

mask

Source:

mask

Source:

percent

Source:

percent

Source:

regions

Source:

regions

Source:

response

Source:

response

Source:

Methods

reset() → {PamDiff}

Source:
Returns:
Type
PamDiff

resetCache() → {PamDiff}

Deprecated:
  • Yes
Source:
Returns:
Type
PamDiff

setCallback(func) → {PamDiff}

Parameters:
Name Type Description
func function
Deprecated:
  • Yes
Source:
Returns:
Type
PamDiff

setDebug(bool) → {PamDiff}

Parameters:
Name Type Description
bool Boolean
Deprecated:
  • Yes
Source:
Returns:
Type
PamDiff

setDifference(num) → {PamDiff}

Parameters:
Name Type Description
num Number
Deprecated:
  • Yes
Source:
Returns:
Type
PamDiff

setDraw(bool) → {PamDiff}

Parameters:
Name Type Description
bool Boolean
Deprecated:
  • Yes
Source:
Returns:
Type
PamDiff

setMask(bool) → {PamDiff}

Parameters:
Name Type Description
bool Boolean
Deprecated:
  • Yes
Source:
Returns:
Type
PamDiff

setPercent(num) → {PamDiff}

Parameters:
Name Type Description
num Number
Deprecated:
  • Yes
Source:
Returns:
Type
PamDiff

setRegions(arr) → {PamDiff}

Parameters:
Name Type Description
arr Array.<Object>
Deprecated:
  • Yes
Source:
Returns:
Type
PamDiff

setResponse(str) → {PamDiff}

Parameters:
Name Type Description
str String
Deprecated:
  • Yes
Source:
Returns:
Type
PamDiff