aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authordan sinclair <dsinclair@chromium.org>2019-08-03 13:51:11 -0400
committerGitHub <noreply@github.com>2019-08-03 13:51:11 -0400
commite9e2a52ea8282b482c8e4026ed23e986c1fb6177 (patch)
treef66927b5ef85fdec9e6f4ea3553562883bc557f1 /docs
parent5bb9c644ec17a298d901152e9a8e10f8d08c2ee3 (diff)
downloadamber-e9e2a52ea8282b482c8e4026ed23e986c1fb6177.tar.gz
Add root mean square error buffer comparison (#602)
This CL adds a `RMSE_BUFFER` comparator which can be used with two buffers to verify their values are within a given tolerance using the root mean square error comparison method. Issue #600
Diffstat (limited to 'docs')
-rw-r--r--docs/amber_script.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/amber_script.md b/docs/amber_script.md
index 16d1e41..3349270 100644
--- a/docs/amber_script.md
+++ b/docs/amber_script.md
@@ -418,6 +418,7 @@ CLEAR {pipeline}
* `EQ_RGB`
* `EQ_RGBA`
* `EQ_BUFFER`
+ * `RMSE_BUFFER`
```groovy
# Checks that |buffer_name| at |x| has the given |value|s when compared
@@ -446,6 +447,11 @@ EXPECT {buffer_name} IDX _x_in_pixels_ _y_in_pixels_ \
# Checks that |buffer_1| contents are equal to those of |buffer_2|
EXPECT {buffer_1} EQ_BUFFER {buffer_2}
+
+# Checks that the Root Mean Square Error when comparing |buffer_1| to
+# |buffer_2| is less than or equal too |tolerance|. Note, |tolerance| is a
+# unit-less number.
+EXPECT {buffer_1} RMSE_BUFFER {buffer_2} TOLERANCE _value_
```
## Examples