boofcv.struct.image

Enum ImageDataType

java.lang.Object

java.lang.Enum<ImageDataType>

boofcv.struct.image.ImageDataType

All Implemented Interfaces:

Serializable, Comparable<ImageDataType>

public enum ImageDataType
extends Enum<ImageDataType>

Describes the physical characteristics of the internal primitive data types inside the image

Author:

Peter Abeles

Enum Constant Summary

Enum Constants

Enum Constant and Description
F Single Band floating point image
F32 Single Band 32-bit floating point image
F64 Single Band 64-bit floating point image
I Single Band Integer image
I16 Single Band 16-bit integer image
I8 Single Band 8-bit integer image
S16 Single Band Signed 16-bit integer image
S32 Single Band Signed 32-bit integer image
S64 Single Band Signed 64-bit integer image
S8 Single Band Signed 8-bit image
U16 Single Band Unsigned 16-bit image
U8 Single Band Unsigned 8-bit image

Method Summary

Methods

Modifier and Type	Method and Description
static ImageDataType	classToType(Class imageClass)
Class	getDataType() The primitive data type used by each pixel.
double	getMaxValue() Returns the maximum allowed value for data elements in this data type
double	getMinValue() Returns the minimum allowed value for data elements in this data type
int	getNumBits() Number of bits per pixel in the image.
Class	getSumType() Type of data used when summing elements in the image.
boolean	isAbstract() If the image is an abstract data type or not.
boolean	isInteger() If each pixel is an integer or not.
boolean	isSigned() If the image has a signed or unsigned data type.
static Class	typeToClass(ImageDataType type)
static ImageDataType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ImageDataType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

U8

public static final ImageDataType U8

Single Band Unsigned 8-bit image

S8

public static final ImageDataType S8

Single Band Signed 8-bit image

U16

public static final ImageDataType U16

Single Band Unsigned 16-bit image

S16

public static final ImageDataType S16

Single Band Signed 16-bit integer image

S32

public static final ImageDataType S32

Single Band Signed 32-bit integer image

S64

public static final ImageDataType S64

Single Band Signed 64-bit integer image

F32

public static final ImageDataType F32

Single Band 32-bit floating point image

F64

public static final ImageDataType F64

Single Band 64-bit floating point image

I8

public static final ImageDataType I8

Single Band 8-bit integer image

I16

public static final ImageDataType I16

Single Band 16-bit integer image

I

public static final ImageDataType I

Single Band Integer image

F

public static final ImageDataType F

Single Band floating point image

Method Detail

values

public static ImageDataType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ImageDataType c : ImageDataType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ImageDataType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

classToType

public static ImageDataType classToType(Class imageClass)

typeToClass

public static Class typeToClass(ImageDataType type)

getNumBits

public int getNumBits()

Number of bits per pixel in the image.

isAbstract

public boolean isAbstract()

If the image is an abstract data type or not.

isSigned

public boolean isSigned()

If the image has a signed or unsigned data type.

isInteger

public boolean isInteger()

If each pixel is an integer or not.

getDataType

public Class getDataType()

The primitive data type used by each pixel.

getSumType

public Class getSumType()

Type of data used when summing elements in the image.

getMaxValue

public double getMaxValue()

Returns the maximum allowed value for data elements in this data type

getMinValue

public double getMinValue()

Returns the minimum allowed value for data elements in this data type