jarvis.analysis.stem.convolution_apprx
======================================

.. py:module:: jarvis.analysis.stem.convolution_apprx

.. autoapi-nested-parse::

   Module to simulate STEM images using convoltuin approximation.



Classes
-------

.. autoapisummary::

   jarvis.analysis.stem.convolution_apprx.STEMConv


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

.. py:class:: STEMConv(atoms=None, output_size=[50, 50], power_factor=1.7, gaussian_width=0.5, lorentzian_width=0.5, intensity_ratio=0.5, nbins=100, tol=0.5, crop=False)

   Bases: :py:obj:`object`


   Module to simulate STEM images using convoltuin approximation.


   .. py:attribute:: atoms
      :value: None



   .. py:attribute:: output_size
      :value: [50, 50]



   .. py:attribute:: power_factor
      :value: 1.7



   .. py:attribute:: gaussian_width
      :value: 0.5



   .. py:attribute:: lorentzian_width
      :value: 0.5



   .. py:attribute:: intensity_ratio
      :value: 0.5



   .. py:attribute:: nbins
      :value: 100



   .. py:attribute:: tol
      :value: 0.5



   .. py:attribute:: crop
      :value: False



   .. py:method:: superpose_deltas(positions, array)

      Superpose deltas.



   .. py:method:: simulate_surface(atoms: jarvis.core.atoms.Atoms, px_scale: float = 0.2, eps: float = 0.6, rot: float = 0, shift: List = [0, 0])

      Simulate a STEM image.

      atoms: jarvis.core.Atoms material slab
      px_scale: pixel size in angstroms/px
      eps: tolerance factor (angstroms)
      for rendering atoms outside the field of view
      rot: rotation about the image center (degrees)
      shift: rigid translation of field of view [dx, dy] (angstroms)