vil1_image_as_impl< T > Struct Template Reference

Inheritance diagram for vil1_image_as_impl< T >:

vil1_image_impl vil1_memory_image_of_format< T > vil1_memory_image_format List of all members.

Detailed Description

template<class T>
struct vil1_image_as_impl< T >

Definition at line 23 of file vil1_image_as.cxx.


Public Types

typedef vil1_memory_image_of_format<
T > 
format

Public Member Functions

 vil1_image_as_impl (vil1_image const &underlying)
int planes () const
 Dimensions: Planes x W x H x Components.
int width () const
 Dimensions: Planes x W x H x Components.
int height () const
 Dimensions: Planes x W x H x Components.
int components () const
 Dimensions: Planes x W x H x Components.
int bits_per_component () const
 Number of bits per component.
vil1_component_format component_format () const
 Format.
vil1_image get_plane (unsigned int p) const
 return the ith plane.
bool get_section (void *buf, int x0, int y0, int width, int height) const
 Copy buffer of this to BUF.
bool put_section (void const *, int, int, int, int)
 Copy plane PLANE of BUF to this.
virtual vcl_string is_a () const
 Return the name of the class;.
virtual bool is_class (vcl_string const &) const
 Return true if the name of the class matches the argument.
virtual char const * file_format () const
 Return a string describing the file format.
virtual bool get_property (char const *tag, void *property_value=0) const
 Extra property information.
virtual bool set_property (char const *tag, void const *property_value=0) const

Public Attributes

vil1_image image
int components
int bits_per_component
vil1_component_format component_format

Member Typedef Documentation

template<class T>
typedef vil1_memory_image_of_format<T> vil1_image_as_impl< T >::format

Definition at line 25 of file vil1_image_as.cxx.


Constructor & Destructor Documentation

template<class T>
vil1_image_as_impl< T >::vil1_image_as_impl ( vil1_image const &  underlying  )  [inline]

Definition at line 27 of file vil1_image_as.cxx.


Member Function Documentation

template<class T>
int vil1_image_as_impl< T >::planes (  )  const [inline, virtual]

Dimensions: Planes x W x H x Components.

Implements vil1_image_impl.

Definition at line 28 of file vil1_image_as.cxx.

template<class T>
int vil1_image_as_impl< T >::width (  )  const [inline, virtual]

Dimensions: Planes x W x H x Components.

Implements vil1_image_impl.

Definition at line 29 of file vil1_image_as.cxx.

template<class T>
int vil1_image_as_impl< T >::height (  )  const [inline, virtual]

Dimensions: Planes x W x H x Components.

Implements vil1_image_impl.

Definition at line 30 of file vil1_image_as.cxx.

template<class T>
int vil1_image_as_impl< T >::components (  )  const [inline, virtual]

Dimensions: Planes x W x H x Components.

Implements vil1_image_impl.

Definition at line 31 of file vil1_image_as.cxx.

template<class T>
int vil1_image_as_impl< T >::bits_per_component (  )  const [inline, virtual]

Number of bits per component.

Size (in bits) for the smallest entity of the image.

Implements vil1_image_impl.

Definition at line 32 of file vil1_image_as.cxx.

template<class T>
vil1_component_format vil1_image_as_impl< T >::component_format (  )  const [inline, virtual]

Format.

A standard RGB RGB RGB image has

Implements vil1_image_impl.

Definition at line 33 of file vil1_image_as.cxx.

template<class T>
vil1_image vil1_image_as_impl< T >::get_plane ( unsigned int  p  )  const [inline, virtual]

return the ith plane.

Reimplemented from vil1_image_impl.

Definition at line 34 of file vil1_image_as.cxx.

template<class T>
VCL_DEFINE_SPECIALIZATION bool vil1_image_as_impl< T >::get_section ( void *  buf,
int  x0,
int  y0,
int  width,
int  height 
) const [virtual]

Copy buffer of this to BUF.

The buffer is stored like this for each pixel: component0(plane0,plane1,plane2,...),component1(plane0,plane1,plane2,...),...
total size of BUF in bytes should be (bits_per_component * components + 7) / 8 i.e. rounding to the next multiple of 8 bits (only correct if 1 byte = 8 bits)

Implements vil1_image_impl.

Definition at line 257 of file vil1_image_as.cxx.

template<class T>
bool vil1_image_as_impl< T >::put_section ( void const *  ,
int  ,
int  ,
int  ,
int   
) [inline, virtual]

Copy plane PLANE of BUF to this.

The buffer should look like this for each pixel: component0(plane0,plane1,plane2,...),component1(plane0,plane1,plane2,...),...
total size of BUF in bytes should be (bits_per_component * components + 7) / 8 i.e. rounding to the next multiple of 8 bits (only correct if 1 byte = 8 bits)

Implements vil1_image_impl.

Definition at line 46 of file vil1_image_as.cxx.

template<class T>
VCL_DEFINE_SPECIALIZATION vcl_string vil1_image_as_impl< T >::is_a (  )  const [virtual]

Return the name of the class;.

Reimplemented from vil1_image_impl.

Definition at line 291 of file vil1_image_as.cxx.

template<class T>
VCL_DEFINE_SPECIALIZATION bool vil1_image_as_impl< T >::is_class ( vcl_string const &   )  const [virtual]

Return true if the name of the class matches the argument.

Reimplemented from vil1_image_impl.

Definition at line 298 of file vil1_image_as.cxx.

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

Return a string describing the file format.

Only file images have a format, others return 0

Reimplemented in vil1_bmp_generic_image, vil1_gen_generic_image, vil1_gif_loader_saver, vil1_gif_loader_saver_proxy, vil1_iris_generic_image, vil1_jpeg_generic_image, vil1_mit_generic_image, vil1_png_generic_image, vil1_pnm_generic_image, vil1_ras_generic_image, vil1_tiff_generic_image, vil1_viff_generic_image, and vil1_image_proxy_impl.

Definition at line 134 of file vil1_image_impl.h.

bool vil1_image_impl::get_property ( char const *  tag,
void *  property_value = 0 
) const [virtual, inherited]

Extra property information.

Reimplemented in vil1_bmp_generic_image, vil1_gen_generic_image, vil1_gif_loader_saver, vil1_iris_generic_image, vil1_jpeg_generic_image, vil1_mit_generic_image, vil1_png_generic_image, vil1_pnm_generic_image, vil1_ras_generic_image, vil1_tiff_generic_image, vil1_viff_generic_image, vil1_block_cache_image_impl, vil1_image_proxy_impl, vil1_memory_image_impl, vil1_resample_image_impl, and vil1_skip_image_impl.

Definition at line 23 of file vil1_image_impl.cxx.

bool vil1_image_impl::set_property ( char const *  tag,
void const *  property_value = 0 
) const [virtual, inherited]

Reimplemented in vil1_tiff_generic_image, and vil1_image_proxy_impl.

Definition at line 28 of file vil1_image_impl.cxx.


Member Data Documentation

template<class T>
vil1_image vil1_image_as_impl< T >::image

Definition at line 26 of file vil1_image_as.cxx.

int vil1_memory_image_format::components [inherited]

Definition at line 26 of file vil1_memory_image.h.

int vil1_memory_image_format::bits_per_component [inherited]

Definition at line 27 of file vil1_memory_image.h.

vil1_component_format vil1_memory_image_format::component_format [inherited]

Definition at line 28 of file vil1_memory_image.h.


The documentation for this struct was generated from the following file:
Generated on Sat Nov 22 05:08:31 2008 for core/vil1 by  doxygen 1.5.1