vil_image_view_base Class Reference

#include <vil_image_view_base.h>

Inheritance diagram for vil_image_view_base:

[legend]List of all members.

---

Detailed Description

An abstract base class of smart pointers to actual image data in memory.

If you want an actual image, try instantiating vil_image_view<T>.

Definition at line 26 of file vil_image_view_base.h.

Public Member Functions
virtual	~vil_image_view_base ()
unsigned	ni () const
	Width.
unsigned	nj () const
	Height.
unsigned	nplanes () const
	Number of planes.
unsigned long	size () const
	The number of pixels.
virtual void	set_size (unsigned width, unsigned height)=0
	set_size current planes to width x height.
virtual void	set_size (unsigned width, unsigned height, unsigned n_planes)=0
	resize to width x height x n_planes.
virtual void	print (vcl_ostream &) const =0
	Print a 1-line summary of contents.
virtual vcl_string	is_a () const =0
	Return class name.
virtual enum vil_pixel_format	pixel_format () const =0
	Return a description of the concrete data pixel type.
virtual bool	is_class (vcl_string const &s) const
	True if this is (or is derived from) class s.
Protected Member Functions
	vil_image_view_base (unsigned n_i, unsigned n_j, unsigned n_planes)
	vil_image_view_base ()
	Default is an empty one-plane image.
Protected Attributes
unsigned	ni_
	Number of columns.
unsigned	nj_
	Number of rasters.
unsigned	nplanes_
	Number of planes.
Private Member Functions
void	ref ()
void	unref ()
Private Attributes
int	reference_count_
Friends
class	vil_smart_ptr< vil_image_view_base >

---

Constructor & Destructor Documentation

vil_image_view_base::vil_image_view_base (  unsigned  n_i, unsigned  n_j, unsigned  n_planes )  [inline, protected]

Definition at line 36 of file vil_image_view_base.h.

vil_image_view_base::vil_image_view_base (   )  [inline, protected]

Default is an empty one-plane image. Don't set nplanes_ to zero as it confuses set_size(nx,ny) later Definition at line 41 of file vil_image_view_base.h.

virtual vil_image_view_base::~vil_image_view_base (   )  [inline, virtual]

Definition at line 45 of file vil_image_view_base.h.

---

Member Function Documentation

virtual vcl_string vil_image_view_base::is_a (   )  const [pure virtual]

Return class name. Implemented in vil_image_view< T >, and vil_image_view< bool >.

virtual bool vil_image_view_base::is_class (  vcl_string const &  s  )  const [inline, virtual]

True if this is (or is derived from) class s. Reimplemented in vil_image_view< T >, and vil_image_view< bool >. Definition at line 78 of file vil_image_view_base.h.

unsigned vil_image_view_base::ni (   )  const [inline]

Width. Definition at line 48 of file vil_image_view_base.h.

unsigned vil_image_view_base::nj (   )  const [inline]

Height. Definition at line 50 of file vil_image_view_base.h.

unsigned vil_image_view_base::nplanes (   )  const [inline]

Number of planes. Definition at line 52 of file vil_image_view_base.h.

virtual enum vil_pixel_format vil_image_view_base::pixel_format (   )  const [pure virtual]

Return a description of the concrete data pixel type. For example if the value is VIL_PIXEL_FORMAT_BYTE, you can safely cast, or assign the base class reference to a vil_image_view<vxl_byte>. Implemented in vil_image_view< T >, and vil_image_view< bool >.

virtual void vil_image_view_base::print (  vcl_ostream &   )  const [pure virtual]

Print a 1-line summary of contents. Implemented in vil_image_view< T >, and vil_image_view< bool >.

void vil_image_view_base::ref (   )  [inline, private]

Definition at line 84 of file vil_image_view_base.h.

virtual void vil_image_view_base::set_size (  unsigned  width, unsigned  height, unsigned  n_planes )  [pure virtual]

resize to width x height x n_planes. If already correct size, this function returns quickly Implemented in vil_image_view< T >, and vil_image_view< bool >.

virtual void vil_image_view_base::set_size (  unsigned  width, unsigned  height )  [pure virtual]

set_size current planes to width x height. If already correct size, this function returns quickly Implemented in vil_image_view< T >, and vil_image_view< bool >.

unsigned long vil_image_view_base::size (   )  const [inline]

The number of pixels. Definition at line 55 of file vil_image_view_base.h.

void vil_image_view_base::unref (   )  [inline, private]

Definition at line 85 of file vil_image_view_base.h.

---

Friends And Related Function Documentation

friend class vil_smart_ptr< vil_image_view_base > [friend]

Definition at line 83 of file vil_image_view_base.h.

---

Member Data Documentation

unsigned vil_image_view_base::ni_ [protected]

Number of columns. Definition at line 30 of file vil_image_view_base.h.

unsigned vil_image_view_base::nj_ [protected]

Number of rasters. Definition at line 32 of file vil_image_view_base.h.

unsigned vil_image_view_base::nplanes_ [protected]

Number of planes. Definition at line 34 of file vil_image_view_base.h.

int vil_image_view_base::reference_count_ [private]

Definition at line 88 of file vil_image_view_base.h.

---

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

• core/vil/vil_image_view_base.h

---