boost::gil::image

container interface over image view. Models ImageConcept, PixelBasedConcept

Synopsis

Declared in <boost/gil/image.hpp>

template<
    typename Pixel,
    bool IsPlanar = false,
    typename Alloc = std::allocator<unsigned char>>
class image;

Description

/////////////////////////////////////////////////////////////////////////////////////

A 2D container whose elements are pixels. It is templated over the pixel type, a boolean indicating whether it should be planar, and an optional allocator.

Note that its element type does not have to be a pixel. image can be instantiated with any Regular element, in which case it models the weaker RandomAccess2DImageConcept and does not model PixelBasedConcept

When recreating an image of the same or smaller size the memory will be reused if possible.

/////////////////////////////////////////////////////////////////////////////////////

Type Aliases

Name

allocator_type

const_view_t

coord_t

point_t

value_type

view_t

x_coord_t

y_coord_t

Member Functions

Name

Description

image [constructor]

Constructors

~image [destructor]

Destructor

operator=

Assignment operators

allocator

dimensions

height

recreate

//////////////////

swap

width

Data Members

Name

_view

Friends

Name

Description

boost::gil::image

container interface over image view. Models ImageConcept, PixelBasedConcept

Non-Member Functions

Name

Description

const_view

Returns the constant‐pixel view of an image

extend_boundary

adds new row and column at all sides. Image padding introduces new pixels around the edges of an image. The border provides space for annotations or acts as a boundary when using advanced filtering techniques.

extend_col

adds new column at left and right. Image padding introduces new pixels around the edges of an image. The border provides space for annotations or acts as a boundary when using advanced filtering techniques.

extend_row

adds new row at top and bottom. Image padding introduces new pixels around the edges of an image. The border provides space for annotations or acts as a boundary when using advanced filtering techniques.

operator!=

Inequality operator

operator==

Equality operator

view

Returns the non‐constant‐pixel view of an image

Created with MrDocs