:py:mod:`vamtoolbox.metrics`
============================

.. py:module:: vamtoolbox.metrics


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


Functions
~~~~~~~~~

.. autoapisummary::

   vamtoolbox.metrics.calcCV
   vamtoolbox.metrics.calcVER
   vamtoolbox.metrics.calcPW
   vamtoolbox.metrics.calcIPDR



.. py:function:: calcCV(target, recon, layerwise=False)

   Calculate coefficient of variance in target region

   :param target as the reference to which the reconstruction is compared:

   recon : ndarray
       reconstruction to evaluate

   layerwise : bool, optional
       if True, the CV is computed per z-slice

   :returns: if layerwise == True, ndarray will have size equal to the # of z slices
   :rtype: float or ndarray


.. py:function:: calcVER(target, recon, layerwise=False)

   Calculate volumetric error rate

   :param target as the reference to which the reconstruction is compared:

   recon : ndarray
       reconstruction to evaluate

   layerwise : bool, optional
       if True, the VER is computed per z-slice

   :returns: if layerwise == True, ndarray will have size equal to the # of z slices
   :rtype: float or ndarray


.. py:function:: calcPW(target, recon, layerwise=False)

   Calculate process window

   :param target as the reference to which the reconstruction is compared:

   recon : ndarray
       reconstruction to evaluate

   layerwise : bool, optional
       if True, the PW is computed per z-slice

   :returns: if layerwise == True, ndarray will have size equal to the # of z slices
   :rtype: float or ndarray


.. py:function:: calcIPDR(target, recon, layerwise=False)

   Calculate in-part dose range

   :param target as the reference to which the reconstruction is compared:

   recon : ndarray
       reconstruction to evaluate

   layerwise : bool, optional
       if True, the IPDR is computed per z-slice

   :returns: if layerwise == True, ndarray will have size equal to the # of z slices
   :rtype: float or ndarray