foscat.scat
===========

.. py:module:: foscat.scat


Attributes
----------

.. autoapisummary::

   foscat.scat.tf_defined
   foscat.scat.tf_function


Classes
-------

.. autoapisummary::

   foscat.scat.scat
   foscat.scat.funct


Functions
---------

.. autoapisummary::

   foscat.scat.read


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

.. py:data:: tf_defined

.. py:data:: tf_function

.. py:function:: read(filename)

.. py:class:: scat(p00, s0, s1, s2, s2l, j1, j2, cross=False, backend=None)

   .. py:attribute:: bk_type
      :value: 'SCAT'



   .. py:attribute:: P00


   .. py:attribute:: S0


   .. py:attribute:: S1


   .. py:attribute:: S2


   .. py:attribute:: S2L


   .. py:attribute:: j1


   .. py:attribute:: j2


   .. py:attribute:: cross
      :value: False



   .. py:attribute:: backend
      :value: None



   .. py:method:: set_bk_type(bk_type)


   .. py:method:: get_j_idx()


   .. py:method:: get_S0()


   .. py:method:: get_S1()


   .. py:method:: get_S2()


   .. py:method:: get_S2L()


   .. py:method:: get_P00()


   .. py:method:: reset_P00()


   .. py:method:: constant()


   .. py:method:: domult(x, y)


   .. py:method:: dodiv(x, y)


   .. py:method:: domin(x, y)


   .. py:method:: doadd(x, y)


   .. py:method:: toreal(value)


   .. py:method:: addcomplex(value, amp)


   .. py:method:: add_complex(amp)


   .. py:method:: real()


   .. py:method:: relu()


   .. py:method:: l1_abs(x)


   .. py:method:: plot(name=None, hold=True, color='blue', lw=1, legend=True)


   .. py:method:: save(filename)


   .. py:method:: read(filename)


   .. py:method:: get_np(x)


   .. py:method:: std()


   .. py:method:: mean()


   .. py:method:: sqrt()


   .. py:method:: L1()


   .. py:method:: square_comp()


   .. py:method:: iso_mean(repeat=False)


   .. py:method:: fft_ang(nharm=1, imaginary=False)


   .. py:method:: iso_std(repeat=False)


   .. py:method:: cleanval(x)


   .. py:method:: filter_inf()


   .. py:method:: interp(nscale, extend=False, constant=False, threshold=1e+30, use_mask=False)


   .. py:method:: flatten()


   .. py:method:: flattenMask()


   .. py:method:: model(i__y, add=0, dx=3, dell=2, weigth=None, inverse=False)


   .. py:method:: findn(n)


   .. py:method:: findidx(s2)


   .. py:method:: extrapol_s2(add, lnorm=1)


   .. py:method:: extrapol_s1(i_s1, add)


   .. py:method:: extrapol(add)


.. py:class:: funct(NORIENT=4, LAMBDA=1.2, KERNELSZ=3, slope=1.0, all_type='float32', nstep_max=20, padding='SAME', gpupos=0, mask_thres=None, mask_norm=False, isMPI=False, TEMPLATE_PATH=None, BACKEND='torch', use_2D=False, use_1D=False, return_data=False, DODIV=False, use_median=False, InitWave=None, silent=True, mpi_size=1, mpi_rank=0)

   Bases: :py:obj:`foscat.FoCUS.FoCUS`


   .. py:method:: fill(im, nullval=hp.UNSEEN)


   .. py:method:: moments(list_scat)


   .. py:method:: eval(image1, image2=None, mask=None, Auto=True, s0_off=1e-06, calc_var=False, norm=None)


   .. py:method:: square(x)


   .. py:method:: sqrt(x)


   .. py:method:: reduce_distance(x, y, sigma=None)


   .. py:method:: reduce_mean(x, axis=None)


   .. py:method:: reduce_sum(x, axis=None)


   .. py:method:: ldiff(sig, x)


   .. py:method:: log(x)


   .. py:method:: abs(x)


   .. py:method:: inv(x)


   .. py:method:: one()


   .. py:method:: eval_comp_fast(image1, image2=None, mask=None, Auto=True, s0_off=1e-06)


   .. py:method:: eval_fast(image1, image2=None, mask=None, Auto=True, s0_off=1e-06)