icl::core::FixedConverter Class Reference

Special converter "producing" images with fixed parameters. More...

#include <FixedConverter.h>

Inheritance diagram for icl::core::FixedConverter:

Public Member Functions
	FixedConverter (const ImgParams &p, depth d=depth8u, bool applyToROIOnly=false)
	Create a new FixedConverter Object with given destination params and depth. More...
void	apply (const ImgBase *poSrc, ImgBase **ppoDst)
	Converts the source image into the given destination image. More...
void	setApplyToROIOnly (bool applyToROIOnly)
	set up wheater to apply on the source image or on the source images ROI More...
void	setParams (const ImgParams &p)
	sets up the output image parameters More...
void	setOperationOrder (Converter::oporder o)
	sets up the order to use when applying several conversion internally More...
void	setScaleMode (scalemode scaleMode)
	sets a new scalemode (default is interpolateNN) More...

Private Attributes
ImgParams	m_oParams
	destination image parameters More...
Converter	m_oConverter
	Converter to apply conversion. More...
depth	m_eDepth
	destination image depth More...

Additional Inherited Members
Protected Member Functions inherited from icl::utils::Uncopyable
	Uncopyable ()
	Empty base constructor. More...

Detailed Description

Special converter "producing" images with fixed parameters.

This class can be used to convert images with arbitrary params and depth to well defined fixed params and depth. Its functionality bases on the icl::Converter class which is created as a member of the FixedConverter.

See also

icl::Converter

Constructor & Destructor Documentation

FixedConverter()

icl::core::FixedConverter::FixedConverter	(	const ImgParams &	p,
		depth	d = depth8u,
		bool	applyToROIOnly = false
	)

Create a new FixedConverter Object with given destination params and depth.

Parameters

p	output image parameters
d	output image depth
applyToROIOnly	decides wheater to apply the conversion on the whole source image or only on the source images ROI

Member Function Documentation

apply()

void icl::core::FixedConverter::apply	(	const ImgBase *	poSrc,
		ImgBase **	ppoDst
	)

Converts the source image into the given destination image.

The given destination image pointer is adapted in its depth and parameters before apply function of the Converter member is called.

Parameters

poSrc	source image
ppoDst	destination image, null is not allowed! If it points to NULL, the a appropriate destination image is created at *ppoDst else it is adapted to the parameters of the FixedConverter object

setApplyToROIOnly()

void icl::core::FixedConverter::setApplyToROIOnly ( bool  applyToROIOnly )

inline

set up wheater to apply on the source image or on the source images ROI

Parameters

applyToROIOnly

given flag

setOperationOrder()

void icl::core::FixedConverter::setOperationOrder ( Converter::oporder  o )

inline

sets up the order to use when applying several conversion internally

Parameters

o	new operation order

See also

Converter

setParams()

void icl::core::FixedConverter::setParams ( const ImgParams &  p )

inline

sets up the output image parameters

Parameters

p	output image parameters

setScaleMode()

void icl::core::FixedConverter::setScaleMode ( scalemode  scaleMode )

inline

sets a new scalemode (default is interpolateNN)

Member Data Documentation

m_eDepth

depth icl::core::FixedConverter::m_eDepth

private

destination image depth

m_oConverter

Converter icl::core::FixedConverter::m_oConverter

private

Converter to apply conversion.

m_oParams

ImgParams icl::core::FixedConverter::m_oParams

private

destination image parameters

---

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

• /Users/alneuman/vm/icl/ICLCore/src/ICLCore/FixedConverter.h