:py:mod:`flatspin.vertices`
===========================

.. py:module:: flatspin.vertices

.. autoapi-nested-parse::

   Vertex analysis



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


Functions
~~~~~~~~~

.. autoapisummary::

   flatspin.vertices.find_vertices
   flatspin.vertices.vertex_type_ising
   flatspin.vertices.vertex_type_square
   flatspin.vertices.vertex_type_tri
   flatspin.vertices.vertex_type
   flatspin.vertices.vertex_pos
   flatspin.vertices.vertex_mag



Attributes
~~~~~~~~~~

.. autoapisummary::

   flatspin.vertices.vertex_patterns


.. py:data:: vertex_patterns
   

   

.. py:function:: find_vertices(grid, angle, win_size)

   Find the vertices of a geometry

   :param grid: The grid of the spin positions
   :type grid: Grid object
   :param angle: The angles of each spin
   :type angle: 1D array
   :param win_size: The window size to scan the grid
   :type win_size: (height, width)
   :param Returns a tuple (vi:
   :param vj:
   :param indices) where vi:
   :param vj are the vertex indices:
   :param and indices is a list of spin indices corresponding to each vertex:
   :param index.:


.. py:function:: vertex_type_ising(spin, angle)


.. py:function:: vertex_type_square(spin, angle)


.. py:function:: vertex_type_tri(spin, angle)


.. py:function:: vertex_type(spin, angle)

   Determine the type of a vertex given its spins and angles


.. py:function:: vertex_pos(pos, vertices)


.. py:function:: vertex_mag(mag, vertices)