de.unihalle.informatik.MiToBo.math.arrays.filter

Class GaussFilterDouble1D

java.lang.Object

de.unihalle.informatik.Alida.operator.ALDOperator

de.unihalle.informatik.MiToBo.core.operator.MTBOperator

de.unihalle.informatik.MiToBo.math.arrays.filter.ArrayFilterDouble1D

de.unihalle.informatik.MiToBo.math.arrays.filter.GaussFilterDouble1D

All Implemented Interfaces:

de.unihalle.informatik.Alida.datatypes.ALDConfigurationValidator, de.unihalle.informatik.Alida.operator.events.ALDOperatorExecutionProgressEventListener, EventListener

@ALDAOperator(genericExecutionMode=ALL,
              level=STANDARD)
public class GaussFilterDouble1D
extends ArrayFilterDouble1D

This class implements a Gaussian filter for 1D arrays.

The size of the filter kernel mask is chosen as two times the given standard deviation plus one, truncated to the next full integer value.

If a kernel array is provided, that one is used. Otherwise a kernel is automatically created from the given standard deviation.

Author:

moeller

Nested Class Summary

Nested classes/interfaces inherited from class de.unihalle.informatik.Alida.operator.ALDOperator

de.unihalle.informatik.Alida.operator.ALDOperator.HidingMode, de.unihalle.informatik.Alida.operator.ALDOperator.HistoryConstructionMode

Field Summary

Fields

Modifier and Type	Field and Description
private double[]	kernel Kernel array, either provided externally or filled internally based on given standard deviation.
private double	sigma Standard deviation of the Gaussian kernel to be applied.

Fields inherited from class de.unihalle.informatik.MiToBo.math.arrays.filter.ArrayFilterDouble1D

dataIsPeriodic, inputArray, outputArray

Fields inherited from class de.unihalle.informatik.Alida.operator.ALDOperator

completeDAG, name, operatorExecutionEventlistenerList, portHashAccess, verbose, versionProvider

Constructor Summary

Constructors

Constructor and Description
GaussFilterDouble1D() Default constructor.

Method Summary

Modifier and Type	Method and Description
protected double[]	getGaussKernel() Get normalized Gaussian kernel for given parameters.
static double[]	getGaussKernel(double sigma) Get normalized Gaussian kernel for given parameters.
double[]	getKernel() Get the kernel which is currently in use.
protected void	operate() This method does the actual work.
void	setKernel(double[] k) Set Gaussian kernel.
void	setSigma(double s) Set standard deviation of Gaussian kernel.

Methods inherited from class de.unihalle.informatik.MiToBo.math.arrays.filter.ArrayFilterDouble1D

getResultArray, setDataIsPeriodic, setInputArray

Methods inherited from class de.unihalle.informatik.MiToBo.core.operator.MTBOperator

readResolve

Methods inherited from class de.unihalle.informatik.Alida.operator.ALDOperator

addOperatorExecutionProgressEventListener, addParameter, addParameter, addParameterUnconditioned, fieldContained, fireOperatorExecutionProgressEvent, getALDPortHashAccessKey, getConstructionMode, getDocumentation, getHidingMode, getInactiveParameterNames, getInInoutNames, getInInoutNames, getInNames, getInOutNames, getMissingRequiredInputs, getName, getNumParameters, getOutInoutNames, getOutNames, getParameter, getParameterDescriptor, getParameterDescriptorUnconditioned, getParameterNames, getParameterUnconditioned, getSupplementalNames, getVerbose, getVersion, handleOperatorExecutionProgressEvent, hasInOutParameters, hasParameter, isAnnotatedParameter, isConfigured, print, print, print, printInterface, printInterface, readHistory, reinitializeParameterDescriptors, removeOperatorExecutionProgressEventListener, removeParameter, runOp, runOp, runOp, setConstructionMode, setConstructionMode, setConstructionMode, setHidingMode, setName, setParameter, setParameterUnconditioned, setVerbose, toStringVerbose, unconfiguredItems, validate, validateCustom, validateGeneric, writeHistory, writeHistory, writeHistory

Methods inherited from class java.lang.Object

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

Field Detail

sigma

@Parameter(label="Standard Deviation \u03a3",
           required=true,
           dataIOOrder=2,
           direction=IN,
           description="Standard deviation \u03a3 of Gaussian kernel.")
private double sigma

Standard deviation of the Gaussian kernel to be applied.

kernel

private double[] kernel

Kernel array, either provided externally or filled internally based on given standard deviation.

Constructor Detail

GaussFilterDouble1D

public GaussFilterDouble1D()
                    throws de.unihalle.informatik.Alida.exceptions.ALDOperatorException

Default constructor.

Throws:

de.unihalle.informatik.Alida.exceptions.ALDOperatorException - Thrown in case of problems during execution.

Method Detail

setSigma

public void setSigma(double s)

Set standard deviation of Gaussian kernel.

Parameters:

s - Standard deviation to apply.

setKernel

public void setKernel(double[] k)

Set Gaussian kernel.

If provided, sigma is ignored. Note that no checks are included, thus, the user has to take care of correct values and scaling.

This function is especially useful if the same kernel has to be applied many, many times to different data. Then it needs to be generated only once and can be reused.

Parameters:

k - Gaussian kernel array to be used.

getKernel

public double[] getKernel()

Get the kernel which is currently in use.

Returns:

Active kernel.

operate

protected void operate()

This method does the actual work.

Specified by:

operate in class de.unihalle.informatik.Alida.operator.ALDOperator

getGaussKernel

protected double[] getGaussKernel()

Get normalized Gaussian kernel for given parameters.

Returns:

Gaussian kernel.

getGaussKernel

public static double[] getGaussKernel(double sigma)

Get normalized Gaussian kernel for given parameters.

Returns:

Gaussian kernel.