vil1_mit_generic_image Class Reference

#include <vil1_mit.h>

Inheritance diagram for vil1_mit_generic_image:

vil1_image_impl List of all members.

Detailed Description

Generic image implementation for MIT files.

Definition at line 52 of file vil1_mit.h.


Public Member Functions

 vil1_mit_generic_image (vil1_stream *is)
 vil1_mit_generic_image (vil1_stream *is, int planes, int width, int height, int components, int bits_per_component, vil1_component_format format)
 ~vil1_mit_generic_image ()
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 int bytes_per_pixel () const
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 the image interpreted as rgb bytes.
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 ()
bool write_header ()

Private Attributes

vil1_streamis_
int magic_
int width_
int height_
int maxval_
int start_of_data_
int components_
int bits_per_component_
int type_
int bits_per_pixel_

Friends

class vil1_mit_file_format

Constructor & Destructor Documentation

vil1_mit_generic_image::vil1_mit_generic_image ( vil1_stream is  ) 

Definition at line 110 of file vil1_mit.cxx.

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

Definition at line 133 of file vil1_mit.cxx.

vil1_mit_generic_image::~vil1_mit_generic_image (  ) 

Definition at line 165 of file vil1_mit.cxx.


Member Function Documentation

bool vil1_mit_generic_image::read_header (  )  [private]

Definition at line 170 of file vil1_mit.cxx.

bool vil1_mit_generic_image::write_header (  )  [private]

Definition at line 189 of file vil1_mit.cxx.

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

Dimensions. Planes x W x H x Components.

Implements vil1_image_impl.

Definition at line 83 of file vil1_mit.h.

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

Dimensions: Planes x W x H x Components.

Implements vil1_image_impl.

Definition at line 84 of file vil1_mit.h.

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

Dimensions: Planes x W x H x Components.

Implements vil1_image_impl.

Definition at line 85 of file vil1_mit.h.

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

Dimensions: Planes x W x H x Components.

Implements vil1_image_impl.

Definition at line 86 of file vil1_mit.h.

virtual int vil1_mit_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 88 of file vil1_mit.h.

virtual int vil1_mit_generic_image::bytes_per_pixel (  )  const [inline, virtual]

Definition at line 93 of file vil1_mit.h.

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

Format.

A standard RGB RGB RGB image has

Implements vil1_image_impl.

Definition at line 98 of file vil1_mit.h.

bool vil1_mit_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 199 of file vil1_mit.cxx.

bool vil1_mit_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 223 of file vil1_mit.cxx.

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

Return the image interpreted as rgb bytes.

virtual bool get_section_rgb_byte(void* buf, int x0, int y0, int width, int height) const; virtual bool get_section_float(void* buf, int x0, int y0, int width, int height) const; virtual bool get_section_byte(void* buf, int x0, int y0, int width, int height) const;

Reimplemented from vil1_image_impl.

Definition at line 128 of file vil1_mit.cxx.

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

Extra property information.

Reimplemented from vil1_image_impl.

Definition at line 117 of file vil1_mit.cxx.

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

return the ith plane.

Reimplemented from vil1_image_impl.

Definition at line 245 of file vil1_mit.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_mit_file_format [friend]

Definition at line 70 of file vil1_mit.h.


Member Data Documentation

vil1_stream* vil1_mit_generic_image::is_ [private]

Definition at line 54 of file vil1_mit.h.

int vil1_mit_generic_image::magic_ [private]

Definition at line 55 of file vil1_mit.h.

int vil1_mit_generic_image::width_ [private]

Definition at line 56 of file vil1_mit.h.

int vil1_mit_generic_image::height_ [private]

Definition at line 57 of file vil1_mit.h.

int vil1_mit_generic_image::maxval_ [private]

Definition at line 58 of file vil1_mit.h.

int vil1_mit_generic_image::start_of_data_ [private]

Definition at line 60 of file vil1_mit.h.

int vil1_mit_generic_image::components_ [private]

Definition at line 61 of file vil1_mit.h.

int vil1_mit_generic_image::bits_per_component_ [private]

Definition at line 62 of file vil1_mit.h.

int vil1_mit_generic_image::type_ [private]

Definition at line 64 of file vil1_mit.h.

int vil1_mit_generic_image::bits_per_pixel_ [private]

Definition at line 65 of file vil1_mit.h.


The documentation for this class was generated from the following files:
Generated on Thu Aug 21 05:08:19 2008 for core/vil1 by  doxygen 1.5.1