Package com.xinapse.multisliceimage.UNC

Enum Class UNCPixFormat

java.lang.Object
java.lang.Enum<UNCPixFormat>
com.xinapse.multisliceimage.UNC.UNCPixFormat
All Implemented Interfaces:
Serializable, Comparable<UNCPixFormat>, Constable
public enum UNCPixFormat extends Enum<UNCPixFormat>
This class represents the pixel formats (data types) that can be used in UNC images.

  • Enum Constant Details

  • Method Details

    • values

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

    • getBytesPerPixel

      public int getBytesPerPixel()
      Returns the number of bytes per pixel for this UNCPixFormat.
      Returns:
      the number of bytes per pixel.

    • toString

      public String toString()
      Returns a String describing this data format.
      Overrides:
      toString in class Enum<UNCPixFormat>
      Returns:
      a String describing this data format.

    • getPixelDataType

      public PixelDataType getPixelDataType()
      Returns the PixelDataType corresponding to this UNCPixFormat.
      Returns:
      the PixelDataType corresponding to this UNCPixFormat.

    • getInstance

      public static UNCPixFormat getInstance(PixelDataType pixelDataType) throws UNCException
      Returns the UNCPixFormat corresponding to a PixelDataType.
      Parameters:
      pixelDataType - a PixelDataType corresponding to the returned UNCPixFormat.
      Returns:
      the UNCPixFormat corresponding to the PixelDataType argument.
      Throws:
      UNCException - if there is no corresponding UNCPixFormat.