Skip to content

Commit

Permalink
Deploying to gh-pages from @ 80f7c0a 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
mwestphal committed Dec 21, 2024
1 parent face912 commit 47323fa
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion assets/js/search-data.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion doc/libf3d/doxygen/api/classf3d_1_1image.html
Original file line number Diff line number Diff line change
Expand Up @@ -574,7 +574,7 @@ <h3>Enumeration of supported channel types<a class="headerlink" href="#classf3d_
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK3f3d5image7compareERK5imagedRd">
<span id="_CPPv3NK3f3d5image7compareERK5imagedRd"></span><span id="_CPPv2NK3f3d5image7compareERK5imagedRd"></span><span id="f3d::image::compare__imageCR.double.doubleRC"></span><span class="target" id="classf3d_1_1image_1a9e3f22780c719f2ada05905e42c056f0"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">compare</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N3f3d5imageE" title="f3d::image"><span class="n"><span class="pre">image</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">reference</span></span>, <span class="kt"><span class="pre">double</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">threshold</span></span>, <span class="kt"><span class="pre">double</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">error</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK3f3d5image7compareERK5imagedRd" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Compare current image to a reference using the provided threshold. If the comparison fails, ie. error is higher than the threshold, this outputs the resulting diff and error and return false, return true otherwise. The error is minimum between Minkownski and Wasserstein distance on a SSIM computation, as specified in VTK. Please note, due to possible arithmetic imprecision in the SSIM computation using a threshold of zero may return false with identical images. Depending on the VTK version, another comparison algorithm may be used. Threshold should be in range [0, 1[, this returns false otherwise. 1e-14: Pixel perfect comparison. 0.04: Visually indistinguishable. 0.1: Small visible difference. 0.5: Comparable images. 1.0: Different type, size or number of components </p>
<dd><p>Compare current image to a reference using the provided threshold. If the comparison fails, ie. error is higher than the threshold, this outputs the resulting diff and error and return false, return true otherwise. The error is minimum between Minkownski and Wasserstein distance on a SSIM computation, as specified in VTK. Please note, due to possible arithmetic imprecision in the SSIM computation using a threshold of zero may return false with identical images. Depending on the VTK version, another comparison algorithm may be used. Threshold should be in range [0, 1[, this returns false otherwise. 1e-14: Pixel perfect comparison. 0.05: Visually indistinguishable. 0.1: Small visible difference. 0.5: Comparable images. 1.0: Different type, size or number of components </p>
</dd></dl>

<dl class="cpp function">
Expand Down
2 changes: 1 addition & 1 deletion doc/libf3d/doxygen/searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion doc/user/OPTIONS.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion doc/user/OPTIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ Options|Description
Options|Default|Description
------|------|------
\-\-ref=\<png file\>||Render and compare with the provided *reference image*, for testing purposes. Use with output option to generate new baselines and diff images.
\-\-ref-threshold=\<threshold\>|0.04|Set the *comparison threshold* to trigger a test failure or success. The default (0.04) correspond to almost visually identical images.
\-\-ref-threshold=\<threshold\>|0.05|Set the *comparison threshold* to trigger a test failure or success. The default (0.05) correspond to almost visually identical images.
\-\-interaction-test-record=\<log file\>||Path to an interaction log file to *record interaction events* to.
\-\-interaction-test-play=\<log file\>||Path to an interaction log file to *play interactions events* from when loading a file.

Expand Down

0 comments on commit 47323fa

Please sign in to comment.