Enum SoImageDataAdapter.Interpretations

  • All Implemented Interfaces:
    IntegerValuedEnum, java.io.Serializable, java.lang.Comparable<SoImageDataAdapter.Interpretations>
    Enclosing class:
    SoImageDataAdapter

    public static enum SoImageDataAdapter.Interpretations
    extends java.lang.Enum<SoImageDataAdapter.Interpretations>
    implements IntegerValuedEnum
    Image Interpretation. This enumeration defines the way the data values in the image should be interpreted. Some engines require their input image to have a specific interpretation type and give an error if the interpretation type is incorrect. Engines automatically set the appropriate interpretation type in their output image(s). The application is responsible for setting the appropriate interpretation type in images created by the application, for example if a mask image is loaded from disk.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      BINARY
      Image is a mask.
      LABEL
      Image is a collection of objects defined by id (label) values.
      VALUE
      Image is a grayscale or color image.
    • Enum Constant Detail

      • VALUE

        public static final SoImageDataAdapter.Interpretations VALUE
        Image is a grayscale or color image. A ‘VALUE’ type image with exactly 3 or 4 channels is assumed to be a color image (RGB or RGBA). In all other cases, each channel is independently treated as a grayscale image.
      • LABEL

        public static final SoImageDataAdapter.Interpretations LABEL
        Image is a collection of objects defined by id (label) values. In other words, the value of each voxel is a label id. If the image has multiple channels, e.g. a color image, only the first channel is used. Using a raw (unsegmented) grayscale image as input may give unexpected results, e.g. a large number of very small objects.
      • BINARY

        public static final SoImageDataAdapter.Interpretations BINARY
        Image is a mask. In other words, the value of each voxel is a boolean. If a grayscale image is used as input, 0 is false and all other values are true. If the image has multiple channels, e.g. a color image, only the first channel is used.
    • Method Detail

      • values

        public static SoImageDataAdapter.Interpretations[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (SoImageDataAdapter.Interpretations c : SoImageDataAdapter.Interpretations.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static SoImageDataAdapter.Interpretations 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
      • valueOf

        public static SoImageDataAdapter.Interpretations valueOf​(int val)
        Returns the enum constant of this type with the specified integer value
        Returns:
        the enum constant of this type with the specified integer value.
      • getValue

        public int getValue()
        Description copied from interface: IntegerValuedEnum
        Returns the integer value of the enum constant.
        Specified by:
        getValue in interface IntegerValuedEnum
        Returns:
        the integer value of the enum constant.