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

#include <mln/win/cube3d.hh>

Public Member Functions

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

Protected Member Functions

void insert (const dpoint3d &d)

Protected Attributes

unsigned length_
mln::window< dpoint3dwin_

Public Types

typedef dpsites_fwd_piter< cube3dbkd_qiter
typedef Window< void > category
typedef psite center_t
typedef dpoint3d dpsite
typedef cube3d exact_t
typedef dpsites_fwd_piter< cube3dfwd_qiter
typedef dpoint3d::psite psite
typedef fwd_qiter qiter
typedef window< dpoint3dregular
typedef dpoint3d::site site

Detailed Description

Cube window defined on the 3D grid.

An cube3d is centered and symmetric; so its height (length) is odd.

For instance:

    *   o o o
    *  o o o
    * o o o

    *   o o o
    *  o x o
    * o o o

    *   o o o
    *  o o o
    * o o o
    * 

is defined with length = 3.

Definition at line 69 of file cube3d.hh.

Constructor & Destructor Documentation

mln::win::cube3d::cube3d ( unsigned  length)

Constructor.

Parameters
[in]lengthLength, thus height, of the cube3d.
Precondition
length is odd.

Member Function Documentation

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

unsigned mln::win::cube3d::delta_ ( ) const

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

Reimplemented from mln::internal::classical_window_base< dpoint3d, cube3d >.

const dpoint3d & mln::internal::classical_window_base< dpoint3d , cube3d >::dp ( unsigned  i) const
inherited

Give the i-th delta-point.

bool mln::internal::classical_window_base< dpoint3d , cube3d >::has ( const dpoint3d dp) const
inherited

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

void mln::internal::classical_window_base< dpoint3d , cube3d >::insert ( const dpoint3d d)
protectedinherited
bool mln::internal::classical_window_base< dpoint3d , cube3d >::is_centered ( ) const
inherited

Test if the window is centered; return true.

bool mln::internal::classical_window_base< dpoint3d , cube3d >::is_empty ( ) const
inherited

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

bool mln::internal::classical_window_base< dpoint3d , cube3d >::is_symmetric ( ) const
inherited

Test if the window is symmetric; return true.

bool mln::internal::window_base< dpoint3d , cube3d >::is_valid ( ) const
inherited

return true by default.

unsigned mln::win::cube3d::length ( ) const

Give the cube length, that is, its height.

void mln::internal::classical_window_base< dpoint3d , cube3d >::print ( std::ostream &  ostr) const
inherited

Print into ostr the window definition.

void mln::win::cube3d::print_ ( std::ostream &  ostr) const

Give the number of delta-points.

const std::vector<dpoint3d >& mln::internal::classical_window_base< dpoint3d , cube3d >::std_vector ( ) const
inherited

Give the vector of delta-points.

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

const std::vector<dpoint3d >& mln::internal::classical_window_base< dpoint3d , cube3d >::vect ( ) const
inherited

Give the vector of delta-points.

Member Data Documentation

unsigned mln::win::cube3d::length_
protected

Definition at line 91 of file cube3d.hh.

Definition at line 119 of file classical_window_base.hh.

Member Typedef Documentation

Backward site iterator associated type.

Definition at line 68 of file classical_window_base.hh.

typedef Window<void> mln::Window< cube3d >::category
inherited

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

Type of the window center.

Definition at line 64 of file window_base.hh.

DPsite associated type.

Definition at line 55 of file window_base.hh.

typedef cube3d mln::Object< cube3d >::exact_t
inherited

Definition at line 105 of file object.hh.

Forward site iterator associated type.

Definition at line 65 of file classical_window_base.hh.

Psite associated type.

Definition at line 58 of file window_base.hh.

Site iterator associated type.

Definition at line 71 of file classical_window_base.hh.

Regular window associated type.

Definition at line 61 of file classical_window_base.hh.

Site associated type.

Definition at line 61 of file window_base.hh.