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

Class ArrayFilterDouble1D

java.lang.Object

de.unihalle.informatik.Alida.operator.ALDOperator

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

GaussFilterDouble1D

public abstract class ArrayFilterDouble1D
extends MTBOperator

This class defines a superclass for filters for 1D arrays.

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
protected boolean	dataIsPeriodic Flag to indicate if data is periodic.
protected double[]	inputArray Input data array.
protected double[]	outputArray Result data array.

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

completeDAG, name, operatorExecutionEventlistenerList, portHashAccess, verbose, versionProvider

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ArrayFilterDouble1D() Default constructor.

Method Summary

Modifier and Type	Method and Description
double[]	getResultArray() Returns result array.
void	setDataIsPeriodic(boolean flag) Specify if data is periodic or not.
void	setInputArray(double[] array) Set array to process.

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, operate, 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

inputArray

@Parameter(label="Input Array",
           required=true,
           dataIOOrder=0,
           direction=IN,
           description="Input array.")
protected double[] inputArray

Input data array.

dataIsPeriodic

@Parameter(label="Array is periodic?",
           required=true,
           dataIOOrder=1,
           direction=IN,
           description="If checked, array data is assumed to be periodic.")
protected boolean dataIsPeriodic

Flag to indicate if data is periodic.

If the flag is set to false, padding is done with zeros.

outputArray

@Parameter(label="Output Array",
           required=true,
           dataIOOrder=0,
           direction=OUT,
           description="Output array.")
protected transient double[] outputArray

Result data array.

Constructor Detail

ArrayFilterDouble1D

protected ArrayFilterDouble1D()
                       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

setInputArray

public void setInputArray(double[] array)

Set array to process.

Parameters:

array - Data array to process.

setDataIsPeriodic

public void setDataIsPeriodic(boolean flag)

Specify if data is periodic or not.

Parameters:

flag - If true data is assumed to be periodic.

getResultArray

public double[] getResultArray()

Returns result array.

Returns:

Filtered array.