new docs

mattclifford1 · Nov 27, 2024 · 78e2b0b · 78e2b0b
1 parent b2a9026
commit 78e2b0b
Show file tree

Hide file tree

Showing 135 changed files with 3,633 additions and 1,741 deletions.
diff --git a/dev_resources/docs/IQM_Vis.UI.rst b/dev_resources/docs/IQM_Vis.UI.rst
@@ -12,10 +12,18 @@ IQM\_Vis.UI.custom\_widgets module
    :undoc-members:
    :show-inheritance:
 
-IQM\_Vis.UI.experiment\_mode module
------------------------------------
+IQM\_Vis.UI.experiment\_mode\_2AFC module
+-----------------------------------------
 
-.. automodule:: IQM_Vis.UI.experiment_mode
+.. automodule:: IQM_Vis.UI.experiment_mode_2AFC
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+IQM\_Vis.UI.experiment\_mode\_JND module
+----------------------------------------
+
+.. automodule:: IQM_Vis.UI.experiment_mode_JND
    :members:
    :undoc-members:
    :show-inheritance:

diff --git a/dev_resources/docs/IQM_Vis.examples.KODAK_dataset.rst b/dev_resources/docs/IQM_Vis.examples.KODAK_dataset.rst
@@ -0,0 +1,10 @@
+IQM\_Vis.examples.KODAK\_dataset package
+========================================
+
+Module contents
+---------------
+
+.. automodule:: IQM_Vis.examples.KODAK_dataset
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/dev_resources/docs/IQM_Vis.examples.rst b/dev_resources/docs/IQM_Vis.examples.rst
@@ -7,6 +7,7 @@ Subpackages
 .. toctree::
    :maxdepth: 4
 
+   IQM_Vis.examples.KODAK_dataset
    IQM_Vis.examples.images
 
 Submodules
@@ -36,14 +37,6 @@ IQM\_Vis.examples.dists module
    :undoc-members:
    :show-inheritance:
 
-IQM\_Vis.examples.experiment module
------------------------------------
-
-.. automodule:: IQM_Vis.examples.experiment
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 IQM\_Vis.examples.kodak module
 ------------------------------
 
@@ -52,30 +45,6 @@ IQM\_Vis.examples.kodak module
    :undoc-members:
    :show-inheritance:
 
-IQM\_Vis.examples.multiple module
----------------------------------
-
-.. automodule:: IQM_Vis.examples.multiple
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-IQM\_Vis.examples.new\_api module
----------------------------------
-
-.. automodule:: IQM_Vis.examples.new_api
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-IQM\_Vis.examples.simple module
--------------------------------
-
-.. automodule:: IQM_Vis.examples.simple
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 Module contents
 ---------------
 

diff --git a/dev_resources/docs/_autosummary/IQM_Vis.UI.experiment_mode_2AFC.rst b/dev_resources/docs/_autosummary/IQM_Vis.UI.experiment_mode_2AFC.rst
@@ -0,0 +1,36 @@
+IQM\_Vis.UI.experiment\_mode\_2AFC
+==================================
+
+.. automodule:: IQM_Vis.UI.experiment_mode_2AFC
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      sort_list
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      make_experiment_2AFC
+      reset_image_widget_to_black
+
+
+
+
+
+
+
+
+
diff --git a/dev_resources/docs/_autosummary/IQM_Vis.UI.experiment_mode_JND.rst b/dev_resources/docs/_autosummary/IQM_Vis.UI.experiment_mode_JND.rst
@@ -0,0 +1,30 @@
+IQM\_Vis.UI.experiment\_mode\_JND
+=================================
+
+.. automodule:: IQM_Vis.UI.experiment_mode_JND
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      make_experiment_JND
+      reset_image_widget_to_black
+
+
+
+
+
+
+
+
+
diff --git a/dev_resources/docs/_autosummary/IQM_Vis.UI.images.rst b/dev_resources/docs/_autosummary/IQM_Vis.UI.images.rst
@@ -23,16 +23,19 @@ IQM\_Vis.UI.images
       ~images.change_to_specific_trans
       ~images.completed_range_results
       ~images.display_images
+      ~images.display_metric_JND_plot
       ~images.display_metric_correlation_plot
       ~images.display_metric_images
       ~images.display_metric_range_plot
       ~images.display_metrics
       ~images.display_metrics_graph
       ~images.display_metrics_text
       ~images.display_radar_plots
+      ~images.get_export_dir
       ~images.get_metrics_over_all_trans_with_init_values
       ~images.init_worker_thread
       ~images.load_experiment_from_dir
+      ~images.load_experiment_from_dir_JND
       ~images.load_human_experiment
       ~images.load_new_images_folder
       ~images.load_new_single_image

diff --git a/dev_resources/docs/_autosummary/IQM_Vis.UI.rst b/dev_resources/docs/_autosummary/IQM_Vis.UI.rst
@@ -1,4 +1,4 @@
-IQM\_Vis.UI
+IQM\_Vis.UI
 ===========
 
 .. automodule:: IQM_Vis.UI
@@ -28,7 +28,8 @@ IQM\_Vis.UI
    :recursive:
 
    IQM_Vis.UI.custom_widgets
-   IQM_Vis.UI.experiment_mode
+   IQM_Vis.UI.experiment_mode_2AFC
+   IQM_Vis.UI.experiment_mode_JND
    IQM_Vis.UI.images
    IQM_Vis.UI.layout
    IQM_Vis.UI.main

diff --git a/dev_resources/docs/_autosummary/IQM_Vis.UI.widgets.rst b/dev_resources/docs/_autosummary/IQM_Vis.UI.widgets.rst
@@ -13,12 +13,16 @@ IQM\_Vis.UI.widgets
 
    .. autosummary::
 
+      ~widgets.JND_dataset_range_lower
+      ~widgets.JND_dataset_range_upper
       ~widgets.__init__
+      ~widgets.change_dataset_name
       ~widgets.change_display_im_display_brightness
       ~widgets.change_display_im_rgb_brightness
       ~widgets.change_display_im_size
       ~widgets.change_graph_size
-      ~widgets.change_human_scores_after_exp
+      ~widgets.change_human_scores_after_exp_2AFC
+      ~widgets.change_human_scores_after_exp_JND
       ~widgets.change_num_steps
       ~widgets.change_plot_lims
       ~widgets.change_post_processing
@@ -33,7 +37,8 @@ IQM\_Vis.UI.widgets
       ~widgets.export_trans_images
       ~widgets.generic_value_change
       ~widgets.init_widgets
-      ~widgets.launch_experiment
+      ~widgets.launch_experiment_2AFC
+      ~widgets.launch_experiment_JND
       ~widgets.make_slider_range
       ~widgets.open_mlp_new
       ~widgets.reset_slider_group

diff --git a/dev_resources/docs/_autosummary/IQM_Vis.examples.KODAK_dataset.rst b/dev_resources/docs/_autosummary/IQM_Vis.examples.KODAK_dataset.rst
@@ -0,0 +1,23 @@
+IQM\_Vis.examples.KODAK\_dataset
+================================
+
+.. automodule:: IQM_Vis.examples.KODAK_dataset
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/dev_resources/docs/_autosummary/IQM_Vis.examples.rst b/dev_resources/docs/_autosummary/IQM_Vis.examples.rst
@@ -1,4 +1,4 @@
-IQM\_Vis.examples
+IQM\_Vis.examples
 =================
 
 .. automodule:: IQM_Vis.examples
@@ -27,13 +27,10 @@ IQM\_Vis.examples
    :toctree:
    :recursive:
 
+   IQM_Vis.examples.KODAK_dataset
    IQM_Vis.examples.all
    IQM_Vis.examples.dataset
    IQM_Vis.examples.dists
-   IQM_Vis.examples.experiment
    IQM_Vis.examples.images
    IQM_Vis.examples.kodak
-   IQM_Vis.examples.multiple
-   IQM_Vis.examples.new_api
-   IQM_Vis.examples.simple
 
diff --git a/dev_resources/docs/_autosummary/IQM_Vis.metrics.NLPD_torch.layers.rst b/dev_resources/docs/_autosummary/IQM_Vis.metrics.NLPD_torch.layers.rst
@@ -1,4 +1,4 @@
-IQM\_Vis.metrics.NLPD\_torch.layers
+IQM\_Vis.metrics.NLPD\_torch.layers
 ===================================
 
 .. automodule:: IQM_Vis.metrics.NLPD_torch.layers
@@ -21,11 +21,3 @@ IQM\_Vis.metrics.NLPD\_torch.layers
 
 
 
-.. rubric:: Modules
-
-.. autosummary::
-   :toctree:
-   :recursive:
-
-   IQM_Vis.metrics.NLPD_torch.layers.divisive_normalisation
-
diff --git a/dev_resources/docs/_autosummary/IQM_Vis.metrics.NLPD_torch.pyramids.rst b/dev_resources/docs/_autosummary/IQM_Vis.metrics.NLPD_torch.pyramids.rst
@@ -1,4 +1,4 @@
-IQM\_Vis.metrics.NLPD\_torch.pyramids
+IQM\_Vis.metrics.NLPD\_torch.pyramids
 =====================================
 
 .. automodule:: IQM_Vis.metrics.NLPD_torch.pyramids
@@ -18,9 +18,6 @@ IQM\_Vis.metrics.NLPD\_torch.pyramids
    .. autosummary::
 
       LaplacianPyramid
-      LaplacianPyramidGDN
-      SteerablePyramid
-      SteerableWavelet
 
 
 

diff --git a/dev_resources/docs/_autosummary/IQM_Vis.metrics.NLPD_torch.utils.rst b/dev_resources/docs/_autosummary/IQM_Vis.metrics.NLPD_torch.utils.rst
@@ -1,4 +1,4 @@
-IQM\_Vis.metrics.NLPD\_torch.utils
+IQM\_Vis.metrics.NLPD\_torch.utils
 ==================================
 
 .. automodule:: IQM_Vis.metrics.NLPD_torch.utils
@@ -28,7 +28,4 @@ IQM\_Vis.metrics.NLPD\_torch.utils
    :recursive:
 
    IQM_Vis.metrics.NLPD_torch.utils.conv
-   IQM_Vis.metrics.NLPD_torch.utils.fourier
-   IQM_Vis.metrics.NLPD_torch.utils.interp1d
-   IQM_Vis.metrics.NLPD_torch.utils.pyramid_filters
 
diff --git a/dev_resources/docs/_autosummary/IQM_Vis.utils.save_utils.rst b/dev_resources/docs/_autosummary/IQM_Vis.utils.save_utils.rst
@@ -1,4 +1,4 @@
-IQM\_Vis.utils.save\_utils
+IQM\_Vis.utils.save\_utils
 ==========================
 
 .. automodule:: IQM_Vis.utils.save_utils
@@ -20,6 +20,10 @@ IQM\_Vis.utils.save\_utils
    .. autosummary::
 
       get_IQM_file
+      get_JND_image_names
+      get_JND_ref_image_dir
+      get_JND_ref_image_unprocessed_dir
+      get_JND_user_ID
       get_human_scores_file
       get_human_times_file
       get_image_name_from_human_scores
@@ -31,9 +35,11 @@ IQM\_Vis.utils.save\_utils
       load_json_dict
       load_obj
       make_name_for_trans
+      save_2AFC_experiment_results
+      save_JND_experiment_results
       save_and_merge_df_as_csv
+      save_and_merge_rm_duplicates_df_as_csv
       save_df_as_csv
-      save_experiment_results
       save_json_dict
       save_obj
 

diff --git a/dev_resources/docs/_build/doctrees/IQM_Vis.UI.doctree b/dev_resources/docs/_build/doctrees/IQM_Vis.UI.doctree
diff --git a/dev_resources/docs/_build/doctrees/IQM_Vis.doctree b/dev_resources/docs/_build/doctrees/IQM_Vis.doctree
diff --git a/dev_resources/docs/_build/doctrees/IQM_Vis.examples.KODAK_dataset.doctree b/dev_resources/docs/_build/doctrees/IQM_Vis.examples.KODAK_dataset.doctree
diff --git a/dev_resources/docs/_build/doctrees/IQM_Vis.examples.doctree b/dev_resources/docs/_build/doctrees/IQM_Vis.examples.doctree
diff --git a/dev_resources/docs/_build/doctrees/IQM_Vis.metrics.SSIM.doctree b/dev_resources/docs/_build/doctrees/IQM_Vis.metrics.SSIM.doctree
diff --git a/dev_resources/docs/_build/doctrees/IQM_Vis.utils.doctree b/dev_resources/docs/_build/doctrees/IQM_Vis.utils.doctree
diff --git a/dev_resources/docs/_build/doctrees/Tutorials.doctree b/dev_resources/docs/_build/doctrees/Tutorials.doctree
diff --git a/dev_resources/docs/_build/doctrees/_autosummary/IQM_Vis.UI.doctree b/dev_resources/docs/_build/doctrees/_autosummary/IQM_Vis.UI.doctree
diff --git a/dev_resources/docs/_build/doctrees/_autosummary/IQM_Vis.UI.experiment_mode.doctree b/dev_resources/docs/_build/doctrees/_autosummary/IQM_Vis.UI.experiment_mode.doctree
diff --git a/dev_resources/docs/_build/doctrees/_autosummary/IQM_Vis.UI.experiment_mode_2AFC.doctree b/dev_resources/docs/_build/doctrees/_autosummary/IQM_Vis.UI.experiment_mode_2AFC.doctree
diff --git a/dev_resources/docs/_build/doctrees/_autosummary/IQM_Vis.UI.experiment_mode_JND.doctree b/dev_resources/docs/_build/doctrees/_autosummary/IQM_Vis.UI.experiment_mode_JND.doctree
diff --git a/dev_resources/docs/_build/doctrees/_autosummary/IQM_Vis.UI.images.doctree b/dev_resources/docs/_build/doctrees/_autosummary/IQM_Vis.UI.images.doctree
diff --git a/dev_resources/docs/_build/doctrees/_autosummary/IQM_Vis.UI.widgets.doctree b/dev_resources/docs/_build/doctrees/_autosummary/IQM_Vis.UI.widgets.doctree
diff --git a/dev_resources/docs/_build/doctrees/_autosummary/IQM_Vis.examples.KODAK_dataset.doctree b/dev_resources/docs/_build/doctrees/_autosummary/IQM_Vis.examples.KODAK_dataset.doctree
diff --git a/dev_resources/docs/_build/doctrees/_autosummary/IQM_Vis.examples.doctree b/dev_resources/docs/_build/doctrees/_autosummary/IQM_Vis.examples.doctree
diff --git a/dev_resources/docs/_build/doctrees/_autosummary/IQM_Vis.examples.experiment.doctree b/dev_resources/docs/_build/doctrees/_autosummary/IQM_Vis.examples.experiment.doctree
diff --git a/dev_resources/docs/_build/doctrees/_autosummary/IQM_Vis.examples.multiple.doctree b/dev_resources/docs/_build/doctrees/_autosummary/IQM_Vis.examples.multiple.doctree
diff --git a/dev_resources/docs/_build/doctrees/_autosummary/IQM_Vis.examples.new_api.doctree b/dev_resources/docs/_build/doctrees/_autosummary/IQM_Vis.examples.new_api.doctree
diff --git a/dev_resources/docs/_build/doctrees/_autosummary/IQM_Vis.examples.simple.doctree b/dev_resources/docs/_build/doctrees/_autosummary/IQM_Vis.examples.simple.doctree
diff --git a/...ld/doctrees/_autosummary/IQM_Vis.metrics.NLPD_torch.layers.divisive_normalisation.doctree b/...ld/doctrees/_autosummary/IQM_Vis.metrics.NLPD_torch.layers.divisive_normalisation.doctree
diff --git a/dev_resources/docs/_build/doctrees/_autosummary/IQM_Vis.metrics.NLPD_torch.layers.doctree b/dev_resources/docs/_build/doctrees/_autosummary/IQM_Vis.metrics.NLPD_torch.layers.doctree
diff --git a/dev_resources/docs/_build/doctrees/_autosummary/IQM_Vis.metrics.NLPD_torch.pyramids.doctree b/dev_resources/docs/_build/doctrees/_autosummary/IQM_Vis.metrics.NLPD_torch.pyramids.doctree
diff --git a/dev_resources/docs/_build/doctrees/_autosummary/IQM_Vis.metrics.NLPD_torch.utils.doctree b/dev_resources/docs/_build/doctrees/_autosummary/IQM_Vis.metrics.NLPD_torch.utils.doctree
diff --git a/...ources/docs/_build/doctrees/_autosummary/IQM_Vis.metrics.NLPD_torch.utils.fourier.doctree b/...ources/docs/_build/doctrees/_autosummary/IQM_Vis.metrics.NLPD_torch.utils.fourier.doctree
diff --git a/...urces/docs/_build/doctrees/_autosummary/IQM_Vis.metrics.NLPD_torch.utils.interp1d.doctree b/...urces/docs/_build/doctrees/_autosummary/IQM_Vis.metrics.NLPD_torch.utils.interp1d.doctree
diff --git a/...ocs/_build/doctrees/_autosummary/IQM_Vis.metrics.NLPD_torch.utils.pyramid_filters.doctree b/...ocs/_build/doctrees/_autosummary/IQM_Vis.metrics.NLPD_torch.utils.pyramid_filters.doctree
diff --git a/dev_resources/docs/_build/doctrees/_autosummary/IQM_Vis.utils.save_utils.doctree b/dev_resources/docs/_build/doctrees/_autosummary/IQM_Vis.utils.save_utils.doctree
diff --git a/dev_resources/docs/_build/doctrees/environment.pickle b/dev_resources/docs/_build/doctrees/environment.pickle