Deploying to gh-pages from @ 7ae6a1a 🚀

doc/libf3d/doxygen/_sources/api/program_listing_file_public_image.h.rst

@@ -76,7 +76,7 @@ Program Listing for File image.h
      image& setContent(void* buffer);
      [[nodiscard]] void* getContent() const;
    
-     bool compare(const image& reference, double threshold, double& error) const;
+     double compare(const image& reference) const;
    
      const image& save(
        const std::filesystem::path& filePath, SaveFormat format = SaveFormat::PNG) const;

doc/libf3d/doxygen/api/classf3d_1_1image.html

@@ -397,13 +397,13 @@ <h2>Class Documentation<a class="headerlink" href="#class-documentation" title="
 <dl class="cpp function">
 <dt class="sig sig-object cpp" id="_CPPv4NK3f3d5imageeqERK5image">
 <span id="_CPPv3NK3f3d5imageeqERK5image"></span><span id="_CPPv2NK3f3d5imageeqERK5image"></span><span id="f3d::image::eq-operator__imageCRC"></span><span class="target" id="classf3d_1_1image_1a9946310d12ccca5d8524eb99686c7852"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="k"><span class="pre">operator</span></span><span class="o"><span class="pre">==</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="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK3f3d5imageeqERK5image" title="Permalink to this definition">#</a><br /></dt>
-<dd><p>Comparison operators, uses <a class="reference internal" href="#classf3d_1_1image_1a9e3f22780c719f2ada05905e42c056f0"><span class="std std-ref">image::compare</span></a> with a threshold of 1e-14. </p>
+<dd><p>Comparison operators, uses <a class="reference internal" href="#classf3d_1_1image_1a49d3d5c99d0a1cb014e6c3392caa9f45"><span class="std std-ref">image::compare</span></a> with a threshold of 1e-14. </p>
 </dd></dl>
 
 <dl class="cpp function">
 <dt class="sig sig-object cpp" id="_CPPv4NK3f3d5imageneERK5image">
 <span id="_CPPv3NK3f3d5imageneERK5image"></span><span id="_CPPv2NK3f3d5imageneERK5image"></span><span id="f3d::image::neq-operator__imageCRC"></span><span class="target" id="classf3d_1_1image_1a0117eff18734cc22b4658d9b5cf9ffcf"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="k"><span class="pre">operator</span></span><span class="o"><span class="pre">!=</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="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK3f3d5imageneERK5image" title="Permalink to this definition">#</a><br /></dt>
-<dd><p>Comparison operators, uses <a class="reference internal" href="#classf3d_1_1image_1a9e3f22780c719f2ada05905e42c056f0"><span class="std std-ref">image::compare</span></a> with a threshold of 1e-14. </p>
+<dd><p>Comparison operators, uses <a class="reference internal" href="#classf3d_1_1image_1a49d3d5c99d0a1cb014e6c3392caa9f45"><span class="std std-ref">image::compare</span></a> with a threshold of 1e-14. </p>
 </dd></dl>
 
 </div>
@@ -573,9 +573,9 @@ <h3>Enumeration of supported channel types<a class="headerlink" href="#classf3d_
 </dd></dl>
 
 <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>
+<dt class="sig sig-object cpp" id="_CPPv4NK3f3d5image7compareERK5image">
+<span id="_CPPv3NK3f3d5image7compareERK5image"></span><span id="_CPPv2NK3f3d5image7compareERK5image"></span><span id="f3d::image::compare__imageCRC"></span><span class="target" id="classf3d_1_1image_1a49d3d5c99d0a1cb014e6c3392caa9f45"></span><span class="kt"><span class="pre">double</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="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK3f3d5image7compareERK5image" title="Permalink to this definition">#</a><br /></dt>
+<dd><p>Compare current image to a reference. 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 a non-zero value can be returned with identical images. Depending on the VTK version, another comparison algorithm may be used. Error value meaning is described below: 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></dl>
 
 <dl class="cpp function">

doc/libf3d/doxygen/api/program_listing_file_public_image.h.html

@@ -383,7 +383,7 @@ <h1>Program Listing for File image.h</h1>
 <span class="w">  </span><span class="n">image</span><span class="o">&amp;</span><span class="w"> </span><span class="nf">setContent</span><span class="p">(</span><span class="kt">void</span><span class="o">*</span><span class="w"> </span><span class="n">buffer</span><span class="p">);</span>
 <span class="w">  </span><span class="p">[[</span><span class="n">nodiscard</span><span class="p">]]</span><span class="w"> </span><span class="kt">void</span><span class="o">*</span><span class="w"> </span><span class="n">getContent</span><span class="p">()</span><span class="w"> </span><span class="k">const</span><span class="p">;</span>
 
-<span class="w">  </span><span class="kt">bool</span><span class="w"> </span><span class="nf">compare</span><span class="p">(</span><span class="k">const</span><span class="w"> </span><span class="n">image</span><span class="o">&amp;</span><span class="w"> </span><span class="n">reference</span><span class="p">,</span><span class="w"> </span><span class="kt">double</span><span class="w"> </span><span class="n">threshold</span><span class="p">,</span><span class="w"> </span><span class="kt">double</span><span class="o">&amp;</span><span class="w"> </span><span class="n">error</span><span class="p">)</span><span class="w"> </span><span class="k">const</span><span class="p">;</span>
+<span class="w">  </span><span class="kt">double</span><span class="w"> </span><span class="nf">compare</span><span class="p">(</span><span class="k">const</span><span class="w"> </span><span class="n">image</span><span class="o">&amp;</span><span class="w"> </span><span class="n">reference</span><span class="p">)</span><span class="w"> </span><span class="k">const</span><span class="p">;</span>
 
 <span class="w">  </span><span class="k">const</span><span class="w"> </span><span class="n">image</span><span class="o">&amp;</span><span class="w"> </span><span class="nf">save</span><span class="p">(</span>
 <span class="w">    </span><span class="k">const</span><span class="w"> </span><span class="n">std</span><span class="o">::</span><span class="n">filesystem</span><span class="o">::</span><span class="n">path</span><span class="o">&amp;</span><span class="w"> </span><span class="n">filePath</span><span class="p">,</span><span class="w"> </span><span class="n">SaveFormat</span><span class="w"> </span><span class="n">format</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">SaveFormat</span><span class="o">::</span><span class="n">PNG</span><span class="p">)</span><span class="w"> </span><span class="k">const</span><span class="p">;</span>

doc/libf3d/doxygen/genindex.html

@@ -481,7 +481,7 @@ <h2 id="F">F</h2>
 </li>
       <li><a href="api/classf3d_1_1image.html#_CPPv4N3f3d5image11ChannelType5SHORTE">f3d::image::ChannelType::SHORT (C++ enumerator)</a>
 </li>
-      <li><a href="api/classf3d_1_1image.html#_CPPv4NK3f3d5image7compareERK5imagedRd">f3d::image::compare (C++ function)</a>
+      <li><a href="api/classf3d_1_1image.html#_CPPv4NK3f3d5image7compareERK5image">f3d::image::compare (C++ function)</a>
 </li>
       <li><a href="api/classf3d_1_1image.html#_CPPv4NK3f3d5image15getChannelCountEv">f3d::image::getChannelCount (C++ function)</a>
 </li>