Package org.apache.sis.coverage.grid

# Enum GridClippingMode

Object
Enum<GridClippingMode>
GridClippingMode

All Implemented Interfaces:
  `Serializable`, `Comparable<GridClippingMode>`, `Constable`

public enum GridClippingMode extends Enum<GridClippingMode>
Specifies clipping behavior during computations of `GridExtent`. The clipping mode controls which computation steps are constrained to the extent of the base grid geometry.

Since:
  1.1

Defined in the `sis-feature` module

- ## Nested Class Summary

  ## Nested classes/interfaces inherited from class Enum

  `Enum​.EnumDesc<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 GridClippingMode`
  `valueOf(String name)`
  Returns the enum constant of this type with the specified name.
  `static GridClippingMode[]`
  `values()`
  Returns an array containing the constants of this enum type, in the order they are declared.

  ### Methods inherited from class Enum

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

  ### Methods inherited from class Object

  `getClass, notify, notifyAll, 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 `GridDerivation` 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:
      - `GridDerivation​.margin(int...)`

- ## Method Details

  - ### values

    public static GridClippingMode[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.
    Returns:
      an array containing the constants of this enum type, in the order they are declared

  - ### valueOf

    public static GridClippingMode valueOf(String name)
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
      `NullPointerException` - if the argument is null