BasisAtom

class sknano.core.atoms.BasisAtom(*args, lattice=None, xs=None, ys=None, zs=None, **kwargs)[source] [edit on github][source]

Bases: sknano.core.atoms.mixins.AtomTransformationsMixin, sknano.core.atoms.lattice_atoms.LatticeAtom, sknano.core.atoms.xyz_atoms.XYZAtom

An Atom sub-class for a crystal structure basis atom.

Parameters:

Attributes

Z Atomic number \(Z\).
dr \(x, y, z\) components of Atom displacement vector.
element Element symbol.
fmtstr Format string.
lattice Crystal3DLattice.
m An alias for mass.
mass Atomic mass \(m_a\) in atomic mass units.
r \(x, y, z\) components of Atom position vector.
r0 \(x, y, z\) components of Atom position vector at t=0.
rs Scaled \(x, y, z\) components of Atom position vector.
symbol Element symbol.
x \(x\)-coordinate in units of Angstroms.
xs Scaled \(x\)-coordinate.
y \(y\)-coordinate in units of Angstroms.
ys Scaled \(y\)-coordinate.
z \(z\)-coordinate in units of Angstroms.
zs Scaled \(z\)-coordinate.

Methods

get_coords([asdict]) Return atom coords.
getattr(attr[, default, recursive]) Get atom attribute named attr.
reset_attrs(**kwargs) Reset atom attributes.
rezero([epsilon]) Alias for Atom.rezero_xyz, but calls super class rezero method as well.
rezero_coords([epsilon]) Alias for Atom.rezero_xyz.
rezero_xyz([epsilon]) Re-zero position vector components.
rotate(**kwargs) Rotate Atom position vector.
todict() Return dict of constructor parameters.
translate(t[, fix_anchor_point, cartesian]) Translate Atom position vector by Vector t.
update_attrs(**kwargs) Update atom attributes.