vil1_pnm_generic_image Class Reference

#include <vil1_pnm.h>

Inheritance diagram for vil1_pnm_generic_image:

vil1_image_impl List of all members.

Detailed Description

Generic image implementation for PNM files.

Definition at line 36 of file vil1_pnm.h.


Public Member Functions

 vil1_pnm_generic_image (vil1_stream *is)
 vil1_pnm_generic_image (vil1_stream *is, int planes, int width, int height, int components, int bits_per_component, vil1_component_format format)
 ~vil1_pnm_generic_image ()
virtual int planes () const
 Dimensions: planes x width x height x components.
virtual int width () const
 Dimensions: Planes x W x H x Components.
virtual int height () const
 Dimensions: Planes x W x H x Components.
virtual int components () const
 Dimensions: Planes x W x H x Components.
virtual int bits_per_component () const
 Number of bits per component.
virtual enum vil1_component_format component_format () const
 Format.
virtual bool get_section (void *buf, int x0, int y0, int width, int height) const
 Copy contents of this image to buf.
virtual bool put_section (void const *buf, int x0, int y0, int width, int height)
 Copy contents of buf to this image.
char const * file_format () const
 Return a string describing the file format.
bool get_property (char const *tag, void *prop=0) const
 Extra property information.
vil1_image get_plane (unsigned int p) const
 return the ith plane.
virtual bool set_property (char const *tag, void const *property_value=0) const
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.

Private Member Functions

bool read_header ()
 This method accepts any valid PNM file (first 3 bytes "P1\n" to "P6\n").
bool write_header ()

Private Attributes

vil1_streamvs_
int magic_
int width_
int height_
unsigned long int maxval_
int start_of_data_
int components_
int bits_per_component_

Friends

class vil1_pnm_file_format

Constructor & Destructor Documentation

vil1_pnm_generic_image::vil1_pnm_generic_image ( vil1_stream is  ) 

Definition at line 67 of file vil1_pnm.cxx.

vil1_pnm_generic_image::vil1_pnm_generic_image ( vil1_stream is,
int  planes,
int  width,
int  height,
int  components,
int  bits_per_component,
vil1_component_format  format 
)

Definition at line 90 of file vil1_pnm.cxx.

vil1_pnm_generic_image::~vil1_pnm_generic_image (  ) 

Definition at line 124 of file vil1_pnm.cxx.


Member Function Documentation

bool vil1_pnm_generic_image::read_header (  )  [private]

This method accepts any valid PNM file (first 3 bytes "P1\n" to "P6\n").

Definition at line 186 of file vil1_pnm.cxx.

bool vil1_pnm_generic_image::write_header (  )  [private]

Definition at line 249 of file vil1_pnm.cxx.

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

Dimensions: planes x width x height x components.

Implements vil1_image_impl.

Definition at line 64 of file vil1_pnm.h.

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

Dimensions: Planes x W x H x Components.

Implements vil1_image_impl.

Definition at line 65 of file vil1_pnm.h.

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

Dimensions: Planes x W x H x Components.

Implements vil1_image_impl.

Definition at line 66 of file vil1_pnm.h.

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

Dimensions: Planes x W x H x Components.

Implements vil1_image_impl.

Definition at line 67 of file vil1_pnm.h.

virtual int vil1_pnm_generic_image::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 69 of file vil1_pnm.h.

virtual enum vil1_component_format vil1_pnm_generic_image::component_format (  )  const [inline, virtual]

Format.

A standard RGB RGB RGB image has

Implements vil1_image_impl.

Definition at line 70 of file vil1_pnm.h.

bool vil1_pnm_generic_image::get_section ( void *  buf,
int  x0,
int  y0,
int  width,
int  height 
) const [virtual]

Copy contents of this image to buf.

Implements vil1_image_impl.

Definition at line 296 of file vil1_pnm.cxx.

bool vil1_pnm_generic_image::put_section ( void const *  buf,
int  x0,
int  y0,
int  width,
int  height 
) [virtual]

Copy contents of buf to this image.

Implements vil1_image_impl.

Definition at line 381 of file vil1_pnm.cxx.

char const * vil1_pnm_generic_image::file_format (  )  const [virtual]

Return a string describing the file format.

Only file images have a format, others return 0

Reimplemented from vil1_image_impl.

Definition at line 85 of file vil1_pnm.cxx.

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

Extra property information.

Reimplemented from vil1_image_impl.

Definition at line 74 of file vil1_pnm.cxx.

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

return the ith plane.

Reimplemented from vil1_image_impl.

Definition at line 475 of file vil1_pnm.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.

virtual vcl_string vil1_image_impl::is_a (  )  const [inline, virtual, inherited]

Return the name of the class;.

Reimplemented in vil1_block_cache_image_impl, vil1_clamp_image_impl, vil1_crop_image_impl, vil1_flip_components_impl, vil1_flipud_impl, vil1_image_as_impl< T >, vil1_image_proxy_impl, vil1_memory_image_impl, vil1_resample_image_impl, vil1_scale_intensities_image_impl, and vil1_skip_image_impl.

Definition at line 141 of file vil1_image_impl.h.

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

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

Reimplemented in vil1_block_cache_image_impl, vil1_clamp_image_impl, vil1_crop_image_impl, vil1_flip_components_impl, vil1_flipud_impl, vil1_image_as_impl< T >, vil1_image_proxy_impl, vil1_memory_image_impl, vil1_resample_image_impl, vil1_scale_intensities_image_impl, and vil1_skip_image_impl.

Definition at line 144 of file vil1_image_impl.h.


Friends And Related Function Documentation

friend class vil1_pnm_file_format [friend]

Definition at line 51 of file vil1_pnm.h.


Member Data Documentation

vil1_stream* vil1_pnm_generic_image::vs_ [private]

Definition at line 38 of file vil1_pnm.h.

int vil1_pnm_generic_image::magic_ [private]

Definition at line 39 of file vil1_pnm.h.

int vil1_pnm_generic_image::width_ [private]

Definition at line 40 of file vil1_pnm.h.

int vil1_pnm_generic_image::height_ [private]

Definition at line 41 of file vil1_pnm.h.

unsigned long int vil1_pnm_generic_image::maxval_ [private]

Definition at line 42 of file vil1_pnm.h.

int vil1_pnm_generic_image::start_of_data_ [private]

Definition at line 44 of file vil1_pnm.h.

int vil1_pnm_generic_image::components_ [private]

Definition at line 45 of file vil1_pnm.h.

int vil1_pnm_generic_image::bits_per_component_ [private]

Definition at line 46 of file vil1_pnm.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