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

#include <omImageChannelInfo.h>

Public Member Functions
	ChannelInfo ()
	Create a channel info object with an UNDEFINED channel type and primitive type. More...

	ChannelInfo (const ChannelType &newType, const ScalarType &newScalarType)
	Create a channel info object with the specified semantic type and storage primitive type. More...

const ChannelType &	getType () const
	Return the semantic type of this image channel. More...

void	setType (const ChannelType &newType)
	Set the semantic type of this image channel. More...

const ScalarType &	getStorageType () const
	Return the primitive type that this image channel is stored in. More...

void	setStorageType (const ScalarType &newScalarType)
	Set the primitive type that this image channel is stored in. More...

Size	getSizeInBytes () const
	Return the number of bytes that the channel for each pixel. More...

Bool	operator== (const ChannelInfo &other) const
	Return whether or not this image channel info object is the same as another. More...

Bool	operator!= (const ChannelInfo &other) const
	Return whether or not this image channel info object is not the same as another. More...

String	toString () const
	Return a string representation of the channel type.. More...

	operator String () const
	Convert this channel type into a string representation. More...

Detailed Description

A class storing information about a channel of an image.

Constructor & Destructor Documentation

om::images::base::ChannelInfo::ChannelInfo ( )

inline

Create a channel info object with an UNDEFINED channel type and primitive type.

om::images::base::ChannelInfo::ChannelInfo	(	const ChannelType &	newType,
		const ScalarType &	newScalarType
	)

inline

Create a channel info object with the specified semantic type and storage primitive type.

const ChannelType& om::images::base::ChannelInfo::getType ( ) const

inline

Return the semantic type of this image channel.

void om::images::base::ChannelInfo::setType ( const ChannelType & newType )

inline

Set the semantic type of this image channel.

const ScalarType& om::images::base::ChannelInfo::getStorageType ( ) const

inline

Return the primitive type that this image channel is stored in.

void om::images::base::ChannelInfo::setStorageType ( const ScalarType & newScalarType )

inline

Set the primitive type that this image channel is stored in.

Size om::images::base::ChannelInfo::getSizeInBytes ( ) const

inline

Return the number of bytes that the channel for each pixel.

Bool om::images::base::ChannelInfo::operator== ( const ChannelInfo & other ) const

inline

Return whether or not this image channel info object is the same as another.

Bool om::images::base::ChannelInfo::operator!= ( const ChannelInfo & other ) const

inline

Return whether or not this image channel info object is not the same as another.

String om::images::base::ChannelInfo::toString ( ) const

Return a string representation of the channel type..

om::images::base::ChannelInfo::operator String ( ) const

inline

Convert this channel type into a string representation.

The documentation for this class was generated from the following file: