vil1_file_format Class Reference

#include <vil1_file_format.h>

Inheritance diagram for vil1_file_format:

vil1_bmp_file_format vil1_gen_file_format vil1_gif_file_format vil1_iris_file_format vil1_jpeg_file_format vil1_mit_file_format vil1_png_file_format vil1_pnm_file_format vil1_ras_file_format vil1_tiff_file_format vil1_viff_file_format List of all members.

Detailed Description

Base class for image formats.

There is one derived class for each handled file format in the directory file_formats. E.g. vil1/file_formats/vil1_pnm.h etc

Definition at line 18 of file vil1_file_format.h.


Public Member Functions

virtual ~vil1_file_format ()
virtual char const * tag () const=0
 Return a character string which uniquely identifies this format.
virtual vil1_image_implmake_input_image (vil1_stream *vs)=0
 Attempt to make a generic_image which will read from vil1_stream vs.
virtual vil1_image_implmake_output_image (vil1_stream *vs, int planes, int width, int height, int components, int bits_per_component, enum vil1_component_format)=0
 Make a "generic_image" on which put_section may be applied.

Static Public Member Functions

static vil1_file_format ** all ()

Constructor & Destructor Documentation

vil1_file_format::~vil1_file_format (  )  [virtual]

Definition at line 8 of file vil1_file_format.cxx.


Member Function Documentation

virtual char const* vil1_file_format::tag (  )  const [pure virtual]

Return a character string which uniquely identifies this format.

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

Implemented in vil1_bmp_file_format, vil1_gen_file_format, vil1_gif_file_format, vil1_iris_file_format, vil1_jpeg_file_format, vil1_mit_file_format, vil1_png_file_format, vil1_pnm_file_format, vil1_ras_file_format, vil1_tiff_file_format, and vil1_viff_file_format.

virtual vil1_image_impl* vil1_file_format::make_input_image ( vil1_stream vs  )  [pure virtual]

Attempt to make a generic_image which will read from vil1_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 vil1_image_impl on which get_section may be applied.

Implemented in vil1_bmp_file_format, vil1_gen_file_format, vil1_gif_file_format, vil1_iris_file_format, vil1_jpeg_file_format, vil1_mit_file_format, vil1_png_file_format, vil1_pnm_file_format, vil1_ras_file_format, vil1_tiff_file_format, and vil1_viff_file_format.

virtual vil1_image_impl* vil1_file_format::make_output_image ( vil1_stream vs,
int  planes,
int  width,
int  height,
int  components,
int  bits_per_component,
enum  vil1_component_format 
) [pure virtual]

Make a "generic_image" on which put_section may be applied.

The stream vs is assumed to be open for writing, as an image header may be written to it immediately. The width/height etc are explicitly specified, so that file_format implementors know what they need to do...

vil1_file_format ** vil1_file_format::all (  )  [static]

Definition at line 71 of file vil1_file_format.cxx.


The documentation for this class was generated from the following files:
Generated on Sun Nov 22 05:09:20 2009 for core/vil1 by  doxygen 1.5.1