vil1_skip_image_impl Class Reference

#include <vil1_skip_image_impl.h>

Inheritance diagram for vil1_skip_image_impl:

vil1_image_impl List of all members.

Detailed Description

Adaptor which produces a new image by skipping rows and columns.

Definition at line 17 of file vil1_skip_image_impl.h.


Public Member Functions

 vil1_skip_image_impl (vil1_image const &underlying, unsigned sx, unsigned sy)
 ~vil1_skip_image_impl ()
int planes () const
 these inlines partly document the semantics of vil1_skip_image.
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 w, int h) const
 Copy buffer of this to BUF.
bool put_section (void const *buf, int x0, int y0, int w, int h)
 Copy plane PLANE of BUF to this.
bool get_property (char const *tag, void *property_value_out=0) const
 Extra property information.
virtual vcl_string is_a () const
 Return the name of the class.
virtual bool is_class (vcl_string const &s) 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 set_property (char const *tag, void const *property_value=0) const

Private Attributes

vil1_image base
unsigned skipx
unsigned skipy

Constructor & Destructor Documentation

vil1_skip_image_impl::vil1_skip_image_impl ( vil1_image const &  underlying,
unsigned  sx,
unsigned  sy 
)

Definition at line 16 of file vil1_skip_image_impl.cxx.

vil1_skip_image_impl::~vil1_skip_image_impl (  )  [inline]

Definition at line 21 of file vil1_skip_image_impl.h.


Member Function Documentation

int vil1_skip_image_impl::planes (  )  const [inline, virtual]

these inlines partly document the semantics of vil1_skip_image.

Implements vil1_image_impl.

Definition at line 24 of file vil1_skip_image_impl.h.

int vil1_skip_image_impl::width (  )  const [inline, virtual]

Dimensions: Planes x W x H x Components.

Implements vil1_image_impl.

Definition at line 25 of file vil1_skip_image_impl.h.

int vil1_skip_image_impl::height (  )  const [inline, virtual]

Dimensions: Planes x W x H x Components.

Implements vil1_image_impl.

Definition at line 26 of file vil1_skip_image_impl.h.

int vil1_skip_image_impl::components (  )  const [inline, virtual]

Dimensions: Planes x W x H x Components.

Implements vil1_image_impl.

Definition at line 27 of file vil1_skip_image_impl.h.

int vil1_skip_image_impl::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 28 of file vil1_skip_image_impl.h.

vil1_component_format vil1_skip_image_impl::component_format (  )  const [inline, virtual]

Format.

A standard RGB RGB RGB image has

Implements vil1_image_impl.

Definition at line 29 of file vil1_skip_image_impl.h.

vil1_image vil1_skip_image_impl::get_plane ( unsigned int  p  )  const [virtual]

return the ith plane.

Reimplemented from vil1_image_impl.

Definition at line 28 of file vil1_skip_image_impl.cxx.

bool vil1_skip_image_impl::get_section ( void *  buf,
int  x0,
int  y0,
int  w,
int  h 
) 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 46 of file vil1_skip_image_impl.cxx.

bool vil1_skip_image_impl::put_section ( void const *  buf,
int  x0,
int  y0,
int  w,
int  h 
) [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 34 of file vil1_skip_image_impl.cxx.

bool vil1_skip_image_impl::get_property ( char const *  tag,
void *  property_value_out = 0 
) const [virtual]

Extra property information.

Reimplemented from vil1_image_impl.

Definition at line 39 of file vil1_skip_image_impl.cxx.

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

Return the name of the class.

Reimplemented from vil1_image_impl.

Definition at line 39 of file vil1_skip_image_impl.h.

virtual bool vil1_skip_image_impl::is_class ( vcl_string const &  s  )  const [inline, virtual]

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

Reimplemented from vil1_image_impl.

Definition at line 42 of file vil1_skip_image_impl.h.

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

vil1_image vil1_skip_image_impl::base [private]

Definition at line 46 of file vil1_skip_image_impl.h.

unsigned vil1_skip_image_impl::skipx [private]

Definition at line 47 of file vil1_skip_image_impl.h.

unsigned vil1_skip_image_impl::skipy [private]

Definition at line 47 of file vil1_skip_image_impl.h.


The documentation for this class was generated from the following files:
Generated on Mon Mar 8 05:09:36 2010 for core/vil1 by  doxygen 1.5.1