Module org.apache.sis.feature

Package org.apache.sis.coverage.grid

Enum Class GridClippingMode

Object

Enum<GridClippingMode>

GridClippingMode

All Implemented Interfaces:

Serializable, Comparable<Grid­Clipping­Mode>, Constable

public enum GridClippingMode
extends Enum<GridClippingMode>

Specifies clipping behavior during computations of Grid­Extent. The clipping mode controls which computation steps are constrained to the extent of the base grid geometry.

Since:

1.1

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.Enum­Desc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BORDER_EXPANSION	Clipping is applied on the Area Of Interest supplied by user, before expansion for margin and chunk size.
NONE	No clipping is applied.
STRICT	All computation steps (including addition of a margin) are constrained to the base grid extent.

Method Summary

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

Methods inherited from class Enum

clone, compare­To, describe­Constable, equals, finalize, get­Declaring­Class, hash­Code, name, ordinal, to­String, value­Of

Methods inherited from class Object

get­Class, notify, notify­All, wait, wait, wait

Enum Constant Details

NONE

public static final GridClippingMode NONE

No clipping is applied.

STRICT

public static final GridClippingMode STRICT

All computation steps (including addition of a margin) are constrained to the base grid extent. The final grid geometry computed by Grid­Derivation will have an extent completely contained inside the extent of the base grid geometry.

BORDER_EXPANSION

public static final GridClippingMode BORDER_EXPANSION

Clipping is applied on the Area Of Interest supplied by user, before expansion for margin and chunk size. After clipping, the addition of a margin and the rounding to chunk size may cause the final grid extent to expand outside the base grid extent.

See Also:

• Grid­Derivation.margin(int...)

Method Details

values

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

Illegal­Argument­Exception - if this enum class has no constant with the specified name

Null­Pointer­Exception - if the argument is null