.. kwimage documentation master file, created by
   sphinx-quickstart on Sat Feb 16 21:34:45 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.


:gitlab_url: https://gitlab.kitware.com/computer-vision/kwimage

Welcome to kwimage's documentation!
===================================

.. The __init__ files contains the top-level documentation overview
.. autoapimodule:: kwarray
    :show-inheritance:
    :special-members: __init__


Function Usefulness
===================

================================================================ ================
 Function name                                                   Usefulness
================================================================ ================
:func:`kwimage.Boxes`                                                         461
:func:`kwimage.Detections`                                                    245
:func:`kwimage.imwrite`                                                       198
:func:`kwimage.imread`                                                        177
:func:`kwimage.Polygon`                                                       132
:func:`kwimage.imresize`                                                      119
:func:`kwimage.grab_test_image`                                                91
:func:`kwimage.convert_colorspace`                                             80
:func:`kwimage.Color`                                                          74
:func:`kwimage.Mask`                                                           71
:func:`kwimage.ensure_uint255`                                                 71
:func:`kwimage.Points`                                                         63
:func:`kwimage.atleast_3channels`                                              62
:func:`kwimage.ensure_float01`                                                 58
:func:`kwimage.MultiPolygon`                                                   52
:func:`kwimage.ensure_alpha_channel`                                           49
:func:`kwimage.Heatmap`                                                        46
:func:`kwimage.draw_text_on_image`                                             45
:func:`kwimage.stack_images_grid`                                              44
:func:`kwimage.grab_test_image_fpath`                                          41
:func:`kwimage.stack_images`                                                   38
:func:`kwimage.overlay_alpha_layers`                                           28
:func:`kwimage.overlay_alpha_images`                                           27
:func:`kwimage.Coords`                                                         26
:func:`kwimage.MaskList`                                                       25
:func:`kwimage.PolygonList`                                                    25
:func:`kwimage.imscale`                                                        16
:func:`kwimage.PointsList`                                                     15
:func:`kwimage.Segmentation`                                                   14
:func:`kwimage.gaussian_patch`                                                 14
:func:`kwimage.normalize`                                                      14
:func:`kwimage.draw_clf_on_image`                                              14
:func:`kwimage.draw_vector_field`                                              13
:func:`kwimage.make_heatmask`                                                  11
:func:`kwimage.warp_points`                                                    11
:func:`kwimage.warp_tensor`                                                    11
:func:`kwimage.Affine`                                                         11
:func:`kwimage.load_image_shape`                                                9
:func:`kwimage.encode_run_length`                                               8
:func:`kwimage.subpixel_accum`                                                  7
:func:`kwimage.subpixel_slice`                                                  7
:func:`kwimage.non_max_supression`                                              6
:func:`kwimage.num_channels`                                                    6
:func:`kwimage.subpixel_getvalue`                                               5
:func:`kwimage.SegmentationList`                                                5
:func:`kwimage.add_homog`                                                       5
:func:`kwimage.fourier_mask`                                                    4
:func:`kwimage.make_vector_field`                                               4
:func:`kwimage.decode_run_length`                                               4
:func:`kwimage.daq_spatial_nms`                                                 3
:func:`kwimage.rle_translate`                                                   3
:func:`kwimage.padded_slice`                                                    2
:func:`kwimage.make_channels_comparable`                                        2
:func:`kwimage.draw_line_segments_on_image`                                     2
:func:`kwimage.remove_homog`                                                    1
:func:`kwimage.subpixel_maximum`                                                1
:func:`kwimage.subpixel_setvalue`                                               1
:func:`kwimage.subpixel_translate`                                              1
:func:`kwimage.warp_affine`                                                     1
================================================================ ================


.. toctree::
   :maxdepth: 2
   :caption: Contents:

.. .. toctree::
..   kwarray



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`