Package omeis.providers.re.data

Class PlaneFactory

  • public class PlaneFactory
extends java.lang.Object
    Encapsulates access to the image raw data. Contains the logic to interpret a linear byte array as a 5D array. Knows how to extract a 2D-plane from the 5D array, but delegates to the specified 2D-Plane the retrieval of pixel values.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String BIT
      Deprecated.
      static int BYTE
      Identifies the type used to store pixel values.
      static int DOUBLE
      Identifies the type used to store pixel values.
      static java.lang.String DOUBLE_TYPE
      Deprecated.
      static int FLOAT
      Identifies the type used to store pixel values.
      static java.lang.String FLOAT_TYPE
      Deprecated.
      static int INT
      Identifies the type used to store pixel values.
      static java.lang.String INT16
      Deprecated.
      static java.lang.String INT32
      Deprecated.
      static java.lang.String INT8
      Deprecated.
      static int LONG
      Identifies the type used to store pixel values.
      static int SHORT
      Identifies the type used to store pixel values.
      static java.lang.String UINT16
      Deprecated.
      static java.lang.String UINT32
      Deprecated.
      static java.lang.String UINT8
      Deprecated.

    • Constructor Summary

      Constructors 
      Constructor Description
      PlaneFactory()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static Plane2D createPlane​(omeis.providers.re.data.PlaneDef planeDef, int channel, ome.model.core.Pixels pixels, ome.io.nio.PixelBuffer buffer)
      Factory method to fetch plane data and create an object to access it.
      static boolean in​(ome.model.enums.PixelsType type, java.lang.String[] strings)
      A static helper method to check if a type is one of the elements in an array.
      static boolean isTypeSigned​(ome.model.enums.PixelsType type)
      A static helper method to retrieve pixel byte signage.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • BIT

        @Deprecated
public static final java.lang.String BIT
        Deprecated.
        Identifies the Bit data type used to store pixel values, as per OME spec.
        See Also:
        Constant Field Values

      • INT8

        @Deprecated
public static final java.lang.String INT8
        Deprecated.
        Identifies the INT8 data type used to store pixel values, as per OME spec.
        See Also:
        Constant Field Values

      • INT16

        @Deprecated
public static final java.lang.String INT16
        Deprecated.
        Identifies the INT16 data type used to store pixel values, as per OME spec.
        See Also:
        Constant Field Values

      • INT32

        @Deprecated
public static final java.lang.String INT32
        Deprecated.
        Identifies the INT32 data type used to store pixel values, as per OME spec.
        See Also:
        Constant Field Values

      • UINT8

        @Deprecated
public static final java.lang.String UINT8
        Deprecated.
        Identifies the UINT8 data type used to store pixel values, as per OME spec.
        See Also:
        Constant Field Values

      • UINT16

        @Deprecated
public static final java.lang.String UINT16
        Deprecated.
        Identifies the UINT16 data type used to store pixel values, as per OME spec.
        See Also:
        Constant Field Values

      • UINT32

        @Deprecated
public static final java.lang.String UINT32
        Deprecated.
        Identifies the UINT32 data type used to store pixel values, as per OME spec.
        See Also:
        Constant Field Values

      • FLOAT_TYPE

        @Deprecated
public static final java.lang.String FLOAT_TYPE
        Deprecated.
        Identifies the FLOAT data type used to store pixel values, as per OME spec.
        See Also:
        Constant Field Values

      • DOUBLE_TYPE

        @Deprecated
public static final java.lang.String DOUBLE_TYPE
        Deprecated.
        Identifies the DOUBLE data type used to store pixel values, as per OME spec.
        See Also:
        Constant Field Values

      • BYTE

        public static final int BYTE
        Identifies the type used to store pixel values.
        See Also:
        Constant Field Values

      • SHORT

        public static final int SHORT
        Identifies the type used to store pixel values.
        See Also:
        Constant Field Values

      • INT

        public static final int INT
        Identifies the type used to store pixel values.
        See Also:
        Constant Field Values

      • LONG

        public static final int LONG
        Identifies the type used to store pixel values.
        See Also:
        Constant Field Values

      • FLOAT

        public static final int FLOAT
        Identifies the type used to store pixel values.
        See Also:
        Constant Field Values

      • DOUBLE

        public static final int DOUBLE
        Identifies the type used to store pixel values.
        See Also:
        Constant Field Values

    • Constructor Detail

      • PlaneFactory

        public PlaneFactory()

    • Method Detail

      • in

        public static boolean in​(ome.model.enums.PixelsType type,
                         java.lang.String[] strings)
        A static helper method to check if a type is one of the elements in an array.
        Parameters:
        type - A pixels type enumeration.
        strings - The strings for which you want to check against.
        Returns:
        True on successful match and false on failure to match.

      • isTypeSigned

        public static boolean isTypeSigned​(ome.model.enums.PixelsType type)
        A static helper method to retrieve pixel byte signage.
        Parameters:
        type - The pixels type for which you want to know the byte width.
        Returns:
        The number of bytes per pixel value.

      • createPlane

        public static Plane2D createPlane​(omeis.providers.re.data.PlaneDef planeDef,
                                  int channel,
                                  ome.model.core.Pixels pixels,
                                  ome.io.nio.PixelBuffer buffer)
        Factory method to fetch plane data and create an object to access it.
        Parameters:
        planeDef - Defines the plane to be retrieved. Must not be null.
        channel - The wavelength at which data is to be fetched.
        pixels - The pixels from which the data is to be fetched.
        buffer - The pixels buffer from which the data is to be fetched.
        Returns:
        A plane 2D object that encapsulates the actual plane pixels.