SpatialLDOS

class SpatialLDOS(data: ndarray, energy: ndarray, structure: Structure)

Holds the results of KPM.calc_spatial_ldos()

It behaves like a product of a Series and a StructureMap.

Methods

ldos(position[, sublattice])	Return the LDOS as a function of energy at a specific position
structure_map(energy)	Return a StructureMap of the spatial LDOS at the given energy

ldos(position: _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes], sublattice: str = '') → Series

Return the LDOS as a function of energy at a specific position

Parameters:

positionarray_like

sublatticeOptional[str]

Returns:

Series

structure_map(energy: float) → StructureMap

Return a StructureMap of the spatial LDOS at the given energy

Parameters:

energyfloat

Produce a structure map for LDOS data closest to this energy value.

Returns:

StructureMap