Skip to content

Commit 8ed6979

Browse files
Updated README.md with BIF histogram test instructions
1 parent cf15380 commit 8ed6979

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ Lillholm, M. & Griffin, L. D. (2008). Novel image feature alphabets for object r
7878
[Author version](http://www.cs.ucl.ac.uk/fileadmin/UCL-CS/images/CGVI/Lewis2.pdf) from UCL's CS department.
7979

8080
## Tests
81+
### BIF classes and orientations
8182
Run tests to verify the output of the library for canonical features for each BIF class using one of:
8283

8384
`mtBifs_test(1);` to print a test report in the Matlab command window.
@@ -90,6 +91,17 @@ and outcome messages for further processing with no printed output.
9091
For more information on running the provided tests and defining additional test
9192
cases of your own, type `doc mtBifs_test` at the Matlab command line.
9293

94+
### BIF histograms
95+
Run a test to verify the fast BIF histogram generation code produces the same
96+
BIF histograms as an idiot-proof pixel-by-pixel calculation using one of:
97+
98+
`mtBifs_roiHistograms_test(1);` to print a test report in the Matlab command window.
99+
100+
`mtBifs_roiHistograms_test(2);` to print test report and also show test image,
101+
BIFs and sample histogram for manual verification.
102+
103+
`[testOutcomes, testOutcomeDetails] = mtBifs_roiHistograms_test(0);` to save the test outcomes
104+
and outcome messages for further processing with no printed output.
93105

94106
## Citation
95107
O'Reilly, Martin (2016): BifLib Matlab BIF library. figshare.

0 commit comments

Comments
 (0)