vil_pyramid_image_list_format Class Reference

#include <vil_pyramid_image_list.h>

Inheritance diagram for vil_pyramid_image_list_format:

vil_file_format List of all members.

Detailed Description

Definition at line 23 of file vil_pyramid_image_list.h.


Public Member Functions

 ~vil_pyramid_image_list_format ()
virtual char const * tag () const
 Return a character string which uniquely identifies this format.
virtual vil_image_resource_sptr make_input_image (vil_stream *vs)
 should return 0 so that no attempt is made to create a single image resource.
virtual vil_pyramid_image_resource_sptr make_input_pyramid_image (char const *directory)
 Read a pyramid resource. Image list files are stored in directory.
virtual vil_pyramid_image_resource_sptr make_pyramid_image_from_base (char const *directory, vil_image_resource_sptr const &base_image, unsigned nlevels, bool copy_base, char const *level_file_format, char const *filename)
 Construct a pyramid image resource from a base image.
virtual vil_image_resource_sptr make_output_image (vil_stream *vs, unsigned ni, unsigned nj, unsigned nplanes, enum vil_pixel_format)
 A non-pyramid output image doesn't make sense here.
virtual vil_pyramid_image_resource_sptr make_pyramid_output_image (char const *directory)
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.
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.

Static Public Member Functions

static vil_file_format ** all ()
static void add_file_format (vil_file_format *ff)
 The function will take ownership of ff;.

Constructor & Destructor Documentation

vil_pyramid_image_list_format::~vil_pyramid_image_list_format (  )  [inline]

Definition at line 26 of file vil_pyramid_image_list.h.


Member Function Documentation

virtual char const* vil_pyramid_image_list_format::tag (  )  const [inline, virtual]

Return a character string which uniquely identifies this format.

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

Implements vil_file_format.

Definition at line 30 of file vil_pyramid_image_list.h.

virtual vil_image_resource_sptr vil_pyramid_image_list_format::make_input_image ( vil_stream vs  )  [inline, virtual]

should return 0 so that no attempt is made to create a single image resource.

Implements vil_file_format.

Definition at line 33 of file vil_pyramid_image_list.h.

vil_pyramid_image_resource_sptr vil_pyramid_image_list_format::make_input_pyramid_image ( char const *  directory  )  [virtual]

Read a pyramid resource. Image list files are stored in directory.

If not, return a null resource.

Reimplemented from vil_file_format.

Definition at line 19 of file vil_pyramid_image_list.cxx.

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

Construct a pyramid image resource from a base image.

Each level has the same scale ratio (0.5) to the preceeding level. Level 0 is the original base image. If copy base is false then Level 0 is already present in the directory and is used without modification. Each pyramid file in the directory is named filename + "level_index", e.g. R0, R1, ... Rn.

Definition at line 98 of file vil_pyramid_image_list.cxx.

virtual vil_image_resource_sptr vil_pyramid_image_list_format::make_output_image ( vil_stream vs,
unsigned  ni,
unsigned  nj,
unsigned  nplanes,
enum vil_pixel_format   
) [inline, virtual]

A non-pyramid output image doesn't make sense here.

Implements vil_file_format.

Definition at line 56 of file vil_pyramid_image_list.h.

vil_pyramid_image_resource_sptr vil_pyramid_image_list_format::make_pyramid_output_image ( char const *  directory  )  [virtual]

Reimplemented from vil_file_format.

Definition at line 32 of file vil_pyramid_image_list.cxx.

virtual vil_pyramid_image_resource_sptr vil_file_format::make_pyramid_image_from_base ( char const *  ,
vil_image_resource_sptr const &  ,
unsigned  ,
char const *   
) [inline, virtual, inherited]

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 preceeding 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 49 of file vil_file_format.h.

virtual vil_blocked_image_resource_sptr vil_file_format::make_blocked_output_image ( vil_stream ,
unsigned  ,
unsigned  ,
unsigned  ,
unsigned  ,
unsigned  ,
enum vil_pixel_format   
) [inline, virtual, inherited]

Construct a blocked output image resource.

Returns a null resource unless the format supports blocking

Reimplemented in vil_tiff_file_format.

Definition at line 68 of file vil_file_format.h.

vil_file_format ** vil_file_format::all (  )  [static, inherited]

Definition at line 165 of file vil_file_format.cxx.

void vil_file_format::add_file_format ( vil_file_format ff  )  [static, inherited]

The function will take ownership of ff;.

Definition at line 148 of file vil_file_format.cxx.


The documentation for this class was generated from the following files:
Generated on Sat Nov 7 05:08:41 2009 for core/vil by  doxygen 1.5.1