Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

common/lib/cv: Test docs #189

Merged
merged 11 commits into from
Dec 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions doc/source/_static/full_width_theme.css
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,7 @@
height: 100%;
max-width: 100% !important;
margin: auto;
}
.py.property {
display: block !important;
e10harvey marked this conversation as resolved.
Show resolved Hide resolved
}
Original file line number Diff line number Diff line change
Expand Up @@ -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
101 changes: 101 additions & 0 deletions doc/source/library_reference/common/lib/cv/config.rst
Original file line number Diff line number Diff line change
@@ -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
e10harvey marked this conversation as resolved.
Show resolved Hide resolved

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
10 changes: 10 additions & 0 deletions doc/source/library_reference/common/lib/cv/index.rst
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion doc/source/library_reference/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion opencsp/common/lib/camera/CameraTransform.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading
Loading