:py:mod:`vamtoolbox.optimize`
=============================

.. py:module:: vamtoolbox.optimize


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   vamtoolbox.optimize.Options



Functions
~~~~~~~~~

.. autoapisummary::

   vamtoolbox.optimize.optimize



.. py:class:: Options(method: str = 'CAL', n_iter: int = 50, d_h: float = 0.8, d_l: float = 0.7, filter: str = 'ram-lak', units: str = 'normalized', blb=0, bub=None, **kwargs)


   .. py:attribute:: __default_FBP

      

   .. py:attribute:: __default_CAL

      

   .. py:attribute:: __default_PM

      

   .. py:attribute:: __default_OSMO

      

   .. py:attribute:: __default_BCLP

      

   .. py:method:: __str__()

      Return str(self).



.. py:function:: optimize(target_geo: vamtoolbox.geometry.TargetGeometry, proj_geo: vamtoolbox.geometry.ProjectionGeometry, options: Options, output='packaged')

   Performs VAM optimization using the selected optimizer in options

   :param target_geo:
   :type target_geo: geometry.TargetGeometry object
   :param proj_geo:
   :type proj_geo: geometry.ProjectionGeometry object
   :param options:
   :type options: optimize.Options object

   :returns: * *geometry.Sinogram object*
             * *geometry.Reconstruction object*