vil1_viff_generic_image Class Reference

#include <vil1_viff.h>

Inheritance diagram for vil1_viff_generic_image:

Detailed Description

Generic image implementation for VIFF (Khoros) files.

Definition at line 44 of file vil1_viff.h.


Public Member Functions
	vil1_viff_generic_image (vil1_stream *is)
	vil1_viff_generic_image (vil1_stream *is, int planes, int width, int height, int components, int bits_per_component, vil1_component_format format)
	~vil1_viff_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)
	Write BUF into image plane PLANE of this.
virtual vil1_image	get_plane (unsigned int p) const
	Emulate a single plane image.
virtual bool	get_section_rgb_byte (void *buf, int x0, int y0, int width, int height) const
	Return the image interpreted as rgb bytes.
virtual bool	get_section_float (void *buf, int x0, int y0, int width, int height) const
virtual bool	get_section_byte (void *buf, int x0, int y0, int width, int height) const
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.
vxl_uint_32	ispare1 () const
	User defined spare values in header.
vxl_uint_32	ispare2 () const
float	fspare1 () const
float	fspare2 () const
void	set_ispare1 (vxl_uint_32 ispare1)
void	set_ispare2 (vxl_uint_32 ispare2)
void	set_fspare1 (float fspare1)
void	set_fspare2 (float fspare2)
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 ()
bool	check_endian ()
Private Attributes
vil1_stream *	is_
int	width_
int	height_
int	maxval_
int	planes_
int	start_of_data_
int	bits_per_component_
enum vil1_component_format	format_
bool	endian_consistent_
vil1_viff_xvimage	header_
Friends
class	vil1_viff_file_format

Constructor & Destructor Documentation

vil1_viff_generic_image::vil1_viff_generic_image ( vil1_stream * is )

Definition at line 99 of file vil1_viff.cxx.

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

Definition at line 128 of file vil1_viff.cxx.

vil1_viff_generic_image::~vil1_viff_generic_image ( )

Definition at line 143 of file vil1_viff.cxx.

Member Function Documentation

bool vil1_viff_generic_image::read_header ( ) [private]

Definition at line 148 of file vil1_viff.cxx.

bool vil1_viff_generic_image::write_header ( ) [private]

Definition at line 238 of file vil1_viff.cxx.

bool vil1_viff_generic_image::check_endian ( ) [private]

Definition at line 371 of file vil1_viff.cxx.

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

Dimensions. Planes x W x H x Components.

Implements vil1_image_impl.

Definition at line 77 of file vil1_viff.h.

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

Dimensions: Planes x W x H x Components.

Implements vil1_image_impl.

Definition at line 78 of file vil1_viff.h.

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

Dimensions: Planes x W x H x Components.

Implements vil1_image_impl.

Definition at line 79 of file vil1_viff.h.

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

Dimensions: Planes x W x H x Components.

Implements vil1_image_impl.

Definition at line 80 of file vil1_viff.h.

virtual int vil1_viff_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 82 of file vil1_viff.h.

virtual enum vil1_component_format vil1_viff_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 83 of file vil1_viff.h.