Abstract representation of an image source or image destination. More...

#include <vil_image_resource.h>

Inheritance diagram for vil_image_resource:

[legend]

Public Member Functions
	vil_image_resource ()
	the reference count starts at 0. More...

virtual	~vil_image_resource ()

virtual unsigned	nplanes () const =0
	Dimensions: Planes x ni x nj. More...

virtual unsigned	ni () const =0
	Dimensions: Planes x ni x nj. More...

virtual unsigned	nj () const =0
	Dimensions: Planes x ni x nj. More...

virtual enum vil_pixel_format	pixel_format () const =0
	Pixel Format. More...

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

vil_image_view_base_sptr	get_view () const
	Create a read/write view of all the data. More...

virtual vil_image_view_base_sptr	get_copy_view (unsigned i0, unsigned n_i, unsigned j0, unsigned n_j) const =0
	Create a read/write view of a copy of this data. More...

vil_image_view_base_sptr	get_copy_view () const
	Create a read/write view of a copy of all the data. More...

virtual bool	put_view (const vil_image_view_base &im, unsigned i0, unsigned j0)=0
	Put the data in this view back into the image source. More...

virtual bool	put_view (const vil_image_view_base &im)
	Put the data in this view back into the image source at the origin. More...

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

virtual char const *	file_format () const
	Return a string describing the file format. More...

virtual bool	get_property (char const tag, void property_value=nullptr) const =0
	Extra property information. More...

Protected Member Functions
void	ref ()

void	unref ()

Protected Attributes
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. More...

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, std::ptrdiff_t k_lo, std::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. More...

vil_image_resource_sptr	vil_clamp (const vil_image_resource_sptr &src, double low, double hi)
	Clamp an image resource between two values. More...

bool	vil_copy_deep (const vil_image_resource_sptr &src, vil_image_resource_sptr &dest)
	Copy src to dest. More...

vil_image_resource_sptr	vil_copy_deep (const vil_image_resource_sptr &src)
	Creates an in memory vil_image_resource and copies the src to it. More...

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

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

vil_image_resource_sptr	vil_flip_lr (const vil_image_resource_sptr &src)
	Flip an image resource left to right. More...

vil_image_resource_sptr	vil_flip_ud (const vil_image_resource_sptr &src)
	Flip an image resource left to right. More...

vil_image_resource_sptr	vil_load_image_resource (char const *filename, bool verbose=true)
	Load an image resource object from a file. More...

vil_image_resource_sptr	vil_load_image_resource_raw (vil_stream *, bool verbose=true)
	Load from a stream. More...

vil_image_resource_sptr	vil_load_image_resource_raw (char const *, bool verbose=true)
	Load an image resource object from a file. More...

vil_image_resource_sptr	vil_load_image_resource_plugin (char const *)
	Load from a filename with a plugin. More...

template<class sumT >
bool	vil_math_mean_and_variance (sumT &mean, sumT &var, const vil_image_resource_sptr im, const vil_image_view< bool > &mask, unsigned p)
	Mean and variance of masked elements in plane p for vil_image_resource. More...

vil_image_resource_sptr	vil_new_image_resource (unsigned ni, unsigned nj, unsigned nplanes, vil_pixel_format format)
	Make a new image of given format. More...

vil_image_resource_sptr	vil_new_image_resource_interleaved (unsigned ni, unsigned nj, unsigned nplanes, vil_pixel_format format)
	Make a new image of given format with interleaved planes. More...

vil_image_resource_sptr	vil_new_image_resource_of_view (vil_image_view_base const &view)
	Make a new image resource that is a wrapper on an existing view's data. More...

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

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

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

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

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

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=nullptr)
	Make a new vil_image_resource, writing to file "filename", size ni x nj, copying pixel format etc from "prototype". More...

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=nullptr)
	Make a new vil_image_resource, writing to stream "os", size ni x nj, copying pixel format etc from "prototype". More...

vil_image_resource_sptr	vil_plane (const vil_image_resource_sptr &src, unsigned p)
	Return a specific plane of an image. More...

bool	vil_save_image_resource (const vil_image_resource_sptr &ir, char const filename, char const file_format)
	Send vil_image_resource to disk. More...

bool	vil_save_image_resource (const vil_image_resource_sptr &ir, char const *filename)
	Save vil_image_resource to file, deducing format from filename. More...

vil_image_resource_sptr	vil_transpose (const vil_image_resource_sptr &src)
	Transpose an image. More...

Detailed Description

Abstract representation of an image source or image destination.

Most references to vil_image_resource objects should usually be done through smart pointers - vil_image_resource_sptr;

All image data is presumed to be in planes, not components. This does not say whether the data is stored on disk or in memory as RGBRGBRGB.. or RRR..GGG..BBB.., just that the interface will always tell you that it has a multi-plane single-component view.

Definition at line 31 of file vil_image_resource.h.

Constructor & Destructor Documentation

◆ vil_image_resource()

vil_image_resource::vil_image_resource ( )

the reference count starts at 0.

Definition at line 14 of file vil_image_resource.cxx.

◆ ~vil_image_resource()

vil_image_resource::~vil_image_resource ( )

virtualdefault

Member Function Documentation

◆ file_format()

virtual char const* vil_image_resource::file_format ( ) const

inlinevirtual

Return a string describing the file format.

Only file images have a format, others return 0

Reimplemented in vil_tiff_pyramid_resource, vil_tiff_image, vil_pyramid_image_list, vil_openjpeg_image, vil_nitf2_image, vil_pnm_image, vil_j2k_image, vil_ras_image, vil_mit_image, vil_bmp_image, vil_viff_image, vil_pyramid_image_resource, vil_png_image, vil_j2k_nitf2_pyramid_image_resource, vil_dicom_image, vil_iris_generic_image, vil_jpeg_image, vil_j2k_pyramid_image_resource, vil_openjpeg_pyramid_image_resource, and vil_sgi_image.

Definition at line 101 of file vil_image_resource.h.

◆ get_copy_view() [1/2]

virtual vil_image_view_base_sptr vil_image_resource::get_copy_view	(	unsigned	i0,
		unsigned	n_i,
		unsigned	j0,
		unsigned	n_j
	)		const

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

◆ get_copy_view() [2/2]

vil_image_view_base_sptr vil_image_resource::get_copy_view ( ) const

inline

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

Definition at line 80 of file vil_image_resource.h.

◆ get_property()

bool vil_image_resource::get_property	(	char const *	tag,
		void *	property_value = `nullptr`
	)		const

pure virtual

◆ get_view() [1/2]

virtual vil_image_view_base_sptr vil_image_resource::get_view	(	unsigned	i0,
		unsigned	n_i,
		unsigned	j0,
		unsigned	n_j
	)		const

inlinevirtual

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_flip_ud_image_resource, vil_memory_image, vil_plane_image_resource, vil_clamp_image_resource, vil_flip_lr_image_resource, vil_decimate_image_resource, vil_dicom_image, vil_crop_image_resource, and vil_transpose_image_resource.

Definition at line 64 of file vil_image_resource.h.

◆ get_view() [2/2]

vil_image_view_base_sptr vil_image_resource::get_view ( ) const

inline

Create a read/write view of all the data.

Definition at line 69 of file vil_image_resource.h.

◆ ni()

virtual unsigned vil_image_resource::ni ( ) const

pure virtual

Dimensions: Planes x ni x nj.

The number of pixels in each row.

◆ nj()

virtual unsigned vil_image_resource::nj ( ) const

pure virtual

Dimensions: Planes x ni x nj.

The number of pixels in each column.

◆ nplanes()

virtual unsigned vil_image_resource::nplanes ( ) const

pure virtual

Dimensions: Planes x ni x nj.

This concept is treated as a synonym to components.

◆ pixel_format()

virtual enum vil_pixel_format vil_image_resource::pixel_format ( ) const

pure virtual

Pixel Format.

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

◆ put_view() [1/2]

virtual bool vil_image_resource::put_view	(	const vil_image_view_base &	im,
		unsigned	i0,
		unsigned	j0
	)

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

◆ put_view() [2/2]

virtual bool vil_image_resource::put_view ( const vil_image_view_base & im )

inlinevirtual

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

Reimplemented in vil_j2k_image.

Definition at line 92 of file vil_image_resource.h.

◆ ref()

void vil_image_resource::ref ( )

inlineprotected

Definition at line 110 of file vil_image_resource.h.

◆ unref()

void vil_image_resource::unref ( )

inlineprotected

Definition at line 111 of file vil_image_resource.h.

◆ view_fits()

bool vil_image_resource::view_fits	(	const vil_image_view_base &	im,
		unsigned	i0,
		unsigned	j0
	)

virtual

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

This includes checking that the pixel type is scalar.

Reimplemented in vil_j2k_image.

Definition at line 27 of file vil_image_resource.cxx.

Friends And Related Function Documentation

◆ vil_clamp()

vil_image_resource_sptr vil_clamp	(	const vil_image_resource_sptr &	src,
		double	low,
		double	hi
	)

Definition at line 22 of file vil_clamp.cxx.

◆ vil_convolve_1d()

template<class destT , class kernelT , class accumT >

vil_image_resource_sptr vil_convolve_1d	(	const vil_image_resource_sptr &	src_im,
		const destT	dt,
		const kernelT *	kernel,
		int	k_lo,
		int	k_hi,
		const accumT	ac,
		vil_convolve_boundary_option	start_option,
		vil_convolve_boundary_option	end_option
	)

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 406 of file vil_convolve_1d.h.

◆ vil_copy_deep() [1/2]

bool vil_copy_deep	(	const vil_image_resource_sptr &	src,
		vil_image_resource_sptr &	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 45 of file vil_copy.cxx.

◆ vil_copy_deep() [2/2]

vil_image_resource_sptr vil_copy_deep ( const vil_image_resource_sptr & src )

The size and pixel type of the return vil_image_resource is determined by src O(size)

Definition at line 89 of file vil_copy.cxx.

◆ vil_correlate_1d()

template<class destT , class kernelT , class accumT >

vil_image_resource_sptr vil_correlate_1d	(	const vil_image_resource_sptr &	src_im,
		const destT	dt,
		const kernelT *	kernel,
		std::ptrdiff_t	k_lo,
		std::ptrdiff_t	k_hi,
		const accumT	ac,
		vil_convolve_boundary_option	start_option,
		vil_convolve_boundary_option	end_option
	)

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 218 of file vil_correlate_1d.h.

◆ vil_crop()

vil_image_resource_sptr vil_crop	(	const vil_image_resource_sptr &	src,
		unsigned	i0,
		unsigned	n_i,
		unsigned	j0,
		unsigned	n_j
	)

Definition at line 15 of file vil_crop.cxx.

◆ vil_decimate()

vil_image_resource_sptr vil_decimate	(	const vil_image_resource_sptr &	src,
		unsigned	i_factor,
		unsigned	j_factor = `0`
	)

Definition at line 23 of file vil_decimate.cxx.

◆ vil_flip_lr()

vil_image_resource_sptr vil_flip_lr ( const vil_image_resource_sptr & src )

Definition at line 14 of file vil_flip.cxx.

◆ vil_flip_ud()

vil_image_resource_sptr vil_flip_ud ( const vil_image_resource_sptr & src )

Definition at line 121 of file vil_flip.cxx.

◆ vil_load_image_resource()

vil_image_resource_sptr vil_load_image_resource	(	char const *	filename,
		bool	verbose = `true`
	)

Definition at line 68 of file vil_load.cxx.

◆ vil_load_image_resource_plugin()

vil_image_resource_sptr vil_load_image_resource_plugin ( char const * )

Definition at line 80 of file vil_load.cxx.

◆ vil_load_image_resource_raw() [1/2]

vil_image_resource_sptr vil_load_image_resource_raw	(	vil_stream *	,
		bool	verbose = `true`
	)

Won't use plugins.

Definition at line 19 of file vil_load.cxx.

◆ vil_load_image_resource_raw() [2/2]

vil_image_resource_sptr vil_load_image_resource_raw	(	char const *	,
		bool	verbose = `true`
	)

Won't use plugins.

Definition at line 46 of file vil_load.cxx.

◆ vil_math_mean_and_variance()

template<class sumT >

bool vil_math_mean_and_variance	(	sumT &	mean,
		sumT &	var,
		const vil_image_resource_sptr	im,
		const vil_image_view< bool > &	mask,
		unsigned	p
	)

Definition at line 380 of file vil_math.h.

◆ vil_new_image_resource() [1/8]

vil_image_resource_sptr vil_new_image_resource	(	unsigned	ni,
		unsigned	nj,
		unsigned	nplanes,
		vil_pixel_format	format
	)

If the format is not scalar, the number of planes must be 1. When you create a multi-component image in this way, the vil_image_resource API will treat it as a scalar pixel image with multiple planes. (This doesn't affect the underlying data storage.)

Definition at line 32 of file vil_new.cxx.

◆ vil_new_image_resource() [2/8]

vil_image_resource_sptr vil_new_image_resource	(	unsigned	ni,
		unsigned	nj,
		vil_image_resource_sptr const &	prototype
	)

Definition at line 69 of file vil_new.cxx.

◆ vil_new_image_resource() [3/8]

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
	)

Definition at line 77 of file vil_new.cxx.

◆ vil_new_image_resource() [4/8]

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 = `nullptr`
	)

◆ vil_new_image_resource() [5/8]

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 = `nullptr`
	)

◆ vil_new_image_resource() [6/8]

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
	)

Definition at line 104 of file vil_new.cxx.

◆ vil_new_image_resource() [7/8]

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
	)

Definition at line 123 of file vil_new.cxx.

◆ vil_new_image_resource() [8/8]

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
	)

Definition at line 143 of file vil_new.cxx.

◆ vil_new_image_resource_interleaved()

vil_image_resource_sptr vil_new_image_resource_interleaved	(	unsigned	ni,
		unsigned	nj,
		unsigned	nplanes,
		vil_pixel_format	format
	)

The format must be scalar.

Definition at line 44 of file vil_new.cxx.

◆ vil_new_image_resource_of_view()

vil_image_resource_sptr vil_new_image_resource_of_view ( vil_image_view_base const & view )

Note: The output will be a shallow copy of the input, so changing the pixel values of one may change the pixel value of the other. Thanks to the magic of smart pointers, the output will remain valid even if you destroy the input. When you wrap a multi-component image in this way, the vil_image_resource API will treat it as a scalar pixel image with multiple planes. (This doesn't affect the underlying data storage.)

Definition at line 62 of file vil_new.cxx.

◆ vil_plane()

vil_image_resource_sptr vil_plane	(	const vil_image_resource_sptr &	src,
		unsigned	p
	)

Definition at line 19 of file vil_plane.cxx.

◆ vil_save_image_resource() [1/2]

bool vil_save_image_resource	(	const vil_image_resource_sptr &	ir,
		char const *	filename,
		char const *	file_format
	)

Definition at line 129 of file vil_save.cxx.

◆ vil_save_image_resource() [2/2]

bool vil_save_image_resource	(	const vil_image_resource_sptr &	ir,
		char const *	filename
	)

Definition at line 148 of file vil_save.cxx.

◆ vil_smart_ptr< vil_image_resource >

friend class vil_smart_ptr< vil_image_resource >

friend

Definition at line 109 of file vil_image_resource.h.

◆ vil_transpose()

vil_image_resource_sptr vil_transpose ( const vil_image_resource_sptr & src )

Definition at line 14 of file vil_transpose.cxx.

Member Data Documentation

◆ reference_count_

vcl_atomic_count vil_image_resource::reference_count_

protected

Definition at line 114 of file vil_image_resource.h.

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

core/vil/vil_image_resource.h
core/vil/algo/vil_convolve_1d.h
core/vil/algo/vil_correlate_1d.h
core/vil/vil_clamp.h
core/vil/vil_copy.cxx
core/vil/vil_copy.h
core/vil/vil_crop.h
core/vil/vil_decimate.h
core/vil/vil_flip.h
core/vil/vil_image_resource.cxx
core/vil/vil_load.h
core/vil/vil_math.h
core/vil/vil_new.cxx
core/vil/vil_new.h
core/vil/vil_plane.h
core/vil/vil_save.h
core/vil/vil_transpose.h

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Related Functions

Detailed Description

Constructor & Destructor Documentation

◆ vil_image_resource()

◆ ~vil_image_resource()

Member Function Documentation

◆ file_format()

◆ get_copy_view() [1/2]

◆ get_copy_view() [2/2]

◆ get_property()

◆ get_view() [1/2]

◆ get_view() [2/2]

◆ ni()

◆ nj()

◆ nplanes()

◆ pixel_format()

◆ put_view() [1/2]

◆ put_view() [2/2]

◆ ref()

◆ unref()

◆ view_fits()

Friends And Related Function Documentation

◆ vil_clamp()

◆ vil_convolve_1d()

◆ vil_copy_deep() [1/2]

◆ vil_copy_deep() [2/2]

◆ vil_correlate_1d()

◆ vil_crop()

◆ vil_decimate()

◆ vil_flip_lr()

◆ vil_flip_ud()

◆ vil_load_image_resource()

◆ vil_load_image_resource_plugin()

◆ vil_load_image_resource_raw() [1/2]

◆ vil_load_image_resource_raw() [2/2]

◆ vil_math_mean_and_variance()

◆ vil_new_image_resource() [1/8]

◆ vil_new_image_resource() [2/8]

◆ vil_new_image_resource() [3/8]

◆ vil_new_image_resource() [4/8]

◆ vil_new_image_resource() [5/8]

◆ vil_new_image_resource() [6/8]

◆ vil_new_image_resource() [7/8]

◆ vil_new_image_resource() [8/8]

◆ vil_new_image_resource_interleaved()

◆ vil_new_image_resource_of_view()

◆ vil_plane()

◆ vil_save_image_resource() [1/2]

◆ vil_save_image_resource() [2/2]

◆ vil_smart_ptr< vil_image_resource >

◆ vil_transpose()

Member Data Documentation

◆ reference_count_