========
PyWI API
========

.. module:: pywi

The library provides classes which are usable by third party tools.

.. note::

    This project is still in *beta* stage, so the API is not finalized yet.

Benchmark package:

.. toctree::
   :maxdepth: 1

   pywi.benchmark.metrics.refbased <api_benchmark_metrics_refbased>
   pywi.benchmark.io.refbased.fits <api_benchmark_io_refbased_fits>

Filter package:

.. toctree::
   :maxdepth: 1

   pywi.processing.filtering.hard_filter <api_processing_filtering_hard_filter>
   pywi.processing.filtering.pixel_clusters <api_processing_filtering_pixel_clusters>

Transform package:

.. toctree::
   :maxdepth: 1

   pywi.processing.transform.mrtransform_wrapper <api_processing_transform_mrtransform>

I/O package:

.. toctree::
   :maxdepth: 1

   pywi.io.fits <api_io_fits>
   pywi.io.images <api_io_images>
   pywi.io.pil <api_io_pil>
   pywi.io.plot <api_io_plot>

Optimization package:

.. toctree::
   :maxdepth: 1

   pywi.optimization.bruteforce <api_optimization_bruteforce>
   pywi.optimization.differential_evolution <api_optimization_differential_evolution>
   pywi.optimization.saes <api_optimization_saes>
   pywi.optimization.objectivefunc.wavelets_mrfilter_delta_psi <api_optimization_objectivefunc_wavelets_mrfilter_delta_psi>

User interface package (UI):

.. toctree::
   :maxdepth: 1

   pywi.ui.argparse_commons <api_ui_argparse>
   pywi.ui.commons <api_ui_commons>
   pywi.ui.filter_with_mrfilter <api_ui_filter_with_mrfilter>
   pywi.ui.filter_with_mrtransform <api_ui_filter_with_mrtransform>