vil1_memory_image Class Reference

#include <vil1_memory_image.h>

Inheritance diagram for vil1_memory_image:

List of all members.

---

Detailed Description

vil1_image, stored entirely in memory.

Definition at line 32 of file vil1_memory_image.h.

Public Member Functions
	vil1_memory_image ()
	vil1_memory_image (int planes, int w, int h, vil1_memory_image_format const &)
	vil1_memory_image (int planes, int w, int h, int components, int bits_per_component, vil1_component_format)
	vil1_memory_image (int planes, int w, int h, vil1_pixel_format_t)
	vil1_memory_image (int w, int h, int components, int bits_per_component, vil1_component_format)
	vil1_memory_image (int w, int h, vil1_pixel_format_t)
	vil1_memory_image (vil1_image const &)
	If that is a memory image, just point to it, otherwise get_section.
	vil1_memory_image (vil1_memory_image const &)
vil1_memory_image &	operator= (vil1_memory_image const &)
void	resize (int width, int height)
void	resize (int planes, int width, int height)
void *	get_buffer ()
	vil1_memory_image (void *buf, int planes, int w, int h, vil1_memory_image_format const &)
	vil1_memory_image (void *buf, int planes, int w, int h, int components, int bits_per_component, vil1_component_format)
	vil1_memory_image (void *buf, int planes, int w, int h, vil1_pixel_format_t)
	vil1_memory_image (void *buf, int w, int h, int components, int bits_per_component, vil1_component_format)
	vil1_memory_image (void *buf, int w, int h, vil1_pixel_format_t)
int	width () const
	Dimensions: Planes x W x H x Components.
int	height () const
	Dimensions: Planes x W x H x Components.
void	assert_size (int width, int height) const
void	recache_from_impl ()
	Reset this class's member variables from the image implementation.
int	planes () const
	Dimensions: Planes x W x H x Components.
int	components () const
	Dimensions: Planes x W x H x Components.
int	bits_per_component () const
	Format.
enum vil1_component_format	component_format () const
	Format.
vil1_image	get_plane (unsigned int p) const
	return the ith plane.
bool	get_section (void *buf, int x0, int y0, int wd, int ht) const
	Copy from image to buf.
bool	put_section (void const *buf, int x0, int y0, int wd, int ht)
	Copy from buf to image.
bool	get_property (char const *tag, void *property_value=0) const
	Getting property information.
bool	set_property (char const *tag, void const *property_value=0)
	Setting property information.
char const *	file_format () const
	Return a string describing the file format.
int	rows () const
	Number of rows.
int	cols () const
	Number of columns.
int	get_size_bytes () const
	return size in bytes.
vcl_ostream &	print (vcl_ostream &) const
	Print a 1-line summary of contents.
bool	operator== (vil1_image const &that) const
	equality means equality of implementation, not pixels.
bool	operator< (vil1_image const &that) const
	needed for sorted containers of images.
	operator safe_bool () const
	conversion to bool.
bool	operator! () const
	inverse conversion to bool.
vil1_image_impl *	impl () const
	use "sptr.impl()" to get a pointer to the impl object.
Protected Attributes
int	width_
int	height_
void **	rows0_
vil1_image_impl *	ptr

---

Constructor & Destructor Documentation

vil1_memory_image::vil1_memory_image

(

)

Definition at line 32 of file vil1_memory_image.cxx.

vil1_memory_image::vil1_memory_image	(	int	planes,
		int	w,
		int	h,
		vil1_memory_image_format const &
	)

Definition at line 37 of file vil1_memory_image.cxx.

vil1_memory_image::vil1_memory_image	(	int	planes,
		int	w,
		int	h,
		int	components,
		int	bits_per_component,
		vil1_component_format
	)

Definition at line 44 of file vil1_memory_image.cxx.

vil1_memory_image::vil1_memory_image	(	int	planes,
		int	w,
		int	h,
		vil1_pixel_format_t
	)

Definition at line 52 of file vil1_memory_image.cxx.

vil1_memory_image::vil1_memory_image	(	int	w,
		int	h,
		int	components,
		int	bits_per_component,
		vil1_component_format
	)

Definition at line 58 of file vil1_memory_image.cxx.

vil1_memory_image::vil1_memory_image	(	int	w,
		int	h,
		vil1_pixel_format_t
	)

Definition at line 66 of file vil1_memory_image.cxx.

vil1_memory_image::vil1_memory_image

(

vil1_image const &

)

If that is a memory image, just point to it, otherwise get_section.

Definition at line 102 of file vil1_memory_image.cxx.

vil1_memory_image::vil1_memory_image

(

vil1_memory_image const &

)

Definition at line 108 of file vil1_memory_image.cxx.

vil1_memory_image::vil1_memory_image	(	void *	buf,
		int	planes,
		int	w,
		int	h,
		vil1_memory_image_format const &
	)

Definition at line 149 of file vil1_memory_image.cxx.

vil1_memory_image::vil1_memory_image	(	void *	buf,
		int	planes,
		int	w,
		int	h,
		int	components,
		int	bits_per_component,
		vil1_component_format
	)

Definition at line 156 of file vil1_memory_image.cxx.

vil1_memory_image::vil1_memory_image	(	void *	buf,
		int	planes,
		int	w,
		int	h,
		vil1_pixel_format_t
	)

Definition at line 164 of file vil1_memory_image.cxx.

vil1_memory_image::vil1_memory_image	(	void *	buf,
		int	w,
		int	h,
		int	components,
		int	bits_per_component,
		vil1_component_format
	)

Definition at line 171 of file vil1_memory_image.cxx.

vil1_memory_image::vil1_memory_image	(	void *	buf,
		int	w,
		int	h,
		vil1_pixel_format_t
	)

Definition at line 179 of file vil1_memory_image.cxx.

---

Member Function Documentation

vil1_memory_image & vil1_memory_image::operator=

(

vil1_memory_image const &

)

Definition at line 114 of file vil1_memory_image.cxx.

void vil1_memory_image::resize	(	int	width,
		int	height
	)

Reimplemented in vil1_memory_image_of< T >, and vil1_memory_image_of< vxl_byte >.

Definition at line 121 of file vil1_memory_image.cxx.

void vil1_memory_image::resize	(	int	planes,
		int	width,
		int	height
	)

Reimplemented in vil1_memory_image_of< T >, and vil1_memory_image_of< vxl_byte >.

Definition at line 129 of file vil1_memory_image.cxx.

void* vil1_memory_image::get_buffer

(

)

[inline]

Reimplemented in vil1_memory_image_of< T >, and vil1_memory_image_of< vxl_byte >.

Definition at line 49 of file vil1_memory_image.h.

int vil1_memory_image::width

(

)

const [inline]

Dimensions: Planes x W x H x Components.

Reimplemented from vil1_image.

Definition at line 59 of file vil1_memory_image.h.

int vil1_memory_image::height

(

)

const [inline]

Dimensions: Planes x W x H x Components.

Reimplemented from vil1_image.

Definition at line 60 of file vil1_memory_image.h.

void vil1_memory_image::assert_size	(	int	width,
		int	height
	)			const

Definition at line 137 of file vil1_memory_image.cxx.

void vil1_memory_image::recache_from_impl

(

)

Reset this class's member variables from the image implementation.

This is is useful if the impl object has been modified outside the control of this object.

Definition at line 189 of file vil1_memory_image.cxx.

int vil1_image::planes

(

)

const [inline, inherited]

Dimensions: Planes x W x H x Components.

Definition at line 36 of file vil1_image.h.

int vil1_image::components

(

)

const [inline, inherited]

Dimensions: Planes x W x H x Components.

Definition at line 45 of file vil1_image.h.

int vil1_image::bits_per_component

(

)

const [inline, inherited]

Format.

Definition at line 48 of file vil1_image.h.

enum vil1_component_format vil1_image::component_format

(

)

const [inline, inherited]

Format.

Definition at line 51 of file vil1_image.h.

vil1_image vil1_image::get_plane

(

unsigned int

p

)

const [inline, inherited]

return the ith plane.

Definition at line 55 of file vil1_image.h.

bool vil1_image::get_section	(	void *	buf,
		int	x0,
		int	y0,
		int	wd,
		int	ht
	)			const [inline, inherited]

Copy from image to buf.

Definition at line 58 of file vil1_image.h.

bool vil1_image::put_section	(	void const *	buf,
		int	x0,
		int	y0,
		int	wd,
		int	ht
	)			[inline, inherited]

Copy from buf to image.

Definition at line 62 of file vil1_image.h.

bool vil1_image::get_property	(	char const *	tag,
		void *	property_value = 0
	)			const [inline, inherited]

Getting property information.

Definition at line 66 of file vil1_image.h.

bool vil1_image::set_property	(	char const *	tag,
		void const *	property_value = 0
	)			[inline, inherited]

Setting property information.

Definition at line 70 of file vil1_image.h.

char const* vil1_image::file_format

(

)

const [inline, inherited]

Return a string describing the file format.

Only file images have a format, others return 0

Definition at line 75 of file vil1_image.h.

int vil1_image::rows

(

)

const [inline, inherited]

Number of rows.

Definition at line 81 of file vil1_image.h.

int vil1_image::cols

(

)

const [inline, inherited]

Number of columns.

Definition at line 83 of file vil1_image.h.

int vil1_image::get_size_bytes

(

)

const [inherited]

return size in bytes.

Definition at line 37 of file vil1_image.cxx.

vcl_ostream & vil1_image::print

(

vcl_ostream &

)

const [inherited]

Print a 1-line summary of contents.

Definition at line 13 of file vil1_image.cxx.

bool vil1_image::operator==

(

vil1_image const &

that

)

const [inline, inherited]

equality means equality of implementation, not pixels.

Definition at line 132 of file vil1_image.h.

bool vil1_image::operator<

(

vil1_image const &

that

)

const [inline, inherited]

needed for sorted containers of images.

Definition at line 137 of file vil1_image.h.

vil1_image::operator safe_bool

(

)

const [inline, inherited]

conversion to bool.

Definition at line 142 of file vil1_image.h.

bool vil1_image::operator!

(

)

const [inline, inherited]

inverse conversion to bool.

Definition at line 146 of file vil1_image.h.

vil1_image_impl* vil1_image::impl

(

)

const [inline, inherited]

use "sptr.impl()" to get a pointer to the impl object.

Definition at line 150 of file vil1_image.h.

---

Member Data Documentation

int vil1_memory_image::width_ [protected]

Definition at line 69 of file vil1_memory_image.h.

int vil1_memory_image::height_ [protected]

Definition at line 70 of file vil1_memory_image.h.

void** vil1_memory_image::rows0_ [protected]

Definition at line 71 of file vil1_memory_image.h.

vil1_image_impl* vil1_image::ptr [protected, inherited]

Definition at line 155 of file vil1_image.h.

---

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

• core/vil1/vil1_memory_image.h
• core/vil1/vil1_memory_image.cxx

---