mimas::const_image_ref< T, TPtr > Class Template Reference

Wrapper for read-only access of image-data. More...

#include <image_ref.h>

Inheritance diagram for mimas::const_image_ref< T, TPtr >:

[legend]Collaboration diagram for mimas::const_image_ref< T, TPtr >:


Public Member Functions
	const_image_ref (void)
	Default constructor.
	const_image_ref (TPtr _data, int _width, int _height)
template<typename OPtr>
	const_image_ref (const const_image_ref< T, OPtr > &_imgref)
int	getWidth (void) const
	Width of image.
int	getHeight (void) const
	Height of image.
int	getSize (void) const
	Size.
const T &	getPixel (int x, int y) const
	Get const-reference to a pixel.
const T &	pixel (int x, int y) const
	Get const-reference to a pixel.
const T *	rawData (void) const
	Read-only access to data.
bool	initialised (void) const
bool	in (const mimas::point p) const
bool	in (const mimas::pixel p) const
bool	in (int x, int y) const
const_iterator	upperLeft (void) const
const_iterator	lowerRight (void) const
const_iterator	ul (void) const
const_iterator	lr (void) const
Protected Attributes
TPtr	data
	Data-pointer.
int	width
int	height
T	dummy
Classes
class	const_iterator

Detailed Description

template<typename T, typename TPtr = const T*>
class mimas::const_image_ref< T, TPtr >

Wrapper for read-only access of image-data.

This class is used for wrapping raw constant data to make it accessible to the Mimas-library.

Definition at line 26 of file image_ref.h.

Constructor & Destructor Documentation

template<typename T, typename TPtr = const T*>

mimas::const_image_ref< T, TPtr >::const_image_ref ( void ) [inline]

Default constructor.

Creates an empty image.

Definition at line 31 of file image_ref.h.

template<typename T, typename TPtr = const T*>

mimas::const_image_ref< T, TPtr >::const_image_ref	(	TPtr	_data,
		int	_width,
		int	_height
	)			`[inline]`

Definition at line 33 of file image_ref.h.

template<typename T, typename TPtr = const T*>

template<typename OPtr>

mimas::const_image_ref< T, TPtr >::const_image_ref ( const const_image_ref< T, OPtr > & _imgref ) [inline]

Definition at line 37 of file image_ref.h.

Member Function Documentation

template<typename T, typename TPtr = const T*>

int mimas::const_image_ref< T, TPtr >::getWidth ( void ) const [inline]

Width of image.

Definition at line 198 of file image_ref.h.

Referenced by mimas::activeContour< T >::adaptContour(), mimas::correlate(), mimas::correlation(), mimas::correlationChamfer(), mimas::cgh_scene< T >::createFromImage(), mimas::despeckleKuwahara(), mimas::despeckleMedian(), mimas::displayWithOverlay(), mimas::edgeHaynesJain(), mimas::edgeLoG(), mimas::canny< T >::getEdges(), mimas::const_image_ref< Pixel_T, Pixel_T * >::getPixel(), mimas::halfResolution(), mimas::halfResolutionEdgePyramid(), mimas::canny< T >::hysteresis(), mimas::image_apply(), mimas::image_func(), mimas::const_image_ref< Pixel_T, Pixel_T * >::in(), mimas::const_image_ref< Pixel_T, Pixel_T * >::lowerRight(), mimas::const_image_ref< Pixel_T, Pixel_T * >::lr(), mimas::max_val(), mimas::min_val(), mimas::oilPainting(), mimas::image< Pixel_T >::operator=(), mimas::paethRotateRadian(), mimas::const_image_ref< Pixel_T, Pixel_T * >::pixel(), mimas::canny< T >::separable_convolution(), mimas::const_image_ref< Pixel_T, Pixel_T * >::ul(), mimas::const_image_ref< Pixel_T, Pixel_T * >::upperLeft(), and mimas::stereo< T >::writeNormalisedDepthMapToFilePGM().

template<typename T, typename TPtr = const T*>

int mimas::const_image_ref< T, TPtr >::getHeight ( void ) const [inline]

Height of image.

Definition at line 200 of file image_ref.h.

Referenced by mimas::activeContour< T >::adaptContour(), mimas::correlate(), mimas::correlation(), mimas::correlationChamfer(), mimas::cgh_scene< T >::createFromImage(), mimas::despeckleKuwahara(), mimas::despeckleMedian(), mimas::displayWithOverlay(), mimas::edgeHaynesJain(), mimas::edgeLoG(), mimas::canny< T >::getEdges(), mimas::const_image_ref< Pixel_T, Pixel_T * >::getPixel(), mimas::halfResolution(), mimas::halfResolutionEdgePyramid(), mimas::canny< T >::hysteresis(), mimas::image_apply(), mimas::image_func(), mimas::const_image_ref< Pixel_T, Pixel_T * >::in(), mimas::const_image_ref< Pixel_T, Pixel_T * >::lowerRight(), mimas::const_image_ref< Pixel_T, Pixel_T * >::lr(), mimas::max_val(), mimas::min_val(), mimas::oilPainting(), mimas::image< Pixel_T >::operator=(), mimas::paethRotateRadian(), mimas::const_image_ref< Pixel_T, Pixel_T * >::pixel(), mimas::canny< T >::separable_convolution(), and mimas::stereo< T >::writeNormalisedDepthMapToFilePGM().

template<typename T, typename TPtr = const T*>

int mimas::const_image_ref< T, TPtr >::getSize ( void ) const [inline]

Size.

Definition at line 203 of file image_ref.h.

template<typename T, typename TPtr = const T*>

const T& mimas::const_image_ref< T, TPtr >::getPixel	(	int	x,
		int	y
	)			const `[inline]`

Get const-reference to a pixel.

This method includes clipping! Specifying out-of-image coordinates will result in a const-reference to the dummy pixel.

Parameters:

	x	x-coordinate
	y	y-coordinate

See also:: pixel
dummy

Reimplemented in mimas::image_ref< T >, mimas::image_ref< double >, mimas::image_ref< int >, mimas::image_ref< mimas::rgba< unsigned char > >, mimas::image_ref< mimas::pol_scale_info >, mimas::image_ref< mimas::pol_angle >, mimas::image_ref< boost::shared_ptr< mimas::prop > >, and mimas::image_ref< Pixel_T >.

Definition at line 213 of file image_ref.h.

Referenced by mimas::halfResolutionEdgePyramid(), and mimas::paethRotateRadian().

template<typename T, typename TPtr = const T*>

const T& mimas::const_image_ref< T, TPtr >::pixel	(	int	x,
		int	y
	)			const `[inline]`

Get const-reference to a pixel.

No clipping!

Parameters:

	x	x-coordinate
	y	y-coordinate

See also:: getPixel

Definition at line 233 of file image_ref.h.

Referenced by mimas::correlation(), mimas::correlationChamfer(), mimas::despeckleKuwahara(), mimas::despeckleMedian(), mimas::displayWithOverlay(), mimas::halfResolution(), and mimas::oilPainting().

template<typename T, typename TPtr = const T*>

const T* mimas::const_image_ref< T, TPtr >::rawData ( void ) const [inline]

Read-only access to data.

Definition at line 239 of file image_ref.h.

Referenced by mimas::bilevel_double(), mimas::correlate(), mimas::correlate_separable(), mimas::image_apply(), mimas::max_val(), mimas::min_val(), and mimas::image< Pixel_T >::operator=().

template<typename T, typename TPtr = const T*>

bool mimas::const_image_ref< T, TPtr >::initialised ( void ) const [inline]

Definition at line 244 of file image_ref.h.

Referenced by mimas::image_apply(), mimas::max_val(), mimas::min_val(), and mimas::normalise().

template<typename T, typename TPtr = const T*>

bool mimas::const_image_ref< T, TPtr >::in ( const mimas::point p ) const [inline]

Definition at line 252 of file image_ref.h.

template<typename T, typename TPtr = const T*>

bool mimas::const_image_ref< T, TPtr >::in ( const mimas::pixel p ) const [inline]

Definition at line 260 of file image_ref.h.

template<typename T, typename TPtr = const T*>

bool mimas::const_image_ref< T, TPtr >::in	(	int	x,
		int	y
	)			const `[inline]`

Definition at line 268 of file image_ref.h.

template<typename T, typename TPtr = const T*>

const_iterator mimas::const_image_ref< T, TPtr >::upperLeft ( void ) const [inline]

Definition at line 277 of file image_ref.h.

template<typename T, typename TPtr = const T*>

const_iterator mimas::const_image_ref< T, TPtr >::lowerRight ( void ) const [inline]

Definition at line 282 of file image_ref.h.

template<typename T, typename TPtr = const T*>

const_iterator mimas::const_image_ref< T, TPtr >::ul ( void ) const [inline]

Definition at line 290 of file image_ref.h.

template<typename T, typename TPtr = const T*>

const_iterator mimas::const_image_ref< T, TPtr >::lr ( void ) const [inline]

Definition at line 295 of file image_ref.h.

Member Data Documentation

template<typename T, typename TPtr = const T*>

TPtr mimas::const_image_ref< T, TPtr >::data [protected]

Data-pointer.

Pointer to the data in row-major format.

Definition at line 305 of file image_ref.h.

template<typename T, typename TPtr = const T*>

int mimas::const_image_ref< T, TPtr >::width [protected]

Definition at line 306 of file image_ref.h.

Referenced by mimas::const_image_ref< Pixel_T, Pixel_T * >::getSize(), mimas::const_image_ref< Pixel_T, Pixel_T * >::getWidth(), and mimas::const_image_ref< Pixel_T, Pixel_T * >::initialised().

template<typename T, typename TPtr = const T*>

int mimas::const_image_ref< T, TPtr >::height [protected]

Definition at line 307 of file image_ref.h.

Referenced by mimas::const_image_ref< Pixel_T, Pixel_T * >::getHeight(), mimas::const_image_ref< Pixel_T, Pixel_T * >::getSize(), and mimas::const_image_ref< Pixel_T, Pixel_T * >::initialised().

template<typename T, typename TPtr = const T*>

T mimas::const_image_ref< T, TPtr >::dummy [protected]

Definition at line 308 of file image_ref.h.

Referenced by mimas::const_image_ref< Pixel_T, Pixel_T * >::const_image_ref(), and mimas::const_image_ref< Pixel_T, Pixel_T * >::getPixel().

The documentation for this class was generated from the following file:

image_ref.h

mimas 2.1

Copyright Mon Oct 30 11:31:33 2006, Bala Amavasai, Stuart Meikle, Arul Selvan, Fabio Caparrelli, Jan Wedekind, Manuel Boissenin, ...

mimas::const_image_ref< T, TPtr > Class Template Reference

Public Member Functions

Protected Attributes

Classes

Detailed Description

template<typename T, typename TPtr = const T*> class mimas::const_image_ref< T, TPtr >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename T, typename TPtr = const T*>
class mimas::const_image_ref< T, TPtr >