Package boofcv.struct.border

Enum Class BorderType

java.lang.Object
java.lang.Enum<BorderType>
boofcv.struct.border.BorderType
All Implemented Interfaces:
Serializable, Comparable<BorderType>, java.lang.constant.Constable
public enum BorderType extends Enum<BorderType>
How the image border is handled by a convolution filter. Care should be taken when selecting a border method since some types will not produce meaningful results for all kernel types.

  • Enum Constant Details

    • SKIP

      public static final BorderType SKIP
      Image borders are not processed and are simply skipped over.

    • EXTENDED

      public static final BorderType EXTENDED
      The pixels along the image border are extended outwards. This is recommended for computing the gradient and many convolution operations.

    • NORMALIZED

      public static final BorderType NORMALIZED
      The kernel is renormalized to take in account that parts of it are not inside the image. Typically only used with kernels that blur the image.

    • REFLECT

      public static final BorderType REFLECT
      Access to outside the array are reflected back into the array around the closest border. This is an even symmetric function, e.g. f(-1) = f(1) = 1, f(-2) = f(2) = 2.

    • WRAP

      public static final BorderType WRAP
      Also known as periodic. When a pixel outside of image is accessed it wraps around to the other side of the image as if the image is a loop. Primarily included for historical purposes and because other people use it. In most applications it has the potential of introducing structured noise, which is bad.

    • ZERO

      public static final BorderType ZERO
      The image border is set to a fixed value of zero. Generates harsh edges that can cause artifacts in some applications.

  • Method Details

    • values

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