Celartem::PhotometricComponents

Celartem::PhotometricComponents Struct Reference

#include <pxl_pixeltypes.h>

List of all members.

Public Member Functions

 PhotometricComponents (Photometric inPhotometric=pmRGB8)
void setPhotometric (Photometric inPhotometric)
Photometric composePhotometric () const
bool isValid () const

Public Attributes

ElementType elementType
 Element type; the unit for storing the value.
ColorSpace colorSpace
 Color space.
ChannelLayout layout
 Channel Layout.
size_t channels
 Number of channels.
AlphaType alphaType
 Whether the alpha-channel is associated or not.

Detailed Description

PhotometricComponents helps you to manipulate the components that forms the Photometric.
For the specification of Photometric, you can refer to Photometric Bit Layout. But we don't recommend you to modify the bit fields manually.
See also:
Photometric, PixelAttributes, ElementType, ColorSpace, ChannelType, Photometric Bit Layout

Definition at line 732 of file pxl_pixeltypes.h.

Constructor & Destructor Documentation

Celartem::PhotometricComponents::PhotometricComponents ( Photometric  inPhotometric = pmRGB8  )  [inline]

This constructor initializes the components by the specified Photometric.

Parameters:
inPhotometric The photometric to initialize the components. You can also omit this parameter and then regarded as specifing pmRGB8.
See also:
pmRGB8, Photometric

Definition at line 758 of file pxl_pixeltypes.h.

Member Function Documentation

void Celartem::PhotometricComponents::setPhotometric ( Photometric  inPhotometric  )  [inline]

This function set a Photometric to this instance. All the components in the instance is initialized using the Photometric value.

Parameters:
inPhotometric The photometric to initialize the components.
See also:
Photometric

Definition at line 770 of file pxl_pixeltypes.h.

Referenced by PhotometricComponents().

Photometric Celartem::PhotometricComponents::composePhotometric (  )  const [inline]

This function composes a new Photometric value based on the components in the instance.
If the value of channels is 0 on the call of this function, this function automatically calculates the number of channels corresponding to the current components.

Returns:
The photometric value newly composed.
See also:
Photometric

Definition at line 790 of file pxl_pixeltypes.h.

Referenced by isValid().

bool Celartem::PhotometricComponents::isValid (  )  const [inline]

This function determines whether the current components can compose a valid photometric or not.

Returns:
true if valid, otherwise false.
See also:
Photometric, PixelAttributes, PixelAttributes::isValid

Definition at line 823 of file pxl_pixeltypes.h.

Member Data Documentation

ElementType Celartem::PhotometricComponents::elementType

Element type; the unit for storing the value.

Definition at line 735 of file pxl_pixeltypes.h.

Referenced by composePhotometric(), and setPhotometric().

ColorSpace Celartem::PhotometricComponents::colorSpace

Color space.

Definition at line 738 of file pxl_pixeltypes.h.

Referenced by composePhotometric(), and setPhotometric().

ChannelLayout Celartem::PhotometricComponents::layout

Channel Layout.

Definition at line 741 of file pxl_pixeltypes.h.

Referenced by composePhotometric(), and setPhotometric().

size_t Celartem::PhotometricComponents::channels

Number of channels.

Definition at line 744 of file pxl_pixeltypes.h.

Referenced by composePhotometric(), and setPhotometric().

AlphaType Celartem::PhotometricComponents::alphaType

Whether the alpha-channel is associated or not.

Definition at line 747 of file pxl_pixeltypes.h.

Referenced by composePhotometric(), and setPhotometric().

The documentation for this struct was generated from the following file:
This document is automatically generated using doxygen 1.5.4 at Fri Jun 27 18:23:13 2008.