oln::abstract::image_with_dim< 3, Exact > Class Template Reference

The specialized version for image3d. More...

#include <image_with_dim.hh>

Inheritance diagram for oln::abstract::image_with_dim< 3, Exact >:

Inheritance graph
[legend]
Collaboration diagram for oln::abstract::image_with_dim< 3, Exact >:

Collaboration graph
[legend]
List of all members.

Public Types

typedef image_traits< Exact
>::point_type 
point_type
typedef image_traits< Exact
>::point_type 
dpoint_type
typedef image_traits< Exact
>::iter_type 
iter_type
typedef image_traits< Exact
>::fwd_iter_type 
fwd_iter_type
typedef image_traits< Exact
>::bkd_iter_type 
bkd_iter_type
typedef image_traits< Exact
>::value_type 
value_type
typedef image_traits< Exact
>::size_type 
size_type
typedef image< Exact > super_type
typedef image_with_dim<
3, Exact > 
self_type
typedef Exact exact_type

Public Member Functions

coord nslices () const
 Return the number of slices in the current image.
coord nrows () const
 Return the number of rows in the current image.
coord ncols () const
 Return the number of columns in the image.
const value_type operator() (coord slice, coord row, coord col) const
 Return the value stored at slice, row and col coordinates on the current image.
value_typeoperator() (coord slice, coord row, coord col)
 Return a reference to the value stored at slice, row and col coordinates on the current image.
bool hold (coord slice, coord row, coord col) const
 Test if a point belongs to the current image.
exact_typeoperator= (self_type rhs)
 Perform a shallow copy from rhs to the current image, the points are not duplicated but shared between the two image.

Static Public Member Functions

static std::string name ()

Protected Member Functions

size_t npoints_ () const
 Return the total number of points in the current image.
 image_with_dim ()

Friends

class image< exact_type >

Detailed Description

template<class Exact>
class oln::abstract::image_with_dim< 3, Exact >

The specialized version for image3d.

Definition at line 420 of file image_with_dim.hh.


Member Typedef Documentation

template<class Exact>
typedef image_traits<Exact>::point_type oln::abstract::image_with_dim< 3, Exact >::point_type

Prefer the macro oln_point_type(I) to retrieve the point_type of an image.

See also:
oln::point3d

Reimplemented from oln::abstract::image< Exact >.

Definition at line 424 of file image_with_dim.hh.

template<class Exact>
typedef image_traits<Exact>::point_type oln::abstract::image_with_dim< 3, Exact >::dpoint_type

Prefer the macro oln_dpoint_type(I) to retrieve the dpoint_type of an image.

See also:
oln::dpoint3d

Reimplemented from oln::abstract::image< Exact >.

Definition at line 430 of file image_with_dim.hh.

template<class Exact>
typedef image_traits<Exact>::iter_type oln::abstract::image_with_dim< 3, Exact >::iter_type

Prefer the macro oln_iter_type(I) to retrieve the iter_type of an image.

See also:
iter3d

Reimplemented from oln::abstract::image< Exact >.

Definition at line 436 of file image_with_dim.hh.

template<class Exact>
typedef image_traits<Exact>::fwd_iter_type oln::abstract::image_with_dim< 3, Exact >::fwd_iter_type

Forward iterator type.

Reimplemented from oln::abstract::image< Exact >.

Definition at line 442 of file image_with_dim.hh.

template<class Exact>
typedef image_traits<Exact>::bkd_iter_type oln::abstract::image_with_dim< 3, Exact >::bkd_iter_type

Backward iterator type.

Reimplemented from oln::abstract::image< Exact >.

Definition at line 444 of file image_with_dim.hh.

template<class Exact>
typedef image_traits<Exact>::value_type oln::abstract::image_with_dim< 3, Exact >::value_type

Prefer the macro oln_value_type(I) to retrieve the value_type of an image.

Reimplemented from oln::abstract::image< Exact >.

Definition at line 446 of file image_with_dim.hh.

template<class Exact>
typedef image_traits<Exact>::size_type oln::abstract::image_with_dim< 3, Exact >::size_type

Indicate how the image size is handled.

See also:
oln::image3d_size

Reimplemented from oln::abstract::image< Exact >.

Definition at line 450 of file image_with_dim.hh.


Member Function Documentation

template<class Exact>
bool oln::abstract::image_with_dim< 3, Exact >::hold ( coord  slice,
coord  row,
coord  col 
) const [inline]

Test if a point belongs to the current image.

Returns:
True if the point belongs to the image, false otherwise.

Definition at line 523 of file image_with_dim.hh.

00524       {
00525         return hold(point_type(slice, row, col));
00526       }

template<class Exact>
exact_type& oln::abstract::image_with_dim< 3, Exact >::operator= ( self_type  rhs  )  [inline]

Perform a shallow copy from rhs to the current image, the points are not duplicated but shared between the two image.

See also:
image::clone()

Reimplemented from oln::abstract::image< Exact >.

Definition at line 537 of file image_with_dim.hh.

References mlc_hierarchy::any_with_diamond< E >::exact().

00538       {
00539         return this->exact().assign(rhs.exact());
00540       }


The documentation for this class was generated from the following file:
Generated on Tue Feb 20 20:24:58 2007 for Olena by  doxygen 1.5.1