Package inra.ijpb.plugins

Enum Connectivity3D

java.lang.Object
java.lang.Enum<Connectivity3D>
inra.ijpb.plugins.Connectivity3D
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Connectivity3D>, java.lang.constant.Constable
public enum Connectivity3D
extends java.lang.Enum<Connectivity3D>
An enumeration of connectivity options for 3D Mathematical Morphology operators.
Author:
dlegland

  • Nested Class Summary

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

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant Description
    C26
    The 26-connectivity, that considers all neighbors in three dimensions
    C6
    The 6-connectivity, that considers orthogonal neighbors in three dimensions

  • Method Summary

    Modifier and Type Method Description
    static Connectivity3D fromLabel​(java.lang.String label)
    Determines the connectivity type from its label.
    static java.lang.String[] getAllLabels()
    Returns all the labels for this enumeration.
    int getValue()
    Returns the integer value associated to this connectivity.
    java.lang.String toString()  
    static Connectivity3D valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static Connectivity3D[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • C6

      public static final Connectivity3D C6
      The 6-connectivity, that considers orthogonal neighbors in three dimensions

    • C26

      public static final Connectivity3D C26
      The 26-connectivity, that considers all neighbors in three dimensions

  • Method Details

    • values

      public static Connectivity3D[] 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 Connectivity3D valueOf​(java.lang.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:
      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Enum<Connectivity3D>

    • getValue

      public int getValue()
      Returns the integer value associated to this connectivity.
      Returns:
      the integer value associated to this connectivity.

    • getAllLabels

      public static java.lang.String[] getAllLabels()
      Returns all the labels for this enumeration.
      Returns:
      all the labels for this enumeration.

    • fromLabel

      public static Connectivity3D fromLabel​(java.lang.String label)
      Determines the connectivity type from its label.
      Parameters:
      label - the name of the connectivity
      Returns:
      the connectivity associated to the label
      Throws:
      java.lang.IllegalArgumentException - if label is not recognized.