new docs

docs/_build/html/IQM_Vis.data_handlers.html

@@ -108,6 +108,11 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
 </dd></dl>
 
+<dl class="py function">
+<dt class="sig sig-object py" id="IQM_Vis.data_handlers.data_api.cache_tracked">
+<span class="sig-prename descclassname"><span class="pre">IQM_Vis.data_handlers.data_api.</span></span><span class="sig-name descname"><span class="pre">cache_tracked</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/IQM_Vis/data_handlers/data_api.html#cache_tracked"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#IQM_Vis.data_handlers.data_api.cache_tracked" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
 <dl class="py class">
 <dt class="sig sig-object py" id="IQM_Vis.data_handlers.data_api.dataset_holder">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">IQM_Vis.data_handlers.data_api.</span></span><span class="sig-name descname"><span class="pre">dataset_holder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">image_list:</span> <span class="pre">list</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metrics:</span> <span class="pre">dict</span> <span class="pre">=</span> <span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metric_images:</span> <span class="pre">dict</span> <span class="pre">=</span> <span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">image_loader=&lt;function</span> <span class="pre">load_image&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">image_pre_processing=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">image_post_processing=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">image_list_to_transform=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">human_exp_csv=None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/IQM_Vis/data_handlers/data_api.html#dataset_holder"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#IQM_Vis.data_handlers.data_api.dataset_holder" title="Permalink to this definition"></a></dt>
@@ -145,6 +150,11 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <span class="sig-name descname"><span class="pre">add_metric_image</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/IQM_Vis/data_handlers/data_api.html#dataset_holder.add_metric_image"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#IQM_Vis.data_handlers.data_api.dataset_holder.add_metric_image" title="Permalink to this definition"></a></dt>
 <dd></dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="IQM_Vis.data_handlers.data_api.dataset_holder.clear_all_cache">
+<span class="sig-name descname"><span class="pre">clear_all_cache</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/IQM_Vis/data_handlers/data_api.html#dataset_holder.clear_all_cache"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#IQM_Vis.data_handlers.data_api.dataset_holder.clear_all_cache" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="IQM_Vis.data_handlers.data_api.dataset_holder.get_image_dataset_list">
 <span class="sig-name descname"><span class="pre">get_image_dataset_list</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/IQM_Vis/data_handlers/data_api.html#dataset_holder.get_image_dataset_list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#IQM_Vis.data_handlers.data_api.dataset_holder.get_image_dataset_list" title="Permalink to this definition"></a></dt>
@@ -175,6 +185,11 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <span class="sig-name descname"><span class="pre">get_reference_image</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/IQM_Vis/data_handlers/data_api.html#dataset_holder.get_reference_image"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#IQM_Vis.data_handlers.data_api.dataset_holder.get_reference_image" title="Permalink to this definition"></a></dt>
 <dd></dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="IQM_Vis.data_handlers.data_api.dataset_holder.get_reference_image_by_index">
+<span class="sig-name descname"><span class="pre">get_reference_image_by_index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/IQM_Vis/data_handlers/data_api.html#dataset_holder.get_reference_image_by_index"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#IQM_Vis.data_handlers.data_api.dataset_holder.get_reference_image_by_index" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="IQM_Vis.data_handlers.data_api.dataset_holder.get_reference_image_name">
 <span class="sig-name descname"><span class="pre">get_reference_image_name</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/IQM_Vis/data_handlers/data_api.html#dataset_holder.get_reference_image_name"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#IQM_Vis.data_handlers.data_api.dataset_holder.get_reference_image_name" title="Permalink to this definition"></a></dt>
@@ -251,6 +266,11 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <dt class="sig sig-object py" id="IQM_Vis.data_handlers.data_api_abstract.base_dataset_loader">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">IQM_Vis.data_handlers.data_api_abstract.</span></span><span class="sig-name descname"><span class="pre">base_dataset_loader</span></span><a class="reference internal" href="_modules/IQM_Vis/data_handlers/data_api_abstract.html#base_dataset_loader"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#IQM_Vis.data_handlers.data_api_abstract.base_dataset_loader" title="Permalink to this definition"></a></dt>
 <dd><p>Bases: <a class="reference internal" href="#IQM_Vis.data_handlers.data_api_abstract.base_dataloader" title="IQM_Vis.data_handlers.data_api_abstract.base_dataloader"><code class="xref py py-class docutils literal notranslate"><span class="pre">IQM_Vis.data_handlers.data_api_abstract.base_dataloader</span></code></a></p>
+<dl class="py method">
+<dt class="sig sig-object py" id="IQM_Vis.data_handlers.data_api_abstract.base_dataset_loader.get_reference_image_by_index">
+<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_reference_image_by_index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/IQM_Vis/data_handlers/data_api_abstract.html#base_dataset_loader.get_reference_image_by_index"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#IQM_Vis.data_handlers.data_api_abstract.base_dataset_loader.get_reference_image_by_index" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
 </dd></dl>
 
 </section>

docs/_build/html/IQM_Vis.examples.html

@@ -126,7 +126,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
 <dl class="py function">
 <dt class="sig sig-object py" id="IQM_Vis.examples.dists.load_and_calibrate_image">
-<span class="sig-prename descclassname"><span class="pre">IQM_Vis.examples.dists.</span></span><span class="sig-name descname"><span class="pre">load_and_calibrate_image</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_luminance</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">200</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">256</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/IQM_Vis/examples/dists.html#load_and_calibrate_image"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#IQM_Vis.examples.dists.load_and_calibrate_image" title="Permalink to this definition"></a></dt>
+<span class="sig-prename descclassname"><span class="pre">IQM_Vis.examples.dists.</span></span><span class="sig-name descname"><span class="pre">load_and_calibrate_image</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_luminance</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">200</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">512</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/IQM_Vis/examples/dists.html#load_and_calibrate_image"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#IQM_Vis.examples.dists.load_and_calibrate_image" title="Permalink to this definition"></a></dt>
 <dd></dd></dl>
 
 <dl class="py function">

docs/_build/html/IQM_Vis.utils.html

@@ -100,7 +100,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
 <dl class="py function">
 <dt class="sig sig-object py" id="IQM_Vis.utils.gui_utils.change_im">
-<span class="sig-prename descclassname"><span class="pre">IQM_Vis.utils.gui_utils.</span></span><span class="sig-name descname"><span class="pre">change_im</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">widget</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">im</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resize</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rgb_brightness</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">250</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">display_brightness</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">250</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/IQM_Vis/utils/gui_utils.html#change_im"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#IQM_Vis.utils.gui_utils.change_im" title="Permalink to this definition"></a></dt>
+<span class="sig-prename descclassname"><span class="pre">IQM_Vis.utils.gui_utils.</span></span><span class="sig-name descname"><span class="pre">change_im</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">widget</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">im</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resize</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rgb_brightness</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">250</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">display_brightness</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">250</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">border</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/IQM_Vis/utils/gui_utils.html#change_im"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#IQM_Vis.utils.gui_utils.change_im" title="Permalink to this definition"></a></dt>
 <dd><p>given a numpy image, changes the given widget Frame</p>
 </dd></dl>
 
@@ -493,6 +493,11 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <dd><p>load trans dict from pkl file</p>
 </dd></dl>
 
+<dl class="py function">
+<dt class="sig sig-object py" id="IQM_Vis.utils.save_utils.make_name_for_trans">
+<span class="sig-prename descclassname"><span class="pre">IQM_Vis.utils.save_utils.</span></span><span class="sig-name descname"><span class="pre">make_name_for_trans</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">trans</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/IQM_Vis/utils/save_utils.html#make_name_for_trans"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#IQM_Vis.utils.save_utils.make_name_for_trans" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
 <dl class="py function">
 <dt class="sig sig-object py" id="IQM_Vis.utils.save_utils.save_and_merge_df_as_csv">
 <span class="sig-prename descclassname"><span class="pre">IQM_Vis.utils.save_utils.</span></span><span class="sig-name descname"><span class="pre">save_and_merge_df_as_csv</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">df</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/IQM_Vis/utils/save_utils.html#save_and_merge_df_as_csv"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#IQM_Vis.utils.save_utils.save_and_merge_df_as_csv" title="Permalink to this definition"></a></dt>