IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit
Classes | Enumerations | Functions
ipsdk::imaproc::color Namespace Reference

Namespace aggregating color operations on images. More...

Classes

class  AppendColorChannelImgGpuLvl3
 Level 2 algorithm: Generates a color image by merging the color channel of the two input images, dedicated to GPU calculation. More...
 
class  AppendColorChannelImgLvl1
 Level 1 algorithm: Generates a color image by merging the color channel of the two input images. More...
 
class  AppendColorChannelImgLvl2
 Level 2 algorithm: Generates a color image by merging the color channel of the two input images. More...
 
class  AppendColorChannelImgLvl3
 Level 3 algorithm: Generates a color image by merging the color channel of the two input images. More...
 
class  ColorConvertImgLvl1
 Level 1 algorithm: convert a color image from a given color space to an other. More...
 
class  ColorConvertImgLvl2
 Level 2 algorithm: convert a color image from a given color space to an other. More...
 
class  ColorConvertImgLvl3
 Level 3 algorithm: convert a color image from a given color space to an other. More...
 
class  IPSDKIPLColorException
 Exception class for library IPSDKIPLColor. More...
 
class  LightnessImgLvl1
 Level 1 algorithm: lightness computation from an input color image. More...
 
class  LightnessImgLvl2
 Level 2 algorithm: lightness computation from an input Color color image. More...
 
class  LightnessImgLvl3
 Level 3 algorithm: lightness computation from an input color image. More...
 

Enumerations

enum  eIPSDKIPLColorMessage
 Enumerate describing messages. More...
 
enum  eOutputInitializerMessage { eNullInputAttribute, eExpiredAttributeWeakPtr }
 
enum  eProcessorMessage {
  eAppendColorChannelImgGpuLvl3ToolTipId, eAppendColorChannelImgLvl1ToolTipId, eAppendColorChannelImgLvl2ToolTipId, eAppendColorChannelImgLvl3ToolTipId,
  eColorConvertImgErrorInputRange, eColorConvertImgLvl1ToolTipId, eColorConvertImgLvl2ToolTipId, eColorConvertImgLvl3ToolTipId,
  eLightnessImgLvl1ToolTipId, eLightnessImgLvl2ToolTipId, eLightnessImgLvl3ToolTipId
}
 
enum  eRuleMessage {
  eExpiredAttributeWeakPtr, eRuleColorSpaceMatchEvaluated, eRuleColorSpaceMatchFormal, eRuleAppendColorMatchEvaluated,
  eRuleAppendColorMatchFormal, eRuleNotInit, eRuleSupportedColorSpaceConversionEvaluated, eRuleSupportedColorSpaceConversionFormal
}
 

Functions

IPSDKIPLCOLOR_API const std::string & getIPSDKIPLColorLoggerName ()
 Recovery of logger name associated to library.
 
IPSDKIPLCOLOR_API log4cplus::Logger & getIPSDKIPLColorLogger ()
 Recovery of logger associated to library.
 
IPSDKIPLCOLOR_API const ipsdk::LogMessageManagergetIPSDKIPLColorLogMessageManager ()
 Recovery of message manager associated to library.
 
IPSDKIPLCOLOR_API CustomImageInfoPtr outputTargetColorSpace (const ImageAttributeConstPtr &pInputAttribute, const boost::shared_ptr< const attr::InColorConversionTransform > &pInColorConversionTransform)
 
IPSDKIPLCOLOR_API CustomImageInfoPtr outputAppendColor (const ImageAttributeConstPtr &pInputAttribute1, const ImageAttributeConstPtr &pInputAttribute2)
 function allowing to compute the number of channels of the append color algorithm output
 
IPSDKIPLCOLOR_API processor::RulePtr matchColorSpace (const ImageAttributeConstPtr &pInputImageAttribute, const ImageAttributeConstPtr &pOutputImageAttribute, const boost::shared_ptr< const attr::InColorConversionTransform > &pInColorConversionTransform)
 
IPSDKIPLCOLOR_API processor::RulePtr matchColorSpace (const YStripColor2dAttributeConstPtr &pInputYStripColor2dAttribute, const YStripColor2dAttributeConstPtr &pOutputYStripColor2dAttribute, const boost::shared_ptr< const attr::InColorConversionTransform > &pInColorConversionTransform)
 
IPSDKIPLCOLOR_API processor::RulePtr matchAppendChannel (const ImageAttributeConstPtr &pInputImageAttribute1, const ImageAttributeConstPtr &pinputImageAttribute2, const ImageAttributeConstPtr &pOutputImageAttribute)
 function allowing to check that a output number of channels is the sum of the two input number of channels
 
IPSDKIPLCOLOR_API image::ImagePtr appendColorChannelImg (const image::ImageConstPtr &pInImg1, const image::ImageConstPtr &pInImg2)
 wrapper function for Generates a color images by merging the color channel of the two input images More...
 
IPSDKIPLCOLOR_API void appendColorChannelImg (const image::ImageConstPtr &pInImg1, const image::ImageConstPtr &pInImg2, const image::ImagePtr &pOutImg)
 wrapper function for Generates a color images by merging the color channel of the two input images More...
 
IPSDKIPLCOLOR_API boost::shared_ptr< AppendColorChannelImgLvl1appendColorChannelImg_async (const image::ImageConstPtr &pInImg1, const image::ImageConstPtr &pInImg2)
 asynchronous wrappers
 
IPSDKIPLCOLOR_API boost::shared_ptr< AppendColorChannelImgLvl1appendColorChannelImg_async (const image::ImageConstPtr &pInImg1, const image::ImageConstPtr &pInImg2, const image::ImagePtr &pOutImg)
 asynchronous wrappers
 
IPSDKIPLCOLOR_API image::ImagePtr getAsyncProcessorOutput (boost::shared_ptr< AppendColorChannelImgLvl1 > pProcessor)
 function to retrieve the result of an asynchronous processor
 
IPSDKIPLCOLOR_API image::ImagePtr colorConvertImg (const ipsdk::image::ImageConstPtr &pInColorImg, const ipsdk::image::eColorGeometryType &targetColorSpace)
 wrapper function for convert a color image from a given color space to an other More...
 
IPSDKIPLCOLOR_API image::ImagePtr colorConvertImg (const ipsdk::image::ImageConstPtr &pInColorImg, const ipsdk::imaproc::attr::ColorConversionTransformConstPtr &pInColorConversionTransform)
 wrapper function for convert a color image from a given color space to an other More...
 
IPSDKIPLCOLOR_API void colorConvertImg (const ipsdk::image::ImageConstPtr &pInColorImg, const ipsdk::image::eColorGeometryType &targetColorSpace, const ipsdk::image::ImagePtr &pOutColorImg)
 wrapper function for convert a color image from a given color space to an other More...
 
IPSDKIPLCOLOR_API void colorConvertImg (const ipsdk::image::ImageConstPtr &pInColorImg, const ipsdk::imaproc::attr::ColorConversionTransformConstPtr &pInColorConversionTransform, const ipsdk::image::ImagePtr &pOutColorImg)
 wrapper function for convert a color image from a given color space to an other More...
 
IPSDKIPLCOLOR_API boost::shared_ptr< ColorConvertImgLvl1colorConvertImg_async (const ipsdk::image::ImageConstPtr &pInColorImg, const ipsdk::image::eColorGeometryType &targetColorSpace)
 asynchronous wrappers
 
IPSDKIPLCOLOR_API boost::shared_ptr< ColorConvertImgLvl1colorConvertImg_async (const ipsdk::image::ImageConstPtr &pInColorImg, const ipsdk::imaproc::attr::ColorConversionTransformConstPtr &pInColorConversionTransform)
 asynchronous wrappers
 
IPSDKIPLCOLOR_API boost::shared_ptr< ColorConvertImgLvl1colorConvertImg_async (const ipsdk::image::ImageConstPtr &pInColorImg, const ipsdk::image::eColorGeometryType &targetColorSpace, const ipsdk::image::ImagePtr &pOutColorImg)
 asynchronous wrappers
 
IPSDKIPLCOLOR_API boost::shared_ptr< ColorConvertImgLvl1colorConvertImg_async (const ipsdk::image::ImageConstPtr &pInColorImg, const ipsdk::imaproc::attr::ColorConversionTransformConstPtr &pInColorConversionTransform, const ipsdk::image::ImagePtr &pOutColorImg)
 asynchronous wrappers
 
IPSDKIPLCOLOR_API image::ImagePtr getAsyncProcessorOutput (boost::shared_ptr< ColorConvertImgLvl1 > pProcessor)
 function to retrieve the result of an asynchronous processor
 
IPSDKIPLCOLOR_API void lightnessImg (const image::ImageConstPtr &pInColorImg, const image::ImagePtr &pOutLightImg)
 wrapper function for lightness computation from an input RGB color image More...
 
IPSDKIPLCOLOR_API image::ImagePtr lightnessImg (const image::ImageConstPtr &pInColorImg)
 wrapper function for lightness computation from an input RGB color image More...
 
IPSDKIPLCOLOR_API void lightnessImg (const image::ImageConstPtr &pInColorImg, const ipsdk::imaproc::attr::eLightnessType &lightnessType, const image::ImagePtr &pOutLightImg)
 wrapper function for lightness computation from an input RGB color image More...
 
IPSDKIPLCOLOR_API image::ImagePtr lightnessImg (const image::ImageConstPtr &pInColorImg, const ipsdk::imaproc::attr::eLightnessType &lightnessType)
 wrapper function for lightness computation from an input RGB color image More...
 
IPSDKIPLCOLOR_API boost::shared_ptr< LightnessImgLvl1lightnessImg_async (const image::ImageConstPtr &pInColorImg, const image::ImagePtr &pOutLightImg)
 asynchronous wrappers
 
IPSDKIPLCOLOR_API boost::shared_ptr< LightnessImgLvl1lightnessImg_async (const image::ImageConstPtr &pInColorImg)
 asynchronous wrappers
 
IPSDKIPLCOLOR_API boost::shared_ptr< LightnessImgLvl1lightnessImg_async (const image::ImageConstPtr &pInColorImg, const ipsdk::imaproc::attr::eLightnessType &lightnessType, const image::ImagePtr &pOutLightImg)
 asynchronous wrappers
 
IPSDKIPLCOLOR_API boost::shared_ptr< LightnessImgLvl1lightnessImg_async (const image::ImageConstPtr &pInColorImg, const ipsdk::imaproc::attr::eLightnessType &lightnessType)
 asynchronous wrappers
 
IPSDKIPLCOLOR_API image::ImagePtr getAsyncProcessorOutput (boost::shared_ptr< LightnessImgLvl1 > pProcessor)
 function to retrieve the result of an asynchronous processor
 

Detailed Description

Namespace aggregating color operations on images.

Enumeration Type Documentation

◆ eIPSDKIPLColorMessage

Enumerate describing messages.

Note
This enumerate is associated to a message map
See also
IPSDK_Message_Map

◆ eOutputInitializerMessage

Enumerator
eNullInputAttribute 

Input attribute should not be null.

eExpiredAttributeWeakPtr 

Input attribute weak pointer has expired, can't get it.

Attribute weak pointer has expired, can't get it.

◆ eProcessorMessage

Enumerator
eAppendColorChannelImgGpuLvl3ToolTipId 

Level 2 algorithm: Generates a color images by merging the color channel of the two input images on Gpu.

eAppendColorChannelImgLvl1ToolTipId 

Level 1 algorithm: Generates a color images by merging the color channel of the two input images.

eAppendColorChannelImgLvl2ToolTipId 

Level 2 algorithm: Generates a color images by merging the color channel of the two input images.

eAppendColorChannelImgLvl3ToolTipId 

Level 3 algorithm: Generates a color images by merging the color channel of the two input images.

eColorConvertImgErrorInputRange 

Error: the image values does not match the range [d, d].

eColorConvertImgLvl1ToolTipId 

Level 1 algorithm: convert a color image from a given color space to an other.

eColorConvertImgLvl2ToolTipId 

Level 2 algorithm: convert a color image from a given color space to an other.

eColorConvertImgLvl3ToolTipId 

Level 3 algorithm: convert a color image from a given color space to an other.

eLightnessImgLvl1ToolTipId 

Level 1 algorithm: lightness computation from an input RGB color image.

eLightnessImgLvl2ToolTipId 

Level 2 algorithm: lightness computation from an input RGB color image.

eLightnessImgLvl3ToolTipId 

Level 3 algorithm: lightness computation from an input RGB color image.

◆ eRuleMessage

Enumerator
eExpiredAttributeWeakPtr 

Input attribute weak pointer has expired, can't get it.

Attribute weak pointer has expired, can't get it.

eRuleColorSpaceMatchEvaluated 

Color space match between input image s[s with value s], output image s[s with value s] and color conversion matrix attribute s[with target s and matrix size d].

eRuleColorSpaceMatchFormal 

Color space match between input image s, output image s and color conversion matrix attribute s.

eRuleAppendColorMatchEvaluated 

Append color match between input images s and s with output image s.

eRuleAppendColorMatchFormal 

Append color match between input images s and s with output image s.

eRuleNotInit 

Initialize rule before trying to use its data.

eRuleSupportedColorSpaceConversionEvaluated 

Color space conversion between input strip s[s with value s] and output strip s[s with value s] is supported.

eRuleSupportedColorSpaceConversionFormal 

Color space conversion between input strip s and output strip s is supported.

Function Documentation

◆ outputTargetColorSpace()

IPSDKIPLCOLOR_API CustomImageInfoPtr ipsdk::imaproc::color::outputTargetColorSpace ( const ImageAttributeConstPtr pInputAttribute,
const boost::shared_ptr< const attr::InColorConversionTransform > &  pInColorConversionTransform 
)

function allowing to check that a source/target color space associated to a color conversion matrix match associated input/output image

◆ matchColorSpace() [1/2]

IPSDKIPLCOLOR_API processor::RulePtr ipsdk::imaproc::color::matchColorSpace ( const ImageAttributeConstPtr pInputImageAttribute,
const ImageAttributeConstPtr pOutputImageAttribute,
const boost::shared_ptr< const attr::InColorConversionTransform > &  pInColorConversionTransform 
)

function allowing to check that a source/target color space associated to a color conversion matrix match associated input/output image

◆ matchColorSpace() [2/2]

IPSDKIPLCOLOR_API processor::RulePtr ipsdk::imaproc::color::matchColorSpace ( const YStripColor2dAttributeConstPtr pInputYStripColor2dAttribute,
const YStripColor2dAttributeConstPtr pOutputYStripColor2dAttribute,
const boost::shared_ptr< const attr::InColorConversionTransform > &  pInColorConversionTransform 
)

function allowing to check that a source/target color space associated to a color conversion matrix match associated input/output y strip 2d