$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Drawing

Functions

template<typename I , typename B >
void mln::draw::box (Image< I > &ima, const Box< B > &b, const typename I::value &v)
template<typename I , typename B >
void mln::draw::box_plain (Image< I > &ima, const Box< B > &b, const typename I::value &v)
template<typename I >
void mln::draw::dashed_line (Image< I > &ima, const typename I::psite &beg, const typename I::psite &end, const typename I::value &v)
template<typename I >
void mln::draw::line (Image< I > &ima, const typename I::psite &beg, const typename I::psite &end, const typename I::value &v)
template<typename I >
void mln::draw::plot (Image< I > &ima, const typename I::point &p, const typename I::value &v)
template<typename I >
void mln::draw::polygon (Image< I > &ima, const p_array< typename I::site > &par, const typename I::value &v, unsigned output_ratio)
template<typename I >
void mln::draw::polygon (Image< I > &ima, const p_array< typename I::site > &par, const typename I::value &v)
template<typename I , typename S >
void mln::draw::site_set (Image< I > &ima, const Site_Set< S > &s, const typename I::value &v, unsigned output_ratio=1)

Detailed Description

All routines for drawing into images.

Function Documentation

template<typename I , typename B >
void mln::draw::box ( Image< I > &  ima,
const Box< B > &  b,
const typename I::value &  v 
)

Draw a box at value v in image ima.

Parameters
[in,out]imaThe image to be drawn.
[in]bthe boxto draw.
[in]vThe value to assign to all drawn pixels.
Precondition
ima has to be initialized.
ima has beg.
ima has end.
template<typename I , typename B >
void mln::draw::box_plain ( Image< I > &  ima,
const Box< B > &  b,
const typename I::value &  v 
)

Draw a plain box at value v in image ima.

Parameters
[in,out]imaThe image to be drawn.
[in]bthe box to draw.
[in]vThe value to assign to all drawn pixels.
Precondition
ima has to be initialized.
ima has beg.
ima has end.
template<typename I >
void mln::draw::dashed_line ( Image< I > &  ima,
const typename I::psite &  beg,
const typename I::psite &  end,
const typename I::value &  v 
)

Draw a dashed line at level v in image ima between the points beg and end.

Parameters
[in,out]imaThe image to be drawn.
[in]begThe start point to drawn dashed line.
[in]endThe end point to drawn dashed line.
[in]vThe value to assign to all drawn pixels.
Precondition
ima has to be initialized.
ima has beg.
ima has end.
template<typename I >
void mln::draw::line ( Image< I > &  ima,
const typename I::psite &  beg,
const typename I::psite &  end,
const typename I::value &  v 
)

Draw a line at level v in image ima between the points beg and end.

Parameters
[in,out]imaThe image to be drawn.
[in]begThe start point to drawn line.
[in]endThe end point to drawn line.
[in]vThe value to assign to all drawn pixels.
Precondition
ima has to be initialized.
ima has beg.
ima has end.
template<typename I >
void mln::draw::plot ( Image< I > &  ima,
const typename I::point &  p,
const typename I::value &  v 
)

Plot a point at level v in image ima.

Parameters
[in,out]imaThe image to be drawn.
[in]pThe point to be plotted.
[in]vThe value to assign to all drawn pixels.
Precondition
ima has to be initialized.
ima has p.
template<typename I >
void mln::draw::polygon ( Image< I > &  ima,
const p_array< typename I::site > &  par,
const typename I::value &  v,
unsigned  output_ratio 
)

Draw a polygon at level v in image ima.

Parameters
[in,out]imaThe image to be drawn.
[in]parThe polygon site set.
[in]vThe value to assign to all drawn pixels.
[in]output_ratioSubsampling ratio.
Precondition
ima has to be initialized.
template<typename I >
void mln::draw::polygon ( Image< I > &  ima,
const p_array< typename I::site > &  par,
const typename I::value &  v 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. output_ratio is set to 1 (no subsampling).

template<typename I , typename S >
void mln::draw::site_set ( Image< I > &  ima,
const Site_Set< S > &  s,
const typename I::value &  v,
unsigned  output_ratio = 1 
)

Draw a sites with value v in image ima.

Parameters
[in,out]imaThe image to be drawn.
[in]sthe site set to draw.
[in]vThe value to assign to all drawn pixels.
[in]output_ratiosize ratio between output image and the image from which the bboxes were calculated.
Precondition
s is included in ima domain.