vil_bmp_file_format Class Reference

Loader for BMP files. More...

#include <vil_bmp.h>

Inheritance diagram for vil_bmp_file_format:

Public Types
typedef std::list< vil_file_format * >::iterator	iterator

Public Member Functions
char const *	tag () const override
	Return a character string which uniquely identifies this format. More...
vil_image_resource_sptr	make_input_image (vil_stream *vs) override
	Attempt to make a generic_image which will read from vil_stream vs. More...
vil_image_resource_sptr	make_output_image (vil_stream *vs, unsigned nx, unsigned ny, unsigned nplanes, vil_pixel_format format) override
virtual vil_pyramid_image_resource_sptr	make_input_pyramid_image (char const *)
	Read a pyramid resource from a list of image files in a directory. More...
virtual vil_pyramid_image_resource_sptr	make_pyramid_image_from_base (char const *, vil_image_resource_sptr const &, unsigned, char const *)
	Construct a pyramid image resource from a base image. More...
virtual vil_pyramid_image_resource_sptr	make_pyramid_image_from_base (char const *directory, vil_image_resource_sptr const &base_image, unsigned int nlevels, bool copy_base, char const *level_file_format, char const *filename)
virtual vil_blocked_image_resource_sptr	make_blocked_output_image (vil_stream *, unsigned, unsigned, unsigned, unsigned, unsigned, enum vil_pixel_format)
	Construct a blocked output image resource. More...
virtual vil_pyramid_image_resource_sptr	make_pyramid_output_image (char const *)

Static Public Member Functions
static std::list< vil_file_format * > &	all ()
static void	add_file_format (vil_file_format *ff)
	The function will take ownership of ff;. More...

Detailed Description

Loader for BMP files.

Definition at line 41 of file vil_bmp.h.

Member Typedef Documentation

iterator

typedef std::list<vil_file_format*>::iterator vil_file_format::iterator

inherited

Definition at line 89 of file vil_file_format.h.

Member Function Documentation

add_file_format()

void vil_file_format::add_file_format ( vil_file_format *  ff )

staticinherited

The function will take ownership of ff;.

Definition at line 163 of file vil_file_format.cxx.

all()

std::list< vil_file_format * > & vil_file_format::all ( )

staticinherited

Definition at line 173 of file vil_file_format.cxx.

make_blocked_output_image()

virtual vil_blocked_image_resource_sptr vil_file_format::make_blocked_output_image ( vil_stream *  , unsigned  , unsigned  , unsigned  , unsigned  , unsigned  , enum vil_pixel_format    )

inlinevirtualinherited

Construct a blocked output image resource.

Returns a null resource unless the format supports blocking

Reimplemented in vil_tiff_file_format.

Definition at line 75 of file vil_file_format.h.

make_input_image()

vil_image_resource_sptr vil_bmp_file_format::make_input_image ( vil_stream *  vs )

overridevirtual

Attempt to make a generic_image which will read from vil_stream vs.

Reads enough of vs to determine if it's this format, and if not, returns 0. If it is, returns a subclass of vil_image_resource on which get_section may be applied.

Implements vil_file_format.

Definition at line 22 of file vil_bmp.cxx.

make_input_pyramid_image()

virtual vil_pyramid_image_resource_sptr vil_file_format::make_input_pyramid_image ( char const *  )

inlinevirtualinherited

Read a pyramid resource from a list of image files in a directory.

... or from an image file_format that supports multiple images per file.

Reimplemented in vil_tiff_file_format, and vil_pyramid_image_list_format.

Definition at line 36 of file vil_file_format.h.

make_output_image()

vil_image_resource_sptr vil_bmp_file_format::make_output_image ( vil_stream *  vs, unsigned  nx, unsigned  ny, unsigned  nplanes, vil_pixel_format  format  )

override

Definition at line 35 of file vil_bmp.cxx.

make_pyramid_image_from_base() [1/2]

virtual vil_pyramid_image_resource_sptr vil_file_format::make_pyramid_image_from_base ( char const *  , vil_image_resource_sptr const &  , unsigned  , char const *    )

inlinevirtualinherited

Construct a pyramid image resource from a base image.

All levels are stored in the same resource file. Each level has the same scale ratio (0.5) to the preceding level. Level 0 is the original base image. The resource is returned open for reading. The temporary directory is for storing intermediate image resources during the construction of the pyramid. Files are be removed from the directory after completion. If temp_dir is 0 then the intermediate resources are created in memory.

Reimplemented in vil_tiff_file_format.

Definition at line 48 of file vil_file_format.h.

make_pyramid_image_from_base() [2/2]

virtual vil_pyramid_image_resource_sptr vil_file_format::make_pyramid_image_from_base ( char const *  directory, vil_image_resource_sptr const &  base_image, unsigned int  nlevels, bool  copy_base, char const *  level_file_format, char const *  filename  )

inlinevirtualinherited

Reimplemented in vil_pyramid_image_list_format.

Definition at line 55 of file vil_file_format.h.

make_pyramid_output_image()

virtual vil_pyramid_image_resource_sptr vil_file_format::make_pyramid_output_image ( char const *  )

inlinevirtualinherited

Reimplemented in vil_tiff_file_format, and vil_pyramid_image_list_format.

Definition at line 85 of file vil_file_format.h.

tag()

char const * vil_bmp_file_format::tag ( ) const

overridevirtual

Return a character string which uniquely identifies this format.

E.g. "pnm", "jpeg", etc.

Implements vil_file_format.

Definition at line 46 of file vil_bmp.cxx.

---

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

• core/vil/file_formats/vil_bmp.h
• core/vil/file_formats/vil_bmp.cxx