de.lmu.ifi.dbs.jfeaturelib.edgeDetector

Class Kernel

java.lang.Object

de.lmu.ifi.dbs.jfeaturelib.edgeDetector.AbstractDescriptor

de.lmu.ifi.dbs.jfeaturelib.edgeDetector.Kernel

All Implemented Interfaces:

Descriptor

public class Kernel
extends AbstractDescriptor

Performs convolution with a given Kernel directly on this image. Basiacally it is just a wrapper for ImageJ's ImageProcessor.convolve(). Predefined masks are SOBEL, SCHARR, PREWITT

Author:

Benedikt, Franz

See Also:

ImageProcessor.convolve(float[], int, int)

Nested Class Summary

Nested classes/interfaces inherited from interface de.lmu.ifi.dbs.jfeaturelib.Descriptor

Descriptor.Supports

Field Summary

Fields

Modifier and Type	Field and Description
static float[]	PREWITT 3x3 PREWITT mask (-1, 0, 1, ...)
static float[]	SCHARR Standard 3x3 SCHARR mask (1 0 -1, 2, 0, -2, 1, 0, -1 ) See http://en.wikipedia.org/wiki/Sobel_operator
static float[]	SOBEL Standard 3x3 SOBEL mask (1 0 -1, 2, 0, -2, 1, 0, -1 ) See http://en.wikipedia.org/wiki/Sobel_operator

Fields inherited from interface de.lmu.ifi.dbs.jfeaturelib.Descriptor

DOES_ALL

Constructor Summary

Constructors

Constructor and Description
Kernel() Constructs a new detector with standart Sobel kernel
Kernel(double[] kernel) Constructs a new detector with given double[] kernel.
Kernel(float[] kernel) Constructs a new detector with given float[] kernel and according width.
Kernel(float[] kernel, int width) Constructs a new detector with given float[] kernel and according width.

Method Summary

Methods

Modifier and Type	Method and Description
float[]	getKernel() Return the convolution kernel before transformation
int	getKernelWidth() Returns width of the kernel
int	getTreshold() Returns treshold
void	process() Proceses the image applying the kernel in x- and y-direction
void	run(ij.process.ImageProcessor ip) Start processing of this algorithm on the given image processor.
void	setKernel(float[] kernel) Sets the convolution kernel (must be odd sized).
void	setKernelWidth(int kernelWidth) Deprecated. since 1.5.0
void	setTreshold(int treshold) Setter for treshold, default zero
EnumSet<Descriptor.Supports>	supports() Defines the capability of the algorithm.

Methods inherited from class de.lmu.ifi.dbs.jfeaturelib.edgeDetector.AbstractDescriptor

addPropertyChangeListener, endProgress, setProperties, startProgress

Methods inherited from class java.lang.Object

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

Field Detail

SOBEL

public static final float[] SOBEL

Standard 3x3 SOBEL mask (1 0 -1, 2, 0, -2, 1, 0, -1 ) See http://en.wikipedia.org/wiki/Sobel_operator

SCHARR

public static final float[] SCHARR

Standard 3x3 SCHARR mask (1 0 -1, 2, 0, -2, 1, 0, -1 ) See http://en.wikipedia.org/wiki/Sobel_operator

PREWITT

public static final float[] PREWITT

3x3 PREWITT mask (-1, 0, 1, ...) See http://en.wikipedia.org/wiki/Prewitt_operator

Constructor Detail

Kernel

public Kernel()

Constructs a new detector with standart Sobel kernel

Kernel

public Kernel(double[] kernel)

Constructs a new detector with given double[] kernel. The double array is converted immediately to a float array.

Parameters:

kernel - double[] with kernel

Kernel

public Kernel(float[] kernel)

Constructs a new detector with given float[] kernel and according width.

Parameters:

kernel - float[] with kernel

Kernel

public Kernel(float[] kernel,
      int width)

Constructs a new detector with given float[] kernel and according width.

Parameters:

kernel - float[] with kernel

width - width of kernel

Method Detail

getKernel

public float[] getKernel()

Return the convolution kernel before transformation

Returns:

float[] with kernel

setKernel

public void setKernel(float[] kernel)

Sets the convolution kernel (must be odd sized).

Parameters:

kernel - float[] with kernel

Throws:

IllegalArgumentException - if the size is even

getKernelWidth

public int getKernelWidth()

Returns width of the kernel

Returns:

int with width of kernel

setKernelWidth

@Deprecated
public void setKernelWidth(int kernelWidth)

Deprecated. since 1.5.0

Setter for width of the kernel

Parameters:

kernelWidth - int with width

getTreshold

public int getTreshold()

Returns treshold

Returns:

treshold

setTreshold

public void setTreshold(int treshold)

Setter for treshold, default zero

Parameters:

treshold -

process

public void process()

Proceses the image applying the kernel in x- and y-direction

supports

public EnumSet<Descriptor.Supports> supports()

Defines the capability of the algorithm.

Returns:

the set of supported capabilities.

See Also:

PlugInFilter, supports()

run

public void run(ij.process.ImageProcessor ip)

Description copied from interface: Descriptor

Start processing of this algorithm on the given image processor. Keep in mind that if the imageProcessor is changed, Supports.NoChanges must not be set. This is also the case even if only ImageProcessor.snapshot() is used.

Parameters:

ip - ImageProcessor of the source image