diff options
| -rw-r--r-- | src/argaze/AreaOfInterest/AOIFeatures.py | 22 |
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) |