org.openimaj.image

Class SingleBandImage<Q extends Comparable<Q>,I extends SingleBandImage<Q,I>>

java.lang.Object

org.openimaj.image.Image<Q,I>

org.openimaj.image.SingleBandImage<Q,I>

Type Parameters:

Q - The pixel type

I - The concrete image subclass type.

All Implemented Interfaces:

Serializable, Cloneable, ImageProvider<I>, SinglebandImageProcessor.Processable<Q,I,I>, SinglebandKernelProcessor.Processable<Q,I,I>

Direct Known Subclasses:

FImage

public abstract class SingleBandImage<Q extends Comparable<Q>,I extends SingleBandImage<Q,I>>
extends Image<Q,I>
implements SinglebandImageProcessor.Processable<Q,I,I>, SinglebandKernelProcessor.Processable<Q,I,I>

A base class for representing a single band image of any pixel type.

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

Modifier and Type	Field and Description
int	height The image height
int	width The image width

Constructor Summary

Constructors

Constructor and Description
SingleBandImage()

Method Summary

Methods

Modifier and Type	Method and Description
abstract I	clone() Deep copy of an image (internal image buffers copied).
boolean	equals(Object obj)
I	fill(Q colour) Fill this image with the given colour.
int	getHeight() Returns the image height in pixels.
int	getWidth() Get the width (number of columns) in this image.
I	process(KernelProcessor<Q,I> p) Process this image with the given KernelProcessor and return new image containing the result.
I	process(KernelProcessor<Q,I> p, boolean pad) Process this image with the given KernelProcessor and return new image containing the result.
I	process(SinglebandImageProcessor<Q,I> p) Process with the given SinglebandImageProcessor returning a new image.
I	process(SinglebandKernelProcessor<Q,I> p)
I	process(SinglebandKernelProcessor<Q,I> p, boolean pad)
I	processInplace(SinglebandImageProcessor<Q,I> p) Process with the given SinglebandImageProcessor storing the result in this processable image.
I	processInplace(SinglebandKernelProcessor<Q,I> p)
I	processInplace(SinglebandKernelProcessor<Q,I> p, boolean pad)

Methods inherited from class org.openimaj.image.Image

abs, accumulateWith, add, add, addInplace, addInplace, analyseWith, analyseWith, analyseWithMasked, clip, clipMax, clipMin, combineWith, createRenderer, createRenderer, defaultBackgroundColour, defaultForegroundColour, divide, divide, divideInplace, divideInplace, 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, extractCentreSubPix, extractROI, extractROI, extractROI, flipX, flipY, getBounds, getCols, getContentArea, getField, getFieldCopy, getFieldInterpolate, getImage, getPixel, getPixel, getPixelComparator, getPixelInterp, getPixelInterp, getPixelVector, getRows, internalAssign, internalAssign, internalCopy, inverse, max, min, multiply, multiply, multiplyInplace, multiplyInplace, newInstance, normalise, overlay, overlayInplace, padding, padding, paddingSymmetric, process, process, process, process, processInplace, processInplace, processInplace, processInplace, processInplace, processMasked, processMaskedInplace, replace, setPixel, shiftDown, shiftDown, shiftDownInplace, shiftDownInplace, shiftLeft, shiftLeft, shiftLeftInplace, shiftLeftInplace, shiftRight, shiftRight, shiftRightInplace, shiftRightInplace, shiftUp, shiftUp, shiftUpInplace, shiftUpInplace, subtract, subtract, subtractInplace, subtractInplace, threshold, toByteImage, toPackedARGBPixels, transform, trim, zero

Methods inherited from class java.lang.Object

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

Field Detail

height

public int height

The image height

width

public int width

The image width

Constructor Detail

SingleBandImage

public SingleBandImage()

Method Detail

getHeight

public int getHeight()

Returns the image height in pixels.

Specified by:

getHeight in class Image<Q extends Comparable<Q>,I extends SingleBandImage<Q,I>>

Returns:

The image height in pixels.

See Also:

Image.getHeight()

getWidth

public int getWidth()

Get the width (number of columns) in this image.

Specified by:

getWidth in class Image<Q extends Comparable<Q>,I extends SingleBandImage<Q,I>>

Returns:

the image width

See Also:

Image.getWidth()

process

public I process(KernelProcessor<Q,I> p)

Process this image with the given KernelProcessor and return new image containing the result.

Overrides:

process in class Image<Q extends Comparable<Q>,I extends SingleBandImage<Q,I>>

Parameters:

p - The KernelProcessor to apply.

Returns:

A new image containing the result.

See Also:

Image.process(org.openimaj.image.processor.KernelProcessor)

process

public I process(KernelProcessor<Q,I> p,
        boolean pad)

Process this image with the given KernelProcessor and return new image containing the result.

Overrides:

process in class Image<Q extends Comparable<Q>,I extends SingleBandImage<Q,I>>

Parameters:

p - The KernelProcessor to apply.

pad - Should the image be zero padded so the kernel reaches the edges of the output

Returns:

A new image containing the result.

See Also:

Image.process(org.openimaj.image.processor.KernelProcessor, boolean)

process

public I process(SinglebandKernelProcessor<Q,I> p)

Specified by:

process in interface SinglebandKernelProcessor.Processable<Q extends Comparable<Q>,I extends SingleBandImage<Q,I>,I extends SingleBandImage<Q,I>>

Parameters:

p - the processor

Returns:

the processed image

See Also:

SinglebandKernelProcessor.Processable.process(org.openimaj.image.processor.SinglebandKernelProcessor)

process

public I process(SinglebandKernelProcessor<Q,I> p,
        boolean pad)

Specified by:

process in interface SinglebandKernelProcessor.Processable<Q extends Comparable<Q>,I extends SingleBandImage<Q,I>,I extends SingleBandImage<Q,I>>

Parameters:

p - the processor

pad - Should the image be zero padded so the kernel reaches the edges of the output

Returns:

the processed image

See Also:

SinglebandKernelProcessor.Processable.process(org.openimaj.image.processor.SinglebandKernelProcessor, boolean)

processInplace

public I processInplace(SinglebandKernelProcessor<Q,I> p)

Specified by:

processInplace in interface SinglebandKernelProcessor.Processable<Q extends Comparable<Q>,I extends SingleBandImage<Q,I>,I extends SingleBandImage<Q,I>>

Parameters:

p - the processor

Returns:

the processed image

See Also:

SinglebandKernelProcessor.Processable.processInplace(org.openimaj.image.processor.SinglebandKernelProcessor)

processInplace

public I processInplace(SinglebandKernelProcessor<Q,I> p,
               boolean pad)

Specified by:

processInplace in interface SinglebandKernelProcessor.Processable<Q extends Comparable<Q>,I extends SingleBandImage<Q,I>,I extends SingleBandImage<Q,I>>

Parameters:

p - the processor

pad - Should the image be zero padded so the kernel reaches the edges of the output

Returns:

the processed image

See Also:

SinglebandKernelProcessor.Processable.processInplace(org.openimaj.image.processor.SinglebandKernelProcessor, boolean)

process

public I process(SinglebandImageProcessor<Q,I> p)

Process with the given SinglebandImageProcessor returning a new image.

Specified by:

process in interface SinglebandImageProcessor.Processable<Q extends Comparable<Q>,I extends SingleBandImage<Q,I>,I extends SingleBandImage<Q,I>>

Parameters:

p - The processor to process the image with

Returns:

A new image containing the result.

See Also:

SinglebandImageProcessor.Processable.process(org.openimaj.image.processor.SinglebandImageProcessor)

processInplace

public I processInplace(SinglebandImageProcessor<Q,I> p)

Process with the given SinglebandImageProcessor storing the result in this processable image. Side-affects this processable image.

Specified by:

processInplace in interface SinglebandImageProcessor.Processable<Q extends Comparable<Q>,I extends SingleBandImage<Q,I>,I extends SingleBandImage<Q,I>>

Parameters:

p - The processor to process the image with

Returns:

A new image containing the result.

See Also:

SinglebandImageProcessor.Processable.processInplace(org.openimaj.image.processor.SinglebandImageProcessor)

fill

public I fill(Q colour)

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

Specified by:

fill in class Image<Q extends Comparable<Q>,I extends SingleBandImage<Q,I>>

Parameters:

colour - the colour to fill the image with

Returns:

A reference to this image.

See Also:

Image.fill(java.lang.Object)

clone

public abstract I clone()

Deep copy of an image (internal image buffers copied).

Specified by:

clone in class Image<Q extends Comparable<Q>,I extends SingleBandImage<Q,I>>

Returns:

A copy of this image.

See Also:

Image.clone()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object