pyiqa.matlab_utils.scfpyr_util
==============================

.. py:module:: pyiqa.matlab_utils.scfpyr_util

.. autoapi-nested-parse::

   Complex-valued steerable pyramid

   Created by: https://github.com/tomrunia/PyTorchSteerablePyramid

   Modified by: Jiadi Mo (https://github.com/JiadiMo)

   Refer to:
       - Official Matlab code from https://github.com/LabForComputationalVision/matlabPyrTools/blob/master/buildSCFpyr.m;
       - Original Python code from https://github.com/LabForComputationalVision/pyPyrTools/blob/master/pyPyrTools/SCFpyr.py;







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

.. py:data:: pointOp

.. py:class:: SCFpyr_PyTorch(height=5, nbands=4, scale_factor=2, device=None)

   Bases: :py:obj:`object`


   This is a modified version of buildSFpyr, that constructs a
   complex-valued steerable pyramid  using Hilbert-transform pairs
   of filters. Note that the imaginary parts will *not* be steerable.
   Pytorch version >= 1.8.0



   .. py:method:: build(im_batch)

      Decomposes a batch of images into a complex steerable pyramid.
      The pyramid typically has ~4 levels and 4-8 orientations.

      :param im_batch: Batch of images of shape [N,C,H,W]
      :type im_batch: torch.Tensor

      :returns: list containing torch.Tensor objects storing the pyramid
      :rtype: pyramid