A namespace containing low-level basic classes for image processing. More...

Classes
class	ChannelInfo
	A class storing information about a channel of an image. More...

class	ChannelType
	A class representing the type of an image chnanel. More...

class	Color3D
	A template class representing a 3-component color. More...

class	Color4D
	A template class representing a 4-component color. More...

class	ColorSpace
	A class that describes the space where color is represented in an image. More...

class	Image
	A class that stores packed pixel data for images with an arbitrary number of dimensions. More...

class	ImageBuffer
	A class that contains a floating-point representation of an image that is used for efficient accurate image processing. More...

class	ImageFormat
	An enum class representing the different kinds of image encoding formats. More...

class	ImageFormatFlags
	A class that stores different boolean parameters for image formats. More...

class	ImageFormatSettings
	A class that specifies common settings for image formats. More...

class	ImageFrame
	A class that provides all of the information needed for an ImageFilter to process image data. More...

class	PixelFormat
	A class that describes the storage format for an image pixel. More...

Typedefs
typedef Color3D< Int >	Color3i

typedef Color3D< UByte >	Color3b

typedef Color3D< Float >	Color3f

typedef Color3D< Double >	Color3d

typedef Color4D< Int >	Color4i

typedef Color4D< UByte >	Color4b

typedef Color4D< Float >	Color4f

typedef Color4D< Double >	Color4d

Functions
template<typename T >
Color3D< T >	operator+ (const T &value, const Color3D< T > &color)
	Add a value to every component of the color. More...

template<typename T >
Color3D< T >	operator- (const T &value, const Color3D< T > &color)
	Subtract every component of the color from the value, returning a color result. More...

template<typename T >
Color3D< T >	operator* (const T &value, const Color3D< T > &color)
	Multiply every component of the color with the value, returning a color result. More...

template<typename T >
Color3D< T >	operator/ (const T &value, const Color3D< T > &color)
	Divide a value by every component of the color, returning a color result. More...

template<typename T >
Color4D< T >	operator+ (const T &value, const Color4D< T > &color)
	Add a value to every component of the color. More...

template<typename T >
Color4D< T >	operator- (const T &value, const Color4D< T > &color)
	Subtract every component of the color from the value, returning a color result. More...

template<typename T >
Color4D< T >	operator* (const T &value, const Color4D< T > &color)
	Multiply every component of the color with the value, returning a color result. More...

template<typename T >
Color4D< T >	operator/ (const T &value, const Color4D< T > &color)
	Divide a value by every component of the color, returning a color result. More...

Detailed Description

A namespace containing low-level basic classes for image processing.

Typedef Documentation

typedef Color3D<Int> om::images::base::Color3i

typedef Color3D<UByte> om::images::base::Color3b

typedef Color3D<Float> om::images::base::Color3f

typedef Color3D<Double> om::images::base::Color3d

typedef Color4D<Int> om::images::base::Color4i

typedef Color4D<UByte> om::images::base::Color4b

typedef Color4D<Float> om::images::base::Color4f

typedef Color4D<Double> om::images::base::Color4d

Function Documentation

template<typename T >

Color3D<T> om::images::base::operator+	(	const T &	value,
		const Color3D< T > &	color
	)

inline

Add a value to every component of the color.

This operator adds the value parameter to every component of the color, and returns a color representing this result. It does not modifiy the original color.

Parameters

value	- The value to add to all components of the color.
color	- The color to be added to.

Returns: The resulting color of this addition.

template<typename T >

Color3D<T> om::images::base::operator-	(	const T &	value,
		const Color3D< T > &	color
	)

inline

Subtract every component of the color from the value, returning a color result.

This operator subtracts every component of the 2nd paramter, a color, from the 1st paramter, a value, and then returns a color containing the resulting coloral components. This operator does not modify the orignal color.

Parameters

value	- The value to subtract all components of the color from.
color	- The color to be subtracted.

Returns: The resulting color of this subtraction.

template<typename T >

Color3D<T> om::images::base::operator*	(	const T &	value,
		const Color3D< T > &	color
	)

inline

Multiply every component of the color with the value, returning a color result.

This operator multiplies every component of the 2nd paramter, a color, from the 1st paramter, a value, and then returns a color containing the resulting coloral components. This operator does not modify the orignal color.

Parameters

value	- The value to multiply with all components of the color.
color	- The color to be multiplied with.

Returns: The resulting color of this multiplication.

template<typename T >

Color3D<T> om::images::base::operator/	(	const T &	value,
		const Color3D< T > &	color
	)

inline

Divide a value by every component of the color, returning a color result.

This operator divides the provided value by every component of the color, returning a color representing the component-wise division. The operator does not modify the original color.

Parameters

value	- The value to be divided by all components of the color.
color	- The color to be divided by.

Returns: The resulting color of this division.

template<typename T >

Color4D<T> om::images::base::operator+	(	const T &	value,
		const Color4D< T > &	color
	)

inline

Add a value to every component of the color.

This operator adds the value parameter to every component of the color, and returns a color representing this result. It does not modifiy the original color.

Parameters

value	- The value to add to all components of the color.
color	- The color to be added to.

Returns: The resulting color of this addition.

template<typename T >

Color4D<T> om::images::base::operator-	(	const T &	value,
		const Color4D< T > &	color
	)

inline

Subtract every component of the color from the value, returning a color result.

This operator subtracts every component of the 2nd paramter, a color, from the 1st paramter, a value, and then returns a color containing the resulting coloral components. This operator does not modify the orignal color.

Parameters

value	- The value to subtract all components of the color from.
color	- The color to be subtracted.

Returns: The resulting color of this subtraction.

template<typename T >

Color4D<T> om::images::base::operator*	(	const T &	value,
		const Color4D< T > &	color
	)

inline

Multiply every component of the color with the value, returning a color result.

This operator multiplies every component of the 2nd paramter, a color, from the 1st paramter, a value, and then returns a color containing the resulting coloral components. This operator does not modify the orignal color.

Parameters

value	- The value to multiply with all components of the color.
color	- The color to be multiplied with.

Returns: The resulting color of this multiplication.

template<typename T >

Color4D<T> om::images::base::operator/	(	const T &	value,
		const Color4D< T > &	color
	)

inline

Divide a value by every component of the color, returning a color result.

This operator divides the provided value by every component of the color, returning a color representing the component-wise division. The operator does not modify the original color.

Parameters

value	- The value to be divided by all components of the color.
color	- The color to be divided by.

Returns: The resulting color of this division.

Classes

Typedefs

Functions

Detailed Description

Typedef Documentation

Function Documentation