Module imagingbook.common

Package imagingbook.common.image

Enum Class OutOfBoundsStrategy

java.lang.Object

java.lang.Enum<OutOfBoundsStrategy>

imagingbook.common.image.OutOfBoundsStrategy

All Implemented Interfaces:

Serializable, Comparable<OutOfBoundsStrategy>, Constable

public enum OutOfBoundsStrategy
extends Enum<OutOfBoundsStrategy>

Enumeration type representing the available strategies for accessing pixel locations outside the image bounds.

See Also:

• GridIndexer2D

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
DefaultValue	Replace out-of-bounds pixels by some default value.
MirrorImage	Treat the image as being infinitely mirrored at its borders.
NearestBorder	Replace out-of-bounds pixels by the nearest border pixel.
PeriodicImage	Treat the image as repeating ininitely in x/y directions.
ThrowException	Throw an exception when out-of-boundary coordinates are accessed.

Method Summary

Modifier and Type	Method	Description
static OutOfBoundsStrategy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OutOfBoundsStrategy[]	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

DefaultValue

public static final OutOfBoundsStrategy DefaultValue

Replace out-of-bounds pixels by some default value.

NearestBorder

public static final OutOfBoundsStrategy NearestBorder

Replace out-of-bounds pixels by the nearest border pixel.

MirrorImage

public static final OutOfBoundsStrategy MirrorImage

Treat the image as being infinitely mirrored at its borders.

PeriodicImage

public static final OutOfBoundsStrategy PeriodicImage

Treat the image as repeating ininitely in x/y directions.

ThrowException

public static final OutOfBoundsStrategy ThrowException

Throw an exception when out-of-boundary coordinates are accessed.

Method Details

values

public static OutOfBoundsStrategy[] 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 OutOfBoundsStrategy 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