trim_bandstructure#

ifermi.interpolate.trim_bandstructure(energy_cutoff, band_structure)[source]#

Trim the number of bands in a band structure object based on a cutoff.

Parameters:
  • energy_cutoff (float) – An energy cutoff within which to keep the bands. If the system is metallic then the bands to keep will fall within +/- the cutoff around the Fermi level. If the system has a band gap, the bands from the VBM - energy_cutoff to CBM + energy_cutoff will be kept.

  • band_structure (BandStructure) – A band structure.

Return type:

BandStructure

Returns:

A trimmed band structure.