doc: Update RST for camera

sandialabs · Nov 27, 2024 · 7a5b3a8 · 7a5b3a8
1 parent f329198
commit 7a5b3a8
Show file tree

Hide file tree

Showing 4 changed files with 68 additions and 1 deletion.
diff --git a/doc/source/library_reference/common/lib/camera/config.rst b/doc/source/library_reference/common/lib/camera/config.rst
@@ -0,0 +1,56 @@
+Base Class
+==========
+
+.. currentmodule:: opencsp.common.lib.camera.Camera
+
+.. automodule:: opencsp.common.lib.camera.Camera
+   :members:
+   :special-members: __init__
+   :undoc-members:
+   :show-inheritance:
+   :member-order: groupwise
+
+Image Acquisition Classes
+=========================
+
+.. currentmodule:: opencsp.common.lib.camera.ImageAcquisitionAbstract
+
+.. automodule:: opencsp.common.lib.camera.ImageAcquisitionAbstract
+   :members:
+   :special-members: __init__
+   :undoc-members:
+   :show-inheritance:
+   :member-order: groupwise
+
+.. currentmodule:: opencsp.common.lib.camera.ImageAcquisition_DCAM_color
+
+.. automodule:: opencsp.common.lib.camera.ImageAcquisition_DCAM_color
+   :members:
+   :special-members: __init__
+   :undoc-members:
+   :show-inheritance:
+   :member-order: groupwise
+
+UCamera Classes and Utility Functions
+=====================================
+
+.. currentmodule:: opencsp.common.lib.camera.UCamera
+
+.. automodule:: opencsp.common.lib.camera.UCamera
+   :members:
+   :special-members: __init__
+   :undoc-members:
+   :show-inheritance:
+   :member-order: groupwise
+
+Utility Functions
+=================
+
+.. currentmodule:: opencsp.common.lib.camera.image_processing
+
+.. automodule:: opencsp.common.lib.camera.image_processing
+   :members:
+   :special-members: __init__
+   :undoc-members:
+   :show-inheritance:
+   :member-order: groupwise
diff --git a/doc/source/library_reference/common/lib/camera/index.rst b/doc/source/library_reference/common/lib/camera/index.rst
@@ -0,0 +1,9 @@
+Camera
+======
+
+This is a collection of camera utilities for OpenCSP.
+
+.. toctree::
+   :maxdepth: 1
+
+   config.rst
diff --git a/doc/source/library_reference/index.rst b/doc/source/library_reference/index.rst
@@ -10,4 +10,5 @@ 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/index.rst
+   common/lib/cv/index.rst
+   common/lib/camera/index.rst
diff --git a/opencsp/common/lib/camera/image_processing.py b/opencsp/common/lib/camera/image_processing.py
@@ -13,6 +13,7 @@ def encode_RG_to_RGB(image: np.ndarray) -> np.ndarray:
     image : np.ndarray
         Input 2d image directly from RG Bayer pattern sensor. Pixels are
         arranged as:
+
             R  G  ...
             G  B  ...
             .  .  ...
-Original file line number
+Diff line change
@@ Expand Up / @@ -13,6 +13,7 @@ def encode_RG_to_RGB(image: np.ndarray) -> np.ndarray: @@
         image : np.ndarray
             Input 2d image directly from RG Bayer pattern sensor. Pixels are
             arranged as:
                 R  G  ...
                 G  B  ...
                 .  .  ...
@@ Expand Down @@