jarvis.analysis.stm.tersoff_hamann
==================================

.. py:module:: jarvis.analysis.stm.tersoff_hamann

.. autoapi-nested-parse::

   Module to simulate STM with Tershoff-Hamann approach.



Classes
-------

.. autoapisummary::

   jarvis.analysis.stm.tersoff_hamann.TersoffHamannSTM


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

.. py:class:: TersoffHamannSTM(chg_name='PARCHG', min_size=50.0, height_tol=2, zcut=None, use_interpolated=True, crop_from_center=False, crop_mult=3, min_pixel=288, interp_step=1.0, skew=True, extend=0, ft_image_path=None, ft_image_zoom_factor=5, dpi=240, cmap='gray')

   Bases: :py:obj:`object`


   Generate constant height and constant current STM images.


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



   .. py:attribute:: dim
      :value: None



   .. py:attribute:: zmaxp


   .. py:attribute:: nz


   .. py:attribute:: chg


   .. py:attribute:: cmap
      :value: 'gray'



   .. py:attribute:: ft_image_path
      :value: None



   .. py:attribute:: ft_image_zoom_factor
      :value: 5



   .. py:attribute:: height_tol
      :value: 2



   .. py:attribute:: a


   .. py:attribute:: b


   .. py:attribute:: c


   .. py:attribute:: skew
      :value: True



   .. py:attribute:: zcut
      :value: None



   .. py:attribute:: extend
      :value: 0



   .. py:attribute:: crop_mult
      :value: 3



   .. py:attribute:: crop_from_center
      :value: False



   .. py:attribute:: min_size
      :value: 50.0



   .. py:attribute:: repeat


   .. py:attribute:: scell


   .. py:attribute:: use_interpolated
      :value: True



   .. py:attribute:: interp_step
      :value: 1.0



   .. py:attribute:: min_pixel
      :value: 288



   .. py:attribute:: dpi
      :value: 240



   .. py:method:: constant_height(filename='testh.png')

      Get iso-height image.



   .. py:method:: constant_current(pc=None, ext=0.15, filename='testc.png', use_interpolated=True)

      Return the constant-current cut the charge density.



   .. py:method:: get_plot(ax, Z, extent, transform)

      Apply affine transformation.



   .. py:method:: get_interpolated_data(img_data=[])

      Get interpolated data after moving pixels.