vil_crop_image_resource Class Reference

#include <vil_crop.h>

Inheritance diagram for vil_crop_image_resource:

[legend]List of all members.

Detailed Description

A generic_image adaptor that behaves like a cropped version of its input.

Definition at line 36 of file vil_crop.h.

Public Member Functions

vil_crop_image_resource (vil_image_resource_sptr const &, unsigned i0, unsigned n_i, unsigned j0, unsigned n_j)

virtual unsigned nplanes () const

Dimensions: Planes x ni x nj.

virtual unsigned ni () const

Dimensions: Planes x ni x nj.

virtual unsigned nj () const

Dimensions: Planes x ni x nj.

virtual enum vil_pixel_format pixel_format () const

Pixel Format.

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

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

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.

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

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

virtual bool get_property (char const *tag, void *property_value=0) const

Extra property information.

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.

Protected Member Functions

void ref ()

void unref ()

Protected Attributes

vil_image_resource_sptr src_

int i0_

int ni_

int j0_

int nj_

int 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_crop_image_resource::vil_crop_image_resource ( vil_image_resource_sptr const & ,

unsigned i0,

unsigned n_i,

unsigned j0,

unsigned n_j

)

Definition at line 21 of file vil_crop.cxx.

Member Function Documentation

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 100 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 79 of file vil_image_resource.h.

virtual vil_image_view_base_sptr vil_crop_image_resource::get_copy_view ( unsigned i0,

unsigned n_i,

unsigned j0,

unsigned n_j

) 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 49 of file vil_crop.h.

virtual bool vil_crop_image_resource::get_property ( char const * tag,

void * property_value = 0

) const [inline, virtual]

Extra property information.

Implements vil_image_resource.
Definition at line 71 of file vil_crop.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 68 of file vil_image_resource.h.

virtual vil_image_view_base_sptr vil_crop_image_resource::get_view ( unsigned i0,

unsigned n_i,

unsigned j0,

unsigned n_j

) const [inline, virtual]

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 from vil_image_resource.
Definition at line 56 of file vil_crop.h.

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

Dimensions: Planes x ni x nj.
The number of pixels in each row.
Implements vil_image_resource.
Definition at line 43 of file vil_crop.h.

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

Dimensions: Planes x ni x nj.
The number of pixels in each column.
Implements vil_image_resource.
Definition at line 44 of file vil_crop.h.

virtual unsigned vil_crop_image_resource::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 42 of file vil_crop.h.

virtual enum vil_pixel_format vil_crop_image_resource::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 46 of file vil_crop.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 91 of file vil_image_resource.h.

virtual bool vil_crop_image_resource::put_view ( const vil_image_view_base & im,

unsigned i0,

unsigned j0

) [inline, virtual]

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

Implements vil_image_resource.
Definition at line 65 of file vil_crop.h.

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

Definition at line 109 of file vil_image_resource.h.

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

Definition at line 110 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.

Friends And Related Function Documentation

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 404 of file vil_convolve_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.

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.

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 14 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 ( vil_stream * os,

unsigned ni,

unsigned nj,

unsigned nplanes,

vil_image_resource_sptr const & prototype,

char const * file_format = 0

) [related, inherited]

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

) [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,

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

) [related, inherited]

Make a new image.

Definition at line 122 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 103 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

) [related, inherited]

Make a new image.

Definition at line 76 of file vil_new.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 68 of file vil_new.cxx.

bool vil_save_image_resource ( const vil_image_resource_sptr & ir,

char const * filename

) [related, inherited]

Save vil_image_resource to file, deducing format from filename.

bool vil_save_image_resource ( const vil_image_resource_sptr & ir,

char const * filename,

char const * file_format

) [related, inherited]

Send vil_image_resource to disk.

friend class vil_smart_ptr< vil_image_resource > [friend, inherited]

Definition at line 108 of file vil_image_resource.h.

Member Data Documentation

int vil_crop_image_resource::i0_ [protected]

Definition at line 78 of file vil_crop.h.

int vil_crop_image_resource::j0_ [protected]

Definition at line 80 of file vil_crop.h.

int vil_crop_image_resource::ni_ [protected]

Definition at line 79 of file vil_crop.h.

int vil_crop_image_resource::nj_ [protected]

Definition at line 81 of file vil_crop.h.

int vil_image_resource::reference_count_ [protected, inherited]

Definition at line 113 of file vil_image_resource.h.

vil_image_resource_sptr vil_crop_image_resource::src_ [protected]

Definition at line 77 of file vil_crop.h.

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

core/vil/vil_crop.h
core/vil/vil_crop.cxx

Generated on Thu Jan 10 14:40:04 2008 for core/vil by

1.4.4


Public Member Functions
	vil_crop_image_resource (vil_image_resource_sptr const &, unsigned i0, unsigned n_i, unsigned j0, unsigned n_j)
virtual unsigned	nplanes () const
	Dimensions: Planes x ni x nj.
virtual unsigned	ni () const
	Dimensions: Planes x ni x nj.
virtual unsigned	nj () const
	Dimensions: Planes x ni x nj.
virtual enum vil_pixel_format	pixel_format () const
	Pixel Format.
virtual vil_image_view_base_sptr	get_copy_view (unsigned i0, unsigned n_i, unsigned j0, unsigned n_j) const
	Create a read/write view of a copy of this data.
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.
virtual bool	put_view (const vil_image_view_base &im, unsigned i0, unsigned j0)
	Put the data in this view back into the image source.
virtual bool	get_property (char const tag, void property_value=0) const
	Extra property information.
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.
Protected Member Functions
void	ref ()
void	unref ()
Protected Attributes
vil_image_resource_sptr	src_
int	i0_
int	ni_
int	j0_
int	nj_
int	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.