icl::filter::OpROIHandler Class Reference

Utility base class for Image Operators. More...

#include <OpROIHandler.h>

Public Member Functions
virtual	~OpROIHandler ()
	Destructor. More...

Private Member Functions
void	setClipToROI (bool bClipToROI)
	change adaption of destination image (see class description) More...
void	setCheckOnly (bool bCheckOnly)
bool	getClipToROI () const
bool	getCheckOnly () const
	OpROIHandler ()
	Filter is a base class for other classes and should be instantiated. More...
bool	prepare (core::ImgBase **ppoDst, core::depth eDepth, const utils::Size &imgSize, core::format eFormat, int nChannels, const utils::Rect &roi, utils::Time timestamp=utils::Time::null)
virtual bool	prepare (core::ImgBase **ppoDst, const core::ImgBase *poSrc)
	check+adapt destination image to properties of given source image More...
virtual bool	prepare (core::ImgBase **ppoDst, const core::ImgBase *poSrc, core::depth eDepth)
const utils::Size	chooseSize (const core::ImgBase *poSrc)
	return to-be-used image size depending on bClipToROI More...
const utils::Rect	chooseROI (const core::ImgBase *poSrc)
	return to-be-used ROI depending on bClipToROI More...

Private Attributes
bool	m_bClipToROI
bool	m_bCheckOnly

Friends
class	UnaryOp
class	BinaryOp

Detailed Description

Utility base class for Image Operators.

The OpROIHandler class builds a utility base class for ICL unary and binary operator classes. Each Operator is performed on the ROI of the source image(s) only. The destination image is always adapted in its parameters to the necessary values. We distinguish the following modes:

• Adapt the destination image in its size and ROI to the source image. Hence the destination will have the same size and ROI as the source image. Nevertheless the operator is applied on the ROI only, leaving the previous content of the destination image unchanged in this border region. So this mode requires subsequent handling of the border.(bClipToROI = false)

   source image    destination-image
    xxxxxxxxx        xxxxxxxxx
    xxxx....x        xxxx....x
    xxxx....x   -->  xxxx....x
    xxxx....x        xxxx....x
    

• Adapt the destination images size, such that it exactly comprises the ROI of the source image. (bClipToROI = true)

   source image    destination-image
    xxxxxxxxx
    xxxx....x        ....
    xxxx....x   -->  ....
    xxxx....x        ....
    

• Only check the destination images parameters and issue a warning if not set correctly already. In this case the filter operation itself should not be performed. (bCheckOnly = true)

To this end the Filter class provides variables m_bCheck and m_bClipToROI accessible by setter and getter functions as well as several version of the prepare() methods which checks and adapts the destination image if neccessary.

Constructor & Destructor Documentation

~OpROIHandler()

virtual icl::filter::OpROIHandler::~OpROIHandler ( )

inlinevirtual

Destructor.

OpROIHandler()

icl::filter::OpROIHandler::OpROIHandler ( )

inlineprivate

Filter is a base class for other classes and should be instantiated.

Member Function Documentation

chooseROI()

const utils::Rect icl::filter::OpROIHandler::chooseROI ( const core::ImgBase *  poSrc )

inlineprivate

return to-be-used ROI depending on bClipToROI

chooseSize()

const utils::Size icl::filter::OpROIHandler::chooseSize ( const core::ImgBase *  poSrc )

inlineprivate

return to-be-used image size depending on bClipToROI

getCheckOnly()

bool icl::filter::OpROIHandler::getCheckOnly ( ) const

inlineprivate

getClipToROI()

bool icl::filter::OpROIHandler::getClipToROI ( ) const

inlineprivate

prepare() [1/3]

bool icl::filter::OpROIHandler::prepare ( core::ImgBase **  ppoDst, core::depth  eDepth, const utils::Size &  imgSize, core::format  eFormat, int  nChannels, const utils::Rect &  roi, utils::Time  timestamp = utils::Time::null  )

private

check+adapt destination images parameters against given values bCheckOnly mode ignores the given imgSize

prepare() [2/3]

virtual bool icl::filter::OpROIHandler::prepare ( core::ImgBase **  ppoDst, const core::ImgBase *  poSrc  )

inlineprivatevirtual

check+adapt destination image to properties of given source image

prepare() [3/3]

virtual bool icl::filter::OpROIHandler::prepare ( core::ImgBase **  ppoDst, const core::ImgBase *  poSrc, core::depth  eDepth  )

inlineprivatevirtual

check+adapt destination image to properties of given source image but use explicitly given depth

setCheckOnly()

void icl::filter::OpROIHandler::setCheckOnly ( bool  bCheckOnly )

inlineprivate

setClipToROI()

void icl::filter::OpROIHandler::setClipToROI ( bool  bClipToROI )

inlineprivate

change adaption of destination image (see class description)

Friends And Related Function Documentation

BinaryOp

friend class BinaryOp

friend

UnaryOp

friend class UnaryOp

friend

Member Data Documentation

m_bCheckOnly

bool icl::filter::OpROIHandler::m_bCheckOnly

private

m_bClipToROI

bool icl::filter::OpROIHandler::m_bClipToROI

private

---

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

• /Users/alneuman/vm/icl/ICLFilter/src/ICLFilter/OpROIHandler.h