Om  1.0.0
A universal framework for multimedia simulation
Public Types | Public Member Functions | List of all members
om::images::base::ChannelType Class Reference

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

#include <omImageChannelType.h>

Public Types

enum  Enum {
  UNDEFINED, RED, GREEN, BLUE,
  ALPHA, GRAY, CYAN, MAGENTA,
  YELLOW, BLACK, HUE, SATURATION,
  VALUE, LIGHTNESS, Y, U,
  V, I, Q
}
 An enum type that specifies the semantic type of an image channel. More...
 

Public Member Functions

 ChannelType ()
 Create a channel type object with an UNDEFINED channel type. More...
 
 ChannelType (ChannelType::Enum newType)
 Create a channel type object from the specified channel type enum value. More...
 
 operator Enum () const
 Convert this channel type to an enum value. 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 representing the type of an image chnanel.

Member Enumeration Documentation

An enum type that specifies the semantic type of an image channel.

Enumerator
UNDEFINED 

An undefined image channel type that indicates a channel has unkonwn usage.

RED 

An image channel type indicating the channel contains red color information.

GREEN 

An image channel type indicating the channel contains green color information.

BLUE 

An image channel type indicating the channel contains blue color information.

ALPHA 

An image channel type indicating the channel contains alpha (transparency) information.

GRAY 

An image channel type indicating the channel contains grayscale information.

CYAN 

An image channel type indicating the channel contains cyan color information for the CMYK color space.

MAGENTA 

An image channel type indicating the channel contains magenta color information for the CMYK color space.

YELLOW 

An image channel type indicating the channel contains yellow color information for the CMYK color space.

BLACK 

An image channel type indicating the channel contains black color information for the CMYK color space.

HUE 

An image channel type indicating the channel contains hue information for the HSV or HSL color spaces.

SATURATION 

An image channel type indicating the channel contains saturation information for the HSV or HSL color spaces.

VALUE 

An image channel type indicating the channel contains value (intensity) information for the HSV color space.

LIGHTNESS 

An image channel type indicating the channel contains lightness information for the HSL color space.

An image channel type indicating the channel contains luminance information for the YUV color space.

An image channel type indicating the channel contains color information for the YUV color space.

An image channel type indicating the channel contains color information for the YUV color space.

An image channel type indicating the channel contains color information for the YIQ color space.

An image channel type indicating the channel contains color information for the YIQ color space.

Constructor & Destructor Documentation

om::images::base::ChannelType::ChannelType ( )
inline

Create a channel type object with an UNDEFINED channel type.

om::images::base::ChannelType::ChannelType ( ChannelType::Enum  newType)
inline

Create a channel type object from the specified channel type enum value.

Member Function Documentation

om::images::base::ChannelType::operator Enum ( ) const
inline

Convert this channel type to an enum value.

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

Return a string representation of the channel type..

om::images::base::ChannelType::operator String ( ) const
inline

Convert this channel type into a string representation.


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