org.openimaj.image

Class MBFImage

java.lang.Object

org.openimaj.image.Image<T[],I>

org.openimaj.image.MultiBandImage<Float,MBFImage,FImage>

org.openimaj.image.MBFImage

All Implemented Interfaces:

Serializable, Cloneable, Iterable<FImage>, ImageProvider<MBFImage>, SinglebandImageProcessor.Processable<Float,FImage,MBFImage>, SinglebandKernelProcessor.Processable<Float,FImage,MBFImage>

public class MBFImage
extends MultiBandImage<Float,MBFImage,FImage>

A multiband floating-point image.

Author:

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

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.openimaj.image.Image

Image.Field

Field Summary

Fields inherited from class org.openimaj.image.MultiBandImage

bands, colourSpace

Constructor Summary

Constructors

Constructor and Description
MBFImage() Construct an empty MBFImage with a the default RGB colourspace
MBFImage(ColourSpace colourSpace, FImage... images) Construct an MBFImage from single band images.
MBFImage(FImage... images) Construct an MBFImage from single band images with the default RGB colourspace if there are three images, RGBA if there are 4 images, or CUSTOM otherwise.
MBFImage(int[] data, int width, int height) Create an image from a BufferedImage object.
MBFImage(int[] data, int width, int height, boolean alpha) Create an image from a int[] object.
MBFImage(int width, int height) Construct an empty RGB image (3 bands)
MBFImage(int width, int height, ColourSpace colourSpace) Construct an empty image
MBFImage(int width, int height, int nbands) Construct an empty image.

Method Summary

Methods

Modifier and Type	Method and Description
protected Float[]	createPixelArray(int n) Create an array of n pixels
MBFImageRenderer	createRenderer() Create a ImageRenderer capable of drawing into this image.
MBFImageRenderer	createRenderer(RenderHints options) Create a ImageRenderer capable of drawing into this image.
static MBFImage	createRGB(FImage image) Convenience method to create an RGB MBFImage from an FImage by cloning the FImage for each of the R, G and B bands.
MBFImage	fill(Float[] colour) Fill this image with the given colour.
FImage	flatten() Flatten the bands into a single band using the average value of the pixels at each location.
FImage	flattenMax() Flatten the bands into a single band by selecting the maximum value pixel from each band.
Float[]	getPixel(int x, int y) Get the value of the pixel at coordinate (x, y).
Comparator<? super Float[]>	getPixelComparator() Returns a pixel comparator that is able to compare equality of pixels in the given image type.
Float[]	getPixelInterp(double x, double y) Get the value of a sub-pixel using linear-interpolation.
Float[]	getPixelInterp(double x, double y, Float[] b) Get the value of a sub-pixel using linear-interpolation.
float[]	getPixelNative(int x, int y) Get the value of the pixel at coordinate (x, y).
float[]	getPixelNative(Pixel p) Get the value of the pixel at coordinate p
float[][]	getPixelVectorNative(float[][] f) Returns the pixels in this image as a vector (an array of the pixel type).
MBFImage	internalAssign(byte[] bytes, int width, int height) Assign planar RGB bytes (R1G1B1R2G2B2...) to this image.
MBFImage	internalAssign(int[] data, int width, int height) Copy pixels from given ARGB buffer image into this image.
protected Float	intToT(int n) Converts the given integer to a value that can be used as a pixel value.
FImage	newBandInstance(int width, int height) Returns a new instance of an image that represents each band.
MBFImage	newInstance() Returns a new instance of a this image type.
MBFImage	newInstance(int width, int height) Create a new instance of this image subclass with given dimensions.
MBFImage	overlayInplace(MBFImage image, int x, int y) Overlays the given image on this image directly.
static MBFImage	randomImage(int width, int height) Create a random RGB image.
void	setPixel(int x, int y, Float[] val) Sets the pixel at (x,y) to the given value.
void	setPixelNative(int x, int y, float[] val) Sets the pixel at (x,y) to the given value.

Methods inherited from class org.openimaj.image.MultiBandImage

abs, add, addBand, addInplace, addInplace, addInplace, addInplace, addInplace, clip, clip, clipMax, clipMax, clipMin, clipMin, clone, deleteBand, divide, divideInplace, divideInplace, divideInplace, divideInplace, divideInplace, equals, extractCentreSubPix, extractROI, extractROI, flipX, flipY, getBand, getColourSpace, getContentArea, getField, getFieldCopy, getFieldInterpolate, getHeight, getWidth, internalAssign, internalCopy, inverse, iterator, max, min, multiply, multiplyInplace, multiplyInplace, multiplyInplace, multiplyInplace, multiplyInplace, normalise, numBands, process, process, process, process, processInplace, processInplace, processInplace, processInplace, replace, shiftLeftInplace, shiftRightInplace, subtract, subtractInplace, subtractInplace, subtractInplace, subtractInplace, subtractInplace, threshold, threshold, toByteImage, toPackedARGBPixels, zero

Methods inherited from class org.openimaj.image.Image

accumulateWith, add, add, analyseWith, analyseWith, analyseWithMasked, combineWith, defaultBackgroundColour, defaultForegroundColour, divide, divide, drawConnectedPoints, drawCubicBezier, drawImage, drawImage, drawImage, drawLine, drawLine, drawLine, drawLine, drawLine, drawLine, drawLine, drawLines, drawPoint, drawPoints, drawPolygon, drawPolygon, drawPolygonFilled, drawShape, drawShape, drawShapeFilled, drawText, drawText, drawText, drawText, drawText, drawText, drawText, drawText, extractCenter, extractCenter, extractCentreSubPix, extractCentreSubPix, extractCentreSubPix, extractROI, getBounds, getCols, getImage, getPixel, getPixelVector, getRows, multiply, multiply, overlay, padding, padding, paddingSymmetric, process, process, process, process, process, process, processInplace, processInplace, processInplace, processInplace, processInplace, processMasked, processMaskedInplace, shiftDown, shiftDown, shiftDownInplace, shiftDownInplace, shiftLeft, shiftLeft, shiftLeftInplace, shiftRight, shiftRight, shiftRightInplace, shiftUp, shiftUp, shiftUpInplace, shiftUpInplace, subtract, subtract, transform, trim

Methods inherited from class java.lang.Object

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

Constructor Detail

MBFImage

public MBFImage()

Construct an empty MBFImage with a the default RGB colourspace

MBFImage

public MBFImage(ColourSpace colourSpace,
        FImage... images)

Construct an MBFImage from single band images. The given images are used directly as the bands and are not cloned.

Parameters:

colourSpace - the colourspace

images - the bands

MBFImage

public MBFImage(FImage... images)

Construct an MBFImage from single band images with the default RGB colourspace if there are three images, RGBA if there are 4 images, or CUSTOM otherwise. The given images are used directly as the bands and are not cloned; if you want to create an RGB MBFImage from a single FImage, you would need to clone the FImage at least twice.

Parameters:

images - the bands

MBFImage

public MBFImage(int width,
        int height)

Construct an empty RGB image (3 bands)

Parameters:

width - Width of image

height - Height of image

MBFImage

public MBFImage(int width,
        int height,
        ColourSpace colourSpace)

Construct an empty image

Parameters:

width - Width of image

height - Height of image

colourSpace - the colourspace

MBFImage

public MBFImage(int width,
        int height,
        int nbands)

Construct an empty image. If the number of bands is 3, RGB is assumed, if the number is 4, then RGBA is assumed, otherwise the colourspace is set to CUSTOM.

Parameters:

width - Width of image

height - Height of image

nbands - number of bands

MBFImage

public MBFImage(int[] data,
        int width,
        int height)

Create an image from a BufferedImage object. Resultant image have RGB bands in the 0-1 range.

Parameters:

data - array of packed ARGB pixels

width - the image width

height - the image height

MBFImage

public MBFImage(int[] data,
        int width,
        int height,
        boolean alpha)

Create an image from a int[] object. Resultant image will be in the 0-1 range. If alpha is true, bands will be RGBA, otherwise RGB

Parameters:

data - array of packed ARGB pixels

width - the image width

height - the image height

alpha - should we load the alpha channel

Method Detail

flattenMax

public FImage flattenMax()

Description copied from class: MultiBandImage

Flatten the bands into a single band by selecting the maximum value pixel from each band.

Specified by:

flattenMax in class MultiBandImage<Float,MBFImage,FImage>

Returns:

A new flattened image

flatten

public FImage flatten()

Description copied from class: MultiBandImage

Flatten the bands into a single band using the average value of the pixels at each location.

Overrides:

flatten in class MultiBandImage<Float,MBFImage,FImage>

Returns:

A new single-band image containing the result.

getPixel

public Float[] getPixel(int x,
               int y)

Description copied from class: Image

Get the value of the pixel at coordinate (x, y).

Specified by:

getPixel in class Image<Float[],MBFImage>

Parameters:

x - The x-ordinate to get

y - The y-ordinate to get

Returns:

The pixel value at (x, y)

getPixelComparator

public Comparator<? super Float[]> getPixelComparator()

Description copied from class: Image

Returns a pixel comparator that is able to compare equality of pixels in the given image type.

Specified by:

getPixelComparator in class Image<Float[],MBFImage>

Returns:

A Comparator that compares pixels.

getPixelInterp

public Float[] getPixelInterp(double x,
                     double y)

Description copied from class: Image

Get the value of a sub-pixel using linear-interpolation.

Specified by:

getPixelInterp in class Image<Float[],MBFImage>

Parameters:

x - The x-ordinate to get

y - The y-ordinate to get

Returns:

The value of the interpolated point at (x,y)

getPixelInterp

public Float[] getPixelInterp(double x,
                     double y,
                     Float[] b)

Description copied from class: Image

Get the value of a sub-pixel using linear-interpolation. Also specify the colour of the background (for interpolation at the edge)

Specified by:

getPixelInterp in class Image<Float[],MBFImage>

Parameters:

x - The x-ordinate to get.

y - The y-ordinate to get.

b - The colour of the background pixel.

Returns:

The value of the interpolated point at (x,y)

internalAssign

public MBFImage internalAssign(byte[] bytes,
                      int width,
                      int height)

Assign planar RGB bytes (R1G1B1R2G2B2...) to this image.

Parameters:

bytes - the byte array

width - the width of the byte image

height - the height of the byte image

Returns:

this

internalAssign

public MBFImage internalAssign(int[] data,
                      int width,
                      int height)

Description copied from class: Image

Copy pixels from given ARGB buffer image into this image. Side-affects this image.

Specified by:

internalAssign in class Image<Float[],MBFImage>

Parameters:

data - buffer of ARGB packed integer pixels

width - the width of the buffer

height - the height of the buffer

Returns:

A reference to this image.

intToT

protected Float intToT(int n)

Description copied from class: MultiBandImage

Converts the given integer to a value that can be used as a pixel value.

Specified by:

intToT in class MultiBandImage<Float,MBFImage,FImage>

Parameters:

n - The integer to convert.

Returns:

A value that can be used as a pixel value.

newBandInstance

public FImage newBandInstance(int width,
                     int height)

Description copied from class: MultiBandImage

Returns a new instance of an image that represents each band.

Specified by:

newBandInstance in class MultiBandImage<Float,MBFImage,FImage>

Parameters:

width - The width of the image

height - The height of the image

Returns:

A new SingleBandImage of the appropriate type.

newInstance

public MBFImage newInstance()

Description copied from class: MultiBandImage

Returns a new instance of a this image type.

Specified by:

newInstance in class MultiBandImage<Float,MBFImage,FImage>

Returns:

A new MBFImage subclass type.

newInstance

public MBFImage newInstance(int width,
                   int height)

Description copied from class: MultiBandImage

Create a new instance of this image subclass with given dimensions.

Specified by:

newInstance in class MultiBandImage<Float,MBFImage,FImage>

Parameters:

width - The image width

height - The image height

Returns:

A new instance of an image of type I

See Also:

Image.newInstance(int, int)

createRenderer

public MBFImageRenderer createRenderer()

Description copied from class: Image

Create a ImageRenderer capable of drawing into this image.

Specified by:

createRenderer in class Image<Float[],MBFImage>

Returns:

the renderer

createRenderer

public MBFImageRenderer createRenderer(RenderHints options)

Description copied from class: Image

Create a ImageRenderer capable of drawing into this image.

Specified by:

createRenderer in class Image<Float[],MBFImage>

Parameters:

options - Options for the renderer

Returns:

the renderer

getPixelNative

public float[] getPixelNative(Pixel p)

Get the value of the pixel at coordinate p

Parameters:

p - The coordinate to get

Returns:

The pixel value at (x, y)

getPixelNative

public float[] getPixelNative(int x,
                     int y)

Get the value of the pixel at coordinate (x, y).

Parameters:

x - The x-coordinate to get

y - The y-coordinate to get

Returns:

The pixel value at (x, y)

getPixelVectorNative

public float[][] getPixelVectorNative(float[][] f)

Returns the pixels in this image as a vector (an array of the pixel type).

Parameters:

f - The array into which to place the data

Returns:

The pixels in the image as a vector (a reference to the given array).

setPixelNative

public void setPixelNative(int x,
                  int y,
                  float[] val)

Sets the pixel at (x,y) to the given value. Side-affects this image.

Parameters:

x - The x-coordinate of the pixel to set

y - The y-coordinate of the pixel to set

val - The value to set the pixel to.

overlayInplace

public MBFImage overlayInplace(MBFImage image,
                      int x,
                      int y)

Overlays the given image on this image directly. The method returns this image for chaining.

This method assumes the last band in the multiband image is the alpha channel. This allows a 2-channel MBFImage where the first image is an FImage and the second an alpha channel, as well as a standard RGBA image.

Specified by:

overlayInplace in class Image<Float[],MBFImage>

Parameters:

image - The image to overlay

x - The location at which to overlay the image

y - The location at which to overlay the image

Returns:

Returns this image

See Also:

Image.overlayInplace(org.openimaj.image.Image, int, int)

randomImage

public static MBFImage randomImage(int width,
                   int height)

Create a random RGB image.

Parameters:

width - the width

height - the height

Returns:

the image

createRGB

public static MBFImage createRGB(FImage image)

Convenience method to create an RGB MBFImage from an FImage by cloning the FImage for each of the R, G and B bands.

Parameters:

image - the FImage to convert

Returns:

the new RGB MBFImage

fill

public MBFImage fill(Float[] colour)

Description copied from class: MultiBandImage

Fill this image with the given colour. Should overwrite all other data stored in this image. Side-affects this image.

Overrides:

fill in class MultiBandImage<Float,MBFImage,FImage>

Parameters:

colour - the colour to fill the image with

Returns:

A reference to this image.

See Also:

Image.fill(java.lang.Object)

setPixel

public void setPixel(int x,
            int y,
            Float[] val)

Description copied from class: MultiBandImage

Sets the pixel at (x,y) to the given value. Side-affects this image.

Overrides:

setPixel in class MultiBandImage<Float,MBFImage,FImage>

Parameters:

x - The x-ordinate of the pixel to set

y - The y-ordinate of the pixel to set

val - The value to set the pixel to.

See Also:

Image.setPixel(int, int, java.lang.Object)

createPixelArray

protected Float[] createPixelArray(int n)

Description copied from class: MultiBandImage

Create an array of n pixels

Specified by:

createPixelArray in class MultiBandImage<Float,MBFImage,FImage>

Parameters:

n - number of pixels

Returns:

the array