#include <vil1_image.h>
Inheritance diagram for vil1_image:
All operations are delegated to the vil1_image_impl object, which uses class inheritance to make various file images etc. For fuller documentation on any method, see vil1_image_impl
Imagine that vil1_image is a class derived from vbl_smart_ptr<vil1_image_impl>, but with some extra convenience methods. These methods might traditionally be attached to the abstract base class vil1_image_impl, but this avoids cluttering that interface.
You should not derive from vil1_image to make a new image type. Derive from vil1_image_impl instead.
Definition at line 28 of file vil1_image.h.
Public Member Functions | |
| 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 |
| Format. | |
| enum 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 wd, int ht) const |
| Copy from image to buf. | |
| bool | put_section (void const *buf, int x0, int y0, int wd, int ht) |
| Copy from buf to image. | |
| bool | get_property (char const *tag, void *property_value=0) const |
| Getting property information. | |
| bool | set_property (char const *tag, void const *property_value=0) |
| Setting property information. | |
| char const * | file_format () const |
| Return a string describing the file format. | |
| int | rows () const |
| Number of rows. | |
| int | cols () const |
| Number of columns. | |
| int | get_size_bytes () const |
| return size in bytes. | |
| vcl_ostream & | print (vcl_ostream &) const |
| Print a 1-line summary of contents. | |
| vil1_image (vil1_image_impl *p=0) | |
| vil1_image (vil1_image const &that) | |
| ~vil1_image () | |
| Destructor. | |
| vil1_image & | operator= (vil1_image const &that) |
| vil1_image & | operator= (vil1_image_impl *p) |
| bool | operator== (vil1_image const &that) const |
| equality means equality of implementation, not pixels. | |
| bool | operator< (vil1_image const &that) const |
| needed for sorted containers of images. | |
| operator safe_bool () const | |
| conversion to bool. | |
| bool | operator! () const |
| inverse conversion to bool. | |
| vil1_image_impl * | impl () const |
| use "sptr.impl()" to get a pointer to the impl object. | |
Protected Attributes | |
| vil1_image_impl * | ptr |
Private Attributes | |
| VCL_SAFE_BOOL_DEFINE | |
| vil1_image::vil1_image | ( | vil1_image_impl * | p = 0 |
) | [inline] |
Definition at line 93 of file vil1_image.h.
| vil1_image::vil1_image | ( | vil1_image const & | that | ) | [inline] |
Definition at line 99 of file vil1_image.h.
| vil1_image::~vil1_image | ( | ) | [inline] |
| int vil1_image::planes | ( | ) | const [inline] |
| int vil1_image::width | ( | ) | const [inline] |
Dimensions: Planes x W x H x Components.
Reimplemented in vil1_memory_image.
Definition at line 39 of file vil1_image.h.
| int vil1_image::height | ( | ) | const [inline] |
Dimensions: Planes x W x H x Components.
Reimplemented in vil1_memory_image.
Definition at line 42 of file vil1_image.h.
| int vil1_image::components | ( | ) | const [inline] |
| int vil1_image::bits_per_component | ( | ) | const [inline] |
| enum vil1_component_format vil1_image::component_format | ( | ) | const [inline] |
| vil1_image vil1_image::get_plane | ( | unsigned int | p | ) | const [inline] |
| bool vil1_image::get_section | ( | void * | buf, | |
| int | x0, | |||
| int | y0, | |||
| int | wd, | |||
| int | ht | |||
| ) | const [inline] |
| bool vil1_image::put_section | ( | void const * | buf, | |
| int | x0, | |||
| int | y0, | |||
| int | wd, | |||
| int | ht | |||
| ) | [inline] |
| bool vil1_image::get_property | ( | char const * | tag, | |
| void * | property_value = 0 | |||
| ) | const [inline] |
| bool vil1_image::set_property | ( | char const * | tag, | |
| void const * | property_value = 0 | |||
| ) | [inline] |
| char const* vil1_image::file_format | ( | ) | const [inline] |
Return a string describing the file format.
Only file images have a format, others return 0
Definition at line 75 of file vil1_image.h.
| int vil1_image::rows | ( | ) | const [inline] |
| int vil1_image::cols | ( | ) | const [inline] |
| int vil1_image::get_size_bytes | ( | ) | const |
| vcl_ostream & vil1_image::print | ( | vcl_ostream & | ) | const |
| vil1_image& vil1_image::operator= | ( | vil1_image const & | that | ) | [inline] |
Reimplemented in vil1_memory_image_of< T >, and vil1_memory_image_of< vxl_byte >.
Definition at line 111 of file vil1_image.h.
| vil1_image& vil1_image::operator= | ( | vil1_image_impl * | p | ) | [inline] |
Definition at line 122 of file vil1_image.h.
| bool vil1_image::operator== | ( | vil1_image const & | that | ) | const [inline] |
| bool vil1_image::operator< | ( | vil1_image const & | that | ) | const [inline] |
| vil1_image::operator safe_bool | ( | ) | const [inline] |
| bool vil1_image::operator! | ( | ) | const [inline] |
| vil1_image_impl* vil1_image::impl | ( | ) | const [inline] |
vil1_image::VCL_SAFE_BOOL_DEFINE [private] |
Definition at line 30 of file vil1_image.h.
vil1_image_impl* vil1_image::ptr [protected] |
Definition at line 155 of file vil1_image.h.
1.5.1