index.rst 1.9 KB

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