sknano.core.atoms.DipoleAtoms

class sknano.core.atoms.DipoleAtoms(atoms=None, casttype=True, **kwargs)

An Atoms sub-class for DipoleAtoms.

A container class for DipoleAtom objects.

Parameters:

atoms : {None, sequence, DipoleAtoms}, optional

if not None, then a list of DipoleAtom instance objects or an existing DipoleAtoms instance object.

Attributes

M	Total mass of Atoms.
Natoms	Number of atoms in Atoms.
P	Return the total net dipole moment vector of DipoleAtoms.
dipole_moments	Return array of DipoleAtom dipole moments.
elements	ndarray of Atom.elements in Atoms.
fmtstr
masses	ndarray of Atom.masss in Atoms.
symbols	ndarray of Atom.symbols in Atoms.

Methods

append(atom)
clear()
copy()
count(item)
extend(other)
filter(condition[, invert])	Filter Atoms by condition.
filtered(condition[, invert])	Return new list of Atoms filtered by condition.
get_atoms([asarray])	Return list of Atoms.
getatomattr(attr)	Get ndarray of atom attributes attr.
index(item, *args)
insert(i, item)
mapatomattr([from_attr, to_attr, attrmap])	Set/update atom attribute from another atom attribute with dict.
pop([i])
remove(item)
reverse()
rezero([epsilon])	Set values with absolute value less than epsilon to zero.
rotate(**kwargs)	Rotate Atom vectors.
sort([key, reverse])
todict()
translate(t[, fix_anchor_points])	Translate Atom vectors by Vector t.