$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mln::win::sphere3d Class Reference

#include <mln/win/sphere3d.hh>

Public Member Functions

 sphere3d (unsigned diameter)
unsigned delta () const
unsigned delta_ () const
unsigned diameter () const
const D & dp (unsigned i) const
bool has (const D &dp) const
bool is_centered () const
bool is_empty () const
bool is_symmetric () const
bool is_valid () const
void print (std::ostream &ostr) const
void print_ (std::ostream &ostr) const
unsigned size () const
const std::vector< D > & std_vector () const
void sym ()
const std::vector< D > & vect () const

Protected Member Functions

void insert (const D &d)

Protected Attributes

unsigned diameter_
mln::window< D > win_

Public Types

typedef dpsites_fwd_piter< E > bkd_qiter
typedef Window< void > category
typedef psite center_t
typedef D dpsite
typedef E exact_t
typedef dpsites_fwd_piter< E > fwd_qiter
typedef D::psite psite
typedef fwd_qiter qiter
typedef window< D > regular
typedef D::site site

Related Functions

(Note that these are not member functions.)

template<typename I , typename W >
util::array< intnegative_offsets_wrt (const Image< I > &ima, const Window< W > &win)
template<typename I , typename W >
util::array< intoffsets_wrt (const Image< I > &ima, const Window< W > &win)
template<typename I , typename W >
util::array< intpositive_offsets_wrt (const Image< I > &ima, const Window< W > &win)

Detailed Description

3D sphere window; precisely, ball-shaped window defined on the 3D cubic grid.

Definition at line 8 of file sphere3d.dox.

Constructor & Destructor Documentation

mln::win::sphere3d::sphere3d ( unsigned  diameter)

Constructor.

Parameters
[in]diameterDiameter of the sphere.
Precondition
diameter is odd.

Member Function Documentation

template<typename D, typename E>
unsigned mln::internal::classical_window_base< D, E >::delta ( ) const
inherited

Give the maximum coordinate gap between the window center and a window point.

unsigned mln::win::ball< grid::cube , def::coord >::delta_ ( ) const
inherited

Give the maximum coordinate gap between the window center and a window point.

Reimplemented from mln::internal::classical_window_base< D, E >.

unsigned mln::win::ball< grid::cube , def::coord >::diameter ( ) const
inherited

Give the ball diameter.

template<typename D, typename E>
const D& mln::internal::classical_window_base< D, E >::dp ( unsigned  i) const
inherited

Give the i-th delta-point.

template<typename D, typename E>
bool mln::internal::classical_window_base< D, E >::has ( const D &  dp) const
inherited

Test if the delta-point dp belongs to the window.

template<typename D, typename E>
void mln::internal::classical_window_base< D, E >::insert ( const D &  d)
protectedinherited
template<typename D, typename E>
bool mln::internal::classical_window_base< D, E >::is_centered ( ) const
inherited

Test if the window is centered; return true.

template<typename D, typename E>
bool mln::internal::classical_window_base< D, E >::is_empty ( ) const
inherited

Test if the window is empty (null size; no delta-point).

template<typename D, typename E>
bool mln::internal::classical_window_base< D, E >::is_symmetric ( ) const
inherited

Test if the window is symmetric; return true.

template<typename D, typename E>
bool mln::internal::window_base< D, E >::is_valid ( ) const
inherited

return true by default.

template<typename D, typename E>
void mln::internal::classical_window_base< D, E >::print ( std::ostream &  ostr) const
inherited

Print into ostr the window definition.

void mln::win::ball< grid::cube , def::coord >::print_ ( std::ostream &  ostr) const
inherited
template<typename D, typename E>
const std::vector<D>& mln::internal::classical_window_base< D, E >::std_vector ( ) const
inherited

Give the vector of delta-points.

Reimplemented in mln::win::rectangle2d.

template<typename D, typename E>
void mln::internal::classical_window_base< D, E >::sym ( )
inherited

Apply a central symmetry to the target window; a no-op here.

template<typename D, typename E>
const std::vector<D>& mln::internal::classical_window_base< D, E >::vect ( ) const
inherited

Give the vector of delta-points.

Friends And Related Function Documentation

template<typename I , typename W >
util::array< int > negative_offsets_wrt ( const Image< I > &  ima,
const Window< W > &  win 
)
related
template<typename I , typename W >
util::array< int > offsets_wrt ( const Image< I > &  ima,
const Window< W > &  win 
)
related
template<typename I , typename W >
util::array< int > positive_offsets_wrt ( const Image< I > &  ima,
const Window< W > &  win 
)
related

Member Data Documentation

unsigned mln::win::ball< grid::cube , def::coord >::diameter_
protectedinherited

Definition at line 89 of file ball.hh.

template<typename D, typename E>
mln::window<D> mln::internal::classical_window_base< D, E >::win_
protectedinherited

Definition at line 119 of file classical_window_base.hh.

Member Typedef Documentation

template<typename D, typename E>
typedef dpsites_fwd_piter<E> mln::internal::classical_window_base< D, E >::bkd_qiter
inherited

Backward site iterator associated type.

Definition at line 68 of file classical_window_base.hh.

template<typename E>
typedef Window<void> mln::Window< E >::category
inherited

Definition at line 95 of file concept/window.hh.

template<typename D, typename E>
typedef psite mln::internal::window_base< D, E >::center_t
inherited

Type of the window center.

Definition at line 64 of file window_base.hh.

template<typename D, typename E>
typedef D mln::internal::window_base< D, E >::dpsite
inherited

DPsite associated type.

Definition at line 55 of file window_base.hh.

template<typename E>
typedef E mln::Object< E >::exact_t
inherited

Definition at line 105 of file object.hh.

template<typename D, typename E>
typedef dpsites_fwd_piter<E> mln::internal::classical_window_base< D, E >::fwd_qiter
inherited

Forward site iterator associated type.

Definition at line 65 of file classical_window_base.hh.

template<typename D, typename E>
typedef D ::psite mln::internal::window_base< D, E >::psite
inherited

Psite associated type.

Definition at line 58 of file window_base.hh.

template<typename D, typename E>
typedef fwd_qiter mln::internal::classical_window_base< D, E >::qiter
inherited

Site iterator associated type.

Definition at line 71 of file classical_window_base.hh.

template<typename D, typename E>
typedef window<D> mln::internal::classical_window_base< D, E >::regular
inherited

Regular window associated type.

Definition at line 61 of file classical_window_base.hh.

template<typename D, typename E>
typedef D ::site mln::internal::window_base< D, E >::site
inherited

Site associated type.

Definition at line 61 of file window_base.hh.