Merge pull request #189 from e10harvey/doc_strings_exist_common_cv

common/lib/cv: Test docs

doc/source/_static/full_width_theme.css

@@ -2,4 +2,7 @@
   height: 100%;
   max-width: 100% !important;
   margin: auto;
+}
+.py.property {
+  display: block !important;
 }

doc/source/library_reference/common/lib/cv/SpotAnalysis/base_classes.rst

@@ -42,11 +42,4 @@ These are the book keeping classes that enable the spot analysis pipeline.
    :special-members: __init__
    :undoc-members:
    :show-inheritance:
-   :member-order: bysource
-
-.. automodule:: opencsp.common.lib.cv.CacheableImage
-   :members:
-   :special-members: __init__
-   :undoc-members:
-   :show-inheritance:
-   :member-order: groupwise
+   :member-order: bysource

doc/source/library_reference/common/lib/cv/config.rst

@@ -0,0 +1,101 @@
+Base Classes
+============
+
+.. currentmodule:: opencsp.common.lib.cv.CacheableImage
+
+.. automodule:: opencsp.common.lib.cv.CacheableImage
+   :members:
+   :special-members: __init__
+   :undoc-members:
+   :show-inheritance:
+   :member-order: groupwise
+
+.. currentmodule:: opencsp.common.lib.cv.OpticalFlow
+
+.. automodule:: opencsp.common.lib.cv.OpticalFlow
+   :members:
+   :special-members: __init__
+   :undoc-members:
+   :show-inheritance:
+   :member-order: groupwise
+
+Utility Functions
+=================
+
+image_filters
+-------------
+
+.. currentmodule:: opencsp.common.lib.cv.image_filters
+
+.. automodule:: opencsp.common.lib.cv.image_filters
+   :members:
+   :special-members: __init__
+   :undoc-members:
+   :show-inheritance:
+   :member-order: groupwise
+
+image_reshapers
+---------------
+
+.. currentmodule:: opencsp.common.lib.cv.image_reshapers
+
+.. automodule:: opencsp.common.lib.cv.image_reshapers
+   :members:
+   :special-members: __init__
+   :undoc-members:
+   :show-inheritance:
+   :member-order: groupwise
+
+Fiducials
+=========
+
+.. automodule:: opencsp.common.lib.cv.fiducials.AbstractFiducials
+   :members:
+   :special-members: __init__
+   :undoc-members:
+   :show-inheritance:
+   :member-order: groupwise
+
+.. automodule:: opencsp.common.lib.cv.fiducials.BcsFiducial
+   :members:
+   :special-members: __init__
+   :undoc-members:
+   :show-inheritance:
+   :member-order: groupwise
+
+.. automodule:: opencsp.common.lib.cv.fiducials.PointFiducials
+   :members:
+   :special-members: __init__
+   :undoc-members:
+   :show-inheritance:
+   :member-order: groupwise
+
+Annotations
+===========
+
+.. currentmodule:: opencsp.common.lib.cv.annotations.AbstractAnnotations
+
+.. automodule:: opencsp.common.lib.cv.annotations.AbstractAnnotations
+   :members:
+   :special-members: __init__
+   :undoc-members:
+   :show-inheritance:
+   :member-order: groupwise
+
+.. currentmodule:: opencsp.common.lib.cv.annotations.HotspotAnnotation
+
+.. automodule:: opencsp.common.lib.cv.annotations.HotspotAnnotation
+   :members:
+   :special-members: __init__
+   :undoc-members:
+   :show-inheritance:
+   :member-order: groupwise
+
+.. currentmodule:: opencsp.common.lib.cv.annotations.PointAnnotations
+
+.. automodule:: opencsp.common.lib.cv.annotations.PointAnnotations
+   :members:
+   :special-members: __init__
+   :undoc-members:
+   :show-inheritance:
+   :member-order: groupwise

doc/source/library_reference/common/lib/cv/index.rst

@@ -0,0 +1,10 @@
+Computer Vision (CV)
+====================
+
+This is a collection of computer vision utilities for OpenCSP.
+
+.. toctree::
+   :maxdepth: 1
+
+   config.rst
+   SpotAnalysis/index.rst

doc/source/library_reference/index.rst

@@ -10,4 +10,4 @@ This section describes the OpenCSP classes and interfaces.
    app/target/index.rst
    app/camera_calibration/index.rst
    app/scene_reconstruction/index.rst
-   common/lib/cv/SpotAnalysis/index.rst
+   common/lib/cv/index.rst

opencsp/common/lib/camera/CameraTransform.py

@@ -5,7 +5,7 @@
 
 """
 
-from cv2 import cv2 as cv
+import cv2 as cv
 import numpy as np
 
 import opencsp.common.lib.geometry.geometry_3d as g3d