vil1_image_impl Class Reference

#include <vil1_image_impl.h>

Inheritance diagram for vil1_image_impl:

List of all members.

---

Detailed Description

Representation of a generic image.

                          Component   Cell     Pixel      get_section(plane=0,
                          example     example  example      x0=0,y0=0,w=1,h=1)
  
    3 x W x H x 1
       +------+           r           r        r,g,b      r
       |r     |           g           g
     +-|      |           b           b
     |g|      |
   +-| +------+
   |b|      |
   | +------+
   |      |
   +------+
  
   1 x W x H x 3
   +------------+         r           rgb       rgb       rgb
   |rgb|rgb|    |
   +---+---+    |
   |            |
   |            |
   |            |
   

document relationship between :

• Component: r, r
• Cell: r, rgb
• Pixel : spatial location,
• Plane

Definition at line 86 of file vil1_image_impl.h.

Public Member Functions
	vil1_image_impl ()
	the reference count starts at 0.
virtual	~vil1_image_impl ()
virtual int	planes () const=0
	Dimensions: Planes x W x H x Components.
virtual int	width () const=0
	Dimensions: Planes x W x H x Components.
virtual int	height () const=0
	Dimensions: Planes x W x H x Components.
virtual int	components () const=0
	Dimensions: Planes x W x H x Components.
virtual int	bits_per_component () const=0
	Number of bits per component.
virtual enum vil1_component_format	component_format () const=0
	Format.
virtual vil1_image	get_plane (unsigned int p) const
	return the ith plane.
virtual bool	get_section (void *buf, int x0, int y0, int width, int height) const=0
	Copy buffer of this to BUF.
virtual bool	put_section (void const *buf, int x0, int y0, int width, int height)=0
	Copy plane PLANE of BUF to this.
virtual char const *	file_format () const
	Return a string describing the file format.
virtual bool	get_property (char const *tag, void *property_value=0) const
	Extra property information.
virtual bool	set_property (char const *tag, void const *property_value=0) const
virtual vcl_string	is_a () const
	Return the name of the class;.
virtual bool	is_class (vcl_string const &s) const
	Return true if the name of the class matches the argument.
Private Member Functions
void	up_ref ()
void	down_ref ()
Private Attributes
int	reference_count
Friends
class	vil1_image

---

Constructor & Destructor Documentation

vil1_image_impl::vil1_image_impl

(

)

[inline]

the reference count starts at 0.

Definition at line 91 of file vil1_image_impl.h.

virtual vil1_image_impl::~vil1_image_impl

(

)

[inline, virtual]

Definition at line 92 of file vil1_image_impl.h.

---

Member Function Documentation

virtual int vil1_image_impl::planes

(

)

const [pure virtual]

Dimensions: Planes x W x H x Components.

Implemented in vil1_bmp_generic_image, vil1_gen_generic_image, vil1_gif_loader_saver, vil1_gif_loader_saver_proxy, vil1_iris_generic_image, vil1_jpeg_generic_image, vil1_mit_generic_image, vil1_png_generic_image, vil1_pnm_generic_image, vil1_ras_generic_image, vil1_tiff_generic_image, vil1_viff_generic_image, vil1_block_cache_image_impl, vil1_clamp_image_impl, vil1_crop_image_impl, vil1_flip_components_impl, vil1_flipud_impl, vil1_image_as_impl< T >, vil1_image_proxy_impl, vil1_memory_image_impl, vil1_resample_image_impl, vil1_scale_intensities_image_impl, and vil1_skip_image_impl.

virtual int vil1_image_impl::width

(

)

const [pure virtual]

Dimensions: Planes x W x H x Components.

Implemented in vil1_bmp_generic_image, vil1_gen_generic_image, vil1_gif_loader_saver, vil1_gif_loader_saver_proxy, vil1_iris_generic_image, vil1_jpeg_generic_image, vil1_mit_generic_image, vil1_png_generic_image, vil1_pnm_generic_image, vil1_ras_generic_image, vil1_tiff_generic_image, vil1_viff_generic_image, vil1_block_cache_image_impl, vil1_clamp_image_impl, vil1_crop_image_impl, vil1_flip_components_impl, vil1_flipud_impl, vil1_image_as_impl< T >, vil1_image_proxy_impl, vil1_memory_image_impl, vil1_resample_image_impl, vil1_scale_intensities_image_impl, and vil1_skip_image_impl.

virtual int vil1_image_impl::height

(

)

const [pure virtual]

Dimensions: Planes x W x H x Components.

Implemented in vil1_bmp_generic_image, vil1_gen_generic_image, vil1_gif_loader_saver, vil1_gif_loader_saver_proxy, vil1_iris_generic_image, vil1_jpeg_generic_image, vil1_mit_generic_image, vil1_png_generic_image, vil1_pnm_generic_image, vil1_ras_generic_image, vil1_tiff_generic_image, vil1_viff_generic_image, vil1_block_cache_image_impl, vil1_clamp_image_impl, vil1_crop_image_impl, vil1_flip_components_impl, vil1_flipud_impl, vil1_image_as_impl< T >, vil1_image_proxy_impl, vil1_memory_image_impl, vil1_resample_image_impl, vil1_scale_intensities_image_impl, and vil1_skip_image_impl.

virtual int vil1_image_impl::components

(

)

const [pure virtual]

Dimensions: Planes x W x H x Components.

Implemented in vil1_bmp_generic_image, vil1_gen_generic_image, vil1_gif_loader_saver, vil1_gif_loader_saver_proxy, vil1_iris_generic_image, vil1_jpeg_generic_image, vil1_mit_generic_image, vil1_png_generic_image, vil1_pnm_generic_image, vil1_ras_generic_image, vil1_tiff_generic_image, vil1_viff_generic_image, vil1_block_cache_image_impl, vil1_clamp_image_impl, vil1_crop_image_impl, vil1_flip_components_impl, vil1_flipud_impl, vil1_image_as_impl< T >, vil1_image_proxy_impl, vil1_memory_image_impl, vil1_resample_image_impl, vil1_scale_intensities_image_impl, and vil1_skip_image_impl.

virtual int vil1_image_impl::bits_per_component

(

)

const [pure virtual]

Number of bits per component.

Size (in bits) for the smallest entity of the image.

Implemented in vil1_bmp_generic_image, vil1_gen_generic_image, vil1_gif_loader_saver, vil1_gif_loader_saver_proxy, vil1_iris_generic_image, vil1_jpeg_generic_image, vil1_mit_generic_image, vil1_png_generic_image, vil1_pnm_generic_image, vil1_ras_generic_image, vil1_tiff_generic_image, vil1_viff_generic_image, vil1_block_cache_image_impl, vil1_clamp_image_impl, vil1_crop_image_impl, vil1_flip_components_impl, vil1_flipud_impl, vil1_image_as_impl< T >, vil1_image_proxy_impl, vil1_memory_image_impl, vil1_resample_image_impl, vil1_scale_intensities_image_impl, and vil1_skip_image_impl.

virtual enum vil1_component_format vil1_image_impl::component_format

(

)

const [pure virtual]

Format.

A standard RGB RGB RGB image has

• components() == 3
• bits_per_component() == 8
• component_format() == VIL1_COMPONENT_FORMAT_UNSIGNED_INT Use vil1_print(fmt) to return a string description of the format fmt.

Implemented in vil1_bmp_generic_image, vil1_gen_generic_image, vil1_gif_loader_saver, vil1_gif_loader_saver_proxy, vil1_iris_generic_image, vil1_jpeg_generic_image, vil1_mit_generic_image, vil1_png_generic_image, vil1_pnm_generic_image, vil1_ras_generic_image, vil1_tiff_generic_image, vil1_viff_generic_image, vil1_block_cache_image_impl, vil1_clamp_image_impl, vil1_crop_image_impl, vil1_flip_components_impl, vil1_flipud_impl, vil1_image_as_impl< T >, vil1_image_proxy_impl, vil1_memory_image_impl, vil1_resample_image_impl, vil1_scale_intensities_image_impl, and vil1_skip_image_impl.

vil1_image vil1_image_impl::get_plane

(

unsigned int

p

)

const [virtual]

return the ith plane.

Reimplemented in vil1_gen_generic_image, vil1_gif_loader_saver, vil1_iris_generic_image, vil1_jpeg_generic_image, vil1_mit_generic_image, vil1_png_generic_image, vil1_pnm_generic_image, vil1_ras_generic_image, vil1_tiff_generic_image, vil1_viff_generic_image, vil1_block_cache_image_impl, vil1_clamp_image_impl, vil1_flip_components_impl, vil1_flipud_impl, vil1_image_as_impl< T >, vil1_image_proxy_impl, vil1_memory_image_impl, vil1_resample_image_impl, vil1_scale_intensities_image_impl, and vil1_skip_image_impl.

Definition at line 17 of file vil1_image_impl.cxx.

bool vil1_image_impl::get_section	(	void *	buf,
		int	x0,
		int	y0,
		int	width,
		int	height
	)			const [pure virtual]

Copy buffer of this to BUF.

The buffer is stored like this for each pixel: component0(plane0,plane1,plane2,...),component1(plane0,plane1,plane2,...),...
total size of BUF in bytes should be (bits_per_component * components + 7) / 8 i.e. rounding to the next multiple of 8 bits (only correct if 1 byte = 8 bits)

Implemented in vil1_bmp_generic_image, vil1_gen_generic_image, vil1_gif_loader_saver, vil1_gif_loader_saver_proxy, vil1_iris_generic_image, vil1_jpeg_generic_image, vil1_mit_generic_image, vil1_png_generic_image, vil1_pnm_generic_image, vil1_ras_generic_image, vil1_tiff_generic_image, vil1_viff_generic_image, vil1_block_cache_image_impl, vil1_clamp_image_impl, vil1_crop_image_impl, vil1_flip_components_impl, vil1_flipud_impl, vil1_image_as_impl< T >, vil1_image_proxy_impl, vil1_memory_image_impl, vil1_resample_image_impl, vil1_scale_intensities_image_impl, and vil1_skip_image_impl.

Definition at line 33 of file vil1_image_impl.cxx.

bool vil1_image_impl::put_section	(	void const *	buf,
		int	x0,
		int	y0,
		int	width,
		int	height
	)			[pure virtual]

Copy plane PLANE of BUF to this.

The buffer should look like this for each pixel: component0(plane0,plane1,plane2,...),component1(plane0,plane1,plane2,...),...
total size of BUF in bytes should be (bits_per_component * components + 7) / 8 i.e. rounding to the next multiple of 8 bits (only correct if 1 byte = 8 bits)

Implemented in vil1_bmp_generic_image, vil1_gen_generic_image, vil1_gif_loader_saver, vil1_gif_loader_saver_proxy, vil1_iris_generic_image, vil1_jpeg_generic_image, vil1_mit_generic_image, vil1_png_generic_image, vil1_pnm_generic_image, vil1_ras_generic_image, vil1_tiff_generic_image, vil1_viff_generic_image, vil1_block_cache_image_impl, vil1_clamp_image_impl, vil1_crop_image_impl, vil1_flip_components_impl, vil1_flipud_impl, vil1_image_as_impl< T >, vil1_image_proxy_impl, vil1_memory_image_impl, vil1_resample_image_impl, vil1_scale_intensities_image_impl, and vil1_skip_image_impl.

Definition at line 38 of file vil1_image_impl.cxx.

virtual char const* vil1_image_impl::file_format

(

)

const [inline, virtual]

Return a string describing the file format.

Only file images have a format, others return 0

Reimplemented in vil1_bmp_generic_image, vil1_gen_generic_image, vil1_gif_loader_saver, vil1_gif_loader_saver_proxy, vil1_iris_generic_image, vil1_jpeg_generic_image, vil1_mit_generic_image, vil1_png_generic_image, vil1_pnm_generic_image, vil1_ras_generic_image, vil1_tiff_generic_image, vil1_viff_generic_image, and vil1_image_proxy_impl.

Definition at line 134 of file vil1_image_impl.h.

bool vil1_image_impl::get_property	(	char const *	tag,
		void *	property_value = 0
	)			const [virtual]

Extra property information.

Reimplemented in vil1_bmp_generic_image, vil1_gen_generic_image, vil1_gif_loader_saver, vil1_iris_generic_image, vil1_jpeg_generic_image, vil1_mit_generic_image, vil1_png_generic_image, vil1_pnm_generic_image, vil1_ras_generic_image, vil1_tiff_generic_image, vil1_viff_generic_image, vil1_block_cache_image_impl, vil1_image_proxy_impl, vil1_memory_image_impl, vil1_resample_image_impl, and vil1_skip_image_impl.

Definition at line 23 of file vil1_image_impl.cxx.

bool vil1_image_impl::set_property	(	char const *	tag,
		void const *	property_value = 0
	)			const [virtual]

Reimplemented in vil1_tiff_generic_image, and vil1_image_proxy_impl.

Definition at line 28 of file vil1_image_impl.cxx.

virtual vcl_string vil1_image_impl::is_a

(

)

const [inline, virtual]

Return the name of the class;.

Reimplemented in vil1_block_cache_image_impl, vil1_clamp_image_impl, vil1_crop_image_impl, vil1_flip_components_impl, vil1_flipud_impl, vil1_image_as_impl< T >, vil1_image_proxy_impl, vil1_memory_image_impl, vil1_resample_image_impl, vil1_scale_intensities_image_impl, and vil1_skip_image_impl.

Definition at line 141 of file vil1_image_impl.h.

virtual bool vil1_image_impl::is_class

(

vcl_string const &

s

)

const [inline, virtual]

Return true if the name of the class matches the argument.

Reimplemented in vil1_block_cache_image_impl, vil1_clamp_image_impl, vil1_crop_image_impl, vil1_flip_components_impl, vil1_flipud_impl, vil1_image_as_impl< T >, vil1_image_proxy_impl, vil1_memory_image_impl, vil1_resample_image_impl, vil1_scale_intensities_image_impl, and vil1_skip_image_impl.

Definition at line 144 of file vil1_image_impl.h.

void vil1_image_impl::up_ref

(

)

[inline, private]

Definition at line 150 of file vil1_image_impl.h.

void vil1_image_impl::down_ref

(

)

[inline, private]

Definition at line 151 of file vil1_image_impl.h.

---

Friends And Related Function Documentation

friend class vil1_image [friend]

Definition at line 147 of file vil1_image_impl.h.

---

Member Data Documentation

int vil1_image_impl::reference_count [private]

Definition at line 156 of file vil1_image_impl.h.

---

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

• core/vil1/vil1_image_impl.h
• core/vil1/vil1_image_impl.cxx

---