vidl2_istream_image_resource Class Reference

#include <vidl2_istream_image_resource.h>

Inheritance diagram for vidl2_istream_image_resource:

[legend]List of all members.

Detailed Description

A vil_image_resource to a frame of a vidl2_istream.

With this class you can create image resources to serveral frames of an open vidl2 istream. When get_view is called the stream is seeked to the relevant frame number and the frame is decoded and converted to an image view. The stream must be seekable unless views are requested in squential order. The stream is closed when all image resources using it are destroyed.

Definition at line 29 of file vidl2_istream_image_resource.h.

Public Member Functions

vidl2_istream_image_resource (const vidl2_istream_sptr &stream, int frame, unsigned int ni, unsigned int nj, unsigned int np, vil_pixel_format format)

vidl2_istream_image_resource (const vidl2_istream_sptr &stream, int frame)

vidl2_istream_image_resource (const vidl2_istream_sptr &stream)

~vidl2_istream_image_resource ()

virtual unsigned nplanes () const

Dimensions.

virtual unsigned ni () const

virtual unsigned nj () const

virtual enum vil_pixel_format pixel_format () const

virtual vil_image_view_base_sptr get_copy_view (unsigned i0, unsigned ni, unsigned j0, unsigned nj) const

Create a read/write view of a copy of this 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.

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

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

vil_image_view_base_sptr get_view () const

vil_image_view_base_sptr get_copy_view () const

bool put_view (const vil_image_view_base &im)

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

virtual char const * file_format () const

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)

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)

bool vil_copy_deep (const vil_image_resource_sptr &src, vil_image_resource_sptr &dest)

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

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

vil_image_resource_sptr vil_load_image_resource (char const *filename)

vil_image_resource_sptr vil_new_image_resource (unsigned ni, unsigned nj, vil_image_resource_sptr const &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)

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)

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)

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)

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)

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)

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

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

Protected Member Functions

void ref ()

void unref ()

Protected Attributes

int reference_count_

Private Member Functions

bool find_image_properties ()

try to find the image format and size from the current frame.

vil_image_view_base_sptr create_empty_view () const

create an empty image of the appropriate type and size.

Private Attributes

vidl2_istream_sptr istream_

int frame_number_

unsigned int ni_

unsigned int nj_

unsigned int np_

vil_pixel_format format_

Friends

friend class vil_smart_ptr

Constructor & Destructor Documentation

vidl2_istream_image_resource::vidl2_istream_image_resource ( const vidl2_istream_sptr & stream,

int frame,

unsigned int ni,

unsigned int nj,

unsigned int np,

vil_pixel_format format

)

Definition at line 19 of file vidl2_istream_image_resource.cxx.

vidl2_istream_image_resource::vidl2_istream_image_resource ( const vidl2_istream_sptr & stream,

int frame

)

Definition at line 53 of file vidl2_istream_image_resource.cxx.

vidl2_istream_image_resource::vidl2_istream_image_resource ( const vidl2_istream_sptr & stream )

Definition at line 64 of file vidl2_istream_image_resource.cxx.

vidl2_istream_image_resource::~vidl2_istream_image_resource ( )

Definition at line 75 of file vidl2_istream_image_resource.cxx.

Member Function Documentation

vil_image_view_base_sptr vidl2_istream_image_resource::create_empty_view ( ) const [private]

create an empty image of the appropriate type and size.

Definition at line 197 of file vidl2_istream_image_resource.cxx.

bool vidl2_istream_image_resource::find_image_properties ( ) [private]

try to find the image format and size from the current frame.

Definition at line 32 of file vidl2_istream_image_resource.cxx.

vil_image_view_base_sptr vidl2_istream_image_resource::get_copy_view ( unsigned i0,

unsigned ni,

unsigned j0,

unsigned nj

) const [virtual]

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

Returns:
0 if unable to get view of correct size.

Implements vil_image_resource.
Definition at line 116 of file vidl2_istream_image_resource.cxx.

bool vidl2_istream_image_resource::get_property ( char const * tag,

void * prop = 0

) const [virtual]

Implements vil_image_resource.
Definition at line 109 of file vidl2_istream_image_resource.cxx.

unsigned vidl2_istream_image_resource::ni ( ) const [virtual]

Implements vil_image_resource.
Definition at line 88 of file vidl2_istream_image_resource.cxx.

unsigned vidl2_istream_image_resource::nj ( ) const [virtual]

Implements vil_image_resource.
Definition at line 95 of file vidl2_istream_image_resource.cxx.

unsigned vidl2_istream_image_resource::nplanes ( ) const [virtual]

Dimensions.

Implements vil_image_resource.
Definition at line 81 of file vidl2_istream_image_resource.cxx.

enum vil_pixel_format vidl2_istream_image_resource::pixel_format ( ) const [virtual]

Implements vil_image_resource.
Definition at line 102 of file vidl2_istream_image_resource.cxx.

bool vidl2_istream_image_resource::put_view ( const vil_image_view_base & im,

unsigned i0,

unsigned j0

) [virtual]

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

Implements vil_image_resource.
Definition at line 187 of file vidl2_istream_image_resource.cxx.

Member Data Documentation

vil_pixel_format vidl2_istream_image_resource::format_ [private]

Definition at line 36 of file vidl2_istream_image_resource.h.

int vidl2_istream_image_resource::frame_number_ [private]

Definition at line 32 of file vidl2_istream_image_resource.h.

vidl2_istream_sptr vidl2_istream_image_resource::istream_ [private]

Definition at line 31 of file vidl2_istream_image_resource.h.

unsigned int vidl2_istream_image_resource::ni_ [private]

Definition at line 33 of file vidl2_istream_image_resource.h.

unsigned int vidl2_istream_image_resource::nj_ [private]

Definition at line 34 of file vidl2_istream_image_resource.h.

unsigned int vidl2_istream_image_resource::np_ [private]

Definition at line 35 of file vidl2_istream_image_resource.h.

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

contrib/brl/bbas/vidl2/vidl2_istream_image_resource.h
contrib/brl/bbas/vidl2/vidl2_istream_image_resource.cxx

Generated on Thu Jan 10 14:51:34 2008 for contrib/brl/bbas/vidl2 by

1.4.4


Public Member Functions
	vidl2_istream_image_resource (const vidl2_istream_sptr &stream, int frame, unsigned int ni, unsigned int nj, unsigned int np, vil_pixel_format format)
	vidl2_istream_image_resource (const vidl2_istream_sptr &stream, int frame)
	vidl2_istream_image_resource (const vidl2_istream_sptr &stream)
	~vidl2_istream_image_resource ()
virtual unsigned	nplanes () const
	Dimensions.
virtual unsigned	ni () const
virtual unsigned	nj () const
virtual enum vil_pixel_format	pixel_format () const
virtual vil_image_view_base_sptr	get_copy_view (unsigned i0, unsigned ni, unsigned j0, unsigned nj) const
	Create a read/write view of a copy of this 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.
bool	get_property (char const tag, void prop=0) const
virtual vil_image_view_base_sptr	get_view (unsigned i0, unsigned n_i, unsigned j0, unsigned n_j) const
vil_image_view_base_sptr	get_view () const
vil_image_view_base_sptr	get_copy_view () const
bool	put_view (const vil_image_view_base &im)
virtual bool	view_fits (const vil_image_view_base &im, unsigned i0, unsigned j0)
virtual char const *	file_format () const
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)
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)
bool	vil_copy_deep (const vil_image_resource_sptr &src, vil_image_resource_sptr &dest)
vil_image_resource_sptr	vil_crop (const vil_image_resource_sptr &src, unsigned i0, unsigned n_i, unsigned j0, unsigned n_j)
vil_image_resource_sptr	vil_decimate (const vil_image_resource_sptr &src, unsigned i_factor, unsigned j_factor=0)
vil_image_resource_sptr	vil_load_image_resource (char const *filename)
vil_image_resource_sptr	vil_new_image_resource (unsigned ni, unsigned nj, vil_image_resource_sptr const &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)
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)
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)
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)
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)
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)
bool	vil_save_image_resource (const vil_image_resource_sptr &ir, char const filename, char const file_format)
bool	vil_save_image_resource (const vil_image_resource_sptr &ir, char const *filename)
Protected Member Functions
void	ref ()
void	unref ()
Protected Attributes
int	reference_count_
Private Member Functions
bool	find_image_properties ()
	try to find the image format and size from the current frame.
vil_image_view_base_sptr	create_empty_view () const
	create an empty image of the appropriate type and size.
Private Attributes
vidl2_istream_sptr	istream_
int	frame_number_
unsigned int	ni_
unsigned int	nj_
unsigned int	np_
vil_pixel_format	format_
Friends
friend class	vil_smart_ptr