summaryrefslogtreecommitdiff
path: root/integralimg.go
diff options
context:
space:
mode:
authorNick White <git@njw.name>2020-08-03 16:35:51 +0100
committerNick White <git@njw.name>2020-08-03 16:35:51 +0100
commit55560bf16ee70335dcb72f80a3f6dacfb88d7ae8 (patch)
tree913fddfe8e730985a321476e86f184971994f176 /integralimg.go
parenteca5854cfec5ec4a13312bd5fdae81f66be3a673 (diff)
Improve documentation
Diffstat (limited to 'integralimg.go')
-rw-r--r--integralimg.go8
1 files changed, 4 insertions, 4 deletions
diff --git a/integralimg.go b/integralimg.go
index f53938d..3585703 100644
--- a/integralimg.go
+++ b/integralimg.go
@@ -180,23 +180,23 @@ func (i Image) bottomRight(r image.Rectangle) uint64 {
return i[y][x]
}
-// Sum returns the sum of all pixels in a rectangle
+// Sum returns the sum of all pixels in a section of an image
func (i Image) Sum(r image.Rectangle) uint64 {
return i.bottomRight(r) + i.topLeft(r) - i.topRight(r) - i.bottomLeft(r)
}
-// Mean returns the average value of pixels in a rectangle
+// Mean returns the average value of pixels in a section of an image
func (i Image) Mean(r image.Rectangle) float64 {
in := r.Intersect(i.Bounds())
return float64(i.Sum(r)) / float64(in.Dx()*in.Dy())
}
-// Sum returns the sum of all pixels in a rectangle
+// Sum returns the sum of all pixels in a section of an image
func (i SqImage) Sum(r image.Rectangle) uint64 {
return Image(i).Sum(r)
}
-// Mean returns the average value of pixels in a rectangle
+// Mean returns the average value of pixels in a section of an image
func (i SqImage) Mean(r image.Rectangle) float64 {
return Image(i).Mean(r)
}