diff options
Diffstat (limited to 'src/argaze/AreaOfInterest/AOIFeatures.py')
-rw-r--r-- | src/argaze/AreaOfInterest/AOIFeatures.py | 56 |
1 files changed, 28 insertions, 28 deletions
diff --git a/src/argaze/AreaOfInterest/AOIFeatures.py b/src/argaze/AreaOfInterest/AOIFeatures.py index a40eaca..438e15f 100644 --- a/src/argaze/AreaOfInterest/AOIFeatures.py +++ b/src/argaze/AreaOfInterest/AOIFeatures.py @@ -72,8 +72,8 @@ class AreaOfInterest(numpy.ndarray): @property def bounding_box(self) -> numpy.array: """Get area's bounding box. - .. warning:: - Available for 2D AOI only.""" + !!! warning + Available for 2D AOI only.""" assert(self.size > 1) assert(self.dimension == 2) @@ -85,8 +85,8 @@ class AreaOfInterest(numpy.ndarray): def clockwise(self) -> AreaOfInterestType: """Get area points in clockwise order. - .. warning:: - Available for 2D AOI only.""" + !!! warning + Available for 2D AOI only.""" assert(self.dimension == 2) @@ -98,10 +98,10 @@ class AreaOfInterest(numpy.ndarray): def contains_point(self, point: tuple) -> bool: """Is a point inside area? - .. warning:: - Available for 2D AOI only. - .. danger:: - The AOI points must be sorted in clockwise order.""" + !!! warning + Available for 2D AOI only. + !!! danger + The AOI points must be sorted in clockwise order.""" assert(self.dimension == 2) assert(len(point) == self.dimension) @@ -110,10 +110,10 @@ class AreaOfInterest(numpy.ndarray): def inner_axis(self, point: tuple) -> tuple: """Transform the coordinates from the global axis to the AOI's axis. - .. warning:: - Available for 2D AOI only. - .. danger:: - The AOI points must be sorted in clockwise order.""" + !!! warning + Available for 2D AOI only. + !!! danger + The AOI points must be sorted in clockwise order.""" assert(self.dimension == 2) @@ -133,10 +133,10 @@ class AreaOfInterest(numpy.ndarray): def outter_axis(self, point: tuple) -> tuple: """Transform the coordinates from the AOI's axis to the global axis. - .. warning:: - Available for 2D AOI only. - .. danger:: - The AOI points must be sorted in clockwise order.""" + !!! warning + Available for 2D AOI only. + !!! danger + The AOI points must be sorted in clockwise order.""" assert(self.dimension == 2) @@ -156,13 +156,13 @@ 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. + !!! warning + Available for 2D AOI only. - * **Returns:** - - intersection shape, - - intersection aoi ratio, - - intersection circle ratio + Returns: + intersection shape + intersection aoi ratio + intersection circle ratio """ assert(self.dimension == 2) @@ -186,8 +186,8 @@ class AreaOfInterest(numpy.ndarray): def draw(self, frame, color, border_size=1): """Draw 2D AOI into frame. - .. warning:: - Available for 2D AOI only.""" + !!! warning + Available for 2D AOI only.""" assert(self.dimension == 2) @@ -211,8 +211,8 @@ class AOIFrame(): def __init__(self, aoi: AreaOfInterestType, size: tuple): """ - .. warning:: - Available for 2D AOI only.""" + !!! warning + Available for 2D AOI only.""" assert(aoi.dimension == 2) @@ -250,8 +250,8 @@ class AOIFrame(): def heatmap_update(self, point: tuple, sigma: float): """Update heatmap matrix. - .. danger:: - Call heatmap_init() method before any update.""" + !!! danger + Call heatmap_init() method before any update.""" point_spread = self.point_spread(point, sigma) |