Skip to content

Commit

Permalink
docs typo
Browse files Browse the repository at this point in the history
  • Loading branch information
MadCake committed Jan 27, 2023
1 parent d8346c6 commit 8d5b037
Show file tree
Hide file tree
Showing 19 changed files with 159 additions and 156 deletions.
2 changes: 1 addition & 1 deletion Unity/Assets/Documentation/Data Layout.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Color representation \f$ \boldsymbol{\tilde{C}}(\delta) \f$ is generated from th
\end{bmatrix} \cdot \ddot{\boldsymbol{C}} (\delta)
\f}

Only 2nd and 3rd components of \f$ \boldsymbol{\tilde{C}}(\delta) \f$ are used for clustering. We can not cluster by hue directly, because it is circular. Instead, we use a two-dimensional representation \f$I_2I_3\f$. Axis \f$I_1\f$ is identical to HSI intensity; the plane \f$ I_2I_3 \f$ corresponds to variations HSI chromaticity (hue/saturation).
Only 2nd and 3rd components of \f$ \boldsymbol{\tilde{C}}(\delta) \f$ are used for clustering. We can not cluster by hue directly, because it is circular. Instead, we use a two-dimensional representation \f$I_2I_3\f$. Axis \f$I_1\f$ is identical to HSI intensity; the plane \f$ I_2I_3 \f$ corresponds to variations in HSI chromaticity (i.e. hue and saturation).

### Code

Expand Down
178 changes: 91 additions & 87 deletions docs/html/_cluster_centers_8cs_source.html
View file

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions docs/html/_launch_parameters_8cs_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html"> 13</a></span> <span class="keyword">public</span> <span class="keyword">class </span><a class="code hl_class" href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html">SerializableLaunchParameters</a></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> {</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> [SerializeReference]</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html#af93b07f9cc6387bb1d0d26eb57e6ce34"> 16</a></span> <span class="keyword">public</span> <a class="code hl_class" href="class_clustering_algorithms_1_1_dispatcher_parameters.html">DispatcherParameters</a> <a class="code hl_variable" href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html#af93b07f9cc6387bb1d0d26eb57e6ce34">abstractDispatcherParameters</a>;</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html#ab81ef5fec87616f666966d3941e17085"> 16</a></span> <span class="keyword">public</span> <a class="code hl_class" href="class_clustering_algorithms_1_1_dispatcher_parameters.html">DispatcherParameters</a> <a class="code hl_variable" href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html#ab81ef5fec87616f666966d3941e17085">dispatcherParameters</a>;</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html#a76b90a959afb372e53a3c033bcc4d35e"> 18</a></span> <span class="keyword">public</span> <span class="keywordtype">string</span> <a class="code hl_variable" href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html#a76b90a959afb372e53a3c033bcc4d35e">videoName</a>;</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html#a3cebd6bd34aad501d5760342508560f8"> 19</a></span> <span class="keyword">public</span> <span class="keywordtype">int</span> <a class="code hl_variable" href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html#a3cebd6bd34aad501d5760342508560f8">numIterations</a>;</div>
Expand Down Expand Up @@ -139,7 +139,7 @@
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html#a67c6470db2e76efc07c0f5c7d31230d0">stopCondition</a>,</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html#a685544050cdd3f102bf327c2d5fcbda8">readback</a>,</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html#acde71e4513b07c3f7fc2a9fc0820d379">useFullResTexRef</a>,</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <a class="code hl_class" href="class_clustering_algorithms_1_1_dispatcher_parameters.html">DispatcherParameters</a> dispatcherParameters</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <a class="code hl_class" href="class_clustering_algorithms_1_1_dispatcher_parameters.html">DispatcherParameters</a> <a class="code hl_variable" href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html#ab81ef5fec87616f666966d3941e17085">dispatcherParameters</a></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> )</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> {</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> this.videoName = <a class="code hl_variable" href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html#a76b90a959afb372e53a3c033bcc4d35e">videoName</a>;</div>
Expand All @@ -151,7 +151,7 @@
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> this.doDownscale = <a class="code hl_variable" href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html#aacdd3cf004e3b0391145660c44e89531">doDownscale</a>;</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> this.algorithm = <a class="code hl_variable" href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html#aeaae03db61de4dca651159923db46aaf">algorithm</a>;</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> this.doRandomizeEmptyClusters = <a class="code hl_variable" href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html#a59072772c791eb77238f0193c27569aa">doRandomizeEmptyClusters</a>;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> this.abstractDispatcherParameters = dispatcherParameters;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> this.dispatcherParameters = <a class="code hl_variable" href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html#ab81ef5fec87616f666966d3941e17085">dispatcherParameters</a>;</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> this.stopCondition = <a class="code hl_variable" href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html#a67c6470db2e76efc07c0f5c7d31230d0">stopCondition</a>;</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> this.useFullResTexRef = <a class="code hl_variable" href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html#acde71e4513b07c3f7fc2a9fc0820d379">useFullResTexRef</a>;</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> this.readback = <a class="code hl_variable" href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html#a685544050cdd3f102bf327c2d5fcbda8">readback</a>;</div>
Expand Down Expand Up @@ -213,11 +213,11 @@
<div class="ttc" id="aclass_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters_html_a685544050cdd3f102bf327c2d5fcbda8"><div class="ttname"><a href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html#a685544050cdd3f102bf327c2d5fcbda8">BenchmarkGeneration.LaunchParameters.SerializableLaunchParameters.readback</a></div><div class="ttdeci">bool readback</div><div class="ttdef"><b>Definition:</b> <a href="_launch_parameters_8cs_source.html#l00028">LaunchParameters.cs:28</a></div></div>
<div class="ttc" id="aclass_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters_html_a76b90a959afb372e53a3c033bcc4d35e"><div class="ttname"><a href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html#a76b90a959afb372e53a3c033bcc4d35e">BenchmarkGeneration.LaunchParameters.SerializableLaunchParameters.videoName</a></div><div class="ttdeci">string videoName</div><div class="ttdef"><b>Definition:</b> <a href="_launch_parameters_8cs_source.html#l00018">LaunchParameters.cs:18</a></div></div>
<div class="ttc" id="aclass_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters_html_aacdd3cf004e3b0391145660c44e89531"><div class="ttname"><a href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html#aacdd3cf004e3b0391145660c44e89531">BenchmarkGeneration.LaunchParameters.SerializableLaunchParameters.doDownscale</a></div><div class="ttdeci">bool doDownscale</div><div class="ttdef"><b>Definition:</b> <a href="_launch_parameters_8cs_source.html#l00024">LaunchParameters.cs:24</a></div></div>
<div class="ttc" id="aclass_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters_html_ab81ef5fec87616f666966d3941e17085"><div class="ttname"><a href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html#ab81ef5fec87616f666966d3941e17085">BenchmarkGeneration.LaunchParameters.SerializableLaunchParameters.dispatcherParameters</a></div><div class="ttdeci">DispatcherParameters dispatcherParameters</div><div class="ttdef"><b>Definition:</b> <a href="_launch_parameters_8cs_source.html#l00016">LaunchParameters.cs:16</a></div></div>
<div class="ttc" id="aclass_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters_html_acde71e4513b07c3f7fc2a9fc0820d379"><div class="ttname"><a href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html#acde71e4513b07c3f7fc2a9fc0820d379">BenchmarkGeneration.LaunchParameters.SerializableLaunchParameters.useFullResTexRef</a></div><div class="ttdeci">bool useFullResTexRef</div><div class="ttdef"><b>Definition:</b> <a href="_launch_parameters_8cs_source.html#l00029">LaunchParameters.cs:29</a></div></div>
<div class="ttc" id="aclass_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters_html_ad498cf6cd6031a80877fc8a816ad699b"><div class="ttname"><a href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html#ad498cf6cd6031a80877fc8a816ad699b">BenchmarkGeneration.LaunchParameters.SerializableLaunchParameters.workingTextureSize</a></div><div class="ttdeci">int workingTextureSize</div><div class="ttdef"><b>Definition:</b> <a href="_launch_parameters_8cs_source.html#l00020">LaunchParameters.cs:20</a></div></div>
<div class="ttc" id="aclass_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters_html_aeaae03db61de4dca651159923db46aaf"><div class="ttname"><a href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html#aeaae03db61de4dca651159923db46aaf">BenchmarkGeneration.LaunchParameters.SerializableLaunchParameters.algorithm</a></div><div class="ttdeci">string algorithm</div><div class="ttdef"><b>Definition:</b> <a href="_launch_parameters_8cs_source.html#l00025">LaunchParameters.cs:25</a></div></div>
<div class="ttc" id="aclass_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters_html_aec6a376cf70aa6afac3974fbed010d5b"><div class="ttname"><a href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html#aec6a376cf70aa6afac3974fbed010d5b">BenchmarkGeneration.LaunchParameters.SerializableLaunchParameters.jitterSize</a></div><div class="ttdeci">int jitterSize</div><div class="ttdef"><b>Definition:</b> <a href="_launch_parameters_8cs_source.html#l00022">LaunchParameters.cs:22</a></div></div>
<div class="ttc" id="aclass_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters_html_af93b07f9cc6387bb1d0d26eb57e6ce34"><div class="ttname"><a href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html#af93b07f9cc6387bb1d0d26eb57e6ce34">BenchmarkGeneration.LaunchParameters.SerializableLaunchParameters.abstractDispatcherParameters</a></div><div class="ttdeci">DispatcherParameters abstractDispatcherParameters</div><div class="ttdef"><b>Definition:</b> <a href="_launch_parameters_8cs_source.html#l00016">LaunchParameters.cs:16</a></div></div>
<div class="ttc" id="aclass_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters_html_af98006d39ea7aa69ba59cf0a3edb3f9a"><div class="ttname"><a href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html#af98006d39ea7aa69ba59cf0a3edb3f9a">BenchmarkGeneration.LaunchParameters.SerializableLaunchParameters.numClusters</a></div><div class="ttdeci">int numClusters</div><div class="ttdef"><b>Definition:</b> <a href="_launch_parameters_8cs_source.html#l00021">LaunchParameters.cs:21</a></div></div>
<div class="ttc" id="aclass_benchmark_generation_1_1_launch_parameters_html"><div class="ttname"><a href="class_benchmark_generation_1_1_launch_parameters.html">BenchmarkGeneration.LaunchParameters</a></div><div class="ttdoc">Call Dispose after using.</div><div class="ttdef"><b>Definition:</b> <a href="_launch_parameters_8cs_source.html#l00010">LaunchParameters.cs:11</a></div></div>
<div class="ttc" id="aclass_benchmark_generation_1_1_launch_parameters_html_a009d07d2874952a7dcbbd2400ccc896f"><div class="ttname"><a href="class_benchmark_generation_1_1_launch_parameters.html#a009d07d2874952a7dcbbd2400ccc896f">BenchmarkGeneration.LaunchParameters.video</a></div><div class="ttdeci">readonly UnityEngine.Video.VideoClip video</div><div class="ttdef"><b>Definition:</b> <a href="_launch_parameters_8cs_source.html#l00083">LaunchParameters.cs:83</a></div></div>
Expand Down
4 changes: 2 additions & 2 deletions ...enchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters-members.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,8 @@

<p>This is the complete list of members for <a class="el" href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html">BenchmarkGeneration.LaunchParameters.SerializableLaunchParameters</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html#af93b07f9cc6387bb1d0d26eb57e6ce34">abstractDispatcherParameters</a></td><td class="entry"><a class="el" href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html">BenchmarkGeneration.LaunchParameters.SerializableLaunchParameters</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html#aeaae03db61de4dca651159923db46aaf">algorithm</a></td><td class="entry"><a class="el" href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html">BenchmarkGeneration.LaunchParameters.SerializableLaunchParameters</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html#aeaae03db61de4dca651159923db46aaf">algorithm</a></td><td class="entry"><a class="el" href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html">BenchmarkGeneration.LaunchParameters.SerializableLaunchParameters</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html#ab81ef5fec87616f666966d3941e17085">dispatcherParameters</a></td><td class="entry"><a class="el" href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html">BenchmarkGeneration.LaunchParameters.SerializableLaunchParameters</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html#aacdd3cf004e3b0391145660c44e89531">doDownscale</a></td><td class="entry"><a class="el" href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html">BenchmarkGeneration.LaunchParameters.SerializableLaunchParameters</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html#a59072772c791eb77238f0193c27569aa">doRandomizeEmptyClusters</a></td><td class="entry"><a class="el" href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html">BenchmarkGeneration.LaunchParameters.SerializableLaunchParameters</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html#aec6a376cf70aa6afac3974fbed010d5b">jitterSize</a></td><td class="entry"><a class="el" href="class_benchmark_generation_1_1_launch_parameters_1_1_serializable_launch_parameters.html">BenchmarkGeneration.LaunchParameters.SerializableLaunchParameters</a></td><td class="entry"></td></tr>
Expand Down
Loading

0 comments on commit 8d5b037

Please sign in to comment.