at.mug.iqm.commons.jaitools

Class KernelFactory

java.lang.Object

at.mug.iqm.commons.jaitools.KernelFactory

public class KernelFactory
extends Object

A factory class with static methods to create a variety of KernelJAI objects with specified geometries

Author:

Michael Bedward

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KernelFactory.ValueType Meaning of the kernel values

Constructor Summary

Constructors

Constructor and Description
KernelFactory()

Method Summary

Modifier and Type	Method and Description
static javax.media.jai.KernelJAI	createAnnulus(int outerRadius, int innerRadius, KernelFactory.ValueType type, float centreValue) Creates a new KernelJAI object with an annular configuration (like a doughnut).
static javax.media.jai.KernelJAI	createCircle(int radius) Create a new KernelJAI object with a circular configuration.
static javax.media.jai.KernelJAI	createCircle(int radius, KernelFactory.ValueType type, float centreValue) Creates a new KernelJAI object with a circular configuration.
static javax.media.jai.KernelJAI	createRectangle(int width, int height) Creates a new KernelJAI object with a rectangular configuraton.
static javax.media.jai.KernelJAI	createRectangle(int width, int height, KernelFactory.ValueType type, int keyX, int keyY, float keyValue) Creates a new KernelJAI object with a rectangular configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

KernelFactory

public KernelFactory()

Method Detail

createCircle

public static javax.media.jai.KernelJAI createCircle(int radius)

Create a new KernelJAI object with a circular configuration. Kernel elements within the circle will have value 1.0f; those outside will have value 0.0f.

This is equivalent to, but faster than, calling...

createCircle(radius, Kernel.ValueType.BINARY, 1.0f)

Parameters:

radius - radius of the circle

Returns:

a new instance of KernelJAI

createCircle

public static javax.media.jai.KernelJAI createCircle(int radius,
                                                     KernelFactory.ValueType type,
                                                     float centreValue)

Creates a new KernelJAI object with a circular configuration. The kernel imgWidth is 2*radius + 1. The kernel's key element is at position x=radius, y=radius

Parameters:

radius - the radius of the circle expressed in pixels

type - one of KernelFactory.ValueType.BINARY, KernelFactory.ValueType.DISTANCE or KernelFactory.ValueType.INVERSE_DISTANCE

centreValue - the value to assign to the kernel centre (key element)

Returns:

a new instance of KernelJAI

createAnnulus

public static javax.media.jai.KernelJAI createAnnulus(int outerRadius,
                                                      int innerRadius,
                                                      KernelFactory.ValueType type,
                                                      float centreValue)

Creates a new KernelJAI object with an annular configuration (like a doughnut). The kernel imgWidth is 2*outerRadius + 1. The kernel's key element is at position x=outerRadius, y=outerRadius

An IllegalArgumentException will be thrown if:

• The value of outerRadius not greater than 0
• The value of innerRadius is not less than outerRadius

Calling this method with innerRadius == 0 is equivalent to calling createCircle(int)

Parameters:

outerRadius - the radius of the circle expressed in pixels

innerRadius - the radius of the 'hole' of the annulus

type - one of KernelFactory.ValueType.BINARY, KernelFactory.ValueType.DISTANCE or KernelFactory.ValueType.INVERSE_DISTANCE

centreValue - the value to assign to the kernel centre (key element)

Returns:

a new instance of KernelJAI

createRectangle

public static javax.media.jai.KernelJAI createRectangle(int width,
                                                        int height)

Creates a new KernelJAI object with a rectangular configuraton. An IllegalArgumentException will be thrown if imgWidth or imgHeight are less than 1.

This is equivalent to calling...

createRectangle(imgWidth, imgHeight, Kernel.ValueType.BINARY, imgWidth/2, imgHeight/2, 1.0f)

Parameters:

width - rectangle imgWidth

height - rectangle imgHeight

Returns:

a new instance of KernelJAI

createRectangle

public static javax.media.jai.KernelJAI createRectangle(int width,
                                                        int height,
                                                        KernelFactory.ValueType type,
                                                        int keyX,
                                                        int keyY,
                                                        float keyValue)

Creates a new KernelJAI object with a rectangular configuration.

An IllegalArgumentException will be thrown if:

• imgWidth or imgHeight are less than 1
• keyX is not in the range 0:imgWidth-1
• keyY is not in the range 0:imgHeight-1

Parameters:

width - rectangle imgWidth

height - rectangle imgHeight

type - one of KernelFactory.ValueType.BINARY, KernelFactory.ValueType.DISTANCE or KernelFactory.ValueType.INVERSE_DISTANCE

keyX - x position of the key element

keyY - y position of the key element (y coords increase downwards)

keyValue - value of the key element

Returns:

a new instance of KernelJAI