boofcv.struct.image

Class ImageInterleaved<T extends ImageInterleaved>

java.lang.Object

boofcv.struct.image.ImageBase<T>

boofcv.struct.image.ImageMultiBand<T>

boofcv.struct.image.ImageInterleaved<T>

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

InterleavedF32, InterleavedF64, InterleavedInteger, InterleavedS64

public abstract class ImageInterleaved<T extends ImageInterleaved>
extends ImageMultiBand<T>

Base class for images that contain multiple interleaved bands. Typically each band represents a different color or frequency of light detected in the imaging sensor.

Each pixel is composed of N bands. In an RGB image each pixel would be composed of 3 elements, [red][green][blue]. The index of the green band at pixel (3,10) would be:
index of green at (3,10) = startIndex + 10*stride + 3*numBands + 1

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
int	numBands How many color bands are contained in each pixel

Fields inherited from class boofcv.struct.image.ImageBase

height, imageType, startIndex, stride, subImage, width

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ImageInterleaved()
protected	ImageInterleaved(int width, int height, int numBands) Creates a new image with all of its parameters initialized, including the data array.

Method Summary

Modifier and Type	Method and Description
protected abstract java.lang.Object	_getData() Returns the data array the image is stored in.
protected abstract void	_setData(java.lang.Object data) Sets the image's internal data array.
abstract ImageDataType	getDataType() Returns image type information
int	getIndex(int x, int y)
int	getIndex(int x, int y, int band)
int	getNumBands() Returns the number of bands or colors stored in this image.
protected abstract java.lang.Class	getPrimitiveDataType()
void	reshape(int width, int height) Changes the width and height of the image.
void	setNumBands(int numBands)
void	setTo(T orig) Sets this image equal to the specified image.
T	subimage(int x0, int y0, int x1, int y1, T subimage) Creates a sub-image from 'this' image.

Methods inherited from class boofcv.struct.image.ImageBase

_createNew, clone, createSameShape, getHeight, getImageType, getStartIndex, getStride, getWidth, indexToPixel, isInBounds, isSubimage, setHeight, setStartIndex, setStride, setWidth, subimage

Methods inherited from class java.lang.Object

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

Field Detail

numBands

public int numBands

How many color bands are contained in each pixel

Constructor Detail

ImageInterleaved

protected ImageInterleaved(int width,
                           int height,
                           int numBands)

Creates a new image with all of its parameters initialized, including the data array.

Parameters:

width - Image's width.

height - Image's height.

numBands - Number of bands/colors.

ImageInterleaved

protected ImageInterleaved()

Method Detail

subimage

public T subimage(int x0,
                  int y0,
                  int x1,
                  int y1,
                  T subimage)

Creates a sub-image from 'this' image. The subimage will share the same internal array that stores each pixel's value, but will only pertain to an axis-aligned rectangular segment of the original.

Specified by:

subimage in class ImageBase<T extends ImageInterleaved>

Parameters:

x0 - x-coordinate of top-left corner of the sub-image.

y0 - y-coordinate of top-left corner of the sub-image.

x1 - x-coordinate of bottom-right corner of the sub-image.

y1 - y-coordinate of bottom-right corner of the sub-image.

subimage -

Returns:

A sub-image of this image.

reshape

public void reshape(int width,
                    int height)

Description copied from class: ImageBase

Changes the width and height of the image. If the image data array isn't large enough to hold an image of this size then a new array is declared. Otherwise the image data array is left unchanged and only the width and height variables are modified.

Specified by:

reshape in class ImageBase<T extends ImageInterleaved>

Parameters:

width - Desired image width

height - Desired image height

getIndex

public int getIndex(int x,
                    int y)

Overrides:

getIndex in class ImageBase<T extends ImageInterleaved>

getIndex

public int getIndex(int x,
                    int y,
                    int band)

setTo

public void setTo(T orig)

Sets this image equal to the specified image. Automatically resized to match the input image.

Specified by:

setTo in class ImageBase<T extends ImageInterleaved>

Parameters:

orig - The original image whose value is to be copied into this one

getNumBands

public int getNumBands()

Description copied from class: ImageMultiBand

Returns the number of bands or colors stored in this image.

Specified by:

getNumBands in class ImageMultiBand<T extends ImageInterleaved>

Returns:

Number of bands in the image.

setNumBands

public final void setNumBands(int numBands)

getDataType

public abstract ImageDataType getDataType()

Returns image type information

Returns:

The type of image.

_getData

protected abstract java.lang.Object _getData()

Returns the data array the image is stored in.

Returns:

data array;

getPrimitiveDataType

protected abstract java.lang.Class getPrimitiveDataType()

_setData

protected abstract void _setData(java.lang.Object data)

Sets the image's internal data array.

Parameters:

data - data array