short description in each function

nirmallab · Mar 4, 2024 · 182cd14 · 182cd14
1 parent 466af72
commit 182cd14
Show file tree

Hide file tree

Showing 7 changed files with 18 additions and 14 deletions.
diff --git a/.DS_Store b/.DS_Store
diff --git a/dist/pixelpartitioner-1.0.1-py3-none-any.whl b/dist/pixelpartitioner-1.0.1-py3-none-any.whl
diff --git a/dist/pixelpartitioner-1.0.1.tar.gz b/dist/pixelpartitioner-1.0.1.tar.gz
diff --git a/pixelpartitioner/PixelPartitioner.py b/pixelpartitioner/PixelPartitioner.py
@@ -3,12 +3,13 @@
 # Created on Tue Feb 13 22:02:40 2024
 # @author: Ajit Johnson Nirmal
 """
+!!! abstract "Short Description"
+    The `PixelPartitioner` function applies multi-class OTSU thresholding to a set of images 
+    to partition pixels based on intensity. It iteratively increases the number of classes for 
+    images with a high percentage of pixels exceeding a specified threshold, accumulating 
+    results in a DataFrame. The final results are saved in a CSV file within the specified output folder.
 
-The `PixelPartitioner` function applies multi-class OTSU thresholding to a set of images 
-to partition pixels based on intensity. It iteratively increases the number of classes for 
-images with a high percentage of pixels exceeding a specified threshold, accumulating 
-results in a DataFrame. The final results are saved in a CSV file within the specified output folder.
-
+## Function
 """
 
 

diff --git a/pixelpartitioner/getImages.py b/pixelpartitioner/getImages.py
@@ -4,10 +4,12 @@
 #@author: Ajit johnson Nirmal
 
 """
-The `pp.getImages` function retrieves image file paths from a specified directory, 
-with an optional filter for file extensions. It simplifies collecting images for analysis, 
-allowing for specific format selection in folders with multiple elements. 
+!!! abstract "Short Description"
+    The `pp.getImages` function retrieves image file paths from a specified directory, 
+    with an optional filter for file extensions. It simplifies collecting images for analysis, 
+    allowing for specific format selection in folders with multiple elements. 
 
+## Function
 """
 # import 
 import os

diff --git a/pixelpartitioner/plotPixel.py b/pixelpartitioner/plotPixel.py
@@ -3,12 +3,13 @@
 # Created on Sun Mar  3 14:13:43 2024
 # @author: Ajit Johnson Nirmal
 """
+!!! abstract "Short Description"
+    The `plotPixel` function visualizes the effect of multi-class OTSU thresholding on an image, 
+    highlighting the positive regions determined by the threshold. he result is a side-by-side plot 
+    of the original and highlighted images, with a quantitative display of the positive pixels' 
+    percentage.
 
-The `plotPixel` function visualizes the effect of multi-class OTSU thresholding on an image, 
-highlighting the positive regions determined by the threshold. he result is a side-by-side plot 
-of the original and highlighted images, with a quantitative display of the positive pixels' 
-percentage.
-
+## Function
 """
 
 #import

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pixelpartitioner"
-version = "1.0.1"
+version = "1.0.2"
 description = "Tools for pixel partitioning, intensity-based segmentation, and visualization."
 authors = ["Ajit Johnson Nirmal <ajitjohnson.n@gmail.com>"]
 readme = "README.md"