Kernel (Alkacon SimAPI)

java.lang.Object
- com.alkacon.simapi.filter.Kernel

public class Kernel
extends java.lang.Object

A convolution kernel.

Author:: Jerry Huxtable

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`cols`
`static float[]`	`EDGE_LAPLACE1`
`static float[]`	`EDGE_LAPLACE2`
`static float[]`	`FREI_CHEN_H`
`static float[]`	`FREI_CHEN_V`
`float[]`	`matrix`
`static float[]`	`PREWITT_H`
`static float[]`	`PREWITT_V`
`static float`	`R2`
`static float[]`	`ROBERTS_H`
`static float[]`	`ROBERTS_V`
`int`	`rows`
`static float[]`	`SOBEL_H`
`static float[]`	`SOBEL_V`
`int`	`xCentre`
`int`	`yCentre`

Constructor Summary

Constructors
Constructor and Description
`Kernel()` Construct a null kernel.
`Kernel(float[] matrix)` Construct a kernel with the given 3x3 matrix.
`Kernel(int rows, int cols, float[] matrix)` Construct a kernel with the given matrix.
`Kernel(int rows, int cols, int xCentre, int yCentre, float[] matrix)` Construct a kernel with the given matrix.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`float[]`	`getMatrix()`
`void`	`normalize()` Normalize a convolution kernel.
`void`	`setMatrix(float[] matrix)` Set the (3x3) convolution kernel.
`void`	`setMatrix(int rows, int cols, float[] matrix)` Set the convolution kernel.
`void`	`setMatrix(int rows, int cols, int xCentre, int yCentre, float[] matrix)` Set the convolution kernel.

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

- Field Detail
  - R2
```
public static final float R2
```
  - ROBERTS_V
```
public static final float[] ROBERTS_V
```
  - ROBERTS_H
```
public static final float[] ROBERTS_H
```
  - PREWITT_V
```
public static final float[] PREWITT_V
```
  - PREWITT_H
```
public static final float[] PREWITT_H
```
  - SOBEL_V
```
public static final float[] SOBEL_V
```
  - SOBEL_H
```
public static float[] SOBEL_H
```
  - FREI_CHEN_V
```
public static final float[] FREI_CHEN_V
```
  - FREI_CHEN_H
```
public static float[] FREI_CHEN_H
```
  - EDGE_LAPLACE1
```
public static float[] EDGE_LAPLACE1
```
  - EDGE_LAPLACE2
```
public static float[] EDGE_LAPLACE2
```
  - matrix
```
public float[] matrix
```
  - rows
```
public int rows
```
  - cols
```
public int cols
```
  - xCentre
```
public int xCentre
```
  - yCentre
```
public int yCentre
```
- Constructor Detail
  - Kernel
```
public Kernel()
```
    Construct a null kernel. This is only useful if you're going to change the kernel later on.
  - Kernel
```
public Kernel(float[] matrix)
```
    Construct a kernel with the given 3x3 matrix.
    
    Parameters:
    
    matrix - an array of 9 floats containing the kernel
  - Kernel
```
public Kernel(int rows,
              int cols,
              float[] matrix)
```
    Construct a kernel with the given matrix.
    
    Parameters:
    
    rows - the number of rows in the kernel
    
    cols - the number of columns in the kernel
    
    matrix - an array of rows*cols floats containing the kernel
  - Kernel
```
public Kernel(int rows,
              int cols,
              int xCentre,
              int yCentre,
              float[] matrix)
```
    Construct a kernel with the given matrix.
    
    Parameters:
    
    rows - the number of rows in the kernel
    
    cols - the number of columns in the kernel
    
    xCentre - the centre of the kernel in the x direction
    
    yCentre - the centre of the kernel in the y direction
    
    matrix - an array of rows*cols floats containing the kernel
- Method Detail
  - getMatrix
```
public float[] getMatrix()
```
  - normalize
```
public void normalize()
```
    Normalize a convolution kernel. You can call this to normalize a kernel you've created by hand.
  - setMatrix
```
public void setMatrix(float[] matrix)
```
    Set the (3x3) convolution kernel.
    
    Parameters:
    
    matrix - an array of 9 floats containing the kernel
  - setMatrix
```
public void setMatrix(int rows,
                      int cols,
                      float[] matrix)
```
    Set the convolution kernel.
    
    Parameters:
    
    rows - the number of rows in the kernel
    
    cols - the number of columns in the kernel
    
    matrix - an array of rows*cols floats containing the kernel
  - setMatrix
```
public void setMatrix(int rows,
                      int cols,
                      int xCentre,
                      int yCentre,
                      float[] matrix)
```
    Set the convolution kernel.
    
    Parameters:
    
    rows - the number of rows in the kernel
    
    cols - the number of columns in the kernel
    
    xCentre - the centre of the kernel in the x direction
    
    yCentre - the centre of the kernel in the y direction
    
    matrix - an array of rows*cols floats containing the kernel

Class Kernel

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

R2

ROBERTS_V

ROBERTS_H

PREWITT_V

PREWITT_H

SOBEL_V

SOBEL_H

FREI_CHEN_V

FREI_CHEN_H

EDGE_LAPLACE1

EDGE_LAPLACE2

matrix

rows

cols

xCentre

yCentre

Constructor Detail

Kernel

Kernel

Kernel

Kernel

Method Detail

getMatrix

normalize

setMatrix

setMatrix

setMatrix