vil1_tiff_generic_image Class Reference

#include <vil1_tiff.h>

Inheritance diagram for vil1_tiff_generic_image:

vil1_image_impl List of all members.

Detailed Description

Generic image interface for TIFF files.

Definition at line 37 of file vil1_tiff.h.


Public Member Functions

 vil1_tiff_generic_image (vil1_stream *is)
 vil1_tiff_generic_image (vil1_stream *is, int planes, int width, int height, int components, int bits_per_component, vil1_component_format format)
 ~vil1_tiff_generic_image ()
void get_resolution (float &x_res, float &y_res, unsigned short &units) const
 TIFF specific fields relating to scanned images.
void set_resolution (float x_res, float y_res, unsigned short units)
virtual int planes () const
 Dimensions. Planes x W x H 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 this to BUF,.
virtual bool put_section (void const *buf, int x0, int y0, int width, int height)
 Copy plane PLANE of BUF to this.
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.
bool set_property (char const *tag, const void *prop=0) const
vil1_image get_plane (unsigned int p) const
 return the ith plane.
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 ()
bool write_header ()

Private Attributes

vil1_tiff_structuresp
int width_
int height_
int components_
int bits_per_component_

Friends

class vil1_tiff_file_format

Constructor & Destructor Documentation

vil1_tiff_generic_image::vil1_tiff_generic_image ( vil1_stream is  ) 

Definition at line 233 of file vil1_tiff.cxx.

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

Definition at line 304 of file vil1_tiff.cxx.

vil1_tiff_generic_image::~vil1_tiff_generic_image (  ) 

Definition at line 320 of file vil1_tiff.cxx.


Member Function Documentation

bool vil1_tiff_generic_image::read_header (  )  [private]

Definition at line 332 of file vil1_tiff.cxx.

bool vil1_tiff_generic_image::write_header (  )  [private]

Definition at line 522 of file vil1_tiff.cxx.

void vil1_tiff_generic_image::get_resolution ( float &  x_res,
float &  y_res,
unsigned short &  units 
) const

TIFF specific fields relating to scanned images.

Definition at line 648 of file vil1_tiff.cxx.

void vil1_tiff_generic_image::set_resolution ( float  x_res,
float  y_res,
unsigned short  units 
)

Definition at line 655 of file vil1_tiff.cxx.

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

Dimensions. Planes x W x H x Components.

Implements vil1_image_impl.

Definition at line 67 of file vil1_tiff.h.

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

Dimensions: Planes x W x H x Components.

Implements vil1_image_impl.

Definition at line 68 of file vil1_tiff.h.

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

Dimensions: Planes x W x H x Components.

Implements vil1_image_impl.

Definition at line 69 of file vil1_tiff.h.

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

Dimensions: Planes x W x H x Components.

Implements vil1_image_impl.

Definition at line 70 of file vil1_tiff.h.

virtual int vil1_tiff_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 72 of file vil1_tiff.h.

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

Format.

A standard RGB RGB RGB image has

Implements vil1_image_impl.

Definition at line 73 of file vil1_tiff.h.

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

Copy this to BUF,.

Implements vil1_image_impl.

Definition at line 662 of file vil1_tiff.cxx.

bool vil1_tiff_generic_image::put_section ( void const *  buf,
int  x0,
int  y0,
int  width,
int  height 
) [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 703 of file vil1_tiff.cxx.

char const * vil1_tiff_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 327 of file vil1_tiff.cxx.

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

Extra property information.

Reimplemented from vil1_image_impl.

Definition at line 239 of file vil1_tiff.cxx.

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

Reimplemented from vil1_image_impl.

Definition at line 268 of file vil1_tiff.cxx.

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

return the ith plane.

Reimplemented from vil1_image_impl.

Definition at line 735 of file vil1_tiff.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_tiff_file_format [friend]

Definition at line 50 of file vil1_tiff.h.


Member Data Documentation

vil1_tiff_structures* vil1_tiff_generic_image::p [private]

Definition at line 39 of file vil1_tiff.h.

int vil1_tiff_generic_image::width_ [private]

Definition at line 41 of file vil1_tiff.h.

int vil1_tiff_generic_image::height_ [private]

Definition at line 42 of file vil1_tiff.h.

int vil1_tiff_generic_image::components_ [private]

Definition at line 44 of file vil1_tiff.h.

int vil1_tiff_generic_image::bits_per_component_ [private]

Definition at line 45 of file vil1_tiff.h.


The documentation for this class was generated from the following files:
Generated on Sat Nov 7 05:09:14 2009 for core/vil1 by  doxygen 1.5.1