diff options
| author | Théo de la Hogue | 2023-02-20 15:07:16 +0100 |
|---|---|---|
| committer | Théo de la Hogue | 2023-02-20 15:07:16 +0100 |
| commit | 7bb79c6600e594c6504dd20d704f521db6854f2a (patch) | |
| tree | 20cc8856cf6290301efe57d35094033816ba2116 /src | |
| parent | 051281dda49cf7de68dab863c3261def80ad9a8b (diff) | |
| download | argaze-7bb79c6600e594c6504dd20d704f521db6854f2a.zip argaze-7bb79c6600e594c6504dd20d704f521db6854f2a.tar.gz argaze-7bb79c6600e594c6504dd20d704f521db6854f2a.tar.bz2 argaze-7bb79c6600e594c6504dd20d704f521db6854f2a.tar.xz | |
Commenting what circle_intersection fuction returns
Diffstat (limited to 'src')
| -rw-r--r-- | src/argaze/AreaOfInterest/AOIFeatures.py | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/src/argaze/AreaOfInterest/AOIFeatures.py b/src/argaze/AreaOfInterest/AOIFeatures.py index ea57866..c1df8f1 100644 --- a/src/argaze/AreaOfInterest/AOIFeatures.py +++ b/src/argaze/AreaOfInterest/AOIFeatures.py @@ -148,9 +148,15 @@ class AreaOfInterest(numpy.ndarray): return tuple(numpy.rint(Lp).astype(int)) def circle_intersection(self, center: tuple, radius: float) -> Tuple[numpy.array, float, float]: - """Get intersection shape with a circle, intersection area / AOI area ration and intersection area / circle area ration. + """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 + """ assert(self.dimension == 2) |