mln::border Namespace Reference

Namespace of routines related to image virtual (outer) border. More...

Namespaces
namespace	impl
	Implementation namespace of border namespace.
Functions
template<typename I>
void	adjust (const Image< I > &ima, unsigned min_thickness)
template<typename I>
void	duplicate (const Image< I > &ima)
template<typename I, typename J>
void	equalize (const Image< I > &ima1, const Image< J > &ima2, unsigned min_thickness)
template<typename I>
void	fill (const Image< I > &ima, const typename I::value &v)
template<typename I>
unsigned	find (const Image< I > &ima)
template<typename I>
unsigned	get (const Image< I > &ima)
template<typename I>
void	mirror (const Image< I > &ima)
template<typename I>
void	resize (const Image< I > &ima, unsigned thickness)
	Facade.

---

Detailed Description

Namespace of routines related to image virtual (outer) border.

---

Function Documentation

template<typename I>

void mln::border::adjust	(	const Image< I > &	ima,
		unsigned	min_thickness
	)			[inline]

Adjust the virtual (outer) border of image ima so that its size is at least min_thickness.

Parameters:

[in,out]	ima	The image whose border is to be adjusted.
[in]	min_thickness	The expected border minimum thickness.

Precondition:

ima has to be initialized.

Warning:

If the image border is already larger than min_thickness, this routine is a no-op.

References get(), and resize().

template<typename I>

void mln::border::duplicate

(

const Image< I > &

ima

)

[inline]

Assign the virtual (outer) border of image ima with the duplicate of the inner border of this image.

Parameters:

[in,out]

ima

The image whose border is to be duplicated.

Precondition:

ima has to be initialized.

References get().

Referenced by mln::extension::duplicate().

template<typename I, typename J>

void mln::border::equalize	(	const Image< I > &	ima1,
		const Image< J > &	ima2,
		unsigned	min_thickness
	)			[inline]

Equalize the virtual (outer) border of images ima1 and ima2 so that their size is equal and is at least min_thickness.

Parameters:

[in,out]	ima1	The first image whose border is to be equalizeed.
[in,out]	ima2	The second image whose border is to be equalizeed.
[in]	min_thickness	The expected border minimum thickness of both images.

Precondition:

ima1 has to be initialized.

ima2 has to be initialized.

Warning:

If both image borders already have the same thickness and if this thickness is larger than min_thickness, this routine is a no-op.

References get().

template<typename I>

void mln::border::fill	(	const Image< I > &	ima,
		const typename I::value &	v
	)			[inline]

Fill the virtual (outer) border of image ima with the single value v.

Parameters:

[in,out]	ima	The image whose border is to be filled.
[in]	v	The value to assign to all border pixels.

Precondition:

ima has to be initialized.

template<typename I>

unsigned mln::border::find

(

const Image< I > &

ima

)

[inline]

Find the virtual (outer) border thickness of image ima.

Parameters:

[in]

ima

The image.

Returns:

The border thickness (0 if there is no border).

Precondition:

ima has to be initialized.

template<typename I>

unsigned mln::border::get

(

const Image< I > &

ima

)

[inline]

Get the virtual (outer) border thickness of image ima.

Parameters:

[in]

ima

The image.

Returns:

The border thickness (0 if there is no border).

Precondition:

ima has to be initialized.

Referenced by adjust(), duplicate(), and equalize().

template<typename I>

void mln::border::mirror

(

const Image< I > &

ima

)

[inline]

Mirror the virtual (outer) border of image ima with the (inner) level contents of this image.

Parameters:

[in,out]

ima

The image whose border is to be mirrored.

Precondition:

ima has to be initialized.

template<typename I>

void mln::border::resize	(	const Image< I > &	ima,
		unsigned	thickness
	)			[inline]

Facade.

Resize the virtual (outer) border of image ima to exactly thickness.

Parameters:

[in,out]	ima	The image whose border is to be resized.
[in]	thickness	The expected border thickness.

Precondition:

ima has to be initialized.

Warning:

If the image border already has the expected thickness, this routine is a no-op.

References mln::primary(), and resize().

Referenced by adjust(), and resize().