aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorThéo de la Hogue2024-04-09 17:06:30 +0200
committerThéo de la Hogue2024-04-09 17:06:30 +0200
commitf710965336fbb5c7fb0792d450bc8c80ec835a54 (patch)
treea07749d88cb1838c7c19bb036c17fc2acbd8e910 /src
parent7ecfd846fd2671872aef702deb2f7a52f46ed391 (diff)
downloadargaze-f710965336fbb5c7fb0792d450bc8c80ec835a54.zip
argaze-f710965336fbb5c7fb0792d450bc8c80ec835a54.tar.gz
argaze-f710965336fbb5c7fb0792d450bc8c80ec835a54.tar.bz2
argaze-f710965336fbb5c7fb0792d450bc8c80ec835a54.tar.xz
Fixing doc indentations.
Diffstat (limited to 'src')
-rw-r--r--src/argaze/AreaOfInterest/AOIFeatures.py22
1 files changed, 11 insertions, 11 deletions
diff --git a/src/argaze/AreaOfInterest/AOIFeatures.py b/src/argaze/AreaOfInterest/AOIFeatures.py
index fe4af2c..1a439eb 100644
--- a/src/argaze/AreaOfInterest/AOIFeatures.py
+++ b/src/argaze/AreaOfInterest/AOIFeatures.py
@@ -139,7 +139,7 @@ class AreaOfInterest(numpy.ndarray):
def bounding_box(self) -> numpy.array:
"""Get area's bounding box.
!!! warning
- Available for 2D AOI only."""
+ Available for 2D AOI only."""
assert (self.points_number > 1)
assert (self.dimension == 2)
@@ -152,7 +152,7 @@ class AreaOfInterest(numpy.ndarray):
def clockwise(self) -> Self:
"""Get area points in clockwise order.
!!! warning
- Available for 2D AOI only."""
+ Available for 2D AOI only."""
assert (self.dimension == 2)
@@ -165,9 +165,9 @@ class AreaOfInterest(numpy.ndarray):
def contains_point(self, point: tuple) -> bool:
"""Is a point inside area?
!!! warning
- Available for 2D AOI only.
+ Available for 2D AOI only.
!!! danger
- The AOI points must be sorted in clockwise order."""
+ The AOI points must be sorted in clockwise order."""
assert (self.dimension == 2)
assert (len(point) == self.dimension)
@@ -177,9 +177,9 @@ class AreaOfInterest(numpy.ndarray):
def inner_axis(self, x: float, y: float) -> tuple:
"""Transform a point coordinates from global axis to AOI axis.
!!! warning
- Available for 2D AOI only.
+ Available for 2D AOI only.
!!! danger
- The AOI points must be sorted in clockwise order."""
+ The AOI points must be sorted in clockwise order."""
assert (self.dimension == 2)
@@ -220,12 +220,12 @@ class AreaOfInterest(numpy.ndarray):
def circle_intersection(self, center: tuple, radius: float) -> tuple[numpy.array, float, float]:
"""Get intersection shape with a circle, intersection area / AOI area ratio and intersection area / circle area ratio.
!!! warning
- Available for 2D AOI only.
+ Available for 2D AOI only.
Returns:
- intersection shape
- intersection aoi ratio
- intersection circle ratio
+ intersection shape
+ intersection aoi ratio
+ intersection circle ratio
"""
assert (self.dimension == 2)
@@ -251,7 +251,7 @@ class AreaOfInterest(numpy.ndarray):
def draw(self, image: numpy.array, color, border_size=1):
"""Draw 2D AOI into image.
!!! warning
- Available for 2D AOI only."""
+ Available for 2D AOI only."""
assert (self.dimension == 2)