Skip to content

Commit 3c020a6

Browse files
committed
Explanation on srgb and sxy names. Fixes lucasb-eyer#45.
1 parent 087217c commit 3c020a6

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,12 @@ d.addPairwiseGaussian(sxy=3, compat=3)
103103
d.addPairwiseBilateral(sxy=80, srgb=13, rgbim=im, compat=10)
104104
```
105105

106+
The parameters map to those in the paper as follows: `sxy` in the `Gaussian` case is `$\theta_{\gamma}$`,
107+
and in the `Bilateral` case, `sxy` and `srgb` map to `$\theta_{\alpha}$` and `$\theta_{\beta}$`, respectively.
108+
The names are shorthand for "x/y standard-deviation" and "rgb standard-deviation" and for reference, the formula is:
109+
110+
![Equation 3 in the original paper](https://user-images.githubusercontent.com/10962198/36150757-01122bf2-10c5-11e8-97d2-2e833c1c9461.png)
111+
106112
### Non-RGB bilateral
107113

108114
An important caveat is that `addPairwiseBilateral` only works for RGB images, i.e. three channels.

0 commit comments

Comments
 (0)