vil1_file_image Class Reference

#include <vil1_file_image.h>

Inheritance diagram for vil1_file_image:

List of all members.

---

Detailed Description

Load an image from disk.

Definition at line 17 of file vil1_file_image.h.

Public Types
enum	verbosity { silent, laconic, verbose }
Public Member Functions
	vil1_file_image ()
	vil1_file_image (char const *filename, verbosity v=verbose)
	Attempt to load named file.
	vil1_file_image (vcl_string const &f, verbosity v=verbose)
	Attempt to load named file.
bool	load (char const *filename, verbosity=verbose)
	Attempt to load named file.
bool	load (vcl_string const &, verbosity=verbose)
	Attempt to load named file.
int	planes () const
	Dimensions: Planes x W x H x Components.
int	width () const
	Dimensions: Planes x W x H x Components.
int	height () 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
vil1_image_impl *	ptr

---

Member Enumeration Documentation

enum vil1_file_image::verbosity

Enumerator:

silent
laconic
verbose

Definition at line 20 of file vil1_file_image.h.

---

Constructor & Destructor Documentation

vil1_file_image::vil1_file_image

(

)

[inline]

Definition at line 27 of file vil1_file_image.h.

vil1_file_image::vil1_file_image	(	char const *	filename,
		verbosity	v = verbose
	)			[inline]

Attempt to load named file.

Definition at line 30 of file vil1_file_image.h.

vil1_file_image::vil1_file_image	(	vcl_string const &	f,
		verbosity	v = verbose
	)			[inline]

Attempt to load named file.

Definition at line 32 of file vil1_file_image.h.

---

Member Function Documentation

bool vil1_file_image::load	(	char const *	filename,
		verbosity	= verbose
	)

Attempt to load named file.

Definition at line 16 of file vil1_file_image.cxx.

bool vil1_file_image::load	(	vcl_string const &	,
		verbosity	= verbose
	)

Attempt to load named file.

Definition at line 11 of file vil1_file_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::width

(

)

const [inline, inherited]

Dimensions: Planes x W x H x Components.

Reimplemented in vil1_memory_image.

Definition at line 39 of file vil1_image.h.

int vil1_image::height

(

)

const [inline, inherited]

Dimensions: Planes x W x H x Components.

Reimplemented in vil1_memory_image.

Definition at line 42 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

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_file_image.h
• core/vil1/vil1_file_image.cxx

---