omeis.providers.re.data

Class PlaneFactory

java.lang.Object

omeis.providers.re.data.PlaneFactory

public class PlaneFactory
extends 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.

Author:

Chris Allan

Field Summary

Fields

Modifier and Type	Field and Description
static String	BIT Identifies the Bit data type used to store pixel values, as per OME spec.
static int	BYTE Identifies the type used to store pixel values.
static int	DOUBLE Identifies the type used to store pixel values.
static String	DOUBLE_TYPE Identifies the DOUBLE data type used to store pixel values, as per OME spec.
static int	FLOAT Identifies the type used to store pixel values.
static String	FLOAT_TYPE Identifies the FLOAT data type used to store pixel values, as per OME spec.
static int	INT Identifies the type used to store pixel values.
static String	INT16 Identifies the INT16 data type used to store pixel values, as per OME spec.
static String	INT32 Identifies the INT32 data type used to store pixel values, as per OME spec.
static String	INT8 Identifies the INT8 data type used to store pixel values, as per OME spec.
static int	LONG Identifies the type used to store pixel values.
static int	SHORT Identifies the type used to store pixel values.
static String	UINT16 Identifies the UINT16 data type used to store pixel values, as per OME spec.
static String	UINT32 Identifies the UINT32 data type used to store pixel values, as per OME spec.
static String	UINT8 Identifies the UINT8 data type used to store pixel values, as per OME spec.

Constructor Summary

Constructors

Constructor and Description
PlaneFactory()

Method Summary

Methods

Modifier and Type	Method and Description
static Plane2D	createPlane(PlaneDef planeDef, int channel, Pixels pixels, PixelBuffer buffer) Factory method to fetch plane data and create an object to access it.
static boolean	in(PixelsType type, String[] strings) A static helper method to check if a type is one of the elements in an array.
static boolean	isTypeSigned(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

public static final String BIT

Identifies the Bit data type used to store pixel values, as per OME spec.

See Also:

Constant Field Values

INT8

public static final String INT8

Identifies the INT8 data type used to store pixel values, as per OME spec.

See Also:

Constant Field Values

INT16

public static final String INT16

Identifies the INT16 data type used to store pixel values, as per OME spec.

See Also:

Constant Field Values

INT32

public static final String INT32

Identifies the INT32 data type used to store pixel values, as per OME spec.

See Also:

Constant Field Values

UINT8

public static final String UINT8

Identifies the UINT8 data type used to store pixel values, as per OME spec.

See Also:

Constant Field Values

UINT16

public static final String UINT16

Identifies the UINT16 data type used to store pixel values, as per OME spec.

See Also:

Constant Field Values

UINT32

public static final String UINT32

Identifies the UINT32 data type used to store pixel values, as per OME spec.

See Also:

Constant Field Values

FLOAT_TYPE

public static final String FLOAT_TYPE

Identifies the FLOAT data type used to store pixel values, as per OME spec.

See Also:

Constant Field Values

DOUBLE_TYPE

public static final String DOUBLE_TYPE

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(PixelsType type,
         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(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(PlaneDef planeDef,
                  int channel,
                  Pixels pixels,
                  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.