Package boofcv.struct.image

Class ImageType<T extends ImageBase>

java.lang.Object

boofcv.struct.image.ImageType<T>

All Implemented Interfaces:

Serializable

public class ImageType<T extends ImageBase>
extends Object
implements Serializable

Specifies the type of image data structure.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ImageType.Family

Field Summary

Fields

Modifier and Type	Field	Description
static final ImageType<InterleavedF32>	IL_F32
static final ImageType<InterleavedF64>	IL_F64
static final ImageType<InterleavedS16>	IL_S16
static final ImageType<InterleavedS32>	IL_S32
static final ImageType<InterleavedS64>	IL_S64
static final ImageType<InterleavedS8>	IL_S8
static final ImageType<InterleavedU16>	IL_U16
static final ImageType<InterleavedU8>	IL_U8
int	numBands	Number of bands in the image.
static final ImageType<Planar<GrayF32>>	PL_F32
static final ImageType<Planar<GrayF64>>	PL_F64
static final ImageType<Planar<GrayS16>>	PL_S16
static final ImageType<Planar<GrayS32>>	PL_S32
static final ImageType<Planar<GrayS64>>	PL_S64
static final ImageType<Planar<GrayS8>>	PL_S8
static final ImageType<Planar<GrayU16>>	PL_U16
static final ImageType<Planar<GrayU8>>	PL_U8
static final ImageType<GrayF32>	SB_F32
static final ImageType<GrayF64>	SB_F64
static final ImageType<GrayS16>	SB_S16
static final ImageType<GrayS32>	SB_S32
static final ImageType<GrayS64>	SB_S64
static final ImageType<GrayS8>	SB_S8
static final ImageType<GrayU16>	SB_U16
static final ImageType<GrayU8>	SB_U8

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ImageType()	Create an image type with default values
	ImageType(ImageType.Family family, ImageDataType dataType, int numBands)

Method Summary

Modifier and Type	Method	Description
T[]	createArray(int length)	Creates an array of the specified iamge type
T	createImage(int width, int height)	Creates a new image.
ImageDataType	getDataType()
ImageType.Family	getFamily()
Class	getImageClass()
static Class	getImageClass(ImageType.Family family, ImageDataType dataType)
int	getNumBands()
static <I extends ImageInterleaved<I>> ImageType<I>	il(int numBands, ImageDataType type)
static <I extends ImageInterleaved<I>> ImageType<I>	il(int numBands, Class<I> imageType)
boolean	isSameType(ImageType o)	Returns true if the passed in ImageType is the same as this image type
static <I extends ImageGray<I>> ImageType<Planar<I>>	pl(int numBands, ImageDataType type)
static <I extends ImageGray<I>> ImageType<Planar<I>>	pl(int numBands, Class<I> imageType)
void	setTo(ImageType o)	Sets 'this' to be identical to 'o'
static <I extends ImageGray<I>> ImageType<I>	single(ImageDataType type)
static <I extends ImageGray<I>> ImageType<I>	single(Class<I> imageType)
static <T extends ImageBase> ImageType<T>	stringToType(String name, int numBands)	Converts the short hand string into an image type.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

SB_U8

public static final ImageType<GrayU8> SB_U8

SB_S8

public static final ImageType<GrayS8> SB_S8

SB_U16

public static final ImageType<GrayU16> SB_U16

SB_S16

public static final ImageType<GrayS16> SB_S16

SB_S32

public static final ImageType<GrayS32> SB_S32

SB_S64

public static final ImageType<GrayS64> SB_S64

SB_F32

public static final ImageType<GrayF32> SB_F32

SB_F64

public static final ImageType<GrayF64> SB_F64

IL_U8

public static final ImageType<InterleavedU8> IL_U8

IL_S8

public static final ImageType<InterleavedS8> IL_S8

IL_U16

public static final ImageType<InterleavedU16> IL_U16

IL_S16

public static final ImageType<InterleavedS16> IL_S16

IL_S32

public static final ImageType<InterleavedS32> IL_S32

IL_S64

public static final ImageType<InterleavedS64> IL_S64

IL_F32

public static final ImageType<InterleavedF32> IL_F32

IL_F64

public static final ImageType<InterleavedF64> IL_F64

PL_U8

public static final ImageType<Planar<GrayU8>> PL_U8

PL_S8

public static final ImageType<Planar<GrayS8>> PL_S8

PL_U16

public static final ImageType<Planar<GrayU16>> PL_U16

PL_S16

public static final ImageType<Planar<GrayS16>> PL_S16

PL_S32

public static final ImageType<Planar<GrayS32>> PL_S32

PL_S64

public static final ImageType<Planar<GrayS64>> PL_S64

PL_F32

public static final ImageType<Planar<GrayF32>> PL_F32

PL_F64

public static final ImageType<Planar<GrayF64>> PL_F64

numBands

public int numBands

Number of bands in the image. Single band images ignore this field.

Constructor Details

ImageType

public ImageType(ImageType.Family family,
 ImageDataType dataType,
 int numBands)

ImageType

protected ImageType()

Create an image type with default values

Method Details

single

public static <I extends ImageGray<I>> ImageType<I> single(Class<I> imageType)

single

public static <I extends ImageGray<I>> ImageType<I> single(ImageDataType type)

pl

public static <I extends ImageGray<I>>
ImageType<Planar<I>> pl(int numBands,
 Class<I> imageType)

pl

public static <I extends ImageGray<I>>
ImageType<Planar<I>> pl(int numBands,
 ImageDataType type)

il

public static <I extends ImageInterleaved<I>>
ImageType<I> il(int numBands,
 Class<I> imageType)

il

public static <I extends ImageInterleaved<I>>
ImageType<I> il(int numBands,
 ImageDataType type)

stringToType

public static <T extends ImageBase> ImageType<T> stringToType(String name,
 int numBands)

Converts the short hand string into an image type. A new instance is returned.

getDataType

public ImageDataType getDataType()

createImage

public T createImage(int width,
 int height)

Creates a new image.

Parameters:

width - Number of columns in the image.

height - Number of rows in the image.

Returns:

New instance of the image.

createArray

public T[] createArray(int length)

Creates an array of the specified iamge type

Parameters:

length - Number of elements in the array

Returns:

array of image type

getNumBands

public int getNumBands()

getFamily

public ImageType.Family getFamily()

getImageClass

public Class getImageClass()

getImageClass

public static Class getImageClass(ImageType.Family family,
 ImageDataType dataType)

toString

public String toString()

Overrides:

toString in class Object

isSameType

public boolean isSameType(ImageType o)

Returns true if the passed in ImageType is the same as this image type

setTo

public void setTo(ImageType o)

Sets 'this' to be identical to 'o'

Parameters:

o - What is to be copied.