libs/gil/doc/index.rst

   1 Boost Generic Image Library
   2 ===========================
   3
   4 The Generic Image Library (GIL) is a C++11 library that abstracts image
   5 representations from algorithms and allows writing code that can work on
   6 a variety of images with performance similar to hand-writing for a specific
   7 image type.
   8
   9 Quickstart
  10 ----------
  11
  12 .. toctree::
  13    :maxdepth: 1
  14
  15    installation
  16    tutorial/video
  17    tutorial/histogram
  18    tutorial/gradient
  19    naming
  20
  21 Core Library Documentation
  22 --------------------------
  23
  24 .. toctree::
  25    :maxdepth: 2
  26
  27    design/index
  28    image_processing/index
  29    API Reference <./reference/index.html#://>
  30
  31 Extensions Documentation
  32 ------------------------
  33
  34 .. toctree::
  35    :maxdepth: 2
  36
  37    io
  38    toolbox
  39    numeric
  40
  41 Examples
  42 --------
  43
  44 * :download:`x_gradient.cpp <../example/x_gradient.cpp>`:
  45   Writing an algorithm that operates on generic images
  46 * :download:`dynamic_image.cpp <../example/dynamic_image.cpp>`:
  47   Using images whose properties (color space, channel type) are specified
  48   at run time
  49 * :download:`histogram.cpp <../example/histogram.cpp>`: Creating a histogram
  50 * :download:`interleaved_ptr.cpp <../example/interleaved_ptr.cpp>`,
  51   :download:`interleaved_ptr.hpp <../example/interleaved_ptr.hpp>`,
  52   :download:`interleaved_ref.hpp <../example/interleaved_ref.hpp>`:
  53   Creating your own pixel reference and pixel iterator
  54 * :download:`mandelbrot.cpp <../example/mandelbrot.cpp>`:
  55   Creating a synthetic image defined by a function
  56 * :download:`packed_pixel.cpp <../example/packed_pixel.cpp>`:
  57   Defining bitmasks and images whose channels or pixels are not byte-aligned
  58 * :download:`resize.cpp <../example/resize.cpp>`:
  59   Rescaling an image using bilinear sampling (requires the optional
  60   Numeric extension)
  61 * :download:`affine.cpp <../example/affine.cpp>`:
  62   Applying an affine transformation to an image (requires the optional
  63   Numeric extension)
  64 * :download:`convolution.cpp <../example/convolution.cpp>`:
  65   Blurring images (requires the optional Numeric extension)