Classes | Public Member Functions | Private Attributes
bbgm_feature_image< f_type_ > Class Template Reference

#include <bbgm_feature_image.h>

Inheritance diagram for bbgm_feature_image< f_type_ >:
Inheritance graph
[legend]

List of all members.

Classes

class  const_iterator
class  iterator
 An iterator over the distribution in the image. More...

Public Member Functions

 bbgm_feature_image ()
 Constructor.
 bbgm_feature_image (unsigned int ni, unsigned int nj)
 bbgm_feature_image (unsigned int ni, unsigned int nj, f_type_ const &feature)
unsigned int ni () const
 Return the width of the image.
unsigned int nj () const
 Return the height.
void set_size (unsigned ni, unsigned nj)
 resize to ni x nj.
const f_type_ & operator() (unsigned int i, unsigned int j) const
 Read only access to the features.
f_type_ & operator() (unsigned int i, unsigned int j)
 Access to the features.
void set (unsigned int i, unsigned int j, const f_type_ &d)
 Set the distribution at (i,j) to a copy of d.
iterator begin ()
 Return an iterator to the first element.
iterator end ()
 Return an iterator to one past the last element.
const_iterator begin () const
 Return a const iterator to the first element.
const_iterator end () const
 Return a const iterator to one past the last element.
virtual vcl_string is_a () const
 Return a string name.
virtual bbgm_feature_image_baseclone () const
short version () const
 Return IO version number;.
virtual void b_write (vsl_b_ostream &os) const
 Binary save self to stream.
virtual void b_read (vsl_b_istream &is)
 Binary load self from stream.
void ref ()
void unref ()
int get_references () const
bool is_referenced () const

Private Attributes

vbl_array_2d< f_type_ > data_
 the data.

Detailed Description

template<class f_type_>
class bbgm_feature_image< f_type_ >

Definition at line 43 of file bbgm_feature_image.h.


Constructor & Destructor Documentation

template<class f_type_>
bbgm_feature_image< f_type_ >::bbgm_feature_image ( ) [inline]

Constructor.

Definition at line 47 of file bbgm_feature_image.h.

template<class f_type_>
bbgm_feature_image< f_type_ >::bbgm_feature_image ( unsigned int  ni,
unsigned int  nj 
) [inline]

Definition at line 48 of file bbgm_feature_image.h.

template<class f_type_>
bbgm_feature_image< f_type_ >::bbgm_feature_image ( unsigned int  ni,
unsigned int  nj,
f_type_ const &  feature 
) [inline]

Definition at line 49 of file bbgm_feature_image.h.


Member Function Documentation

template<class f_type_ >
void bbgm_feature_image< f_type_ >::b_read ( vsl_b_istream is) [virtual]

Binary load self from stream.

Implements bbgm_feature_image_base.

Definition at line 55 of file bbgm_feature_image.txx.

template<class f_type_ >
void bbgm_feature_image< f_type_ >::b_write ( vsl_b_ostream os) const [virtual]

Binary save self to stream.

Implements bbgm_feature_image_base.

Definition at line 45 of file bbgm_feature_image.txx.

template<class f_type_>
iterator bbgm_feature_image< f_type_ >::begin ( ) [inline]

Return an iterator to the first element.

Definition at line 107 of file bbgm_feature_image.h.

template<class f_type_>
const_iterator bbgm_feature_image< f_type_ >::begin ( ) const [inline]

Return a const iterator to the first element.

Definition at line 111 of file bbgm_feature_image.h.

template<class f_type_ >
bbgm_feature_image_base * bbgm_feature_image< f_type_ >::clone ( ) const [virtual]

Implements bbgm_feature_image_base.

Definition at line 27 of file bbgm_feature_image.txx.

template<class f_type_>
iterator bbgm_feature_image< f_type_ >::end ( ) [inline]

Return an iterator to one past the last element.

Definition at line 109 of file bbgm_feature_image.h.

template<class f_type_>
const_iterator bbgm_feature_image< f_type_ >::end ( ) const [inline]

Return a const iterator to one past the last element.

Definition at line 113 of file bbgm_feature_image.h.

template<class f_type_ >
vcl_string bbgm_feature_image< f_type_ >::is_a ( ) const [virtual]

Return a string name.

Note:
this is probably not portable

Implements bbgm_feature_image_base.

Definition at line 19 of file bbgm_feature_image.txx.

template<class f_type_>
unsigned int bbgm_feature_image< f_type_ >::ni ( ) const [inline, virtual]

Return the width of the image.

Implements bbgm_feature_image_base.

Definition at line 54 of file bbgm_feature_image.h.

template<class f_type_>
unsigned int bbgm_feature_image< f_type_ >::nj ( ) const [inline, virtual]

Return the height.

Implements bbgm_feature_image_base.

Definition at line 57 of file bbgm_feature_image.h.

template<class f_type_>
const f_type_& bbgm_feature_image< f_type_ >::operator() ( unsigned int  i,
unsigned int  j 
) const [inline]

Read only access to the features.

Definition at line 64 of file bbgm_feature_image.h.

template<class f_type_>
f_type_& bbgm_feature_image< f_type_ >::operator() ( unsigned int  i,
unsigned int  j 
) [inline]

Access to the features.

Definition at line 68 of file bbgm_feature_image.h.

template<class f_type_>
void bbgm_feature_image< f_type_ >::set ( unsigned int  i,
unsigned int  j,
const f_type_ &  d 
) [inline]

Set the distribution at (i,j) to a copy of d.

Definition at line 72 of file bbgm_feature_image.h.

template<class f_type_>
void bbgm_feature_image< f_type_ >::set_size ( unsigned  ni,
unsigned  nj 
) [inline]

resize to ni x nj.

If already correct size, this function returns quickly

Definition at line 61 of file bbgm_feature_image.h.

template<class f_type_ >
short bbgm_feature_image< f_type_ >::version ( ) const

Return IO version number;.

Definition at line 36 of file bbgm_feature_image.txx.


Member Data Documentation

template<class f_type_>
vbl_array_2d<f_type_ > bbgm_feature_image< f_type_ >::data_ [private]

the data.

Definition at line 135 of file bbgm_feature_image.h.


The documentation for this class was generated from the following files: