org.openimaj.image

Class CLImageConversion

java.lang.Object

org.openimaj.image.CLImageConversion

public class CLImageConversion
extends Object

Utility methods for converting between OpenIMAJ Image types and CLImage2Ds for GPGPU acceleration.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Method Summary

Modifier and Type	Method and Description
static com.nativelibs4java.opencl.CLImage2D	convert(com.nativelibs4java.opencl.CLContext context, FImage image) Convert an FImage to CLImage2D.
static <I extends Image<?,I>> com.nativelibs4java.opencl.CLImage2D	convert(com.nativelibs4java.opencl.CLContext context, I image) Convert an Image to CLImage2D.
static com.nativelibs4java.opencl.CLImage2D	convert(com.nativelibs4java.opencl.CLContext context, MBFImage image) Convert an MBFImage to an RGBA CLImage2D.
static FImage	convert(com.nativelibs4java.opencl.CLQueue queue, com.nativelibs4java.opencl.CLEvent evt, com.nativelibs4java.opencl.CLImage2D clImage, FImage oiImage) Convert a CLImage2D to an FImage.
static <I extends Image<?,I>> I	convert(com.nativelibs4java.opencl.CLQueue queue, com.nativelibs4java.opencl.CLEvent evt, com.nativelibs4java.opencl.CLImage2D clImage, I oiImage) Convert a CLImage2D to an Image.
static MBFImage	convert(com.nativelibs4java.opencl.CLQueue queue, com.nativelibs4java.opencl.CLEvent evt, com.nativelibs4java.opencl.CLImage2D clImage, MBFImage oiImage) Convert a CLImage2D to an MBFImage.
static FImage	convertFromFB(FloatBuffer fb, int width, int height, FImage image) Convert packed intensity pixels in a FloatBuffer back into an FImage.
static MBFImage	convertFromFB(FloatBuffer fb, int width, int height, MBFImage image) Convert packed RGBA pixels in a FloatBuffer back into an MBFImage.
static FloatBuffer	convertToFB(FImage image, ByteOrder byteOrder) Converts an FImage to a FloatBuffer containing packed intensity pixels.
static FloatBuffer	convertToFB(MBFImage image, ByteOrder byteOrder) Converts an MBFImage to a FloatBuffer containing packed RGBA pixels.

Methods inherited from class java.lang.Object

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

Method Detail

convertToFB

public static FloatBuffer convertToFB(MBFImage image,
                                      ByteOrder byteOrder)

Converts an MBFImage to a FloatBuffer containing packed RGBA pixels. If the byte order is BIG_ENDIAN then the data is copied to a buffer on the Java heap which is then wrapped by a FloatBuffer. If the byte order is LITTLE_ENDIAN then we allocate a direct buffer in system RAM and copy the pixel values to that directly.

Parameters:

image - The image to convert

byteOrder - the required byte order of the data

Returns:

a FloatBuffer containing packed RGBA pixels

convertToFB

public static FloatBuffer convertToFB(FImage image,
                                      ByteOrder byteOrder)

Converts an FImage to a FloatBuffer containing packed intensity pixels. If the byte order is BIG_ENDIAN then the data is copied to a buffer on the Java heap which is then wrapped by a FloatBuffer. If the byte order is LITTLE_ENDIAN then we allocate a direct buffer in system RAM and copy the pixel values to that directly.

Parameters:

image - The image to convert

byteOrder - the required byte order of the data

Returns:

a FloatBuffer containing packed intensity pixels

convert

public static com.nativelibs4java.opencl.CLImage2D convert(com.nativelibs4java.opencl.CLContext context,
                                                           MBFImage image)

Convert an MBFImage to an RGBA CLImage2D.

Parameters:

context - the OpenCL context

image - the image to convert

Returns:

an OpenCL image

convert

public static com.nativelibs4java.opencl.CLImage2D convert(com.nativelibs4java.opencl.CLContext context,
                                                           FImage image)

Convert an FImage to CLImage2D.

Parameters:

context - the OpenCL context

image - the image to convert

Returns:

an OpenCL image

convert

public static <I extends Image<?,I>> com.nativelibs4java.opencl.CLImage2D convert(com.nativelibs4java.opencl.CLContext context,
                                                                                  I image)

Convert an Image to CLImage2D. MBFImages will be converted to floating-point CLImageFormat.ChannelOrder.RGBA CLImage2Ds. FImages will be converted to either single band or RGBA floating-point CLImage2Ds depending on the hardware. All other types of image are converted by first converting to BufferedImages, and will have 1-byte per band pixels (ARGB).

Type Parameters:

I - The type of image being converted

Parameters:

context - the OpenCL context

image - the image to convert

Returns:

an OpenCL image

convertFromFB

public static MBFImage convertFromFB(FloatBuffer fb,
                                     int width,
                                     int height,
                                     MBFImage image)

Convert packed RGBA pixels in a FloatBuffer back into an MBFImage. The method takes the MBFImage as an argument, and will fill it accordingly. If the image argument is null, a new MBFImage with the RGBA ColourSpace will be created. If the given image is the wrong size, it will be resized. If the given image has less than four bands, then only these bands will be filled. Any bands above the fourth will be ignored.

Parameters:

fb - the FloatBuffer containing the pixels

width - the width

height - the height

image - the image to write to or null

Returns:

the image

convertFromFB

public static FImage convertFromFB(FloatBuffer fb,
                                   int width,
                                   int height,
                                   FImage image)

Convert packed intensity pixels in a FloatBuffer back into an FImage. The method takes the FImage as an argument, and will fill it accordingly. If the image argument is null, a new FImage will be created. If the given image is the wrong size, it will be resized.

Parameters:

fb - the FloatBuffer containing the pixels

width - the width

height - the height

image - the image to write to or null

Returns:

the image

convert

public static MBFImage convert(com.nativelibs4java.opencl.CLQueue queue,
                               com.nativelibs4java.opencl.CLEvent evt,
                               com.nativelibs4java.opencl.CLImage2D clImage,
                               MBFImage oiImage)

Convert a CLImage2D to an MBFImage.

Parameters:

queue - the CLQueue

evt - event to wait for

clImage - the image to convert

oiImage - the output image (or null)

Returns:

the output image

convert

public static FImage convert(com.nativelibs4java.opencl.CLQueue queue,
                             com.nativelibs4java.opencl.CLEvent evt,
                             com.nativelibs4java.opencl.CLImage2D clImage,
                             FImage oiImage)

Convert a CLImage2D to an FImage.

Parameters:

queue - the CLQueue

evt - event to wait for

clImage - the image to convert

oiImage - the output image (or null)

Returns:

the output image

convert

public static <I extends Image<?,I>> I convert(com.nativelibs4java.opencl.CLQueue queue,
                                               com.nativelibs4java.opencl.CLEvent evt,
                                               com.nativelibs4java.opencl.CLImage2D clImage,
                                               I oiImage)

Convert a CLImage2D to an Image.

Type Parameters:

I - Type of image

Parameters:

queue - the CLQueue

evt - event to wait for

clImage - the image to convert

oiImage - the output image (or null)

Returns:

the output image