validate_per_atom_property#
- abtem.atoms.validate_per_atom_property(atoms, props, return_array=False)[source]#
Validate and normalise a per-atom scalar or vector property.
- Parameters:
atoms (Atoms)
props (float, dict, or array-like) – A single value for all atoms, a dict keyed by symbol or atomic number, or a sequence with one entry per atom.
return_array (bool) – If True, always return a flat ndarray rather than a dict.
- Return type:
Union[ndarray,dict[str,ndarray]]