validate_sigmas#
- abtem.atoms.validate_sigmas(atoms, sigmas, return_array=False)[source]#
Validate displacement standard deviations and detect anisotropy.
- Parameters:
atoms (Atoms)
sigmas (AtomProperties) – Isotropic: a single float, per-element dict of floats, or length-N array. Anisotropic: a 3-tuple of floats (identical for all atoms), a per-element dict of 3-tuples/arrays, or an (N, 3) array.
return_array (bool) – If True, always return a flat ndarray rather than a dict.
- Return type:
tuple[Union[ndarray,dict[str,ndarray]],bool]- Returns:
validated_sigmas (ndarray or dict)
anisotropic (bool)