mln::image3d< T > Struct Template Reference
[Basic types]

Basic 3D image class. More...

#include <image3d.hh>

Inherits mln::internal::image_primary< T, mln::box, mln::image3d< T > >.

List of all members.

Package Types

typedef T & lvalue
 Return type of read-write access.
typedef const T & rvalue
 Return type of read-only access.
typedef image3d< tag::value_< T > > skeleton
 Skeleton.
typedef T value
 Value associated type.

Package Functions

const box3dbbox () const
 Give the bounding box domain.
unsigned border () const
 Give the border thickness.
T * buffer ()
 Give a hook to the value buffer.
const T * buffer () const
 Give a hook to the value buffer.
int delta_index (const dpoint3d &dp) const
 Fast Image method.
const box3ddomain () const
 Give the definition domain.
T & element (unsigned i)
 Read-write access to the image value located at index i.
const T & element (unsigned i) const
 Read-only access to the image value located at index i.
bool has (const point3d &p) const
 Test if p is valid.
 image3d (int nslis, int nrows, int ncols, unsigned bdr=border::thickness)
 Constructor with the numbers of indexes and the border thickness.
 image3d (const box3d &b, unsigned bdr=border::thickness)
 Constructor with a box and the border thickness (default is 3).
 image3d ()
 Constructor without argument.
unsigned ncols () const
 Give the number of columns.
unsigned nelements () const
 Give the number of cells (points including border ones).
unsigned nrows () const
 Give the number of rows.
unsigned nslices () const
 Give the number of slices.
T & operator() (const point3d &p)
 Read-write access to the image value located at point p.
const T & operator() (const point3d &p) const
 Read-only access to the image value located at point p.
point3d point_at_index (unsigned o) const
 Give the point corresponding to the offset o.


Detailed Description

template<typename T>
struct mln::image3d< T >

Basic 3D image class.

The parameter T is the type of pixel values. This image class stores data in memory and has a virtual border with constant thickness around data.

Definition at line 129 of file core/image/image3d.hh.


Member Typedef Documentation

template<typename T>
typedef T& mln::image3d< T >::lvalue [package]

Return type of read-write access.

Definition at line 152 of file core/image/image3d.hh.

template<typename T>
typedef const T& mln::image3d< T >::rvalue [package]

Return type of read-only access.

Definition at line 149 of file core/image/image3d.hh.

template<typename T>
typedef image3d< tag::value_<T> > mln::image3d< T >::skeleton [package]

Skeleton.

Definition at line 156 of file core/image/image3d.hh.

template<typename T>
typedef T mln::image3d< T >::value [package]

Value associated type.

Definition at line 146 of file core/image/image3d.hh.


Constructor & Destructor Documentation

template<typename T>
mln::image3d< T >::image3d (  )  [inline, package]

Constructor without argument.

Definition at line 385 of file core/image/image3d.hh.

template<typename T>
mln::image3d< T >::image3d ( const box3d b,
unsigned  bdr = border::thickness 
) [inline, package]

Constructor with a box and the border thickness (default is 3).

Definition at line 391 of file core/image/image3d.hh.

template<typename T>
mln::image3d< T >::image3d ( int  nslis,
int  nrows,
int  ncols,
unsigned  bdr = border::thickness 
) [inline, package]

Constructor with the numbers of indexes and the border thickness.

Definition at line 398 of file core/image/image3d.hh.

References mln::make::box3d().


Member Function Documentation

template<typename T>
const box3d & mln::image3d< T >::bbox (  )  const [inline, package]

Give the bounding box domain.

Definition at line 424 of file core/image/image3d.hh.

template<typename T>
unsigned mln::image3d< T >::border (  )  const [inline, package]

Give the border thickness.

Definition at line 433 of file core/image/image3d.hh.

template<typename T>
T * mln::image3d< T >::buffer (  )  [inline, package]

Give a hook to the value buffer.

Definition at line 550 of file core/image/image3d.hh.

template<typename T>
const T * mln::image3d< T >::buffer (  )  const [inline, package]

Give a hook to the value buffer.

Definition at line 541 of file core/image/image3d.hh.

template<typename T>
int mln::image3d< T >::delta_index ( const dpoint3d dp  )  const [inline, package]

Fast Image method.

Give the offset corresponding to the delta-point dp.

Definition at line 559 of file core/image/image3d.hh.

template<typename T>
const box3d & mln::image3d< T >::domain (  )  const [inline, package]

Give the definition domain.

Definition at line 415 of file core/image/image3d.hh.

template<typename T>
T & mln::image3d< T >::element ( unsigned  i  )  [inline, package]

Read-write access to the image value located at index i.

Definition at line 487 of file core/image/image3d.hh.

References mln::image3d< T >::nelements().

template<typename T>
const T & mln::image3d< T >::element ( unsigned  i  )  const [inline, package]

Read-only access to the image value located at index i.

Definition at line 478 of file core/image/image3d.hh.

References mln::image3d< T >::nelements().

template<typename T>
bool mln::image3d< T >::has ( const point3d p  )  const [inline, package]

Test if p is valid.

Definition at line 451 of file core/image/image3d.hh.

Referenced by mln::image3d< T >::operator()().

template<typename T>
unsigned mln::image3d< T >::ncols (  )  const [inline, package]

Give the number of columns.

Definition at line 532 of file core/image/image3d.hh.

template<typename T>
unsigned mln::image3d< T >::nelements (  )  const [inline, package]

Give the number of cells (points including border ones).

Definition at line 442 of file core/image/image3d.hh.

Referenced by mln::image3d< T >::element(), and mln::image3d< T >::point_at_index().

template<typename T>
unsigned mln::image3d< T >::nrows (  )  const [inline, package]

Give the number of rows.

Definition at line 523 of file core/image/image3d.hh.

template<typename T>
unsigned mln::image3d< T >::nslices (  )  const [inline, package]

Give the number of slices.

Definition at line 514 of file core/image/image3d.hh.

template<typename T>
T & mln::image3d< T >::operator() ( const point3d p  )  [inline, package]

Read-write access to the image value located at point p.

Definition at line 469 of file core/image/image3d.hh.

References mln::image3d< T >::has().

template<typename T>
const T & mln::image3d< T >::operator() ( const point3d p  )  const [inline, package]

Read-only access to the image value located at point p.

Definition at line 460 of file core/image/image3d.hh.

References mln::image3d< T >::has().

template<typename T>
point3d mln::image3d< T >::point_at_index ( unsigned  o  )  const [inline, package]

Give the point corresponding to the offset o.

Definition at line 570 of file core/image/image3d.hh.

References mln::image3d< T >::nelements().


Generated on Sun May 16 01:35:46 2010 for Milena (Olena) by  doxygen 1.5.6