Merge pull request #85 from deepghs/dev/bg

dev(narugo): add background resource
deepghs · May 3, 2024 · 8e1d5a0 · 8e1d5a0
2 parents c25b9e0 + 18161f5
commit 8e1d5a0
Show file tree

Hide file tree

Showing 12 changed files with 1,118 additions and 1 deletion.
diff --git a/docs/source/api_doc/resource/background.rst b/docs/source/api_doc/resource/background.rst
@@ -0,0 +1,51 @@
+imgutils.resource.background
+=======================================
+
+.. currentmodule:: imgutils.resource.background
+
+.. automodule:: imgutils.resource.background
+
+
+BackgroundImageSet
+------------------------------------------
+
+.. autoclass:: BackgroundImageSet
+    :members: __init__, list_image_files, get_image_file, get_image, random_image_file, random_image
+
+
+
+list_bg_image_files
+------------------------------------------
+
+.. autofunction:: list_bg_image_files
+
+
+
+get_bg_image_file
+------------------------------------------
+
+.. autofunction:: get_bg_image_file
+
+
+
+get_bg_image
+------------------------------------------
+
+.. autofunction:: get_bg_image
+
+
+
+random_bg_image_file
+------------------------------------------
+
+.. autofunction:: random_bg_image_file
+
+
+
+random_bg_image
+------------------------------------------
+
+.. autofunction:: random_bg_image
+
+
+
diff --git a/docs/source/api_doc/resource/background_full.plot.py b/docs/source/api_doc/resource/background_full.plot.py
@@ -0,0 +1,16 @@
+import random
+
+from imgutils.resource import list_bg_image_files, get_bg_image
+from plot import image_plot
+
+if __name__ == '__main__':
+    filenames = random.sample(list_bg_image_files(), 9)
+
+    image_plot(
+        *(
+            (get_bg_image(filename), filename)
+            for filename in filenames
+        ),
+        columns=3,
+        figsize=(14, 10),
+    )
diff --git a/docs/source/api_doc/resource/background_full.plot.py.svg b/docs/source/api_doc/resource/background_full.plot.py.svg
diff --git a/docs/source/api_doc/resource/index.rst b/docs/source/api_doc/resource/index.rst
@@ -0,0 +1,14 @@
+imgutils.resource
+=====================
+
+.. currentmodule:: imgutils.resource
+
+.. automodule:: imgutils.resource
+
+
+.. toctree::
+    :maxdepth: 3
+
+    background
+
+
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -37,6 +37,7 @@ configuration file's structure and their versions.
     api_doc/ocr/index
     api_doc/operate/index
     api_doc/pose/index
+    api_doc/resource/index
     api_doc/restore/index
     api_doc/sd/index
     api_doc/segment/index

diff --git a/imgutils/resource/__init__.py b/imgutils/resource/__init__.py
@@ -0,0 +1,5 @@
+"""
+Overview:
+    Quickly get some basic resources. E.g. high quality background images.
+"""
+from .background import *