Celartem::ColorProfile

Celartem::ColorProfile Class Reference

#include <pxl_colorprofile.h>

Inheritance diagram for Celartem::ColorProfile:

Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual String getTextTag (const char *inTagName) const =0
virtual String getDescription () const =0
virtual String getCopyright () const =0
virtual String getManufacturer () const =0
virtual String getDeviceModel () const =0
virtual ColorSpace getColorSpace () const =0
virtual const SimpleArray< u8 > & getRawData () const =0
virtual bool isCompatiblePhotometric (Photometric inPhotometric) const =0
virtual void setAsMetadata (DataStore *ioMetadata) const =0

Static Public Member Functions

static AutoPtr< ColorProfile > create (Storage *inStorage)
static AutoPtr< ColorProfile > create (const void *inBuffer, size_t inSize)
static AutoPtr< ColorProfile > create (const DataStore *inMetadata)
static AutoPtr< ColorProfile > getSRGBProfile ()
static AutoPtr< ColorProfile > create (const String &inName)
static AutoPtr< ColorProfile > createRGBProfile (const PrimaryColorChromaticities &inPrimaries, const GammaTable &inRedGamma, const GammaTable &inGreenGamma, const GammaTable &inBlueGamma)
static AutoPtr< ColorProfile > createGrayProfile (double inGamma, size_t inResolution=256)

Detailed Description

ColorProfile holds an color profile. The instances are used with ImageUtils::PhotometricTransform that converts the colors of the input image.
See also:
ImageUtils::PhotometricTransform, Photometric, Referable

Definition at line 180 of file pxl_colorprofile.h.

Member Function Documentation

static AutoPtr<ColorProfile> Celartem::ColorProfile::create ( Storage *  inStorage  )  [static]

This function creates a new ColorProfile instance using the ICC profile loaded from the specified storage.

Parameters:
inStorage The storage from which the color profile is loaded.
Returns:
Pointer to the newly created ColorProfile instance.
See also:
ImageUtils::PhotometricTransform

static AutoPtr<ColorProfile> Celartem::ColorProfile::create ( const void *  inBuffer,
size_t  inSize 
) [static]

This function creates a new ColorProfile instance using the ICC profile stored on the memory block.

Parameters:
inBuffer Pointer to the buffer that stores color profile.
inSize The size of the color profile.
Returns:
Pointer to the newly created ColorProfile instance.
See also:
ImageUtils::PhotometricTransform

static AutoPtr<ColorProfile> Celartem::ColorProfile::create ( const DataStore *  inMetadata  )  [static]

This function creates a new ColorProfile instance using the ICC profile loaded from the specified Metadata.
The function searchs InterColorProfile(34675) from the specified DataStore instance and create a ColorProfile instance from it.
Please note that this function returns NULL if InterColorProfile(34675) is not found on the specified DataStore instance.

Parameters:
inMetadata The DataStore instance from which the color profile is loaded.
Returns:
Pointer to the newly created ColorProfile instance.
See also:
setAsMetadata, ImageUtils::PhotometricTransform

static AutoPtr<ColorProfile> Celartem::ColorProfile::getSRGBProfile (  )  [static]

This function return a pointer to the sRGB ColorProfile instance.

Returns:
Pointer to the sRGB ColorProfile instance.
See also:
ImageUtils::PhotometricTransform

static AutoPtr<ColorProfile> Celartem::ColorProfile::create ( const String &  inName  )  [static]

This function creates a new ColorProfile instance using system defined color profile specified by name.

Parameters:
inName The name of the system defined color profile.
"sRGB", "gray2.2", "Lab" and "XYZ" are supported.
Returns:
Pointer to the newly created ColorProfile instance.
The following code creates an instance of sRGB profile: 
                AutoPtr<ColorProfile> sRgbProfile = ColorProfile::create("sRGB");

See also:
ImageUtils::PhotometricTransform

static AutoPtr<ColorProfile> Celartem::ColorProfile::createRGBProfile ( const PrimaryColorChromaticities &  inPrimaries,
const GammaTable &  inRedGamma,
const GammaTable &  inGreenGamma,
const GammaTable &  inBlueGamma 
) [static]

This function creates a new ColorProfile instance based on the specified primary color chromaticities and gamma tables.

Parameters:
inPrimaries The primary color chromaticities of the color space.
inRedGamma The gamma of red.
inGreenGamma The gamma of green.
inBlueGamma The gamma of blue.

static AutoPtr<ColorProfile> Celartem::ColorProfile::createGrayProfile ( double  inGamma,
size_t  inResolution = 256 
) [static]

This function creates a new gray profile of the specified gamma.

Parameters:
inGamma The gamma value.
inResolution The number of table entries on the profile.

virtual String Celartem::ColorProfile::getTextTag ( const char *  inTagName  )  const [pure virtual]

This function returns the string of the specified ICC tag in this profile. If the specified tag is not found, it returns empty string.

Returns:
The string corresponding to the specified tag.

virtual String Celartem::ColorProfile::getDescription (  )  const [pure virtual]

This function returns the description of this color profile.

Returns:
String that contains the description of this color profile.

virtual String Celartem::ColorProfile::getCopyright (  )  const [pure virtual]

This function returns the copyright information of this color profile.

Returns:
String that contains the copyright information of this color profile.

virtual String Celartem::ColorProfile::getManufacturer (  )  const [pure virtual]

This function returns the manufacturer information of this color profile.

Returns:
String that contains the copyright information of this color profile.

virtual String Celartem::ColorProfile::getDeviceModel (  )  const [pure virtual]

This function returns the device model information of this color profile.

Returns:
String that contains the copyright information of this color profile.

virtual ColorSpace Celartem::ColorProfile::getColorSpace (  )  const [pure virtual]

This function returns the primary color space of this color profile.

Returns:
The color space in ColorSpace enumeration.

virtual const SimpleArray<u8>& Celartem::ColorProfile::getRawData (  )  const [pure virtual]

This function returns the read-only raw binary of the color profile associated to this instance.

Returns:
Reference to a SimpleArray<u8> instance that holds the binary of the color profile.
See also:
SimpleArray

virtual bool Celartem::ColorProfile::isCompatiblePhotometric ( Photometric  inPhotometric  )  const [pure virtual]

This function checks whether the photometric is compatible to the one of the color profile or not.

Parameters:
inPhotometric The photometric to verify.
Returns:
true if it is a compatible photometric, otherwise false.

virtual void Celartem::ColorProfile::setAsMetadata ( DataStore *  ioMetadata  )  const [pure virtual]

This function sets the ColorProfile instance to the specified DataStore instance.

Parameters:
ioMetadata Pointer to a DataStore instance.
See also:
create

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