vil_image_resource_plugin Class Reference

#include <vil_image_resource_plugin.h>

Inheritance diagram for vil_image_resource_plugin:

Detailed Description

A base class for a plugin for vil images loading.

This class provides an interface for loading images in new formats

Definition at line 24 of file vil_image_resource_plugin.h.


Public Member Functions
	vil_image_resource_plugin ()
	Default constructor.
virtual	~vil_image_resource_plugin ()
	Destructor.
virtual vcl_string	is_a () const
	Name of the class.
virtual vil_pixel_format	pixel_format () const
	Pixel Format.
virtual unsigned	ni () const
	Dimensions: Planes x ni x nj.
virtual unsigned	nj () const
	Dimensions: Planes x ni x nj.
virtual unsigned	nplanes () const
	Dimensions: Planes x ni x nj.
virtual bool	get_property (char const , void =0) const
	Extra property information.
virtual vil_image_view_base_sptr	get_copy_view (unsigned, unsigned, unsigned, unsigned) const
	Create a read/write view of a copy of this data.
virtual bool	put_view (vil_image_view_base const &, unsigned, unsigned)
	Put the data in this view back into the image source.
virtual bool	load_the_image (vil_image_view_base_sptr &image, const vcl_string &path)
	Attempt to load image from named file.
virtual bool	load_the_image (vil_image_view_base_sptr &image, const vcl_string &path, const vcl_string &filetype, const vcl_string &colour)
	Attempt to load image from named file.
virtual void	set_size (int width, int height)
	Set the desired image size.
virtual bool	can_be_loaded (const vcl_string &filename)
	Check whether a filename is a potential candidate for loading and if it is available.
void	set_colour (const vcl_string &colour)
	Set the colour options.
void	set_filetype (const vcl_string &filetype)
	Set the filetype options.
virtual vil_image_view_base_sptr	get_view (unsigned i0, unsigned n_i, unsigned j0, unsigned n_j) const
	Create a read/write view of the data.
vil_image_view_base_sptr	get_view () const
	Create a read/write view of all the data.
vil_image_view_base_sptr	get_copy_view () const
	Create a read/write view of a copy of all the data.
bool	put_view (const vil_image_view_base &im)
	Put the data in this view back into the image source at the origin.
virtual bool	view_fits (const vil_image_view_base &im, unsigned i0, unsigned j0)
	Check that a view will fit into the data at the given offset.
virtual char const *	file_format () const
	Return a string describing the file format.
Static Public Member Functions
static void	register_plugin (vil_image_resource_plugin *plugin)
	Register a vil_image_resource_plugin to the list of plugins.
static void	delete_all_plugins ()
	Delete all registered plugins.
Protected Member Functions
void	ref ()
void	unref ()
Protected Attributes
vcl_string	filetype_
	file type.
vcl_string	colour_
	colour.
vil_pixel_format	pixel_format_
unsigned int	ni_
unsigned int	nj_
unsigned int	nplanes_
int	width_
int	height_
vcl_atomic_count	reference_count_
Friends
class	vil_smart_ptr< vil_image_resource >
Related Functions
(Note that these are not member functions.)
template<class destT, class kernelT, class accumT>
vil_image_resource_sptr	vil_convolve_1d (const vil_image_resource_sptr &src_im, const destT, const kernelT *kernel, int k_lo, int k_hi, const accumT, vil_convolve_boundary_option start_option, vil_convolve_boundary_option end_option)
	Create an image_resource object which convolve kernel[x] x in [k_lo,k_hi] with srcT.
template<class destT, class kernelT, class accumT>
vil_image_resource_sptr	vil_correlate_1d (const vil_image_resource_sptr &src_im, const destT, const kernelT *kernel, vcl_ptrdiff_t k_lo, vcl_ptrdiff_t k_hi, const accumT, vil_convolve_boundary_option start_option, vil_convolve_boundary_option end_option)
	Create an image_resource object which correlate kernel[x] x in [k_lo,k_hi] with srcT.
bool	vil_copy_deep (const vil_image_resource_sptr &src, vil_image_resource_sptr &dest)
	Copy src to dest.
vil_image_resource_sptr	vil_crop (const vil_image_resource_sptr &src, unsigned i0, unsigned n_i, unsigned j0, unsigned n_j)
	Crop to a region of src.
vil_image_resource_sptr	vil_decimate (const vil_image_resource_sptr &src, unsigned i_factor, unsigned j_factor=0)
	decimate to a region of src.
vil_image_resource_sptr	vil_load_image_resource (char const *filename)
	Load an image resource object from a file.
vil_image_resource_sptr	vil_new_image_resource (unsigned ni, unsigned nj, vil_image_resource_sptr const &prototype)
	Make a new image, similar format to the prototype.
vil_image_resource_sptr	vil_new_image_resource (vil_stream os, unsigned ni, unsigned nj, unsigned nplanes, vil_pixel_format format, char const file_format)
	Make a new image.
vil_image_resource_sptr	vil_new_image_resource (char const filename, unsigned ni, unsigned nj, vil_image_resource_sptr const &prototype, char const file_format)
	Make a new vil_image_resource, writing to file "filename", size ni x nj, copying pixel format etc from "prototype".
vil_image_resource_sptr	vil_new_image_resource (char const filename, unsigned ni, unsigned nj, unsigned nplanes, vil_pixel_format format, char const file_format)
	Make a new image.
vil_image_resource_sptr	vil_new_image_resource (vil_stream os, unsigned ni, unsigned nj, vil_image_resource_sptr const &prototype, char const file_format)
	Make a new vil_image_resource, writing to stream "os", size ni x nj, copying pixel format etc from "prototype".
vil_image_resource_sptr	vil_new_image_resource (char const filename, unsigned ni, unsigned nj, unsigned nplanes, vil_image_resource_sptr const &prototype, char const format=0)
	Make a new vil_image_resource, writing to file "filename", size ni x nj, copying pixel format etc from "prototype".
vil_image_resource_sptr	vil_new_image_resource (vil_stream os, unsigned ni, unsigned nj, unsigned nplanes, vil_image_resource_sptr const &prototype, char const file_format=0)
	Make a new vil_image_resource, writing to stream "os", size ni x nj, copying pixel format etc from "prototype".
bool	vil_save_image_resource (const vil_image_resource_sptr &ir, char const filename, char const file_format)
	Send vil_image_resource to disk.
bool	vil_save_image_resource (const vil_image_resource_sptr &ir, char const *filename)
	Save vil_image_resource to file, deducing format from filename.

Constructor & Destructor Documentation

vil_image_resource_plugin::vil_image_resource_plugin ( ) [inline]

Default constructor.

Definition at line 29 of file vil_image_resource_plugin.h.

virtual vil_image_resource_plugin::~vil_image_resource_plugin ( ) [inline, virtual]

Destructor.

Definition at line 32 of file vil_image_resource_plugin.h.

Member Function Documentation

virtual vcl_string vil_image_resource_plugin::is_a ( ) const [inline, virtual]

Name of the class.

Definition at line 35 of file vil_image_resource_plugin.h.

virtual vil_pixel_format vil_image_resource_plugin::pixel_format ( ) const [inline, virtual]

Pixel Format.

A standard RGB RGB RGB of chars image has pixel_format() == VIL_PIXEL_FORMAT_BYTE

Implements vil_image_resource.

Definition at line 37 of file vil_image_resource_plugin.h.

virtual unsigned vil_image_resource_plugin::ni ( ) const [inline, virtual]

Dimensions: Planes x ni x nj.

The number of pixels in each row.

Implements vil_image_resource.

Definition at line 39 of file vil_image_resource_plugin.h.

virtual unsigned vil_image_resource_plugin::nj ( ) const [inline, virtual]

Dimensions: Planes x ni x nj.

The number of pixels in each column.

Implements vil_image_resource.

Definition at line 40 of file vil_image_resource_plugin.h.

virtual unsigned vil_image_resource_plugin::nplanes ( ) const [inline, virtual]

Dimensions: Planes x ni x nj.

This concept is treated as a synonym to components.

Implements vil_image_resource.

Definition at line 41 of file vil_image_resource_plugin.h.

virtual bool vil_image_resource_plugin::get_property	(	char const *	,
		void *	= `0`
	)			const `[inline, virtual]`

Extra property information.

Implements vil_image_resource.

Definition at line 43 of file vil_image_resource_plugin.h.

virtual vil_image_view_base_sptr vil_image_resource_plugin::get_copy_view	(	unsigned	,
		unsigned	,
		unsigned	,
		unsigned
	)			const `[inline, virtual]`

Create a read/write view of a copy of this data.

This function will always return a multi-plane scalar-pixel view of the data.

Returns:: 0 if unable to get view of correct size, or if resource is write-only.

Implements vil_image_resource.

Definition at line 44 of file vil_image_resource_plugin.h.

virtual bool vil_image_resource_plugin::put_view	(	vil_image_view_base const &	,
		unsigned	,
		unsigned
	)			`[inline, virtual]`

Put the data in this view back into the image source.

The view must be of scalar components. Assign your view to a scalar-component view if this is not the case.

Returns:: false if failed, because e.g. resource is read-only, format of view is not correct (if it is a compound pixel type, try assigning it to a multi-plane scalar pixel view.)

Implements vil_image_resource.

Definition at line 47 of file vil_image_resource_plugin.h.

virtual bool vil_image_resource_plugin::load_the_image	(	vil_image_view_base_sptr &	image,
		const vcl_string &	path
	)			`[inline, virtual]`

Attempt to load image from named file.

Returns:: true if successful

Definition at line 51 of file vil_image_resource_plugin.h.

bool vil_image_resource_plugin::load_the_image	(	vil_image_view_base_sptr &	image,
		const vcl_string &	path,
		const vcl_string &	filetype,
		const vcl_string &	colour
	)			`[virtual]`

Attempt to load image from named file.

Parameters:

	filetype	String hinting at what image format is
	colour	define whether to load images as colour or grey-scale. Options are '' (i.e. rely on image), 'Grey' or 'RGB'

Returns:: true if successful

Definition at line 22 of file vil_image_resource_plugin.cxx.

void vil_image_resource_plugin::register_plugin ( vil_image_resource_plugin * plugin ) [static]

Definition at line 47 of file vil_image_resource_plugin.cxx.

void vil_image_resource_plugin::delete_all_plugins ( ) [static]

Delete all registered plugins.

Definition at line 66 of file vil_image_resource_plugin.cxx.

virtual void vil_image_resource_plugin::set_size	(	int	width,
		int	height
	)			`[inline, virtual]`

Set the desired image size.

Definition at line 71 of file vil_image_resource_plugin.h.

bool vil_image_resource_plugin::can_be_loaded ( const vcl_string & filename ) [virtual]

Check whether a filename is a potential candidate for loading and if it is available.

Definition at line 81 of file vil_image_resource_plugin.cxx.

void vil_image_resource_plugin::set_colour ( const vcl_string & colour ) [inline]

Set the colour options.

Definition at line 77 of file vil_image_resource_plugin.h.

void vil_image_resource_plugin::set_filetype ( const vcl_string & filetype ) [inline]

Set the filetype options.

Definition at line 80 of file vil_image_resource_plugin.h.

virtual vil_image_view_base_sptr vil_image_resource::get_view	(	unsigned	i0,
		unsigned	n_i,
		unsigned	j0,
		unsigned	n_j
	)			const `[inline, virtual, inherited]`

Create a read/write view of the data.

Modifying this view might modify the actual data. If you want to modify this data in place, call put_view after you done, and it should work efficiently. This function will always return a multi-plane scalar-pixel view of the data.

Returns:: 0 if unable to get view of correct size, or if resource is write-only.

If you want to fill an existing view (e.g. a window onto some other image), then use

   vil_reformat(data->get_view(..), window);

Reimplemented in vil_dicom_image, vil_clamp_image_resource, vil_crop_image_resource, vil_decimate_image_resource, vil_flip_lr_image_resource, vil_flip_ud_image_resource, vil_memory_image, vil_plane_image_resource, and vil_transpose_image_resource.

Definition at line 64 of file vil_image_resource.h.

vil_image_view_base_sptr vil_image_resource::get_view ( ) const [inline, inherited]

Create a read/write view of all the data.

Definition at line 69 of file vil_image_resource.h.

vil_image_view_base_sptr vil_image_resource::get_copy_view ( ) const [inline, inherited]

Create a read/write view of a copy of all the data.

Reimplemented in vil_j2k_image, and vil_nitf2_image.

Definition at line 80 of file vil_image_resource.h.

bool vil_image_resource::put_view ( const vil_image_view_base & im ) [inline, inherited]

Put the data in this view back into the image source at the origin.

Definition at line 92 of file vil_image_resource.h.

bool vil_image_resource::view_fits	(	const vil_image_view_base &	im,
		unsigned	i0,
		unsigned	j0
	)			`[virtual, inherited]`

Check that a view will fit into the data at the given offset.

This includes checking that the pixel type is scalar.

Definition at line 30 of file vil_image_resource.cxx.

virtual char const* vil_image_resource::file_format ( ) const [inline, virtual, inherited]

Return a string describing the file format.

Only file images have a format, others return 0

Reimplemented in vil_bmp_image, vil_dicom_image, vil_iris_generic_image, vil_jpeg_image, vil_mit_image, vil_nitf2_image, vil_png_image, vil_pnm_image, vil_pyramid_image_list, vil_ras_image, vil_tiff_image, vil_tiff_pyramid_resource, vil_viff_image, and vil_pyramid_image_resource.

Definition at line 101 of file vil_image_resource.h.

void vil_image_resource::ref ( ) [inline, protected, inherited]

Definition at line 110 of file vil_image_resource.h.

void vil_image_resource::unref ( ) [inline, protected, inherited]

Definition at line 111 of file vil_image_resource.h.

Friends And Related Function Documentation

friend class vil_smart_ptr< vil_image_resource > [friend, inherited]

Definition at line 109 of file vil_image_resource.h.

template<class destT, class kernelT, class accumT>

vil_image_resource_sptr vil_convolve_1d	(	const vil_image_resource_sptr &	src_im,
		const	destT,
		const kernelT *	kernel,
		int	k_lo,
		int	k_hi,
		const	accumT,
		vil_convolve_boundary_option	start_option,
		vil_convolve_boundary_option	end_option
	)			`[related, inherited]`

Create an image_resource object which convolve kernel[x] x in [k_lo,k_hi] with srcT.

Note:: This function reverses the kernel. If you don't want the kernel reversed, use vil_correlate_1d instead.

Parameters:

kernel

should point to tap 0.

Definition at line 403 of file vil_convolve_1d.h.

template<class destT, class kernelT, class accumT>

vil_image_resource_sptr vil_correlate_1d	(	const vil_image_resource_sptr &	src_im,
		const	destT,
		const kernelT *	kernel,
		vcl_ptrdiff_t	k_lo,
		vcl_ptrdiff_t	k_hi,
		const	accumT,
		vil_convolve_boundary_option	start_option,
		vil_convolve_boundary_option	end_option
	)			`[related, inherited]`

Create an image_resource object which correlate kernel[x] x in [k_lo,k_hi] with srcT.

Note:: This function does not reverse the kernel. If you want the kernel reversed, use vil_convolve_1d instead.

Parameters:

kernel

should point to tap 0.

Definition at line 214 of file vil_correlate_1d.h.

bool vil_copy_deep	(	const vil_image_resource_sptr &	src,
		vil_image_resource_sptr &	dest
	)			`[related, inherited]`

Copy src to dest.

This is useful if you want to copy on image into a window on another image. src and dest must have identical sizes, and pixel-types. Returns false if the copy failed. O(size).

Definition at line 44 of file vil_copy.cxx.

vil_image_resource_sptr vil_crop	(	const vil_image_resource_sptr &	src,
		unsigned	i0,
		unsigned	n_i,
		unsigned	j0,
		unsigned	n_j
	)			`[related, inherited]`

Crop to a region of src.

Definition at line 15 of file vil_crop.cxx.

vil_image_resource_sptr vil_decimate	(	const vil_image_resource_sptr &	src,
		unsigned	i_factor,
		unsigned	j_factor = `0`
	)			`[related, inherited]`

decimate to a region of src.

vil_image_resource_sptr vil_load_image_resource ( char const * filename ) [related, inherited]

Load an image resource object from a file.

Definition at line 52 of file vil_load.cxx.

vil_image_resource_sptr vil_new_image_resource	(	unsigned	ni,
		unsigned	nj,
		vil_image_resource_sptr const &	prototype
	)			`[related, inherited]`

Make a new image, similar format to the prototype.

Definition at line 69 of file vil_new.cxx.

vil_image_resource_sptr vil_new_image_resource	(	vil_stream *	os,
		unsigned	ni,
		unsigned	nj,
		unsigned	nplanes,
		vil_pixel_format	format,
		char const *	file_format = `0`
	)			`[related, inherited]`

Make a new image.

Definition at line 77 of file vil_new.cxx.

vil_image_resource_sptr vil_new_image_resource	(	char const *	filename,
		unsigned	ni,
		unsigned	nj,
		vil_image_resource_sptr const &	prototype,
		char const *	file_format
	)			`[related, inherited]`

Make a new vil_image_resource, writing to file "filename", size ni x nj, copying pixel format etc from "prototype".

Definition at line 104 of file vil_new.cxx.

vil_image_resource_sptr vil_new_image_resource	(	char const *	filename,
		unsigned	ni,
		unsigned	nj,
		unsigned	nplanes,
		vil_pixel_format	format,
		char const *	file_format = `0`
	)			`[related, inherited]`

Make a new image.

Definition at line 123 of file vil_new.cxx.

vil_image_resource_sptr vil_new_image_resource	(	vil_stream *	os,
		unsigned	ni,
		unsigned	nj,
		vil_image_resource_sptr const &	prototype,
		char const *	file_format
	)			`[related, inherited]`

Make a new vil_image_resource, writing to stream "os", size ni x nj, copying pixel format etc from "prototype".

Definition at line 143 of file vil_new.cxx.

vil_image_resource_sptr vil_new_image_resource	(	char const *	filename,
		unsigned	ni,
		unsigned	nj,
		unsigned	nplanes,
		vil_image_resource_sptr const &	prototype,
		char const *	format = `0`
	)			`[related, inherited]`

Make a new vil_image_resource, writing to file "filename", size ni x nj, copying pixel format etc from "prototype".

vil_image_resource_sptr vil_new_image_resource	(	vil_stream *	os,
		unsigned	ni,
		unsigned	nj,
		unsigned	nplanes,
		vil_image_resource_sptr const &	prototype,
		char const *	file_format = `0`
	)			`[related, inherited]`