:py:mod:`pytomography.utils.scatter`
====================================

.. py:module:: pytomography.utils.scatter


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


Functions
~~~~~~~~~

.. autoapisummary::

   pytomography.utils.scatter.get_smoothed_scatter
   pytomography.utils.scatter.compute_EW_scatter



.. py:function:: get_smoothed_scatter(scatter, proj_meta, sigma_theta = 0, sigma_r = 0, sigma_z = 0, N_sigmas = 3, FOV_mask = None)

   Smooths SPECT projection metadata

   :param scatter: Input projection data
   :type scatter: torch.Tensor
   :param proj_meta: Projection metadata
   :type proj_meta: ProjMeta
   :param sigma_theta: Smoothing in theta (specified in degrees). Defaults to 0.
   :type sigma_theta: float, optional
   :param sigma_r: Smoothing in r (specified in cm). Defaults to 0.
   :type sigma_r: float, optional
   :param sigma_z: Smoothing in z (specified in cm). Defaults to 0.
   :type sigma_z: float, optional
   :param N_sigmas: Number of sigmas to include in the smoothing kernel. Defaults to 3.
   :type N_sigmas: int, optional
   :param FOV_mask: Field of view mask. Defaults to None.
   :type FOV_mask: torch.Tensor, optional

   :returns: Smoothed projections
   :rtype: torch.Tensor


.. py:function:: compute_EW_scatter(projection_lower, projection_upper, width_lower, width_upper, width_peak, weighting_lower = 0.5, weighting_upper = 0.5, proj_meta=None, sigma_theta = 0, sigma_r = 0, sigma_z = 0, N_sigmas = 3, return_scatter_variance_estimate = False, fov_mask = None)

   Computes triple energy window estimate from lower and upper scatter projections as well as window widths

   :param projection_lower: Projection data corresponding to lower energy window
   :type projection_lower: torch.Tensor
   :param projection_upper: Projection data corresponding to upper energy window
   :type projection_upper: torch.Tensor
   :param width_lower: Width of lower energy window
   :type width_lower: float
   :param width_upper: Width of upper energy window
   :type width_upper: float
   :param width_peak: Width of peak energy window
   :type width_peak: float
   :param return_scatter_variance_estimate: Return scatter variance estimate. Defaults to False.
   :type return_scatter_variance_estimate: bool, optional
   :param fov_mask: Field of view mask; may be required when blurring scatter to avoid blurring accross edges. Defaults to None.
   :type fov_mask: torch.tensor, optional

   :returns: Scatter estimate (and scatter variance estimate if specified)
   :rtype: torch.Tensor | Sequence[torch.Tensor]