ed::ImageMask Class Reference

#include <mask.h>

Classes
class	const_iterator

Public Member Functions
void	addPoint (const cv::Point2i &p)
void	addPoint (int idx)
void	addPoint (int x, int y)
void	addPoints (const std::vector< cv::Point2i > &ps)
const_iterator	begin (int width=0) const
void	clear ()
const_iterator	end () const
int	getSize () const
int	height () const
	ImageMask ()
	ImageMask (int width, int height)
void	setSize (int width, int height)
int	width () const

Private Attributes
int	height_
	Height of the mask. More...
std::vector< cv::Point2i >	points_
	Base points of the sub-images. More...
int	width_
	Width of the mask. More...

Detailed Description

Support for scanning an image as a number of sub-image scans.

Definition at line 17 of file mask.h.

Constructor & Destructor Documentation

ImageMask() [1/2]

ed::ImageMask::ImageMask ( )

inline

Definition at line 21 of file mask.h.

ImageMask() [2/2]

ed::ImageMask::ImageMask ( int  width, int  height  )

inline

Construct the mask, while setting the mask size.

Parameters

width	Width of the mask.
height	Height of the mask.

Definition at line 28 of file mask.h.

Member Function Documentation

addPoint() [1/3]

void ed::ImageMask::addPoint ( const cv::Point2i &  p )

inline

Add a sub-image.

Parameters

p	Base-point of the new sub-image.

Definition at line 71 of file mask.h.

addPoint() [2/3]

void ed::ImageMask::addPoint ( int  idx )

inline

Add a one-pixel sub-image.

Parameters

idx	Index number of the pixel (scanning horizontally, from top to bottom).

Definition at line 90 of file mask.h.

addPoint() [3/3]

void ed::ImageMask::addPoint ( int  x, int  y  )

inline

Add a sub-image.

Parameters

x	X coordinate of the new sub-image.
y	Y coordinate of the new sub-image.

Definition at line 81 of file mask.h.

addPoints()

void ed::ImageMask::addPoints ( const std::vector< cv::Point2i > &  ps )

inline

Add a number of sub-images.

Parameters

ps	Base points of the new sub-images.

Definition at line 99 of file mask.h.

begin()

const_iterator ed::ImageMask::begin ( int  width = 0 ) const

inline

Definition at line 180 of file mask.h.

clear()

void ed::ImageMask::clear ( )

inline

Remove all sub-images.

Definition at line 44 of file mask.h.

end()

const_iterator ed::ImageMask::end ( ) const

inline

Definition at line 188 of file mask.h.

getSize()

int ed::ImageMask::getSize ( ) const

inline

Get the number of sub-images.

Returns

The number of sub-images in the mask.

Definition at line 53 of file mask.h.

height()

int ed::ImageMask::height ( ) const

inline

Get the height of the mask.

Returns

The height of the mask.

Definition at line 65 of file mask.h.

setSize()

void ed::ImageMask::setSize ( int  width, int  height  )

inline

Set the size of the image.

Parameters

width	Width of the mask.
height	Height of the mask.

Definition at line 37 of file mask.h.

width()

int ed::ImageMask::width ( ) const

inline

Get the width of the mask.

Returns

The width of the mask.

Definition at line 59 of file mask.h.

Member Data Documentation

height_

int ed::ImageMask::height_

private

Height of the mask.

Definition at line 195 of file mask.h.

points_

std::vector<cv::Point2i> ed::ImageMask::points_

private

Base points of the sub-images.

Definition at line 196 of file mask.h.

width_

int ed::ImageMask::width_

private

Width of the mask.

Definition at line 194 of file mask.h.

---

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

• mask.h