face_properties

ifermi.surface.face_properties(interpolator, vertices, faces, band_idx, spin, reciprocal_lattice)[source]

Interpolate properties data onto the Fermi surfaces.

Parameters:
  • interpolator (LinearInterpolator) – Periodic interpolator for property data.

  • vertices (ndarray) – A (n, 3) float array of the vertices in the isosurface.

  • faces (ndarray) – A (m, 3) int array of the faces of the isosurface.

  • band_idx (int) – The band that the isosurface belongs to.

  • spin (Spin) – The spin channel the isosurface belongs to.

  • reciprocal_lattice (ndarray) – Reciprocal lattice matrix

Return type:

ndarray

Returns:

A (m, …) float array of the interpolated properties at the center of each face in the isosurface.