Public Types | Public Member Functions | Protected Member Functions | Protected Attributes

mln::win::cube3d Struct Reference
[3D windows]

Cube window defined on the 3D grid. More...

#include <cube3d.hh>

Inheritance diagram for mln::win::cube3d:
Inheritance graph

List of all members.

Public Types

typedef dpsites_fwd_piter< cube3dbkd_qiter
 Backward site iterator associated type.
typedef Window< void > category
typedef psite center_t
 Type of the window center.
typedef dpoint3d dpsite
 DPsite associated type.
typedef cube3d exact_t
typedef dpsites_fwd_piter< cube3dfwd_qiter
 Forward site iterator associated type.
typedef dpoint3d::psite psite
 Psite associated type.
typedef fwd_qiter qiter
 Site iterator associated type.
typedef window< dpoint3dregular
 Regular window associated type.
typedef dpoint3d::site site
 Site associated type.

Public Member Functions

 cube3d (unsigned length)
 Constructor.
unsigned delta () const
 Give the maximum coordinate gap between the window center and a window point.
unsigned delta_ () const
 Give the maximum coordinate gap between the window center and a window point.
const dpoint3ddp (unsigned i) const
 Give the i-th delta-point.
bool has (const dpoint3d &dp) const
 Test if the delta-point dp belongs to the window.
bool is_centered () const
 Test if the window is centered; return true.
bool is_empty () const
 Test if the window is empty (null size; no delta-point).
bool is_neighbable_ () const
 Test if this window can be a neighborhood.
bool is_symmetric () const
 Test if the window is symmetric; return true.
bool is_valid () const
 return true by default.
unsigned length () const
 Give the cube length, that is, its height.
void print (std::ostream &ostr) const
 Print into ostr the window definition.
void print_ (std::ostream &ostr) const
unsigned size () const
 Give the number of delta-points.
const std::vector< dpoint3d > & std_vector () const
 Give the vector of delta-points.
void sym ()
 Apply a central symmetry to the target window; a no-op here.
const std::vector< dpoint3d > & vect () const
 Give the vector of delta-points.

Protected Member Functions

void insert (const dpoint3d &d)

Protected Attributes

unsigned length_
mln::window< dpoint3dwin_

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.


Member Typedef Documentation

Backward site iterator associated type.

Definition at line 67 of file classical_window_base.hh.

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

Reimplemented from mln::Object< cube3d >.

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

Type of the window center.

Definition at line 62 of file window_base.hh.

DPsite associated type.

Definition at line 53 of file window_base.hh.

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

Definition at line 173 of file object.hh.

Forward site iterator associated type.

Definition at line 64 of file classical_window_base.hh.

Psite associated type.

Definition at line 56 of file window_base.hh.

Site iterator associated type.

Definition at line 70 of file classical_window_base.hh.

Regular window associated type.

Definition at line 60 of file classical_window_base.hh.

Site associated type.

Definition at line 59 of file window_base.hh.


Constructor & Destructor Documentation

mln::win::cube3d::cube3d ( unsigned  length  )  [inline]

Constructor.

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

Definition at line 99 of file cube3d.hh.

References mln::internal::classical_window_base< dpoint3d, cube3d >::insert().


Member Function Documentation

unsigned mln::internal::classical_window_base< dpoint3d , cube3d >::delta (  )  const [inherited]

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

unsigned mln::win::cube3d::delta_ (  )  const [inline]

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

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

Definition at line 119 of file cube3d.hh.

References length_.

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  )  [protected, inherited]

Referenced by cube3d().

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::window_base< dpoint3d , cube3d >::is_neighbable_ (  )  const [inherited]

Test if this window can be a neighborhood.

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 [inline]

Give the cube length, that is, its height.

Definition at line 113 of file cube3d.hh.

References length_.

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 [inline]

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

Definition at line 125 of file cube3d.hh.

References length_.

unsigned mln::internal::classical_window_base< dpoint3d , cube3d >::size (  )  const [inherited]

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.

void mln::internal::classical_window_base< dpoint3d , cube3d >::sym (  )  [inherited]

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.

Referenced by delta_(), length(), and print_().

Definition at line 118 of file classical_window_base.hh.