vil1_bmp_generic_image Class Reference

#include <vil1_bmp.h>

Inheritance diagram for vil1_bmp_generic_image:

Detailed Description

Generic image implementation for BMP files.

Definition at line 53 of file vil1_bmp.h.


Public Member Functions
	vil1_bmp_generic_image (vil1_stream *is)
	vil1_bmp_generic_image (vil1_stream *is, int planes, int width, int height, int components, int bits_per_component, vil1_component_format format)
	~vil1_bmp_generic_image ()
virtual int	planes () const
	Dimensions. Planes x W x H x Components.
virtual int	width () const
	Dimensions: Planes x W x H x Components.
virtual int	height () const
	Dimensions: Planes x W x H x Components.
virtual int	components () const
	Dimensions: Planes x W x H x Components.
virtual int	bits_per_component () const
	Number of bits per component.
virtual enum vil1_component_format	component_format () const
	Format.
virtual bool	get_section (void *buf, int x0, int y0, int width, int height) const
	Copy plane PLANE of this to BUF,.
virtual bool	put_section (void const *buf, int x0, int y0, int width, int height)
	Copy plane PLANE of BUF to this.
char const *	file_format () const
	Return a string describing the file format.
bool	get_property (char const tag, void prop=0) const
	Extra property information.
virtual vil1_image	get_plane (unsigned int p) const
	return the ith plane.
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
bool	read_header ()
bool	write_header ()
Private Attributes
vil1_stream *	is_
vil1_bmp_file_header	file_hdr
vil1_bmp_core_header	core_hdr
vil1_bmp_info_header	info_hdr
long	bit_map_start
Friends
class	vil1_bmp_file_format

Constructor & Destructor Documentation

vil1_bmp_generic_image::vil1_bmp_generic_image ( vil1_stream * is )

Definition at line 56 of file vil1_bmp.cxx.

vil1_bmp_generic_image::vil1_bmp_generic_image	(	vil1_stream *	is,
		int	planes,
		int	width,
		int	height,
		int	components,
		int	bits_per_component,
		vil1_component_format	format
	)

Definition at line 80 of file vil1_bmp.cxx.

vil1_bmp_generic_image::~vil1_bmp_generic_image ( )

Definition at line 104 of file vil1_bmp.cxx.

Member Function Documentation

virtual int vil1_bmp_generic_image::planes ( ) const [inline, virtual]

Dimensions. Planes x W x H x Components.

Implements vil1_image_impl.

Definition at line 69 of file vil1_bmp.h.

virtual int vil1_bmp_generic_image::width ( ) const [inline, virtual]

Dimensions: Planes x W x H x Components.

Implements vil1_image_impl.

Definition at line 70 of file vil1_bmp.h.

virtual int vil1_bmp_generic_image::height ( ) const [inline, virtual]

Dimensions: Planes x W x H x Components.

Implements vil1_image_impl.

Definition at line 71 of file vil1_bmp.h.

virtual int vil1_bmp_generic_image::components ( ) const [inline, virtual]

Dimensions: Planes x W x H x Components.

Implements vil1_image_impl.

Definition at line 72 of file vil1_bmp.h.

virtual int vil1_bmp_generic_image::bits_per_component ( ) const [inline, virtual]

Number of bits per component.

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

Implements vil1_image_impl.

Definition at line 73 of file vil1_bmp.h.

virtual enum vil1_component_format vil1_bmp_generic_image::component_format ( ) const [inline, 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.

Implements vil1_image_impl.

Definition at line 74 of file vil1_bmp.h.

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

Copy plane PLANE of this to BUF,.

Implements vil1_image_impl.

Definition at line 300 of file vil1_bmp.cxx.

bool vil1_bmp_generic_image::put_section	(	void const *	buf,
		int	x0,
		int	y0,
		int	width,
		int	height
	)			`[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)

Implements vil1_image_impl.

Definition at line 329 of file vil1_bmp.cxx.

char const * vil1_bmp_generic_image::file_format ( ) const [virtual]

Return a string describing the file format.

Only file images have a format, others return 0

Reimplemented from vil1_image_impl.

Definition at line 51 of file vil1_bmp.cxx.