contrib/tbl/vipl/filter/vipl_filter.h File Reference

Here is how the get/set macros are used. More...

#include "vipl_filter_abs.h"
#include <vipl/filter/vipl_trivial_pixeliter.h>
#include <vipl/section/vipl_section_descriptor.h>
#include <vipl/section/vipl_section_container.h>
#include <vcl_stlfwd.h>
#include "vipl_filter_helper.h"

Go to the source code of this file.

Classes
class	vipl_filter< ImgIn, ImgOut, DataIn, DataOut, Arity, PixelItr >
Defines
#define	USE_NAMED_ACCESSORS
#define	GET_NAME   get_pixel
#define	SET_NAME   set_pixel
#define	FGET_NAME   fget_pixel
#define	FSET_NAME   fset_pixel
#define	GET_PIXEL(img, x, y)   (img). GET_NAME (x,y)
#define	SET_PIXEL(img, x, y, expr)   (img). SET_NAME (expr, x,y)
#define	FGET_PIXEL(img, x, y)   (img). FGET_NAME (x,y)
#define	FSET_PIXEL(img, x, y, expr)   (img). FSET_NAME (expr, x,y)
#define	CONVERT_TO_OUT(v)   ((DataOut) (v))
Functions
const void *	DAhelp (vipl_trivial_pixeliter const *, int level=0)

---

Detailed Description

Here is how the get/set macros are used.

First note there are 4 types of access: for each of get and set we can do it with or without bounds/cache checking. These are respectively defined in 4 macros: GET_PIXEL SET_PIXEL FGET_PIXEL FSET_PIXEL (fast get...) Arguments for GET_PIXEL and FGET_PIXEL are (x,y) (i.e. column,row) and they return the value. For SET_PIXEL FSET_PIXEL, the syntax is SET_PIXEL(x,y,value). Note that SET_PIXEL is expected to return value! We support operator() being the access, or if the used defines USE_NAMED_ACCESSORS, the named accessors. For the named accessors the user can #define the names to use. (And if they really want to, they can change the #defines for GET_PIXEL SET_PIXEL... but be careful as existing code uses the args in the given order.)

Definition in file vipl_filter.h.

---

Define Documentation

#define CONVERT_TO_OUT

(

v

)

((DataOut) (v))

Definition at line 83 of file vipl_filter.h.

#define FGET_NAME   fget_pixel

Definition at line 48 of file vipl_filter.h.

#define FGET_PIXEL	(		img,
			x,
			y
	)		(img). FGET_NAME (x,y)

Definition at line 75 of file vipl_filter.h.

#define FSET_NAME   fset_pixel

Definition at line 51 of file vipl_filter.h.

#define FSET_PIXEL	(		img,
			x,
			y,
			expr
	)		(img). FSET_NAME (expr, x,y)

Definition at line 78 of file vipl_filter.h.

#define GET_NAME   get_pixel

Definition at line 42 of file vipl_filter.h.

#define GET_PIXEL	(		img,
			x,
			y
	)		(img). GET_NAME (x,y)

Definition at line 69 of file vipl_filter.h.

#define SET_NAME   set_pixel

Definition at line 45 of file vipl_filter.h.

#define SET_PIXEL	(		img,
			x,
			y,
			expr
	)		(img). SET_NAME (expr, x,y)

Definition at line 72 of file vipl_filter.h.

#define USE_NAMED_ACCESSORS

Definition at line 37 of file vipl_filter.h.

---

Function Documentation

const void* DAhelp	(	vipl_trivial_pixeliter const *	,
		int	level = 0
	)