Public Types | Public Member Functions | Static Public Member Functions | List of all members
vil_pyramid_image_list_format Class Referenceabstract

#include <vil_pyramid_image_list.h>

Inheritance diagram for vil_pyramid_image_list_format:
Inheritance graph
[legend]

Public Types

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

Public Member Functions

 ~vil_pyramid_image_list_format () override=default
 
char const * tag () const override
 Return a character string which uniquely identifies this format. More...
 
vil_image_resource_sptr make_input_image (vil_stream *) override
 should return 0 so that no attempt is made to create a single image resource. More...
 
vil_pyramid_image_resource_sptr make_input_pyramid_image (char const *directory) override
 Read a pyramid resource. Image list files are stored in directory. More...
 
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) override
 Construct a pyramid image resource from a base image. More...
 
vil_image_resource_sptr make_output_image (vil_stream *, unsigned int, unsigned int, unsigned int, enum vil_pixel_format) override
 A non-pyramid output image doesn't make sense here. More...
 
vil_pyramid_image_resource_sptr make_pyramid_output_image (char const *directory) override
 
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_image_resource_sptr make_output_image (vil_stream *, unsigned, unsigned, unsigned, enum vil_pixel_format)=0
 Make a "generic_image" on which put_section may be applied. More...
 
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...
 

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

Definition at line 23 of file vil_pyramid_image_list.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.

Constructor & Destructor Documentation

◆ ~vil_pyramid_image_list_format()

vil_pyramid_image_list_format::~vil_pyramid_image_list_format ( )
overridedefault

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_pyramid_image_list_format::make_input_image ( vil_stream )
inlineoverridevirtual

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.

◆ make_input_pyramid_image()

vil_pyramid_image_resource_sptr vil_pyramid_image_list_format::make_input_pyramid_image ( char const *  directory)
overridevirtual

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

Load a pyramid image. The path should correspond to a directory.

If not, return a null resource.

Reimplemented from vil_file_format.

Definition at line 22 of file vil_pyramid_image_list.cxx.

◆ make_output_image() [1/2]

vil_image_resource_sptr vil_pyramid_image_list_format::make_output_image ( vil_stream ,
unsigned int  ,
unsigned int  ,
unsigned int  ,
enum  vil_pixel_format 
)
inlineoverride

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

Definition at line 56 of file vil_pyramid_image_list.h.

◆ make_output_image() [2/2]

virtual vil_image_resource_sptr vil_file_format::make_output_image ( vil_stream ,
unsigned  ,
unsigned  ,
unsigned  ,
enum  vil_pixel_format 
)
pure virtualinherited

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...

Implemented in vil_tiff_file_format, vil_nitf2_file_format, vil_ras_file_format, vil_jpeg_file_format, vil_pnm_file_format, vil_j2k_file_format, vil_png_file_format, and vil_sgi_file_format.

◆ make_pyramid_image_from_base() [1/2]

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 int  nlevels,
bool  copy_base,
char const *  level_file_format,
char const *  filename 
)
overridevirtual

Construct a pyramid image resource from a base image.

Construct pyramid image files in the directory.

Each level has the same scale ratio (0.5) to the preceding 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.

Each level has the same scale ratio (0.5) to the preceding level. Level 0 is the original base image.

Reimplemented from vil_file_format.

Definition at line 100 of file vil_pyramid_image_list.cxx.

◆ make_pyramid_image_from_base() [2/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_output_image()

vil_pyramid_image_resource_sptr vil_pyramid_image_list_format::make_pyramid_output_image ( char const *  directory)
overridevirtual

Reimplemented from vil_file_format.

Definition at line 34 of file vil_pyramid_image_list.cxx.

◆ tag()

char const* vil_pyramid_image_list_format::tag ( ) const
inlineoverridevirtual

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.


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