===============
Implementations
===============

Included with this toolkit are a number of implementations for the interfaces
described in the previous section.
Unlike the interfaces, which declare operation and use case, implementations
provide variations on *how* to satisfy the interface-defined use case, varying
trade-offs, or results implications.

.. When adding new classes within implementations, sort them alphabetically.

------------------
Image Perturbation
------------------

Class: MCRISEGrid
---------------
.. autoclass:: xaitk_saliency.impls.perturb_image.mc_rise.MCRISEGrid
  :members:

Class: RandomGrid
-----------------
.. autoclass:: xaitk_saliency.impls.perturb_image.random_grid.RandomGrid
  :members:

Class: RISEGrid
---------------
.. autoclass:: xaitk_saliency.impls.perturb_image.rise.RISEGrid
  :members:

Class: SlidingRadial
--------------------
.. autoclass:: xaitk_saliency.impls.perturb_image.sliding_radial.SlidingRadial
  :members:

Class: SlidingWindow
--------------------
.. autoclass:: xaitk_saliency.impls.perturb_image.sliding_window.SlidingWindow
  :members:

------------------
Heatmap Generation
------------------

Class: DRISEScoring
-------------------
.. autoclass:: xaitk_saliency.impls.gen_detector_prop_sal.drise_scoring.DRISEScoring
  :members:

Class: MCRISEScoring
------------------
.. autoclass:: xaitk_saliency.impls.gen_classifier_conf_sal.mc_rise_scoring.MCRISEScoring
  :members:

Class: OcclusionScoring
-----------------------
.. autoclass:: xaitk_saliency.impls.gen_classifier_conf_sal.occlusion_scoring.OcclusionScoring
  :members:

Class: RISEScoring
------------------
.. autoclass:: xaitk_saliency.impls.gen_classifier_conf_sal.rise_scoring.RISEScoring
  :members:

Class: SimilarityScoring
------------------------
.. autoclass:: xaitk_saliency.impls.gen_descriptor_sim_sal.similarity_scoring.SimilarityScoring
  :members:

Class: SquaredDifferenceScoring
-------------------------------
.. autoclass:: xaitk_saliency.impls.gen_classifier_conf_sal.squared_difference_scoring.SquaredDifferenceScoring
  :members:

------------------------------
End-to-End Saliency Generation
------------------------------

Image Classification
--------------------

Class: MCRISEStack
~~~~~~~~~~~~~~~~
.. autoclass:: xaitk_saliency.impls.gen_image_classifier_blackbox_sal.mc_rise.MCRISEStack
  :members:

Class: PerturbationOcclusion
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: xaitk_saliency.impls.gen_image_classifier_blackbox_sal.occlusion_based.PerturbationOcclusion
  :members:

Class: RISEStack
~~~~~~~~~~~~~~~~
.. autoclass:: xaitk_saliency.impls.gen_image_classifier_blackbox_sal.rise.RISEStack
  :members:

Class: SlidingWindowStack
~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: xaitk_saliency.impls.gen_image_classifier_blackbox_sal.slidingwindow.SlidingWindowStack
  :members:

Image Similarity
----------------

Class: PerturbationOcclusion
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: xaitk_saliency.impls.gen_image_similarity_blackbox_sal.occlusion_based.PerturbationOcclusion
  :members:

Class: SBSMStack
~~~~~~~~~~~~~~~~
.. autoclass:: xaitk_saliency.impls.gen_image_similarity_blackbox_sal.sbsm.SBSMStack
  :members:

Object Detection
----------------

Class: PerturbationOcclusion
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: xaitk_saliency.impls.gen_object_detector_blackbox_sal.occlusion_based.PerturbationOcclusion

Class: DRISEStack
~~~~~~~~~~~~~~~~~
.. autoclass:: xaitk_saliency.impls.gen_object_detector_blackbox_sal.drise.DRISEStack