Package com.irurueta.numerical.signal.processing

Enum Class ConvolverEdgeMethod

java.lang.Object

java.lang.Enum<ConvolverEdgeMethod>

com.irurueta.numerical.signal.processing.ConvolverEdgeMethod

All Implemented Interfaces:

Serializable, Comparable<ConvolverEdgeMethod>, Constable

public enum ConvolverEdgeMethod
extends Enum<ConvolverEdgeMethod>

This enumerator indicates how edges should be treated during convolution. Repeat and mirror edge extension methods can be used to prevent certain artifacts when reaching edges of signal.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONSTANT_EDGE	When convolution kernel reaches edge of signal being convoluted, it is assumed that the signal has a constant value (with a value that can be setup).
MIRROR_EDGE	When convolution kernel reaches edge of signal being convoluted, it is assumed that the signal is mirrored.
REPEAT_EDGE	When convolution kernel reaches edge of signal being convoluted, it is assumed that the signal is repeated indefinitely.
ZERO_EDGE	When convolution kernel reaches edge of signal being convoluted, it is assumed that the signal value is zero.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ConvolverEdgeMethod()

Method Summary

Modifier and Type	Method	Description
static ConvolverEdgeMethod	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ConvolverEdgeMethod[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ZERO_EDGE

public static final ConvolverEdgeMethod ZERO_EDGE

When convolution kernel reaches edge of signal being convoluted, it is assumed that the signal value is zero.

CONSTANT_EDGE

public static final ConvolverEdgeMethod CONSTANT_EDGE

When convolution kernel reaches edge of signal being convoluted, it is assumed that the signal has a constant value (with a value that can be setup).

REPEAT_EDGE

public static final ConvolverEdgeMethod REPEAT_EDGE

When convolution kernel reaches edge of signal being convoluted, it is assumed that the signal is repeated indefinitely.

MIRROR_EDGE

public static final ConvolverEdgeMethod MIRROR_EDGE

When convolution kernel reaches edge of signal being convoluted, it is assumed that the signal is mirrored.

Constructor Details

ConvolverEdgeMethod

private ConvolverEdgeMethod()

Method Details

values

public static ConvolverEdgeMethod[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ConvolverEdgeMethod valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null