Sobel

Apply a Sobel filter to an image.

Constructor

new Sobel()

Classes

Sobel

Methods

activate(_bool)

Activate the filter.

Parameters:
NameTypeDescription
_boolboolean

Flag to activate or not.

addEventListener(type, callback)

Add an event listener to this class.

Parameters:
NameTypeDescription
typestring

The event type.

callbackfunction

The function associated with the provided event type, will be called with the fired event.

getName() → {string}

Get the name of the filter.

Returns:

The name of the filter.

Type: 
string

getOriginalImage() → {Image}

Get the original image.

Returns:

The original image.

Type: 
Image

init()

Initialise the filter. Called once the image is loaded.

removeEventListener(type, callback)

Remove an event listener from this class.

Parameters:
NameTypeDescription
typestring

The event type.

callbackfunction

The function associated with the provided event type.

run(args)

Run the filter.

Parameters:
NameTypeDescription
args*

The filter arguments.

setOriginalImage(image)

Set the original image.

Parameters:
NameTypeDescription
imageImage

The original image.

update() → {Image}

Transform the main image using this filter.

Returns:

The transformed image.

Type: 
Image

Sobel Sobel

Sobel filter tool.

Constructor

new Sobel(app)

Parameters:
NameTypeDescription
appApp

The associated application.

Classes

Sobel

Methods

activate(_bool)

Activate the filter.

Parameters:
NameTypeDescription
_boolboolean

Flag to activate or not.

addEventListener(type, callback)

Add an event listener to this class.

Parameters:
NameTypeDescription
typestring

The event type.

callbackfunction

The function associated with the provided event type, will be called with the fired event.

getName() → {string}

Get the name of the filter.

Returns:

The name of the filter.

Type: 
string

getOriginalImage() → {Image}

Get the original image.

Returns:

The original image.

Type: 
Image

init()

Initialise the filter. Called once the image is loaded.

removeEventListener(type, callback)

Remove an event listener from this class.

Parameters:
NameTypeDescription
typestring

The event type.

callbackfunction

The function associated with the provided event type.

run(args)

Run the filter.

Parameters:
NameTypeDescription
args*

The filter arguments.

setOriginalImage(image)

Set the original image.

Parameters:
NameTypeDescription
imageImage

The original image.

update() → {Image}

Transform the main image using this filter.

Returns:

The transformed image.

Type: 
Image