Module image

---

Detailed Description

Version:

2.1

Author:

cyrille.berger@laas.fr, sebastien.bosch@laas.fr, maxime.cottret@laas.fr, thomas.lemaire@laas.fr

The image module is the main module for basic image processing, it is based on the OpenCV library. The jafar::image::Image class uses a cv::Mat as it is main inner data storage for image data and adds some useful services. The developers are encouraged to make use of OpenCV functions directly when possible, this is easy:

• Image class exports cv::Mat, IplImage and CvMat so whenever a cv::Mat, IplImage or CvMat is required a jafar Image can be used
• the cv::Mat methods are accessible through Image mat() method

History

• 2.1 (2010-11-15) - Use official sandbox bindings instead of V1 bindings
• 2.0 (2010-05-10) - Rewritten to be OpenCV 2 complient
• 1.0 (2006-10-02) - Completely rewritten version of the module, a lot cleaner !
• 0.3 (2004-10-31) - Image guideline added. New functions added. Bug fixes.
• 0.2 (2004-10-31) - JfrImage class stabilized. New Gradient, Filters and SpecialTransforms class added
• 0.1 (2004-10-11) - Initial version

Requirements

OpenCV, module display or qdisplay to display images.

About OpenCV

This module is built on top of the OpenCV library developed by Intel and then WillowGarage:

• homepage: http://opencv.willowgarage.com/documentation/index.html
• old homepage: http://www.intel.com/technology/computing/opencv/index.htm
• project page on sourceforge: http://opencvlibrary.sourceforge.net

Macro

Extra doc for macro can go here... (you can delete this section if not relevant)

Tcl interface (generated by swig)

The interface of the module is generated from the following files:

• image.i defines the wrapped classes and functions,
• imageException.i defines the try { } catch block for this module.

Classes
class	jafar::image::Capture
	Wrapper around openCV Capture mechanism. More...
struct	JfrImage_ImageHeader
	Jafar supplementary header. More...
struct	JfrImage_CImage
	Jafar image C structure. More...
class	jafar::image::Image
class	jafar::image::ImageIO
	I/O methods for Image serialization to file. More...
class	jafar::image::ImageException
	Base class for all exceptions defined in the module image. More...
class	jafar::image::image_iterator< type >
class	jafar::image::LKTracker
	Lukas-Kanade based tracker working on Harris corners. More...
class	jafar::image::Pyramid
Namespaces
namespace	jafar::image::filter
Typedefs
typedef enum JfrImage_TypeColorSpace	JfrImage_TypeColorSpace
	Available colorspaces for JfrImage.
typedef enum JfrImage_InterpolationType	JfrImage_InterpolationType
typedef struct JfrImage_CImage	JfrImage_CImage
	Jafar image C structure.
Enumerations
enum	JfrImage_TypeColorSpace {   JfrImage_CS_GRAY, JfrImage_CS_BGR, JfrImage_CS_RGB, JfrImage_CS_HSV,   JfrImage_CS_HSL, JfrImage_CS_CMY, JfrImage_CS_CMYK, JfrImage_CS_LUV,   JfrImage_CS_LAB, JfrImage_CS_XYZ, JfrImage_CS_YXY, JfrImage_CS_BayerBG,   JfrImage_CS_BayerGB, JfrImage_CS_BayerRG, JfrImage_CS_BayerGR, JfrImage_CS_YCbCr,   JfrImage_CS_UNKNOWN }
	Available colorspaces for JfrImage. More...
enum	JfrImage_InterpolationType { JfrImage_INTERP_NEAREST, JfrImage_INTERP_BILINEAR, JfrImage_INTERP_CUBIC }
Functions
int	JfrImage_colorSpaceChannels (JfrImage_TypeColorSpace cs)
	Returns the number of channels required by the color space cs.
int	channelDepthSize (int depth)
	Returns the size in bytes of one channel of a pixel.
void	JfrImage_convertColorMode (const JfrImage_CImage *src_, JfrImage_CImage *dst_)
	C interface to the convertColorMode function.

---

Typedef Documentation

typedef struct JfrImage_CImage JfrImage_CImage

Jafar image C structure.

It is defined for compatibility (GenoM).

typedef enum JfrImage_TypeColorSpace JfrImage_TypeColorSpace

Available colorspaces for JfrImage.

Although OpenCV functions only handle JfrImage_CS_GRAY and JfrImage_CS_BGR images, it is possible to define other colorspace.

Note:

If another colorspace is needed, you may add it.

---

Enumeration Type Documentation

enum JfrImage_TypeColorSpace

Available colorspaces for JfrImage.

Although OpenCV functions only handle JfrImage_CS_GRAY and JfrImage_CS_BGR images, it is possible to define other colorspace.

Note:

If another colorspace is needed, you may add it.

Definition at line 31 of file cImage.h.

---

Function Documentation

int JfrImage_colorSpaceChannels

(

JfrImage_TypeColorSpace

cs

)

Returns the number of channels required by the color space cs.

Return 0 for JfrImage_CS_UNKNOWN.