nl.liacs.timeseries.kernel

Class BasicKernel

java.lang.Object

nl.liacs.timeseries.kernel.AbstractKernel

nl.liacs.timeseries.kernel.DiscreteKernel

nl.liacs.timeseries.kernel.BasicKernel

Direct Known Subclasses:

Binarise, BiWeight, Cosine, Epanechnikov, Triangular, TriCube, TriWeight, Uniform

public class BasicKernel
extends DiscreteKernel

BasicKernel is a concrete implementation of DiscreteKernel.

It serves as the base implementation for many kernels, and should not be used as stand alone kernel.

Author:

Marvin Meeng Last updated 11.07.2012

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GUI_NAME The GUI name for this kernel.
static boolean	HAS_DELAY Can a delay be set for this kernel.
static boolean	HAS_OOBP Does this kernel have an OutOfBoundsPolicy.
static boolean	HAS_WIDTH Does this kernel have a width.
static int	NR_EXTRA_FIELDS The number of extra fields for this kernel.
static java.lang.String	SHORT_NAME The short name for this kernel.

Fields inherited from class nl.liacs.timeseries.kernel.DiscreteKernel

DEFAULT_OOB_POLICY, DEFAULT_WIDTH

Method Summary

Methods

Modifier and Type	Method and Description
double[]	applyTo(double[] theInput) Deprecated.
double[]	applyTo(double[] theInput, int theDelay) Apply the kernel to the specified array, with the specified delay.
java.lang.String	getGuiText() Deprecated.
boolean	getHasDelay() Deprecated.
boolean	getHasOOBP() Deprecated.
boolean	getHasWidth() Deprecated.
java.lang.String	getInfo() Returns the String representation of this Kernel.
double[]	getKernel() Returns the discrete representation of this kernel.
int	getNrExtraFields() Deprecated.
java.lang.String	getShortText() Deprecated.
boolean	isValidWidth(int theWidth) Indicates whether theWidth parameter is a valid width for this Kernel.
AbstractKernel	setOutOfBoundsPolicy(OutOfBoundsPolicy thePolicy) Sets the new OutOfBoundsPolicy for the Kernel.
AbstractKernel	setWidth(int theWidth) Sets the new width for the Kernel.
java.lang.String	toString() Returns the String representation of this Kernel.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

GUI_NAME

public static final java.lang.String GUI_NAME

The GUI name for this kernel.

SHORT_NAME

public static final java.lang.String SHORT_NAME

The short name for this kernel.

See Also:

Constant Field Values

HAS_WIDTH

public static final boolean HAS_WIDTH

Does this kernel have a width.

See Also:

Constant Field Values

HAS_OOBP

public static final boolean HAS_OOBP

Does this kernel have an OutOfBoundsPolicy.

See Also:

Constant Field Values

HAS_DELAY

public static final boolean HAS_DELAY

Can a delay be set for this kernel.

See Also:

Constant Field Values

NR_EXTRA_FIELDS

public static final int NR_EXTRA_FIELDS

The number of extra fields for this kernel.

See Also:

Constant Field Values

Method Detail

setOutOfBoundsPolicy

public AbstractKernel setOutOfBoundsPolicy(OutOfBoundsPolicy thePolicy)

Sets the new OutOfBoundsPolicy for the Kernel. The OutOfBoundsPolicy controls the value used in the array returned by the applyTo method, for those values in the input array to which no whole Kernel could be applied.

Specified by:

setOutOfBoundsPolicy in class DiscreteKernel

Parameters:

thePolicy - The OutOfBoundsPolicy to use.

Returns:

The Kernel on which this method is called.

See Also:

OutOfBoundsPolicy

setWidth

public AbstractKernel setWidth(int theWidth)

Sets the new width for the Kernel. When using the Kernel to calculate a value, width controls the number of adjacent values that are taken into account in the calculation to determine the end result. By default width is defined as DiscreteKernel.DEFAULT_WIDTH, for any new width only odd positive values are allowed for any BasicKernel and its subclasses. This assures the applyTo method functions properly.

Specified by:

setWidth in class DiscreteKernel

Parameters:

theWidth - The new width to be used.

Returns:

The Kernel on which this method is called.

See Also:

isValidWidth(int)

isValidWidth

public boolean isValidWidth(int theWidth)

Indicates whether theWidth parameter is a valid width for this Kernel. Note: BasicKernels accept only odd widths > 0. Some Kernels may use even widths, they can override this method. However, they should then also override the applyTo method.

Specified by:

isValidWidth in class DiscreteKernel

Parameters:

theWidth - The width to test.

Returns:

true if theWidth parameter is a valid width for this Kernel, false otherwise.

See Also:

applyTo(double[])

getKernel

public double[] getKernel()

Description copied from class: DiscreteKernel

Returns the discrete representation of this kernel.

Specified by:

getKernel in class DiscreteKernel

Returns:

The discrete representation of this kernel.

applyTo

@Deprecated
public double[] applyTo(double[] theInput)

Deprecated.

Apply the Kernel to some input array. Values for which it is not possible to apply the whole Kernel are set based on the OutOfBoundsPolicy. Note: this method assumes the Kernel has a positive odd width.

Specified by:

applyTo in class AbstractKernel

Parameters:

theInput - The array on which to apply the Kernel.

Returns:

An array of the same size as theInput, containing the result of applying the Kernel to theInput, or an empty array if theInput is null.

See Also:

OutOfBoundsPolicy, setWidth(int)

applyTo

public double[] applyTo(double[] theInput,
               int theDelay)

Description copied from class: AbstractKernel

Apply the kernel to the specified array, with the specified delay.

The delay may be 0, positive or negative. For a delay of 0 the values in the return array map directly to the input array. For a positive delay of n the values in the input array are 'shifted' n indices to the right. For a negative delay this 'shift' is to the left.

In general, for kernels for which AbstractKernel.getHasWidth() returns true, the application of the kernel to the head and tail of the input array is undefined. This method will fill in the values for which this condition applies by using the OutOfBoundsPolicy set for the kernel.

Specified by:

applyTo in class AbstractKernel

Parameters:

theInput - The array to apply the kernel to.

theDelay - The delay to use.

Returns:

A new double[] with the result.

getGuiText

@Deprecated
public java.lang.String getGuiText()

Deprecated.

Description copied from class: AbstractKernel

Returns the GUI friendly text for the kernel.

For most kernels this method returns the same result as a call to kernel.class.getSimpleName(). For some, the returned String will include some white spaces that beak up the various words, such that it forms regular text.

Specified by:

getGuiText in class AbstractKernel

Returns:

A GUI friendly String.

getShortText

@Deprecated
public java.lang.String getShortText()

Deprecated.

Description copied from class: AbstractKernel

Returns the short text for the kernel.

Specified by:

getShortText in class AbstractKernel

Returns:

A short String indicative of the class name.

getHasWidth

@Deprecated
public boolean getHasWidth()

Deprecated.

Description copied from class: AbstractKernel

Returns whether the kernel has a width.

This is true for a DiscreteKernel, and false for a ContinuousKernel.

Specified by:

getHasWidth in class AbstractKernel

Returns:

true iff the kernel has a width, false otherwise.

See Also:

ContinuousKernel, DiscreteKernel

getHasOOBP

@Deprecated
public boolean getHasOOBP()

Deprecated.

Description copied from class: AbstractKernel

Returns whether the kernel has an OutOfBoundsPolicy.

This is true for a DiscreteKernel, and false for a ContinuousKernel.

Specified by:

getHasOOBP in class AbstractKernel

Returns:

true iff the kernel has an out of bounds policy, false otherwise.

See Also:

OutOfBoundsPolicy, ContinuousKernel, DiscreteKernel

getHasDelay

@Deprecated
public boolean getHasDelay()

Deprecated.

Description copied from class: AbstractKernel

Returns whether a delay can be set for the kernel.

This is true for almost all kernels, but not for MovingAverage.

Specified by:

getHasDelay in class AbstractKernel

Returns:

true iff a delay can be set for the kernel, false otherwise.

getNrExtraFields

@Deprecated
public int getNrExtraFields()

Deprecated.

Description copied from class: AbstractKernel

Returns the number of extra fields for the kernel.

Extra fields hold kernel specific configuration settings, not shared with other kernels.

Specified by:

getNrExtraFields in class AbstractKernel

Returns:

The number of extra fields.

toString

public java.lang.String toString()

Returns the String representation of this Kernel. The items between the braces represent the width and OutOfBoundsPolicy used for this Kernel.

Specified by:

toString in class AbstractKernel

Returns:

The String representation of the kernel.

getInfo

public java.lang.String getInfo()

Returns the String representation of this Kernel. It includes the width and the values of the Kernel itself.

Returns:

The String representation of this Kernel.