org.youscope.common.util

Class ImageTools

java.lang.Object

org.youscope.common.util.ImageTools

public class ImageTools
extends java.lang.Object

Helper functions to transform YouScope images.

Author:

Moritz Lang

Constructor Summary

Constructors

Constructor and Description
ImageTools()

Method Summary

Modifier and Type	Method and Description
static java.awt.Point	backTransformCoordinate(ImageEvent<?> image, java.awt.Point transCoords) Inverse operation to transformCoordinate().
static java.awt.image.BufferedImage	cloneImage(java.awt.image.BufferedImage bufferedImage) Clones a buffered image.
static int[][]	getHistogram(java.awt.image.BufferedImage bufferedImage, int numBins) Generates a histogram for the given image.
static int[][]	getHistogram(ImageEvent<?> imageEvent, int numBins) Generates a histogram for the given image.
static long	getMaximalPixelValue(java.awt.image.BufferedImage bufferedImage) Returns the maximal intensity a pixel in the image can have.
static java.awt.image.BufferedImage	getMicroscopeImage(ImageEvent<?> imageEvent) Creates an image from microscope supplied data.
static java.awt.image.BufferedImage	getMicroscopeImage(ImageEvent<?> imageEvent, java.awt.image.BufferedImage bufferedImage) Creates an image from microscope supplied data, and saves it in the provided image.
static long	getPixelValue(java.awt.image.BufferedImage bufferedImage, int x, int y) Returns the intensity of the pixel at the (zero based) x and y position in original coordinates.
static long	getPixelValue(ImageEvent<?> image, int x, int y) Returns the intensity of the pixel at the (zero based) x and y position in original coordinates.
static java.awt.image.BufferedImage	getScaledImage(java.awt.image.BufferedImage bufferedImage, float lowerCutoff, float upperCutoff, java.awt.image.BufferedImage returnVal) Returns a scaled version of the image.
static java.awt.image.BufferedImage	getScaledMicroscopeImage(ImageEvent<?> imageEvent) Creates an image from microscope supplied data.
static java.awt.image.BufferedImage	getScaledMicroscopeImage(ImageEvent<?> imageEvent, float lowerCutoff, float upperCutoff) Creates an image from microscope supplied data.
static java.awt.image.BufferedImage	getScaledMicroscopeImage(ImageEvent<?> imageEvent, float lowerCutoff, float upperCutoff, java.awt.image.BufferedImage bufferedImage) Creates an image from microscope supplied data, and saves it in the provided image.
static ImageEvent<?>	toYouScopeImage(java.awt.image.BufferedImage image) Converts a BufferedImage to YouScope's internal raw + meta data format.
static java.awt.Point	transformCoordinate(ImageEvent<?> image, java.awt.Point orgCoords) Translates the (zero based) coordinates in the not transposed and not switched coordinate system (as the image is obtained from the camera) to the new coordinate system, in which the image axes are eventually transposed and/or switched.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageTools

public ImageTools()

Method Detail

toYouScopeImage

public static ImageEvent<?> toYouScopeImage(java.awt.image.BufferedImage image)
                                     throws ImageConvertException

Converts a BufferedImage to YouScope's internal raw + meta data format. Note that only a limited set of meta data (width, height, bytes per pixel, bit depth, and number of bands) is set.

Parameters:

image - The image which should be converted.

Returns:

The resulting image.

Throws:

ImageConvertException

getMicroscopeImage

public static java.awt.image.BufferedImage getMicroscopeImage(ImageEvent<?> imageEvent,
                                                              java.awt.image.BufferedImage bufferedImage)
                                                       throws ImageConvertException

Creates an image from microscope supplied data, and saves it in the provided image. Note that a new image is created if the provided image has a different size or type than the image event.

Parameters:

imageEvent - The raw image data and metadata supplied by the microscope.

bufferedImage - The image in which the data should be saved in, or null to create a new image.

Returns:

created Image.

Throws:

ImageConvertException

getMicroscopeImage

public static java.awt.image.BufferedImage getMicroscopeImage(ImageEvent<?> imageEvent)
                                                       throws ImageConvertException

Creates an image from microscope supplied data.

Parameters:

imageEvent - The raw image data and metadata supplied by the microscope.

Returns:

created Image.

Throws:

ImageConvertException

getScaledMicroscopeImage

public static java.awt.image.BufferedImage getScaledMicroscopeImage(ImageEvent<?> imageEvent,
                                                                    float lowerCutoff,
                                                                    float upperCutoff)
                                                             throws ImageConvertException

Creates an image from microscope supplied data. Furthermore the image is scaled such that all lowerCutoff * 100% of the colors become black and the upperCutoff * 100% of the colors become white.

Parameters:

imageEvent - The raw image data and metadata supplied by the microscope.

lowerCutoff - The lower cutoff for pixel grayness.

upperCutoff - The upper cutoff for pixel grayness.

Returns:

created Image.

Throws:

ImageConvertException

cloneImage

public static java.awt.image.BufferedImage cloneImage(java.awt.image.BufferedImage bufferedImage)

Clones a buffered image. The two images are independent, i.e. changes in one do not affect the other.

Parameters:

bufferedImage - The image to clone.

Returns:

the cloned image.

getScaledImage

public static java.awt.image.BufferedImage getScaledImage(java.awt.image.BufferedImage bufferedImage,
                                                          float lowerCutoff,
                                                          float upperCutoff,
                                                          java.awt.image.BufferedImage returnVal)

Returns a scaled version of the image. Only supports 8 and 16bit grayscale images. For all other images, returns the original image.

Parameters:

bufferedImage - The buffered image to transform.

lowerCutoff - Lower cutoff (0<=lowerCutoff

upperCutoff - Upper cutoff (0<=lowerCutoff

returnVal - Image to save the result in, or null to create new image. Note: the function might save the resulting image in this variable, or might not, depending on if returnVal is suited.

Returns:

The scaled image, or the original image if image could not be scaled.

getPixelValue

public static long getPixelValue(ImageEvent<?> image,
                                 int x,
                                 int y)

Returns the intensity of the pixel at the (zero based) x and y position in original coordinates. Use backTransformCoordinate() if only transformed coordinates are available. Method does only work if image is a 1 or 2 byte grayscale image.

Parameters:

image - The image from which the pixel intensity should be extracted.

x - The x position of the pixel (0<=x

y - The y position of the pixel (0<=y

Returns:

The pixel intensity at the specific position, or -1 if position is invalid or image is not a 1 or 2 byte grayscale image.

transformCoordinate

public static java.awt.Point transformCoordinate(ImageEvent<?> image,
                                                 java.awt.Point orgCoords)

Translates the (zero based) coordinates in the not transposed and not switched coordinate system (as the image is obtained from the camera) to the new coordinate system, in which the image axes are eventually transposed and/or switched.

Parameters:

image - The image in which the coordinates are given.

orgCoords - The original coordinates.

Returns:

the switched coordinates, or null if the original coordinates were invalid.

backTransformCoordinate

public static java.awt.Point backTransformCoordinate(ImageEvent<?> image,
                                                     java.awt.Point transCoords)

Inverse operation to transformCoordinate(). Takes a point corresponding to a pixel position in the transformed image, and returns the original coordinates.

Parameters:

image - The image in which the coordinates are given.

transCoords - The transformed coordinates

Returns:

the original coordinates, or null if the transformed coordinates were invalid.

getScaledMicroscopeImage

public static java.awt.image.BufferedImage getScaledMicroscopeImage(ImageEvent<?> imageEvent,
                                                                    float lowerCutoff,
                                                                    float upperCutoff,
                                                                    java.awt.image.BufferedImage bufferedImage)
                                                             throws ImageConvertException

Creates an image from microscope supplied data, and saves it in the provided image. Note that a new image is created if the provided image has a different size or type than the image event. Furthermore the image is scaled such that all lowerCutoff * 100% of the colors become black and the upperCutoff * 100% of the colors become white.

Parameters:

imageEvent - The raw image data and metadata supplied by the microscope.

lowerCutoff - The lower cutoff for pixel grayness.

upperCutoff - The upper cutoff for pixel grayness.

bufferedImage - The image in which the data should be saved in, or null to create a new image.

Returns:

created Image.

Throws:

ImageConvertException

getPixelValue

public static long getPixelValue(java.awt.image.BufferedImage bufferedImage,
                                 int x,
                                 int y)

Returns the intensity of the pixel at the (zero based) x and y position in original coordinates. Method does only work if image is a 1 or 2 byte grayscale image.

Parameters:

bufferedImage - The image from which the pixel intensity should be extracted.

x - The x position of the pixel (0<=x

y - The y position of the pixel (0<=y

Returns:

The pixel intensity at the specific position, or -1 if position is invalid or image is not a 1 or 2 byte grayscale image.

getMaximalPixelValue

public static long getMaximalPixelValue(java.awt.image.BufferedImage bufferedImage)

Returns the maximal intensity a pixel in the image can have. Method does only work if image is a 1 or 2 byte grayscale image.

Parameters:

bufferedImage - The image from which the maximal pixel intensity should be returned.

Returns:

The maximal pixel intensity at the specific position, or -1 if image is not a 1 or 2 byte grayscale image.

getHistogram

public static int[][] getHistogram(java.awt.image.BufferedImage bufferedImage,
                                   int numBins)
                            throws ImageConvertException

Generates a histogram for the given image.

Parameters:

bufferedImage - The buffered image, either stored as byte or short gray image, or int RGB/BGR image.

numBins - The number of bins the histogram should have.

Returns:

histogram.

Throws:

ImageConvertException

getHistogram

public static int[][] getHistogram(ImageEvent<?> imageEvent,
                                   int numBins)
                            throws ImageConvertException

Generates a histogram for the given image.

Parameters:

imageEvent - The raw image data and metadata supplied by the microscope.

numBins - The number of bins the histogram should have.

Returns:

histogram.

Throws:

ImageConvertException

getScaledMicroscopeImage

public static java.awt.image.BufferedImage getScaledMicroscopeImage(ImageEvent<?> imageEvent)
                                                             throws ImageConvertException

Creates an image from microscope supplied data. The grayscale values of each pixel is scaled such that the lightest pixels are white and the darkest black.

Parameters:

imageEvent - The raw image data and metadata supplied by the microscope.

Returns:

Created image.

Throws:

ImageConvertException